This is an automated email from the ASF dual-hosted git repository.
traky 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 d7145d61 docs: remove v2beta3 (#2251)
d7145d61 is described below
commit d7145d617e7778e6493930c637468064b235ec5a
Author: Traky Deng <[email protected]>
AuthorDate: Wed Jun 26 10:14:44 2024 +0800
docs: remove v2beta3 (#2251)
---
docs/en/latest/FAQ.md | 10 ---
docs/en/latest/concepts/apisix_plugin_config.md | 2 +-
docs/en/latest/config.json | 4 -
.../references/apisix_cluster_config_v2beta3.md | 44 ----------
.../references/apisix_pluginconfig_v2beta3.md | 37 --------
docs/en/latest/references/apisix_route_v2beta3.md | 99 ----------------------
docs/en/latest/references/apisix_tls_v2beta3.md | 44 ----------
7 files changed, 1 insertion(+), 239 deletions(-)
diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md
index 39193062..40422c2c 100644
--- a/docs/en/latest/FAQ.md
+++ b/docs/en/latest/FAQ.md
@@ -72,16 +72,6 @@ These CRDs are not templated but will be installed by
default when running `helm
:::
-## Why is there an error like "no matches for kind "ApisixRoute" in version
"apisix.apache.org/v2beta3"" when I try to create a Route?
-
-Make sure that you have the correct version of the CRDs installed in your
cluster (see [updating
CRDs](#how-do-i-update-the-crds-when-updating-apisix-ingress-controller)).
`ApisixRoute` has two versions: `v2beta3` and `v2`.
-
-Also check your `ApisixRoute` definition for the correct version by running:
-
-```shell
-kubectl get crd apisixroutes.apisix.apache.org -o jsonpath='{
.spec.versions[*].name }' -A
-```
-
## How do I modify the Admin API key in APISIX Ingress?
You can change the Admin API key in two ways:
diff --git a/docs/en/latest/concepts/apisix_plugin_config.md
b/docs/en/latest/concepts/apisix_plugin_config.md
index c259410a..7460693a 100644
--- a/docs/en/latest/concepts/apisix_plugin_config.md
+++ b/docs/en/latest/concepts/apisix_plugin_config.md
@@ -35,7 +35,7 @@ spec:
You can then configure a Route to use the `echo-and-cors-apc` Plugin
configuration:
```yaml
-apiVersion: apisix.apache.org/v2beta3
+apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin-route
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
index 62c5ea2e..896647b2 100644
--- a/docs/en/latest/config.json
+++ b/docs/en/latest/config.json
@@ -49,15 +49,11 @@
"type": "category",
"label": "References",
"items": [
- "references/apisix_route_v2beta3",
"references/apisix_route_v2",
"references/apisix_upstream",
"references/apisix_tls_v2",
- "references/apisix_tls_v2beta3",
"references/apisix_cluster_config_v2",
- "references/apisix_cluster_config_v2beta3",
"references/apisix_pluginconfig_v2",
- "references/apisix_pluginconfig_v2beta3",
"references/v2",
"references/apisix_global_rule_v2"
]
diff --git a/docs/en/latest/references/apisix_cluster_config_v2beta3.md
b/docs/en/latest/references/apisix_cluster_config_v2beta3.md
deleted file mode 100644
index c7059bd1..00000000
--- a/docs/en/latest/references/apisix_cluster_config_v2beta3.md
+++ /dev/null
@@ -1,44 +0,0 @@
----
-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
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-See
[concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_cluster_config)
to learn more about how to use the ApisixClusterConfig resource.
-
-## Spec
-
-See the
[definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixClusterConfig.yaml)
on GitHub.
-
-| 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_v2beta3.md
b/docs/en/latest/references/apisix_pluginconfig_v2beta3.md
deleted file mode 100644
index d230497a..00000000
--- a/docs/en/latest/references/apisix_pluginconfig_v2beta3.md
+++ /dev/null
@@ -1,37 +0,0 @@
----
-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
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-## Spec
-
-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 | 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_route_v2beta3.md
b/docs/en/latest/references/apisix_route_v2beta3.md
deleted file mode 100644
index 36a9196a..00000000
--- a/docs/en/latest/references/apisix_route_v2beta3.md
+++ /dev/null
@@ -1,99 +0,0 @@
----
-title: ApisixRoute/v2beta3
-keywords:
- - APISIX ingress
- - Apache APISIX
- - ApisixRoute
-description: Reference for ApisixRoute/v2beta3 custom Kubernetes resource.
----
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-See
[concepts](https://apisix.apache.org/docs/ingress-controller/concepts/apisix_route)
to learn more about how to use the ApisixRoute resource.
-
-## Spec
-
-See the
[definition](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1/ApisixRoute.yaml)
on GitHub.
-
-The table below describes each of the attributes in the spec. The fields
`apiVersion`, `kind`, and `metadata` are similar to other Kubernetes resources
and are excluded below.
-
-| Attribute | Type | Description
|
-|--------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| http | array | HTTP Route
rules.
|
-| http[].name | string (required) | Route rule name.
|
-| http[].priority | integer | Route priority.
Used to determined which Route to use when multiple routes contain the same
URI. Large number means higher priority.
|
-| http[].match | object | Conditions to
match a request with the Route.
|
-| http[].match.paths | array | List of URIs to
match the Route with. The Route will be used if any one of the URIs is matched.
|
-| http[].match.hosts | array | List of hosts to
match the Route with. The Route will be used if any one of the hosts is
matched.
|
-| http[].match.methods | array | List of HTTP
methods (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS`, `CONNECT`,
`TRACE`) to match the Route with. The Route will be used if any one of the
methods is matched. |
-| http[].match.remoteAddrs | array | List of IP
addresses (CIDR format) to match the Route with. The Route will be used if any
one of the IP address is matched.
|
-| http[].match.exprs | array | List of
expressions to match the Route with. The Route will be used if any one of the
expression is matched.
|
-| http[].match.exprs[].subject | object | Subject for the
expression.
|
-| http[].match.exprs[].subject.scope | string | Scope of the
subject. Can be one of `Header`, `Query`, `Cookie`, or `Path`.
|
-| http[].match.exprs[].subject.name | string | Subject name.
Can be empty when the scope is `Path`.
|
-| http[].match.exprs[].op | string | Operator for the
expression. See [Expression operators](#expression-operators) for more details.
|
-| http[].match.exprs[].value | string | Value to compare
the subject with. Can use either this or `http[].match.exprs[].set`.
|
-| http[].match.exprs[].set | array | Set to compare
the subject with. Only used when the operator is `In` or `NotIn`. Can use
either this or `http[].match.exprs[].value`.
|
-| http[].backends | object | List of backend
services. If there are more than one, a weight based traffic split policy would
be applied.
|
-| http[].backends[].serviceName | string | Name of the
backend service. The service and the `ApisixRoute` resource should be created
in the same namespace.
|
-| http[].backends[].servicePort | integer or string | Port number or
the name defined in the service object of the backend.
|
-| http[].backends[].resolveGranularity | string | See [Service
resolution granularity](#service-resolution-granularity) for details.
|
-| http[].backends[].weight | int | Weight with
which to split traffic to the backend. Defaults to `100` and is ignored when
there is only one backend.
|
-| http[].backends[].subset | string | Subset for the
target service. Should be pre-defined in the `ApisixUpstream` resource.
|
-| http[].plugins | array | [APISIX
Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests/) to be
executed if the Route is matched.
|
-| http[].plugins[].name | string | Name of the
Plugin. See [Plugin hub](https://apisix.apache.org/plugins/) for a list of
available Plugins.
|
-| http[].plugins[].enable | boolean | When set to
`true`, the Plugin is enabled on the Route.
|
-| http[].plugins[].config | object | Configuration of
the Plugin. Should have the same fields as in [APISIX
docs](https://apisix.apache.org/docs/apisix/plugins/batch-requests/).
|
-| http[].websocket | boolean | When set to
`true` enables websocket proxy.
|
-| stream | array | Stream route
rules. Contains TCP or UDP rules.
|
-| stream[].protocol | string (required) | The protocol of
rule. Support `TCP` or `UDP`
|
-| stream[].name | string (required) | Name of the
rule.
|
-| stream[].match | object (required) | Conditions to
match the request with the Route.
|
-| stream[].match.ingressPort | integer (required) | Listening port
in the Ingress proxy server. This port should be defined in the [APISIX
configuration](https://github.com/apache/apisix/blob/master/conf/config-default.yaml#L101).
|
-| stream[].backend | object | Backend service
(deprecated). Use `http[].backends` instead.
|
-| stream[].backend.serviceName | string | Name of the
backend service (depricated). The service and the `ApisixRoute` resource should
be created in the same namespace.
|
-| stream[].backend.servicePort | integer or string | Port number or
the name defined in the service object of the backend (deprecated).
|
-| stream[].backend.resolveGranularity | string | See [Service
resolution granularity](#service-resolution-granularity) for details
(depricated).
|
-| stream[].backend.subset | string | Subset for the
target service (depricated). Should be pre-defined in the `ApisixUpstream`
resource.
|
-
-## Expression operators
-
-The following operators can be used in match expressions:
-
-| Operator | Description
|
-| ---------------------------- |
-------------------------------------------------------------------------------
|
-| Equal | Result of the `subject` should be equal to
the `value`. |
-| NotEqual | Result of the `subject` should not be equal
to the `value`. |
-| GreaterThan | Result of the `subject` should be a number
and must be larger than the `value`. |
-| LessThan | Result of the `subject` should be a number
and must be less than the `value`. |
-| In | Result of the `subject` should be a part of
the `set`. |
-| NotIn | Result of the `subject` should be a part of
the `set`. |
-| RegexMatch | Result of the `subject` should match the PCRE
regex pattern of the `value`. |
-| RegexNotMatch | Result of the `subject` should not match the
PCRE regex pattern of the `value`. |
-| RegexMatchCaseInsensitive | Similar to `RegexMatch` but case insensitive.
|
-| RegexNotMatchCaseInsensitive | Similar to `RegexNotMatch` but case
insensitive. |
-
-## Service resolution granularity
-
-By default, the service referenced will be watched to update its endpoint list
in APISIX. To just use the `ClusterIP` of the service, you can set the
`resolveGranularity` attribute to `service` (defaults to `endpoint`):
-
-| Granularity | Description
|
-| ----------- |
----------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| endpoint | Upstream nodes are pods' IP adresses.
|
-| service | Upstream nodes are service cluster IP. Load balancing is
implemented by
[kube-proxy](https://kubernetes.io/docs/concepts/overview/components/#kube-proxy).
|
diff --git a/docs/en/latest/references/apisix_tls_v2beta3.md
b/docs/en/latest/references/apisix_tls_v2beta3.md
deleted file mode 100644
index c507e3e5..00000000
--- a/docs/en/latest/references/apisix_tls_v2beta3.md
+++ /dev/null
@@ -1,44 +0,0 @@
----
-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
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-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. |
