From 9a37596bbf90be7cbac92968b8fb4d8cc65280e0 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 18 Aug 2022 10:15:46 -0600 Subject: [PATCH] Capitalize Kubernetes objects --- docs/installation.md | 12 ++++++------ docs/running-on-kind.md | 2 +- examples/advanced-routing/README.md | 4 ++-- examples/cafe-example/README.md | 4 ++-- examples/https-termination/README.md | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 72e3ca3ae1..f59008c030 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -24,13 +24,13 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi kubectl apply -k "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.5.0" ``` -1. Create the nginx-gateway namespace: +1. Create the nginx-gateway Namespace: ``` kubectl apply -f deploy/manifests/namespace.yaml ``` -1. Create the njs-modules configmap: +1. Create the njs-modules ConfigMap: ``` kubectl create configmap njs-modules --from-file=internal/nginx/modules/src/httpmatches.js -n nginx-gateway @@ -62,17 +62,17 @@ You can gain access to NGINX Kubernetes Gateway by creating a `NodePort` Service ### Create a NodePort Service -Create a service with type `NodePort`: +Create a Service with type `NodePort`: ``` kubectl apply -f deploy/manifests/service/nodeport.yaml ``` -A `NodePort` service will randomly allocate one port on every node of the cluster. To access NGINX Kubernetes Gateway, use an IP address of any node in the cluster along with the allocated port. +A `NodePort` Service will randomly allocate one port on every Node of the cluster. To access NGINX Kubernetes Gateway, use an IP address of any Node in the cluster along with the allocated port. ### Create a LoadBalancer Service -Create a service with type `LoadBalancer` using the appropriate manifest for your cloud provider. +Create a Service with type `LoadBalancer` using the appropriate manifest for your cloud provider. - For GCP or Azure: @@ -108,4 +108,4 @@ Create a service with type `LoadBalancer` using the appropriate manifest for you ### Use NGINX Kubernetes Gateway -To get started, follow the tutorials in the [examples](../examples/) directory. +To get started, follow the tutorials in the [examples](../examples) directory. diff --git a/docs/running-on-kind.md b/docs/running-on-kind.md index 6ce783a8c4..7018363e3f 100644 --- a/docs/running-on-kind.md +++ b/docs/running-on-kind.md @@ -30,4 +30,4 @@ kubectl -n nginx-gateway port-forward 8080:80 8443:443 > Note: NGINX will not listen on any ports until you configure a [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/#gateway) resource with a valid listener. ## Use NGINX Kubernetes Gateway -To get started, follow the tutorials in the [examples](../examples/) directory. +To get started, follow the tutorials in the [examples](../examples) directory. diff --git a/examples/advanced-routing/README.md b/examples/advanced-routing/README.md index 8c4c0dd306..369cb8005c 100644 --- a/examples/advanced-routing/README.md +++ b/examples/advanced-routing/README.md @@ -3,7 +3,7 @@ In this example we will deploy NGINX Kubernetes Gateway and configure advanced routing rules for a simple cafe application. We will use `HTTPRoute` resources to route traffic to the cafe application based on a combination of the request method, headers, and query parameters. -The cafe application consists of four services: `coffee-v1-svc`, `coffee-v2-svc`, `tea-svc`, and `tea-post-svc`. In the next section we will create the following routing rules for the cafe application: +The cafe application consists of four Services: `coffee-v1-svc`, `coffee-v2-svc`, `tea-svc`, and `tea-post-svc`. In the next section we will create the following routing rules for the cafe application: - For the path `/coffee` route requests with the header `version` set to `v2` or with the query param `TEST` set to `v2` to `coffee-v2-svc`, and all other requests to `coffee-v1-svc`. - For the path `/tea` route POST requests to `tea-post-svc`, and all other requests, such as `GET` requests, to `tea-svc`. @@ -27,7 +27,7 @@ The cafe application consists of four services: `coffee-v1-svc`, `coffee-v2-svc` ## 2. Deploy the Cafe Application -1. Create the coffee and the tea deployments and services: +1. Create the coffee and the tea Deployments and Services: ``` kubectl apply -f cafe.yaml diff --git a/examples/cafe-example/README.md b/examples/cafe-example/README.md index 017cc5f177..83d089336f 100644 --- a/examples/cafe-example/README.md +++ b/examples/cafe-example/README.md @@ -22,7 +22,7 @@ In this example we deploy NGINX Kubernetes Gateway, a simple web application, an ## 2. Deploy the Cafe Application -1. Create the coffee and the tea deployments and services: +1. Create the coffee and the tea Deployments and Services: ``` kubectl apply -f cafe.yaml @@ -53,7 +53,7 @@ In this example we deploy NGINX Kubernetes Gateway, a simple web application, an ## 4. Test the Application -To access the application, we will use `curl` to send requests to the `coffee` and `tea` services. +To access the application, we will use `curl` to send requests to the `coffee` and `tea` Services. To get coffee: diff --git a/examples/https-termination/README.md b/examples/https-termination/README.md index e61f9ec4c0..0c53bc15e1 100644 --- a/examples/https-termination/README.md +++ b/examples/https-termination/README.md @@ -22,7 +22,7 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin ## 2. Deploy the Cafe Application -1. Create the coffee and the tea deployments and services: +1. Create the coffee and the tea Deployments and Services: ``` kubectl apply -f cafe.yaml @@ -39,12 +39,12 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin ## 3. Configure HTTPS Termination and Routing -1. Create a secret with a TLS certificate and key: +1. Create a Secret with a TLS certificate and key: ``` kubectl apply -f cafe-secret.yaml ``` - The TLS certificate and key in this secret are used to terminate the TLS connections for the cafe application. + The TLS certificate and key in this Secret are used to terminate the TLS connections for the cafe application. **Important**: This certificate and key are for demo purposes only. 1. Create the `Gateway` resource: @@ -70,7 +70,7 @@ In this example we expand on the simple [cafe-example](../cafe-example) by addin ## 4. Test the Application -To access the application, we will use `curl` to send requests to the `coffee` and `tea` services. +To access the application, we will use `curl` to send requests to the `coffee` and `tea` Services. Since our certificate is self-signed, we'll use curl's `--insecure` option to turn off certificate verification. To get coffee: