istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation to not refer to experimental Gateway APIs (#15150) 

* Update documentation to not refer to experimental APIs

* missed TCPRoute, we did have one example of that

* fix snip

* and again

* and again

* caught error, thanks @ericvn!
This commit is contained in:
Craig Box 2024-05-22 13:56:02 +12:00 committed by GitHub
parent e74a35a901
commit ba064414ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
25 changed files with 28 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/en/boilerplates/gateway-api-gamma-support.md → content/en/boilerplates/gateway-api-gamma-experimental.md
View File

@ -6,10 +6,8 @@
{{< /tip >}} {{< /tip >}}
{{< warning >}} {{< warning >}}
This document configures internal mesh (east-west) traffic This document configures Istio using Gateway API features that are
that requires Gateway API features that are either
[experimental](https://gateway-api.sigs.k8s.io/geps/overview/#status) [experimental](https://gateway-api.sigs.k8s.io/geps/overview/#status)
or Istio specific.
Before using the Gateway API instructions, make sure to: Before using the Gateway API instructions, make sure to:
1) Install the **experimental version** of the Gateway API CRDs: 1) Install the **experimental version** of the Gateway API CRDs:

25
content/en/boilerplates/snips/gateway-api-experimental.sh
View File

@ -1,25 +0,0 @@
#!/bin/bash
# shellcheck disable=SC2034,SC2153,SC2155,SC2164
# Copyright Istio Authors. All Rights Reserved.
#
# Licensed 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.
####################################################################################################
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# boilerplates/gateway-api-experimental.md
####################################################################################################
bpsnip_gateway_api_experimental_install_experimental_crds() {
kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=444631bfe06f3bcca5d0eadf1857eac1d369421d" | kubectl apply -f -
}

6
content/en/boilerplates/snips/gateway-api-gamma-support.sh → content/en/boilerplates/snips/gateway-api-gamma-experimental.sh
View File

@ -17,13 +17,13 @@
#################################################################################################### ####################################################################################################
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# boilerplates/gateway-api-gamma-support.md # boilerplates/gateway-api-gamma-experimental.md
#################################################################################################### ####################################################################################################
bpsnip_gateway_api_gamma_support_install_experimental_crds() { bpsnip_gateway_api_gamma_experimental_install_experimental_crds() {
kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=v1.1.0" | kubectl apply -f - kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd/experimental?ref=v1.1.0" | kubectl apply -f -
} }
bpsnip_gateway_api_gamma_support_enable_alpha_crds() { bpsnip_gateway_api_gamma_experimental_enable_alpha_crds() {
istioctl install --set values.pilot.env.PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING=true --set values.pilot.env.PILOT_ENABLE_ALPHA_GATEWAY_API=true --set profile=minimal -y istioctl install --set values.pilot.env.PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING=true --set values.pilot.env.PILOT_ENABLE_ALPHA_GATEWAY_API=true --set profile=minimal -y
} }

2
content/en/docs/tasks/traffic-management/egress/egress-control/index.md
View File

@ -257,7 +257,7 @@ Similar to inter-cluster requests, routing rules
can also be configured for external services that are accessed using `ServiceEntry` configurations. can also be configured for external services that are accessed using `ServiceEntry` configurations.
In this example, you set a timeout rule on calls to the `httpbin.org` service. In this example, you set a timeout rule on calls to the `httpbin.org` service.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
1) From inside the pod being used as the test source, make a _curl_ request to the `/delay` endpoint of the 1) From inside the pod being used as the test source, make a _curl_ request to the `/delay` endpoint of the
httpbin.org external service: httpbin.org external service:

2
content/en/docs/tasks/traffic-management/egress/egress-control/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/egress/egress-control/index.md # docs/tasks/traffic-management/egress/egress-control/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_before_you_begin_1() { snip_before_you_begin_1() {
kubectl apply -f samples/sleep/sleep.yaml kubectl apply -f samples/sleep/sleep.yaml

2
content/en/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/index.md
View File

