Skip to content

Commit 5f056f8

Browse files
authored
Update docs for v2.11 (#4443)
Includes details about when we will deprecate CRD versions in order to keep CRDs from growing too large. Fixes #2687.
1 parent f04ae3f commit 5f056f8

File tree

8 files changed

+116
-147
lines changed

8 files changed

+116
-147
lines changed

docs/hugo/content/contributing/create-a-new-release.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Perform a simple smoke test to make sure the new release is capable of starting
6060

6161
3. Enable workload identity on that cluster:
6262
```
63-
task: controller:create-mi-for-workload-identity
63+
task controller:create-mi-for-workload-identity
6464
```
6565

6666
4. Install cert-manager
@@ -101,7 +101,7 @@ Perform a simple smoke test to make sure the new release is capable of starting
101101

102102
``` bash
103103
kubectl apply -f v2/samples/resources/v1api/v1api20200601_resourcegroup.yaml
104-
kubectl apply -f v2/samples/network/v1api20201101/v1api20201101_virtualnetwork.yaml
104+
kubectl apply -f v2/samples/network/v1api20240301/v1api20240301_virtualnetwork.yaml
105105
```
106106
11. Make sure they deploy successfully - check in the portal as well.
107107

docs/hugo/content/guide/crd-management.md

+25
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,31 @@ The recommended workflow for removing CRDs you are no longer using is:
129129
4. Delete the CRD using `kubectl delete`.
130130
5. Start the operator pod.
131131

132+
## Number of versions supported in a CRD
133+
134+
There is a limit to how large a CRD can be.
135+
136+
Each time a new version is added to a CRD it gets bigger. Large CRDs, those with many properties or deeply nested
137+
properties, will fit fewer versions before they run into the CRD size limit.
138+
139+
In order to keep CRDs under the size limit, ASO will periodically remove older versions of CRDs that are approaching
140+
the size limit. When doing this we will adhere to the following rules:
141+
142+
* Give at least 1 release advanced notice before a CRD version is removed. Look for the "upcoming breaking changes"
143+
section of the release notes.
144+
* Remove older versions first to make room for newer ones.
145+
* Remove preview versions before removing stable versions.
146+
* Always keep at least the latest 2 stable versions and the latest 1 preview version (if applicable,
147+
not all resources have preview versions). Some resources may retain more than this, but we'll never retain less than
148+
this.
149+
150+
For manually installed CRDs, [`asoctl clean crds`]( {{< relref "asoctl#clean-crds" >}} ) can be used to prepare
151+
CRDs for upgrade when a CRD version that was previously a storage version was removed.
152+
153+
For ASO managed CRDs, ASO will automatically clean up the old storage versions when it's upgraded to the new version
154+
that removed those CRDs. **Note:** This is not yet implemented, it is being tracked by
155+
[#4376](https://github.com/Azure/azure-service-operator/issues/4376).
156+
132157
## Best Practices
133158

134159
* Do not use `crdPattern=*` on AKS free tier clusters. It installs so many CRDs that it can overload kube-apiserver and cause

docs/hugo/content/reference/_index.md

+44-72
Large diffs are not rendered by default.

docs/hugo/content/reference/alertsmanagement/_index.md

+4-11
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,12 @@ no_list: true
55
---
66
To install the CRDs for these resources, your ASO configuration must include `alertsmanagement.azure.com/*` as a one of the configured CRD patterns. See [CRD Management in ASO](https://azure.github.io/azure-service-operator/guide/crd-management/) for details on doing this for both [Helm](https://azure.github.io/azure-service-operator/guide/crd-management/#helm) and [YAML](https://azure.github.io/azure-service-operator/guide/crd-management/#yaml) based installations.
77

8-
### Next Release
9-
10-
Development of these new resources is complete and they will be available in the next release of ASO.
11-
12-
| Resource | ARM Version | CRD Version | Supported From | Sample |
13-
|------------------------|-------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| SmartDetectorAlertRule | 2021-04-01 | v1api20210401 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/alertsmanagement/v1api20210401/v1api20210401_smartdetectoralertrule.yaml) |
15-
168
### Released
179

1810
These resource(s) are available for use in the current release of ASO. Different versions of a given resource reflect different versions of the Azure ARM API.
1911

20-
| Resource | ARM Version | CRD Version | Supported From | Sample |
21-
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
22-
| [PrometheusRuleGroup](https://azure.github.io/azure-service-operator/reference/alertsmanagement/v1api20230301/#alertsmanagement.azure.com/v1api20230301.PrometheusRuleGroup) | 2023-03-01 | v1api20230301 | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/alertsmanagement/v1api20230301/v1api20230301_prometheusrulegroup.yaml) |
12+
| Resource | ARM Version | CRD Version | Supported From | Sample |
13+
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| [PrometheusRuleGroup](https://azure.github.io/azure-service-operator/reference/alertsmanagement/v1api20230301/#alertsmanagement.azure.com/v1api20230301.PrometheusRuleGroup) | 2023-03-01 | v1api20230301 | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/alertsmanagement/v1api20230301/v1api20230301_prometheusrulegroup.yaml) |
15+
| SmartDetectorAlertRule | 2021-04-01 | v1api20210401 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/alertsmanagement/v1api20210401/v1api20210401_smartdetectoralertrule.yaml) |
2316

docs/hugo/content/reference/containerservice/_index.md

+4-11
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,6 @@ no_list: true
55
---
66
To install the CRDs for these resources, your ASO configuration must include `containerservice.azure.com/*` as a one of the configured CRD patterns. See [CRD Management in ASO](https://azure.github.io/azure-service-operator/guide/crd-management/) for details on doing this for both [Helm](https://azure.github.io/azure-service-operator/guide/crd-management/#helm) and [YAML](https://azure.github.io/azure-service-operator/guide/crd-management/#yaml) based installations.
77

8-
### Next Release
9-
10-
Development of these new resources is complete and they will be available in the next release of ASO.
11-
12-
| Resource | ARM Version | CRD Version | Supported From | Sample |
13-
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| [MaintenanceConfiguration](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.MaintenanceConfiguration) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_maintenanceconfiguration.yaml) |
15-
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.ManagedCluster) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_managedcluster.yaml) |
16-
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.ManagedClustersAgentPool) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_managedclustersagentpool.yaml) |
17-
| [TrustedAccessRoleBinding](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.TrustedAccessRoleBinding) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_trustedaccessrolebinding.yaml) |
18-
198
### Released
209

