Skip to content

Capitalize Kubernetes objects #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/running-on-kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ kubectl -n nginx-gateway port-forward <pod-name> 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.
4 changes: 2 additions & 2 deletions examples/advanced-routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/cafe-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions examples/https-termination/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand Down