diff --git a/docs/en/latest/references/apisix_cluster_config_v2.md b/docs/en/latest/references/apisix_cluster_config_v2.md index 5d9ea8e18e..1006f52169 100644 --- a/docs/en/latest/references/apisix_cluster_config_v2.md +++ b/docs/en/latest/references/apisix_cluster_config_v2.md @@ -1,7 +1,11 @@ --- -title: ApisixClusterConfig/v2 Reference +title: ApisixClusterConfig/v2 +keywords: + - APISIX ingress + - Apache APISIX + - ApisixClusterConfig +description: Reference for ApisixClusterConfig/v2 custom Kubernetes resource. --- - +See [concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_cluster_config) to learn more about how to use the ApisixClusterConfig resource. + ## Spec -Spec describes the desired state of an ApisixClusterConfig object. +See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixClusterConfig.yaml) on GitHub. -| Field | Type | Description | -|---------------|----------|-----------------------| -| monitoring | object | Monitoring settings. | -| monitoring.prometheus | object | Prometheus settings. | -| monitoring.prometheus.enable | boolean | Whether to enable Prometheus or not. | -| monitoring.skywalking | object | Skywalking settings. | -| monitoring.skywalking.enable | boolean | Whether to enable Skywalking or not. | -| monitoring.skywalking.sampleRatio | number | The sample ratio for spans, value should be in `[0, 1]`.| -| admin | object | Administrative settings. | -| admin.baseURL | string | the base url for APISIX cluster. | -| admin.AdminKey | string | admin key used for authentication with APISIX cluster. | +| Attribute | Type | Description | +|-----------------------------------|---------|------------------------------------------------| +| monitoring | object | Monitoring configurations. | +| monitoring.prometheus | object | Prometheus configurations. | +| monitoring.prometheus.enable | boolean | When set to `true`, enables Prometheus. | +| monitoring.skywalking | object | Apache SkyWalking configurations. | +| monitoring.skywalking.enable | boolean | When set to `true`, enables SkyWalking. | +| monitoring.skywalking.sampleRatio | number | Sample ratio for spans. Should be in `[0, 1]`. | +| admin | object | Admin configurations. | +| admin.baseURL | string | Base URL of the APISIX cluster. | +| admin.AdminKey | string | Admin key to authenticate with APISIX cluster. | diff --git a/docs/en/latest/references/apisix_cluster_config_v2beta3.md b/docs/en/latest/references/apisix_cluster_config_v2beta3.md index 38d684b31f..c7059bd163 100644 --- a/docs/en/latest/references/apisix_cluster_config_v2beta3.md +++ b/docs/en/latest/references/apisix_cluster_config_v2beta3.md @@ -1,7 +1,11 @@ --- -title: ApisixClusterConfig/v2beta3 Reference +title: ApisixClusterConfig/v2beta3 +keywords: + - APISIX ingress + - Apache APISIX + - ApisixClusterConfig +description: Reference for ApisixClusterConfig/v2beta3 custom Kubernetes resource. --- - +See [concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_cluster_config) to learn more about how to use the ApisixClusterConfig resource. + ## Spec -Spec describes the desired state of an ApisixClusterConfig object. +See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixClusterConfig.yaml) on GitHub. -| Field | Type | Description | -|---------------|----------|-----------------------| -| monitoring | object | Monitoring settings. | -| monitoring.prometheus | object | Prometheus settings. | -| monitoring.prometheus.enable | boolean | Whether to enable Prometheus or not. | -| monitoring.skywalking | object | Skywalking settings. | -| monitoring.skywalking.enable | boolean | Whether to enable Skywalking or not. | -| monitoring.skywalking.sampleRatio | number | The sample ratio for spans, value should be in `[0, 1]`.| -| admin | object | Administrative settings. | -| admin.baseURL | string | the base url for APISIX cluster. | -| admin.AdminKey | string | admin key used for authentication with APISIX cluster. | +| Attribute | Type | Description | +|-----------------------------------|---------|------------------------------------------------| +| monitoring | object | Monitoring configurations. | +| monitoring.prometheus | object | Prometheus configurations. | +| monitoring.prometheus.enable | boolean | When set to `true`, enables Prometheus. | +| monitoring.skywalking | object | Apache SkyWalking configurations. | +| monitoring.skywalking.enable | boolean | When set to `true`, enables SkyWalking. | +| monitoring.skywalking.sampleRatio | number | Sample ratio for spans. Should be in `[0, 1]`. | +| admin | object | Admin configurations. | +| admin.baseURL | string | Base URL of the APISIX cluster. | +| admin.AdminKey | string | Admin key to authenticate with APISIX cluster. | diff --git a/docs/en/latest/references/apisix_pluginconfig_v2.md b/docs/en/latest/references/apisix_pluginconfig_v2.md index 6d8c39950a..154b43a571 100644 --- a/docs/en/latest/references/apisix_pluginconfig_v2.md +++ b/docs/en/latest/references/apisix_pluginconfig_v2.md @@ -1,7 +1,11 @@ --- -title: ApisixPluginConfig/v2 Reference +title: ApisixPluginConfig/v2 +keywords: + - APISIX ingress + - Apache APISIX + - ApisixPluginConfig +description: Reference for ApisixPluginConfig/v2 custom Kubernetes resource. --- - -| Field | Type | Description | -|-------------------------------|----------|---------------------------------------------------------------------------------------------------------------| -| hosts | array | The domain list to identify which hosts (matched with SNI) can use the TLS certificate stored in the Secret. | -| secret | object | The definition of the related Secret object with current ApisixTls object. | -| secret.name | string | The name of the related Secret object with current ApisixTls object. | -| secret.namespace | string | The namespace of the related Secret object with current ApisixTls object. | -| client | object | The configuration of the certificate provided by the client. | -| client.caSecret | object | The definition of the related Secret object with the certificate provided by the client. | -| client.caSecret.name | string | The name of the related Secret object with the certificate provided by the client. | -| client.caSecret.namespace | string | The namespace of the related Secret object with the certificate provided by the client. | -| client.depth | int | The max certificate of chain length. | +See [concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_tls) to learn more about how to use the ApisixTls resource. + +## Spec + +See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixTls.yaml) on GitHub. + +| Attribute | Type | Description | +|---------------------------|--------|-----------------------------------------------------------------------------------------| +| hosts | array | List of hosts (with matched SNI) that can use the TLS certificate stored in the Secret. | +| secret | object | Definition of the Secret related to the current `ApisixTls` object. | +| secret.name | string | Name of the Secret related to the current `ApisixTls` object. | +| secret.namespace | string | Namespace of the Secret related to the current `ApisixTls` object. | +| client | object | Configuration for the certificate provided by the client. | +| client.caSecret | object | Definition of the Secret related to the certificate. | +| client.caSecret.name | string | Name of the Secret related to the certificate provided by the client. | +| client.caSecret.namespace | string | Namespace of the Secret related to the certificate. | +| client.depth | int | The maximum length of the certificate chain. | diff --git a/docs/en/latest/references/apisix_tls_v2beta3.md b/docs/en/latest/references/apisix_tls_v2beta3.md index 6759d5d8d0..c507e3e590 100644 --- a/docs/en/latest/references/apisix_tls_v2beta3.md +++ b/docs/en/latest/references/apisix_tls_v2beta3.md @@ -1,7 +1,11 @@ --- -title: ApisixTls/v2beta3 Reference +title: ApisixTls/v2beta3 +keywords: + - APISIX ingress + - Apache APISIX + - ApisixTls +description: Reference for ApisixTls/v2beta3 custom Kubernetes resource. --- - -| Field | Type | Description | -|-------------------------------|----------|---------------------------------------------------------------------------------------------------------------| -| hosts | array | The domain list to identify which hosts (matched with SNI) can use the TLS certificate stored in the Secret. | -| secret | object | The definition of the related Secret object with current ApisixTls object. | -| secret.name | string | The name of the related Secret object with current ApisixTls object. | -| secret.namespace | string | The namespace of the related Secret object with current ApisixTls object. | -| client | object | The configuration of the certificate provided by the client. | -| client.caSecret | object | The definition of the related Secret object with the certificate provided by the client. | -| client.caSecret.name | string | The name of the related Secret object with the certificate provided by the client. | -| client.caSecret.namespace | string | The namespace of the related Secret object with the certificate provided by the client. | -| client.depth | int | The max certificate of chain length. | +See [concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_tls) to learn more about how to use the ApisixTls resource. + +## Spec + +See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixTls.yaml) on GitHub. + +| Attribute | Type | Description | +|---------------------------|--------|-----------------------------------------------------------------------------------------| +| hosts | array | List of hosts (with matched SNI) that can use the TLS certificate stored in the Secret. | +| secret | object | Definition of the Secret related to the current `ApisixTls` object. | +| secret.name | string | Name of the Secret related to the current `ApisixTls` object. | +| secret.namespace | string | Namespace of the Secret related to the current `ApisixTls` object. | +| client | object | Configuration for the certificate provided by the client. | +| client.caSecret | object | Definition of the Secret related to the certificate. | +| client.caSecret.name | string | Name of the Secret related to the certificate provided by the client. | +| client.caSecret.namespace | string | Namespace of the Secret related to the certificate. | +| client.depth | int | The maximum length of the certificate chain. |