Skip to content

Commit

Permalink
Improve resource indexes to make supported resources easier to scan (#…
Browse files Browse the repository at this point in the history 
…4557)

* Update report generator

* Update documentation fragments for report

* Update docs

* Update generated docs

* Update docs after merge from main

* Update crossplane docs
  • Loading branch information
@theunrepentantgeek
theunrepentantgeek authored Feb 6, 2025
1 parent 0452638 commit 6c95f6c
Show file tree
Hide file tree
Showing 46 changed files with 612 additions and 393 deletions.
415 changes: 239 additions & 176 deletions docs/hugo/content/reference/_index.md
View file

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/hugo/content/reference/alertsmanagement/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ To install the CRDs for these resources, your ASO configuration must include `al
### 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 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| [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) |
Expand Down
37 changes: 21 additions & 16 deletions docs/hugo/content/reference/apimanagement/_index.md
View file

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/hugo/content/reference/appconfiguration/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ To install the CRDs for these resources, your ASO configuration must include `ap
### 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
13 changes: 9 additions & 4 deletions docs/hugo/content/reference/authorization/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,18 @@ 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
### Latest Released Versions

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.
These resource(s) are the latest versions 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/v1api20220401/#authorization.azure.com/v1api20220401.RoleAssignment) | 2022-04-01 | v1api20220401 | v2.4.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/authorization/v1api20220401/v1api20220401_roleassignment.yaml) |
| [RoleDefinition](https://azure.github.io/azure-service-operator/reference/authorization/v1api20220401/#authorization.azure.com/v1api20220401.RoleDefinition) | 2022-04-01 | v1api20220401 | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/authorization/v1api20220401/v1api20220401_roledefinition.yaml) |

### Other Supported Versions

These are older versions of resourced still 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/v1api20220401/#authorization.azure.com/v1api20220401.RoleAssignment) | 2022-04-01 | v1api20220401 | v2.4.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/authorization/v1api20220401/v1api20220401_roleassignment.yaml) |
| [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/v1api20200801preview/v1api20200801preview_roleassignment.yaml) |
| [RoleDefinition](https://azure.github.io/azure-service-operator/reference/authorization/v1api20220401/#authorization.azure.com/v1api20220401.RoleDefinition) | 2022-04-01 | v1api20220401 | v2.8.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/authorization/v1api20220401/v1api20220401_roledefinition.yaml) |

1 change: 0 additions & 1 deletion docs/hugo/content/reference/batch/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ To install the CRDs for these resources, your ASO configuration must include `ba
### 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
21 changes: 13 additions & 8 deletions docs/hugo/content/reference/cache/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,31 @@ 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.
### Latest Released Versions

These resource(s) are the latest versions 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/v1api20230801/#cache.azure.com/v1api20230801.Redis) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redis.yaml) |
| [RedisEnterprise](https://azure.github.io/azure-service-operator/reference/cache/v1api20230701/#cache.azure.com/v1api20230701.RedisEnterprise) | 2023-07-01 | v1api20230701 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230701/v1api20230701_redisenterprise.yaml) |
| [RedisEnterpriseDatabase](https://azure.github.io/azure-service-operator/reference/cache/v1api20230701/#cache.azure.com/v1api20230701.RedisEnterpriseDatabase) | 2023-07-01 | v1api20230701 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230701/v1api20230701_redisenterprisedatabase.yaml) |
| [RedisFirewallRule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisFirewallRule) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redisfirewallrule.yaml) |
| [RedisLinkedServer](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisLinkedServer) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redislinkedserver.yaml) |
| [RedisPatchSchedule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisPatchSchedule) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redispatchschedule.yaml) |

### Other Supported Versions

These are older versions of resourced still 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/v1api20230401/#cache.azure.com/v1api20230401.Redis) | 2023-04-01 | v1api20230401 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230401/v1api20230401_redis.yaml) |
| [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/v1api20201201/v1api20201201_redis.yaml) |
| [RedisEnterprise](https://azure.github.io/azure-service-operator/reference/cache/v1api20230701/#cache.azure.com/v1api20230701.RedisEnterprise) | 2023-07-01 | v1api20230701 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230701/v1api20230701_redisenterprise.yaml) |
| [RedisEnterprise](https://azure.github.io/azure-service-operator/reference/cache/v1api20210301/#cache.azure.com/v1api20210301.RedisEnterprise) | 2021-03-01 | v1api20210301 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20210301/v1api20210301_redisenterprise.yaml) |
| [RedisEnterpriseDatabase](https://azure.github.io/azure-service-operator/reference/cache/v1api20230701/#cache.azure.com/v1api20230701.RedisEnterpriseDatabase) | 2023-07-01 | v1api20230701 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230701/v1api20230701_redisenterprisedatabase.yaml) |
| [RedisEnterpriseDatabase](https://azure.github.io/azure-service-operator/reference/cache/v1api20210301/#cache.azure.com/v1api20210301.RedisEnterpriseDatabase) | 2021-03-01 | v1api20210301 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20210301/v1api20210301_redisenterprisedatabase.yaml) |
| [RedisFirewallRule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisFirewallRule) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redisfirewallrule.yaml) |
| [RedisFirewallRule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230401/#cache.azure.com/v1api20230401.RedisFirewallRule) | 2023-04-01 | v1api20230401 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230401/v1api20230401_redisfirewallrule.yaml) |
| [RedisFirewallRule](https://azure.github.io/azure-service-operator/reference/cache/v1api20201201/#cache.azure.com/v1api20201201.RedisFirewallRule) | 2020-12-01 | v1api20201201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20201201/v1api20201201_redisfirewallrule.yaml) |
| [RedisLinkedServer](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisLinkedServer) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redislinkedserver.yaml) |
| [RedisLinkedServer](https://azure.github.io/azure-service-operator/reference/cache/v1api20230401/#cache.azure.com/v1api20230401.RedisLinkedServer) | 2023-04-01 | v1api20230401 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230401/v1api20230401_redislinkedserver.yaml) |
| [RedisLinkedServer](https://azure.github.io/azure-service-operator/reference/cache/v1api20201201/#cache.azure.com/v1api20201201.RedisLinkedServer) | 2020-12-01 | v1api20201201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20201201/v1api20201201_redislinkedserver.yaml) |
| [RedisPatchSchedule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230801/#cache.azure.com/v1api20230801.RedisPatchSchedule) | 2023-08-01 | v1api20230801 | v2.10.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230801/v1api20230801_redispatchschedule.yaml) |
| [RedisPatchSchedule](https://azure.github.io/azure-service-operator/reference/cache/v1api20230401/#cache.azure.com/v1api20230401.RedisPatchSchedule) | 2023-04-01 | v1api20230401 | v2.3.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20230401/v1api20230401_redispatchschedule.yaml) |
| [RedisPatchSchedule](https://azure.github.io/azure-service-operator/reference/cache/v1api20201201/#cache.azure.com/v1api20201201.RedisPatchSchedule) | 2020-12-01 | v1api20201201 | v2.0.0 | [View](https://github.com/Azure/azure-service-operator/tree/main/v2/samples/cache/v1api20201201/v1api20201201_redispatchschedule.yaml) |

Loading

0 comments on commit 6c95f6c

Please sign in to comment.