Skip to content

Commit 8a9d08c

Browse files
matthchrmatthchr
authored
Documentation for upcoming v2.11.0 release (#4441)
1 parent d5d877d commit 8a9d08c

File tree

4 files changed

+84
-9
lines changed

4 files changed

+84
-9
lines changed

‎docs/hugo/content/guide/breaking-changes/breaking-changes-v2.11.0.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "v2.11.0 Breaking Changes"
3+
linkTitle: "v2.11.0"
4+
weight: -45 # This should be 5 lower than the previous breaking change document
5+
---
6+
7+
## Breaking changes
8+
9+
#### Moved all the "ARM" variants of the CRD types into dedicated subpackages
10+
11+
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.
12+
13+
## Upcoming Breaking changes
14+
15+
### Deprecated managedclusters.containerservice.azure.com API versions
16+
17+
- The v1api20210501 and v1api20231102preview versions will be removed in ASO release 2.12.
18+
- The v1api20230201 version will be removed in ASO release 2.13.
19+
20+
We recommend you move to use a different CRD version to avoid errors.

‎docs/hugo/content/guide/configmaps.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,36 @@ consult its [documentation](../../reference/authorization/v1api20200801preview/#
4545

4646
## How to export ConfigMap data from ASO
4747

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

54-
**Example (from [the UserAssignedIdentity sample](https://github.com/Azure/azure-service-operator/blob/main/v2/samples/managedidentity/v1api20181130/v1api20181130_userassignedidentity.yaml)):**
52+
The resource will not move to [Condition]( {{< relref "conditions" >}} ) `Ready=True` until the data has been written.
53+
54+
**Example `.spec.operatorSpec.configMapExpressions`:**
55+
```yaml
56+
apiVersion: managedidentity.azure.com/v1api20181130
57+
kind: UserAssignedIdentity
58+
metadata:
59+
name: sampleuserassignedidentity
60+
namespace: default
61+
spec:
62+
location: westcentralus
63+
owner:
64+
name: aso-sample-rg
65+
operatorSpec:
66+
configMapExpressions:
67+
- name: identity-settings
68+
key: principalId
69+
value: self.status.principalId
70+
- name: identity-settings
71+
key: principalId
72+
value: self.status.clientId
73+
```
74+
75+
More complex expressions can be exported as well, see [Expressions]( {{< relref "expressions" >}} ) for more details.
76+
77+
**Example `.spec.operatorSpec.configMaps` (from [the UserAssignedIdentity sample](https://github.com/Azure/azure-service-operator/blob/main/v2/samples/managedidentity/v1api20181130/v1api20181130_userassignedidentity.yaml)):**
5578
```yaml
5679
apiVersion: managedidentity.azure.com/v1api20181130
5780
kind: UserAssignedIdentity

‎docs/hugo/content/guide/expressions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: CEL Expressions
3-
linktitle: expressions
3+
linktitle: Expressions
44
weight: 1 # This is the default weight if you just want to be ordered alphabetically
55
---
66

‎docs/hugo/content/guide/secrets.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,45 @@ For this reason, we recommend if you expect to perform secret rotation to mount
5353
## How to retrieve secrets created by Azure
5454

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

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

62-
**Example:**
64+
**Example `.spec.operatorSpec.secretExpressions`:**
65+
```yaml
66+
apiVersion: documentdb.azure.com/v1alpha1api20210515
67+
kind: DatabaseAccount
68+
metadata:
69+
name: sample-db-account
70+
namespace: default
71+
spec:
72+
location: westcentralus
73+
owner:
74+
name: aso-sample-rg
75+
kind: MongoDB
76+
databaseAccountOfferType: Standard
77+
locations:
78+
- locationName: westcentralus
79+
operatorSpec:
80+
secretExpressions:
81+
- name: mysecret
82+
key: primarymasterkey
83+
value: secret.primaryMasterKey
84+
- name: mysecret
85+
key: secondarymasterkey
86+
value: secret.secondaryMasterKey
87+
- name: myendpoint # Can put different values into different Kubernetes secrets, if desired
88+
key: endpoint
89+
value: self.status.documentEndpoint
90+
```
91+
92+
More complex expressions can be exported as well, see [Expressions]( {{< relref "expressions" >}} ) for more details.
93+
94+
**Example `.spec.operatorSpec.secrets`:**
6395
```yaml
6496
apiVersion: documentdb.azure.com/v1alpha1api20210515
6597
kind: DatabaseAccount

0 commit comments

Comments
 (0)