Document upcoming 2.2.0 breaking change (#3036)

Azure · Jun 1, 2023 · 9295eea · 9295eea
1 parent 63e8ae1
commit 9295eea
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/hugo/content/guide/breaking-changes/_index.md b/docs/hugo/content/guide/breaking-changes/_index.md
@@ -15,6 +15,9 @@ You can easily swap from a `v1beta` version to a `v1api` version by just replaci
 
 ## Released Breaking Changes
 
+### Upcoming breaking changes
+* AKS ManagedClusterServicePrincipalProfile.Secret will change from `string` to `genruntime.SecretReference`
+
 ### v2.1.0
 
 Breaking changes are:

diff --git a/docs/hugo/content/guide/breaking-changes/breaking-changes-v2.1.0.md b/docs/hugo/content/guide/breaking-changes/breaking-changes-v2.1.0.md
@@ -30,3 +30,12 @@ allowing references to secrets only if the secret is in the same namespace as th
 This was a security issue which we had to close.
 
 See [#2919](https://github.com/Azure/azure-service-operator/pull/2919)
+
+## Upcoming breaking changes
+
+### AKS ManagedClusterServicePrincipalProfile.Secret will change from `string` to `genruntime.SecretReference`
+
+We realized that this field contains a secret and as such _should not be specified_. Secrets should not appear in plain
+text in CRs. We will be making a breaking change in 2.2.0 to resolve this issue.
+
+**In the meantime:** We strongly recommend you use managed identity (the default) for your clusters.