Skip to content

Commit

Permalink
Add CRD pattern docs for each group (#3147)
Browse files Browse the repository at this point in the history 
* Use templating for fragments
* Add group header
* Update rendered documentation
  • Loading branch information
@theunrepentantgeek
theunrepentantgeek authored Jul 19, 2023
1 parent e748005 commit 0eb6054
Show file tree
Hide file tree
Showing 44 changed files with 257 additions and 134 deletions.
103 changes: 66 additions & 37 deletions docs/hugo/content/reference/_index.md
View file

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/hugo/content/reference/appconfiguration/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: AppConfiguration Supported Resources
linktitle: AppConfiguration
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `appconfiguration.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [ConfigurationStore](https://azure.github.io/azure-service-operator/reference/appconfiguration/v1api20220501/#appconfiguration.azure.com/v1api20220501.ConfigurationStore) | 2022-05-01 | v1api20220501 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/appconfiguration/v1api/v1api20220501_configurationstore.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/authorization/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: Authorization Supported Resources
linktitle: Authorization
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `authorization.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [RoleAssignment](https://azure.github.io/azure-service-operator/reference/authorization/v1api20200801preview/#authorization.azure.com/v1api20200801preview.RoleAssignment) | 2020-08-01-preview | v1api20200801preview | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/authorization/v1api/v1api20200801preview_roleassignment.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/batch/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: Batch Supported Resources
linktitle: Batch
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `batch.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|--------------------------------------------------------------------------------------------------------------------------|
| [BatchAccount](https://azure.github.io/azure-service-operator/reference/batch/v1api20210101/#batch.azure.com/v1api20210101.BatchAccount) | 2021-01-01 | v1api20210101 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/batch/v1api/v1api20210101_batchaccount.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/cache/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: Cache Supported Resources
linktitle: Cache
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `cache.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------|
| [Redis](https://azure.github.io/azure-service-operator/reference/cache/v1api20201201/#cache.azure.com/v1api20201201.Redis) | 2020-12-01 | v1api20201201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api/v1api20201201_redis.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/cdn/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: Cdn Supported Resources
linktitle: Cdn
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `cdn.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------|
| [Profile](https://azure.github.io/azure-service-operator/reference/cdn/v1api20210601/#cdn.azure.com/v1api20210601.Profile) | 2021-06-01 | v1api20210601 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cdn/v1api/v1api20210601_profile.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/compute/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: Compute Supported Resources
linktitle: Compute
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `compute.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------|
| [Disk](https://azure.github.io/azure-service-operator/reference/compute/v1api20200930/#compute.azure.com/v1api20200930.Disk) | 2020-09-30 | v1api20200930 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/compute/v1api/v1api20200930_disk.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/containerinstance/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: ContainerInstance Supported Resources
linktitle: ContainerInstance
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `containerinstance.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------|
| [ContainerGroup](https://azure.github.io/azure-service-operator/reference/containerinstance/v1api20211001/#containerinstance.azure.com/v1api20211001.ContainerGroup) | 2021-10-01 | v1api20211001 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerinstance/v1api/v1api20211001_containergroup.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/containerregistry/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: ContainerRegistry Supported Resources
linktitle: ContainerRegistry
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `containerregistry.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|----------------------------------------------------------------------------------------------------------------------------------|
| [Registry](https://azure.github.io/azure-service-operator/reference/containerregistry/v1api20210901/#containerregistry.azure.com/v1api20210901.Registry) | 2021-09-01 | v1api20210901 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerregistry/v1api/v1api20210901_registry.yaml) |
Expand Down
4 changes: 2 additions & 2 deletions docs/hugo/content/reference/containerservice/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: ContainerService Supported Resources
linktitle: ContainerService
no_list: true
---
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.

### Next Release

Development of these new resources is complete and they will be available in the next release of ASO.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [TrustedAccessRoleBinding](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230202preview/#containerservice.azure.com/v1api20230202preview.TrustedAccessRoleBinding) | 2023-02-02-preview | v1api20230202preview | v2.2.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230202preview/v1api20230202preview_trustedaccessrolebinding.yaml) |
Expand All @@ -16,7 +17,6 @@ Development of these new resources is complete and they will be available in the

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ManagedCluster](https://azure.github.io/azure-service-operator/reference/containerservice/v1api20230202preview/#containerservice.azure.com/v1api20230202preview.ManagedCluster) | 2023-02-02-preview | v1api20230202preview | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/containerservice/v1api20230202preview/v1api20230202preview_managedcluster.yaml) |
Expand Down
3 changes: 2 additions & 1 deletion docs/hugo/content/reference/datafactory/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ title: DataFactory Supported Resources
linktitle: DataFactory
no_list: true
---
To install the CRDs for these resources, your ASO configuration must include `datafactory.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.

### Released

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.


| Resource | ARM Version | CRD Version | Supported From | Sample |
|--------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|---------------------------------------------------------------------------------------------------------------------------|
| [Factory](https://azure.github.io/azure-service-operator/reference/datafactory/v1api20180601/#datafactory.azure.com/v1api20180601.Factory) | 2018-06-01 | v1api20180601 | v2.1.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/datafactory/v1api/v1api20180601_factory.yaml) |
Expand Down
Loading

0 comments on commit 0eb6054

Please sign in to comment.