Skip to content

Commit

Permalink
docs: update all api-version to v2 (#1189)
Browse files Browse the repository at this point in the history
Signed-off-by: Jintao Zhang <zhangjintao9020@gmail.com>
  • Loading branch information
tao12345666333 committed Jul 27, 2022
1 parent 5f45b63 commit 8b51c6e
Show file tree
Hide file tree
Showing 20 changed files with 722 additions and 722 deletions.
2 changes: 1 addition & 1 deletion docs/en/latest/concepts/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ ApisixPluginConfig is a resource under the same Namespace as Ingress
As an example, we attach the annotation `k8s.apisix.apache.org/plugin-conifg-name: "echo-and-cors-apc` for the following Ingress resource, so that `/api/*` route will enable the [echo](https://apisix.apache.org/docs/apisix/plugins/echo/) and [cors](https://apisix.apache.org/docs/apisix/plugins/cors/) plugins.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixPluginConfig
metadata:
name: echo-and-cors-apc
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/concepts/apisix_cluster_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ if you'd like to learn the real running status of your cluster. In such a case,
could create a `ApisixClusterConfig` to enable these features explicitly.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixClusterConfig
metadata:
name: default
Expand All @@ -58,7 +58,7 @@ The default APISIX cluster is configured through command line options like `--de
of Deployment or Pod template. Now with the help of `ApisixClusterConfig`, you can change some administrative fields on it.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixClusterConfig
metadata:
name: default
Expand Down
18 changes: 9 additions & 9 deletions docs/en/latest/concepts/apisix_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ should be routed to service `bar`, in the manner of `ApisixRoute`, the configura
should be:

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: foo-bar-route
Expand Down Expand Up @@ -73,7 +73,7 @@ The `methods` splits traffic according to the HTTP method, the following configu
with `GET` method to `foo` service (a Kubernetes Service).

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: method-route
Expand All @@ -94,7 +94,7 @@ The `exprs` allows user to configure match conditions with arbitrary predicates
It's composed by several expressions, which in turn composed by subject, operator and value/set.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: method-route
Expand Down Expand Up @@ -128,7 +128,7 @@ the `ClusterIP` of this service, if that's what you want, just set
the `resolveGranularity` to `service` (default is `endpoint`).

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: method-route
Expand All @@ -155,7 +155,7 @@ will be applied (which actually uses the [traffic-split](http://apisix.apache.or
You can specify weight for each backend, the default weight is `100`.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: method-route
Expand Down Expand Up @@ -193,7 +193,7 @@ Apache APISIX provides more than 70 [plugins](https://github.com/apache/apisix/t
in `ApisixRoute`. All configuration items are named same to the one in APISIX.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin-route
Expand Down Expand Up @@ -223,7 +223,7 @@ Websocket Proxy
by creating a route with specifying the `websocket` field.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: ws-route
Expand All @@ -247,7 +247,7 @@ TCP Route
apisix-ingress-controller supports the port-based tcp route.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: tcp-route
Expand All @@ -272,7 +272,7 @@ UDP Route
apisix-ingress-controller supports the port-based udp route.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: udp-route
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/concepts/apisix_tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Secret must have two keys `cert` and `key`, which used to store the certificate
PEM format respectively.

```shell
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixTls
metadata:
name: sample-tls
Expand Down
12 changes: 6 additions & 6 deletions docs/en/latest/concepts/apisix_upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To learn more, please check the [Apache APISIX architecture-design docs](https:/
A proper load balancing algorithm is required to scatter requests reasonably for a Kubernetes Service.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: httpbin
Expand All @@ -58,7 +58,7 @@ The above example shows that [ewma](https://linkerd.io/2016/03/16/beyond-round-r
Sometimes the session sticky is desired, and you can use the [Consistent Hashing](https://en.wikipedia.org/wiki/Consistent_hashing) load balancing algorithm.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: httpbin
Expand All @@ -77,7 +77,7 @@ Although Kubelet already provides [probes](https://kubernetes.io/docs/tasks/conf
like the passive feedback capability.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: httpbin
Expand Down Expand Up @@ -128,7 +128,7 @@ if nothing has been sent to a client yet. That is, if an error or timeout occurs
of the transferring of a response, fixing this is impossible.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: httpbin
Expand All @@ -140,7 +140,7 @@ The default connect, read and send timeout are `60s`, which might not proper for
just change them in the `timeout` field.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: httpbin
Expand All @@ -159,7 +159,7 @@ Once in a while a single Kubernetes Service might expose multiple ports which pr
In that case, you can create configurations for individual port.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
name: foo
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Unlike the implementation of Kubernetes Nginx Ingress, the implementation of Ann
For example, the settings of the black and white list can be configured through the `k8s.apisix.apache.org/whitelist-source-range` annotation in the `ApisixRoute` resource object.

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
annotations:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This guide shows how to monitor Apache APISIX Ingress Controller using Prometheu
Use CRD file to enable Prometheus in global configurations. The definition file for custom resources is `ApisixClusterConfig`, so the configuration should be:

```yaml
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixClusterConfig
metadata:
name: default
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/tutorials/check-crd-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ e.g.

```yaml
kubectl apply -f - <<EOF
apiVersion: apisix.apache.org/v2beta3
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin-route
Expand Down
Loading

0 comments on commit 8b51c6e

Please sign in to comment.