Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update API references #1459

Merged
merged 2 commits into from
Nov 16, 2022
Merged

docs: update API references #1459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aed19b6
docs: update API references
pottekkat Nov 14, 2022
f2633ba
fix links
pottekkat Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions docs/en/latest/references/apisix_cluster_config_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. |
34 changes: 20 additions & 14 deletions docs/en/latest/references/apisix_cluster_config_v2beta3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. |
22 changes: 13 additions & 9 deletions docs/en/latest/references/apisix_pluginconfig_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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/). |
22 changes: 13 additions & 9 deletions docs/en/latest/references/apisix_pluginconfig_v2beta3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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/). |
36 changes: 23 additions & 13 deletions docs/en/latest/references/apisix_tls_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. |
36 changes: 23 additions & 13 deletions docs/en/latest/references/apisix_tls_v2beta3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. |