Skip to content

Commit

Permalink
Use consistent "example-" prefix for resource names in example code
Browse files Browse the repository at this point in the history
  • Loading branch information
nathancoleman committed Nov 8, 2022
1 parent b3585ec commit 382ac14
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,21 @@ Specifies a human-readable description of the gateway class. We recommend using
* Required: optional

## Example Configuration
The following example creates a gateway class called `test-gateway-class`:
The following example creates a gateway class called `example-gateway-class`:

<CodeBlockConfig filename="gateway.yaml">

```yaml
apiVersion: gateway.networking.k8s.io/v1alpha2
kind: GatewayClass
metadata:
name: test-gateway-class
name: example-gateway-class
spec:
controllerName: 'hashicorp.com/consul-api-gateway-controller'
parametersRef:
group: api-gateway.consul.hashicorp.com
kind: GatewayClassConfig
name: test-gateway-class-config
name: example-gateway-class-config
description: The gateway class is for creating test gateways class configurations
```
</CodeBlockConfig>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,15 +220,15 @@ If set to `true`, then the Envoy container ports are mapped to host ports.


## Example Configuration
The following example creates a gateway class configuration called `test-gateway-class-config`. Traffic that passes through gateways created from the class configuration authenticate with Consul over HTTPS on port `8501`. Consul client agents communicate with server agents on port `8502` :
The following example creates a gateway class configuration called `example-gateway-class-config`. Traffic that passes through gateways created from the class configuration authenticate with Consul over HTTPS on port `8501`. Consul client agents communicate with server agents on port `8502` :

<CodeBlockConfig filename="gateway.yaml">

```yaml
apiVersion: api-gateway.consul.hashicorp.com/v1alpha1
kind: GatewayClassConfig
metadata:
name: test-gateway-class-config
name: example-gateway-class-config
spec:
useHostPorts: true
logLevel: 'trace'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ apiVersion: api-gateway.consul.hashicorp.com/v1alpha1
kind: MeshService
metadata:
name: example-mesh-service
##...
spec:
name: echo
peer: cluster-02
Expand All @@ -64,7 +63,6 @@ apiVersion: gateway.networking.k8s.io/v1beta1
kind: HTTPRoute
metadata:
name: example-route
##...
spec:
...
rules:
Expand Down

0 comments on commit 382ac14

Please sign in to comment.