Update acme-lb with example-gatewayClass.

sawsa307 · sawsa307 · commit c1ec929f9b0d · 2024-03-01T00:18:26.000Z
* Update acme-lb with example to make it more obvious that
  it is a placeholder gatewayClass that is intended to be replaced.
* Add explanations and reference in simple-gateway.md on Gateway and
  GatewayClass concepts.
diff --git a/examples/experimental/basic-grpc.yaml b/examples/experimental/basic-grpc.yaml
@@ -3,11 +3,11 @@
 apiVersion: gateway.networking.k8s.io/v1
 kind: GatewayClass
 metadata:
-  name: acme-lb
+  name: example
 spec:
   controllerName: acme.io/gateway-controller
   parametersRef:
-    name: acme-lb
+    name: example
     group: acme.io
     kind: Parameters
 ---
@@ -16,7 +16,7 @@ kind: Gateway
 metadata:
   name: my-gateway
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:  # Use GatewayClass defaults for listener definition.
   - name: https
     protocol: HTTPS
diff --git a/examples/standard/basic-http.yaml b/examples/standard/basic-http.yaml
@@ -3,11 +3,11 @@
 apiVersion: gateway.networking.k8s.io/v1
 kind: GatewayClass
 metadata:
-  name: acme-lb
+  name: example
 spec:
   controllerName: acme.io/gateway-controller
   parametersRef:
-    name: acme-lb
+    name: example
     group: acme.io
     kind: Parameters
 ---
@@ -16,7 +16,7 @@ kind: Gateway
 metadata:
   name: my-gateway
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:  # Use GatewayClass defaults for listener definition.
   - name: http
     protocol: HTTP
diff --git a/examples/standard/gateway-addresses.yaml b/examples/standard/gateway-addresses.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: gateway-addresses
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   addresses:
   - value: 1200:0000:AB00:1234:0000:2552:7777:1313
   - value: 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
diff --git a/examples/standard/http-redirect.yaml b/examples/standard/http-redirect.yaml
@@ -5,7 +5,7 @@ metadata:
 spec:
   controllerName: acme.io/gateway-controller
   parametersRef:
-    name: acme-lb
+    name: example
     group: acme.io
     kind: Parameters
 ---
diff --git a/examples/standard/simple-gateway/gateway.yaml b/examples/standard/simple-gateway/gateway.yaml
@@ -6,7 +6,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - protocol: HTTP
     port: 80
diff --git a/examples/standard/tls-basic.yaml b/examples/standard/tls-basic.yaml
@@ -5,7 +5,7 @@ kind: Gateway
 metadata:
   name: tls-basic
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: foo-https
     protocol: HTTPS
diff --git a/examples/standard/tls-cert-cross-namespace.yaml b/examples/standard/tls-cert-cross-namespace.yaml
@@ -6,7 +6,7 @@ metadata:
   name: cross-namespace-tls-gateway
   namespace: gateway-api-example-ns1
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: https
     protocol: HTTPS
diff --git a/examples/standard/wildcard-tls-gateway.yaml b/examples/standard/wildcard-tls-gateway.yaml
@@ -5,7 +5,7 @@ kind: Gateway
 metadata:
   name: wildcard-tls-gateway
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: foo-https
     protocol: HTTPS
diff --git a/geps/gep-1651/index.md b/geps/gep-1651/index.md
@@ -206,7 +206,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   infrastructure:
     routability: Public
   listeners:
@@ -261,7 +261,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   infrastructure:
     routability: Cluster
   listeners:
@@ -276,7 +276,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   infrastructure:
     routability: Cluster
   listeners:
@@ -293,7 +293,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   infrastructure:
     routability: Public
   listeners:
@@ -308,7 +308,7 @@ kind: Gateway
 metadata:
   name: prod-web
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   infrastructure:
     routability: Private
   listeners:
diff --git a/hack/invalid-examples/standard/gateway/duplicate-listeners.yaml b/hack/invalid-examples/standard/gateway/duplicate-listeners.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: duplicate-listeners
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: same
     protocol: HTTP
diff --git a/hack/invalid-examples/standard/gateway/hostname-tcp.yaml b/hack/invalid-examples/standard/gateway/hostname-tcp.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: hostname-tcp
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: example
     hostname: example.com
diff --git a/hack/invalid-examples/standard/gateway/hostname-udp.yaml b/hack/invalid-examples/standard/gateway/hostname-udp.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: hostname-udp
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: example
     hostname: example.com
diff --git a/hack/invalid-examples/standard/gateway/invalid-addresses.yaml b/hack/invalid-examples/standard/gateway/invalid-addresses.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: invalid-addresses
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   addresses:
   - value: 1200:0000:::AB00:1234:0000:2552:7777:1313
   - value: 21DA:D3:0:2F3B:2AY:FF:FE28:9C5A
diff --git a/hack/invalid-examples/standard/gateway/invalid-listener-name.yaml b/hack/invalid-examples/standard/gateway/invalid-listener-name.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: invalid-listener-name
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: bad>
     protocol: HTTP
diff --git a/hack/invalid-examples/standard/gateway/invalid-listener-port.yaml b/hack/invalid-examples/standard/gateway/invalid-listener-port.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: invalid-listener-port
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: foo
     protocol: HTTP
diff --git a/hack/invalid-examples/standard/gateway/invalid-tls-mode.yaml b/hack/invalid-examples/standard/gateway/invalid-tls-mode.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: duplicate-listeners
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: foo
     protocol: HTTPS
diff --git a/hack/invalid-examples/standard/gateway/tlsconfig-tcp.yaml b/hack/invalid-examples/standard/gateway/tlsconfig-tcp.yaml
@@ -3,7 +3,7 @@ kind: Gateway
 metadata:
   name: tlsconfig-tcp
 spec:
-  gatewayClassName: acme-lb
+  gatewayClassName: example
   listeners:
   - name: example
     protocol: TCP
diff --git a/site-src/guides/simple-gateway.md b/site-src/guides/simple-gateway.md
@@ -12,11 +12,18 @@ match all HTTP traffic and directs it to a single Service named `foo-svc`.
 {% include 'standard/simple-gateway/gateway.yaml' %}
 ```
 
-The Gateway represents the instantiation of a logical load balancer. It's
-templated from a hypothetical `acme-lb` GatewayClass. The Gateway listens for
-HTTP traffic on port 80. This particular GatewayClass automatically assigns an
-IP address which will be shown in the `Gateway.status` after it has been
-deployed. 
+The Gateway represents the instantiation of a logical load balancer and the
+GatewayClass defines the load balancer template when users create a Gateway.
+The example Gateway is templated from a hypothetical `example`
+GatewayClass, which is meant to be a placeholder and substitued by users. Here
+is a list of available
+[Gateway Implementation](https://gateway-api.sigs.k8s.io/implementations/) that
+can be used to determine the correct GatewayClass based on the specific
+infrastructure provider.
+
+The Gateway listens for HTTP traffic on port 80. This particular GatewayClass
+automatically assigns an IP address which will be shown in the `Gateway.status`
+after it has been deployed. 
 
 Route resources specify the Gateways they want to attach to using `ParentRefs`. As long as 
 the Gateway allows this attachment (by default Routes from the same namespace are trusted),