@ -19,7 +19,7 @@ dedicated _egress gateway_ service. This example combines the previous two by
describing how to configure an egress gateway to perform TLS origination for describing how to configure an egress gateway to perform TLS origination for
traffic to external services. traffic to external services.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/egress/egress-gateway-tls-origination/index.md # docs/tasks/traffic-management/egress/egress-gateway-tls-origination/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_before_you_begin_1() { snip_before_you_begin_1() {
kubectl apply -f samples/sleep/sleep.yaml kubectl apply -f samples/sleep/sleep.yaml

2
content/en/docs/tasks/traffic-management/egress/egress-gateway/index.md
View File

@ -37,7 +37,7 @@ on them cannot access the Internet. Defining an egress gateway, directing all th
allocating public IPs to the egress gateway nodes allows the application nodes to access external services in a allocating public IPs to the egress gateway nodes allows the application nodes to access external services in a
controlled way. controlled way.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-gamma-experimental >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/egress/egress-gateway/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/egress/egress-gateway/index.md # docs/tasks/traffic-management/egress/egress-gateway/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-gamma-experimental.sh"
snip_before_you_begin_1() { snip_before_you_begin_1() {
kubectl apply -f samples/sleep/sleep.yaml kubectl apply -f samples/sleep/sleep.yaml

2
content/en/docs/tasks/traffic-management/egress/wildcard-egress-hosts/index.md
View File

@ -23,7 +23,7 @@ Each version of `wikipedia.org` in a particular language has its own hostname, e
You want to enable egress traffic by common configuration items for all the Wikipedia sites, You want to enable egress traffic by common configuration items for all the Wikipedia sites,
without the need to specify every language's site separately. without the need to specify every language's site separately.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/egress/wildcard-egress-hosts/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/egress/wildcard-egress-hosts/index.md # docs/tasks/traffic-management/egress/wildcard-egress-hosts/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_before_you_begin_1() { snip_before_you_begin_1() {
istioctl install --set values.pilot.env.PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING=true --set profile=demo --set meshConfig.outboundTrafficPolicy.mode=REGISTRY_ONLY istioctl install --set values.pilot.env.PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING=true --set profile=demo --set meshConfig.outboundTrafficPolicy.mode=REGISTRY_ONLY

4
content/en/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/gtwapi_test.sh
View File

@ -19,8 +19,8 @@ source "tests/util/gateway-api.sh"
install_gateway_api_crds install_gateway_api_crds
# @setup profile=none # @setup profile=none
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-gamma-experimental.sh"
bpsnip_gateway_api_gamma_support_enable_alpha_crds bpsnip_gateway_api_gamma_experimental_enable_alpha_crds
source "content/en/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/test.sh" source "content/en/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/test.sh"
# @cleanup # @cleanup

2
content/en/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/index.md
View File

@ -17,7 +17,7 @@ The example HTTPS service used for this task is a simple [NGINX](https://www.ngi
In the following steps you first deploy the NGINX service in your Kubernetes cluster. In the following steps you first deploy the NGINX service in your Kubernetes cluster.
Then you configure a gateway to provide ingress access to the service via host `nginx.example.com`. Then you configure a gateway to provide ingress access to the service via host `nginx.example.com`.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-gamma-experimental >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/ingress/ingress-sni-passthrough/index.md # docs/tasks/traffic-management/ingress/ingress-sni-passthrough/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-gamma-experimental.sh"
snip_generate_client_and_server_certificates_and_keys_1() { snip_generate_client_and_server_certificates_and_keys_1() {
mkdir example_certs mkdir example_certs

2
content/en/docs/tasks/traffic-management/mirroring/index.md
View File

@ -17,7 +17,7 @@ traffic happens out of band of the critical request path for the primary service
In this task, you will first force all traffic to `v1` of a test service. Then, In this task, you will first force all traffic to `v1` of a test service. Then,
you will apply a rule to mirror a portion of traffic to `v2`. you will apply a rule to mirror a portion of traffic to `v2`.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/mirroring/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/mirroring/index.md # docs/tasks/traffic-management/mirroring/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_before_you_begin_1() { snip_before_you_begin_1() {
cat <<EOF | istioctl kube-inject -f - | kubectl create -f - cat <<EOF | istioctl kube-inject -f - | kubectl create -f -

2
content/en/docs/tasks/traffic-management/request-routing/index.md
View File

@ -12,7 +12,7 @@ test: yes
This task shows you how to route requests dynamically to multiple versions of a This task shows you how to route requests dynamically to multiple versions of a
microservice. microservice.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/request-routing/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/request-routing/index.md # docs/tasks/traffic-management/request-routing/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_route_to_version_1_1() { snip_route_to_version_1_1() {
kubectl apply -f samples/bookinfo/networking/virtual-service-all-v1.yaml kubectl apply -f samples/bookinfo/networking/virtual-service-all-v1.yaml

2
content/en/docs/tasks/traffic-management/request-timeouts/index.md
View File

@ -11,7 +11,7 @@ test: yes
This task shows you how to set up request timeouts in Envoy using Istio. This task shows you how to set up request timeouts in Envoy using Istio.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/request-timeouts/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/request-timeouts/index.md # docs/tasks/traffic-management/request-timeouts/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_request_timeouts_1() { snip_request_timeouts_1() {
kubectl apply -f - <<EOF kubectl apply -f - <<EOF

4
content/en/docs/tasks/traffic-management/tcp-traffic-shifting/gtwapi_test.sh
View File

@ -19,8 +19,8 @@ source "tests/util/gateway-api.sh"
install_gateway_api_crds install_gateway_api_crds
# @setup profile=minimal # @setup profile=minimal
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-gamma-experimental.sh"
bpsnip_gateway_api_gamma_support_enable_alpha_crds bpsnip_gateway_api_gamma_experimental_enable_alpha_crds
source "content/en/docs/tasks/traffic-management/tcp-traffic-shifting/test.sh" source "content/en/docs/tasks/traffic-management/tcp-traffic-shifting/test.sh"
# @cleanup # @cleanup

2
content/en/docs/tasks/traffic-management/tcp-traffic-shifting/index.md
View File

@ -19,7 +19,7 @@ In this task, you will send 100% of the TCP traffic to `tcp-echo:v1`.
Then, you will route 20% of the TCP traffic to `tcp-echo:v2` using Istio's Then, you will route 20% of the TCP traffic to `tcp-echo:v2` using Istio's
weighted routing feature. weighted routing feature.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-gamma-experimental >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/tcp-traffic-shifting/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/tcp-traffic-shifting/index.md # docs/tasks/traffic-management/tcp-traffic-shifting/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-gamma-experimental.sh"
snip_set_up_the_test_environment_1() { snip_set_up_the_test_environment_1() {
kubectl create namespace istio-io-tcp-traffic-shifting kubectl create namespace istio-io-tcp-traffic-shifting

2
content/en/docs/tasks/traffic-management/traffic-shifting/index.md
View File

@ -18,7 +18,7 @@ from one destination to another.
In this task, you will use send 50% of traffic to `reviews:v1` and 50% to `reviews:v3`. Then, you will In this task, you will use send 50% of traffic to `reviews:v1` and 50% to `reviews:v3`. Then, you will
complete the migration by sending 100% of traffic to `reviews:v3`. complete the migration by sending 100% of traffic to `reviews:v3`.
{{< boilerplate gateway-api-gamma-support >}} {{< boilerplate gateway-api-support >}}
## Before you begin ## Before you begin

2
content/en/docs/tasks/traffic-management/traffic-shifting/snips.sh
View File

@ -19,7 +19,7 @@
# WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE: # WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL MARKDOWN FILE:
# docs/tasks/traffic-management/traffic-shifting/index.md # docs/tasks/traffic-management/traffic-shifting/index.md
#################################################################################################### ####################################################################################################
source "content/en/boilerplates/snips/gateway-api-gamma-support.sh" source "content/en/boilerplates/snips/gateway-api-support.sh"
snip_config_all_v1() { snip_config_all_v1() {
kubectl apply -f samples/bookinfo/networking/virtual-service-all-v1.yaml kubectl apply -f samples/bookinfo/networking/virtual-service-all-v1.yaml