2110
These resource(s) are available for use in the current release of ASO. Different versions of a given resource reflect different versions of the Azure ARM API.
@@ -25,16 +14,20 @@ These resource(s) are available for use in the current release of ASO. Different
2514
| [Fleet](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230315preview/#containerservice.azure.com/v1api20230315preview.Fleet) | 2023-03-15-preview | v1api20230315preview | v2.4.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230315preview/v1api20230315preview_fleet.yaml) |
2615
| [FleetsMember](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230315preview/#containerservice.azure.com/v1api20230315preview.FleetsMember) | 2023-03-15-preview | v1api20230315preview | v2.4.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230315preview/v1api20230315preview_fleetsmember.yaml) |
2716
| [FleetsUpdateRun](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230315preview/#containerservice.azure.com/v1api20230315preview.FleetsUpdateRun) | 2023-03-15-preview | v1api20230315preview | v2.4.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230315preview/v1api20230315preview_fleetsupdaterun.yaml) |
17+
| [MaintenanceConfiguration](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.MaintenanceConfiguration) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_maintenanceconfiguration.yaml) |
18+
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.ManagedCluster) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_managedcluster.yaml) |
2819
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240402preview/#containerservice.azure.com/v1api20240402preview.ManagedCluster) | 2024-04-02-preview | v1api20240402preview | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240402preview/v1api20240402preview_managedcluster.yaml) |
2920
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20231102preview/#containerservice.azure.com/v1api20231102preview.ManagedCluster) | 2023-11-02-preview | v1api20231102preview | v2.6.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20231102preview/v1api20231102preview_managedcluster.yaml) |
3021
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20231001/#containerservice.azure.com/v1api20231001.ManagedCluster) | 2023-10-01 | v1api20231001 | v2.5.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20231001/v1api20231001_managedcluster.yaml) |
3122
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230201/#containerservice.azure.com/v1api20230201.ManagedCluster) | 2023-02-01 | v1api20230201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230201/v1api20230201_managedcluster.yaml) |
3223
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20210501/#containerservice.azure.com/v1api20210501.ManagedCluster) | 2021-05-01 | v1api20210501 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20210501/v1api20210501_managedcluster.yaml) |
24+
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.ManagedClustersAgentPool) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_managedclustersagentpool.yaml) |
3325
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240402preview/#containerservice.azure.com/v1api20240402preview.ManagedClustersAgentPool) | 2024-04-02-preview | v1api20240402preview | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240402preview/v1api20240402preview_managedclustersagentpool.yaml) |
3426
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20231102preview/#containerservice.azure.com/v1api20231102preview.ManagedClustersAgentPool) | 2023-11-02-preview | v1api20231102preview | v2.6.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20231102preview/v1api20231102preview_managedclustersagentpool.yaml) |
3527
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20231001/#containerservice.azure.com/v1api20231001.ManagedClustersAgentPool) | 2023-10-01 | v1api20231001 | v2.5.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20231001/v1api20231001_managedclustersagentpool.yaml) |
3628
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230201/#containerservice.azure.com/v1api20230201.ManagedClustersAgentPool) | 2023-02-01 | v1api20230201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230201/v1api20230201_managedclustersagentpool.yaml) |
3729
| [ManagedClustersAgentPool](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20210501/#containerservice.azure.com/v1api20210501.ManagedClustersAgentPool) | 2021-05-01 | v1api20210501 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20210501/v1api20210501_managedclustersagentpool.yaml) |
30+
| [TrustedAccessRoleBinding](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240901/#containerservice.azure.com/v1api20240901.TrustedAccessRoleBinding) | 2024-09-01 | v1api20240901 | v2.11.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240901/v1api20240901_trustedaccessrolebinding.yaml) |
3831
| [TrustedAccessRoleBinding](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20240402preview/#containerservice.azure.com/v1api20240402preview.TrustedAccessRoleBinding) | 2024-04-02-preview | v1api20240402preview | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20240402preview/v1api20240402preview_trustedaccessrolebinding.yaml) |
3932
| [TrustedAccessRoleBinding](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20231001/#containerservice.azure.com/v1api20231001.TrustedAccessRoleBinding) | 2023-10-01 | v1api20231001 | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20231001/v1api20231001_trustedaccessrolebinding.yaml) |
4033

0 commit comments

Comments
 (0)