Skip to content

Commit

Permalink
Documentation for upcoming v2.11.0 release (#4441)
Browse files Browse the repository at this point in the history
  • Loading branch information
matthchr authored Nov 12, 2024
1 parent d5d877d commit 8a9d08c
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "v2.11.0 Breaking Changes"
linkTitle: "v2.11.0"
weight: -45 # This should be 5 lower than the previous breaking change document
---

## Breaking changes

#### Moved all the "ARM" variants of the CRD types into dedicated subpackages

This is only breaking for consumers of the Go package, not for users of the YAML, and only for those using the ARM types directly.

## Upcoming Breaking changes

### Deprecated managedclusters.containerservice.azure.com API versions

- The v1api20210501 and v1api20231102preview versions will be removed in ASO release 2.12.
- The v1api20230201 version will be removed in ASO release 2.13.

We recommend you move to use a different CRD version to avoid errors.
35 changes: 29 additions & 6 deletions docs/hugo/content/guide/configmaps.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,36 @@ consult its [documentation](../../reference/authorization/v1api20200801preview/#

## How to export ConfigMap data from ASO

Some resources support saving data into a `ConfigMap`. The individual properties can be exported to a `ConfigMap` of your choosing by
configuring the `.spec.operatorSpec.configMaps` field. The data will be written to the destination(s) you specify once the resource has
successfully been provisioned in Azure.
The resource will not move to [Condition]( {{< relref "conditions" >}} ) `Ready=True`
until the data has been written.
Data can be exported to a `ConfigMap` of your choosing by
configuring the `.spec.operatorSpec.configMaps` field, or the `.spec.operatorSpec.configMapExpressions` field.
The data will be written to the destination(s) you specify once the resource has successfully been provisioned in Azure.

**Example (from [the UserAssignedIdentity sample](https://github.com/Azure/azure-service-operator/blob/main/v2/samples/managedidentity/v1api20181130/v1api20181130_userassignedidentity.yaml)):**
The resource will not move to [Condition]( {{< relref "conditions" >}} ) `Ready=True` until the data has been written.

**Example `.spec.operatorSpec.configMapExpressions`:**
```yaml
apiVersion: managedidentity.azure.com/v1api20181130
kind: UserAssignedIdentity
metadata:
name: sampleuserassignedidentity
namespace: default
spec:
location: westcentralus
owner:
name: aso-sample-rg
operatorSpec:
configMapExpressions:
- name: identity-settings
key: principalId
value: self.status.principalId
- name: identity-settings
key: principalId
value: self.status.clientId
```

More complex expressions can be exported as well, see [Expressions]( {{< relref "expressions" >}} ) for more details.

**Example `.spec.operatorSpec.configMaps` (from [the UserAssignedIdentity sample](https://github.com/Azure/azure-service-operator/blob/main/v2/samples/managedidentity/v1api20181130/v1api20181130_userassignedidentity.yaml)):**
```yaml
apiVersion: managedidentity.azure.com/v1api20181130
kind: UserAssignedIdentity
Expand Down
2 changes: 1 addition & 1 deletion docs/hugo/content/guide/expressions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: CEL Expressions
linktitle: expressions
linktitle: Expressions
weight: 1 # This is the default weight if you just want to be ordered alphabetically
---

Expand Down
36 changes: 34 additions & 2 deletions docs/hugo/content/guide/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,45 @@ For this reason, we recommend if you expect to perform secret rotation to mount
## How to retrieve secrets created by Azure

Some Azure resources produce secrets themselves. ASO supports automatically querying these secrets
and storing them in the [SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination) you specify.
and storing them in the [SecretDestination](https://pkg.go.dev/github.com/Azure/azure-service-operator/v2/pkg/genruntime#SecretDestination)
you specify. This is done with the `.spec.operatorSpec.secrets` field, if you just need the secret itself,
or the [`.spec.operatorSpec.secretExpressions`]( {{< relref "expressions" >}} ) field, if you want the secret formatted in some way.

These secrets will be written to the destination(s) you specify once the resource has successfully been provisioned in Azure.
The resource will not move to [Condition]( {{< relref "conditions" >}} ) `Ready=True`
until the secrets have been written.

**Example:**
**Example `.spec.operatorSpec.secretExpressions`:**
```yaml
apiVersion: documentdb.azure.com/v1alpha1api20210515
kind: DatabaseAccount
metadata:
name: sample-db-account
namespace: default
spec:
location: westcentralus
owner:
name: aso-sample-rg
kind: MongoDB
databaseAccountOfferType: Standard
locations:
- locationName: westcentralus
operatorSpec:
secretExpressions:
- name: mysecret
key: primarymasterkey
value: secret.primaryMasterKey
- name: mysecret
key: secondarymasterkey
value: secret.secondaryMasterKey
- name: myendpoint # Can put different values into different Kubernetes secrets, if desired
key: endpoint
value: self.status.documentEndpoint
```

More complex expressions can be exported as well, see [Expressions]( {{< relref "expressions" >}} ) for more details.

**Example `.spec.operatorSpec.secrets`:**
```yaml
apiVersion: documentdb.azure.com/v1alpha1api20210515
kind: DatabaseAccount
Expand Down

0 comments on commit 8a9d08c

Please sign in to comment.