You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by zh...@apache.org on 2022/11/16 14:45:35 UTC
[apisix-ingress-controller] branch master updated: docs: update API references (#1459)
This is an automated email from the ASF dual-hosted git repository.
zhangjintao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new 51c07453 docs: update API references (#1459)
51c07453 is described below
commit 51c074539125ee3240bb8d6326395197c588587e
Author: Navendu Pottekkat <na...@apache.org>
AuthorDate: Wed Nov 16 20:15:29 2022 +0530
docs: update API references (#1459)
---
.../latest/references/apisix_cluster_config_v2.md | 34 +++++++++++---------
.../references/apisix_cluster_config_v2beta3.md | 34 +++++++++++---------
.../en/latest/references/apisix_pluginconfig_v2.md | 22 +++++++------
.../references/apisix_pluginconfig_v2beta3.md | 22 +++++++------
docs/en/latest/references/apisix_tls_v2.md | 36 ++++++++++++++--------
docs/en/latest/references/apisix_tls_v2beta3.md | 36 ++++++++++++++--------
6 files changed, 112 insertions(+), 72 deletions(-)
diff --git a/docs/en/latest/references/apisix_cluster_config_v2.md b/docs/en/latest/references/apisix_cluster_config_v2.md
index 5d9ea8e1..1006f521 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.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -21,18 +25,20 @@ title: ApisixClusterConfig/v2 Reference
#
-->
+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 38d684b3..c7059bd1 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.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -21,18 +25,20 @@ title: ApisixClusterConfig/v2beta3 Reference
#
-->
+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 6d8c3995..154b43a5 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.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -23,11 +27,11 @@ title: ApisixPluginConfig/v2 Reference
## Spec
-Spec describes the desired state of an ApisixPluginConfig object.
+See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixPluginConfig.yaml) on GitHub.
-| Field | Type | Description |
-|---------------|----------|----------------------------------------------------|
-| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
-| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
-| plugins[].enable | boolean | Whether the plugin would be used |
-| plugins[].config | object | The configuration of the plugin that must have the same fields as in APISIX. |
+| Field | Type | Description |
+|------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| plugins | array | Plugins that will be executed on the Route. |
+| plugins[].name | string | Name of the Plugin. See [Plugin hub](https://apisix.apache.org/plugins/) for a list of available Plugins. |
+| plugins[].enable | boolean | When set to `true`, enables the Plugin. |
+| plugins[].config | object | Configuration of the Plugin. Must have the same fields as in the [Plugin docs](https://apisix.apache.org/docs/apisix/plugins/batch-requests/). |
diff --git a/docs/en/latest/references/apisix_pluginconfig_v2beta3.md b/docs/en/latest/references/apisix_pluginconfig_v2beta3.md
index 9741a3b9..d230497a 100644
--- a/docs/en/latest/references/apisix_pluginconfig_v2beta3.md
+++ b/docs/en/latest/references/apisix_pluginconfig_v2beta3.md
@@ -1,7 +1,11 @@
---
-title: ApisixPluginConfig/v2beta3 Reference
+title: ApisixPluginConfig/v2beta3
+keywords:
+ - APISIX ingress
+ - Apache APISIX
+ - ApisixPluginConfig
+description: Reference for ApisixPluginConfig/v2beta3 custom Kubernetes resource.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -23,11 +27,11 @@ title: ApisixPluginConfig/v2beta3 Reference
## Spec
-Spec describes the desired state of an ApisixPluginConfig object.
+See the [definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixPluginConfig.yaml) on GitHub.
-| Field | Type | Description |
-|---------------|----------|----------------------------------------------------|
-| plugins | array | A series of custom plugins that will be executed once this route rule is matched |
-| plugins[].name | string | The plugin name, see [docs](http://apisix.apache.org/docs/apisix/getting-started) for learning the available plugins. |
-| plugins[].enable | boolean | Whether the plugin would be used |
-| plugins[].config | object | The configuration of the plugin that must have the same fields as in APISIX. |
+| Field | Type | Description |
+|------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| plugins | array | Plugins that will be executed on the Route. |
+| plugins[].name | string | Name of the Plugin. See [Plugin hub](https://apisix.apache.org/plugins/) for a list of available Plugins. |
+| plugins[].enable | boolean | When set to `true`, enables the Plugin. |
+| plugins[].config | object | Configuration of the Plugin. Must have the same fields as in the [Plugin docs](https://apisix.apache.org/docs/apisix/plugins/batch-requests/). |
diff --git a/docs/en/latest/references/apisix_tls_v2.md b/docs/en/latest/references/apisix_tls_v2.md
index 26142263..8084bc22 100644
--- a/docs/en/latest/references/apisix_tls_v2.md
+++ b/docs/en/latest/references/apisix_tls_v2.md
@@ -1,7 +1,11 @@
---
-title: ApisixTls/v2 Reference
+title: ApisixTls/v2
+keywords:
+ - APISIX ingress
+ - Apache APISIX
+ - ApisixTls
+description: Reference for ApisixTls/v2 custom Kubernetes resource.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -21,14 +25,20 @@ title: ApisixTls/v2 Reference
#
-->
-| 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 6759d5d8..c507e3e5 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.
---
-
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -21,14 +25,20 @@ title: ApisixTls/v2beta3 Reference
#
-->
-| 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. |