Skip to content

Commit 9235dca

Browse files
kate-osbornKate Osborn
authored and
Kate Osborn
committed
Split installation into two docs (#193)
* Split installation into two docs * Update image repository in manifests
1 parent f80b6dd commit 9235dca

File tree

3 files changed

+46
-12
lines changed

3 files changed

+46
-12
lines changed

deploy/manifests/nginx-gateway.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ spec:
8686
- name: nginx-config
8787
mountPath: /etc/nginx
8888
containers:
89-
- image: nginx-kubernetes-gateway:edge
90-
imagePullPolicy: IfNotPresent
89+
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
90+
imagePullPolicy: Always
9191
name: nginx-gateway
9292
volumeMounts:
9393
- name: nginx-config

docs/installation.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
# Installation
22

3+
This guide walks you through how to install NGINX Kubernetes Gateway on a generic Kubernetes cluster.
4+
35
## Prerequisites
46

5-
Before you can install the NGINX Kubernetes Gateway, make sure you have the following software installed on your machine:
67
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
8+
- Kubernetes 1.16+ cluster
79

8-
## Deploy the Gateway
10+
## Deploy NGINX Kubernetes Gateway
911

1012
> Note: NGINX Kubernetes Gateway can only run in the `nginx-gateway` namespace. This limitation will be addressed in the future releases.
1113
12-
You can deploy NGINX Kubernetes Gateway on an existing Kubernetes 1.16+ cluster. The following instructions walk through the steps for deploying on a [kind](https://kind.sigs.k8s.io/) cluster.
13-
14-
1. Load the NGINX Kubernetes Gateway image onto your kind cluster:
14+
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:
1515

1616
```
17-
kind load docker-image nginx-kubernetes-gateway:edge
17+
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git
18+
cd nginx-kubernetes-gateway
1819
```
1920

20-
Make sure to substitute the image name with the name of the image you built.
21-
2221
1. Install the Gateway CRDs:
2322

2423
```
@@ -45,8 +44,6 @@ You can deploy NGINX Kubernetes Gateway on an existing Kubernetes 1.16+ cluster.
4544
4645
1. Deploy the NGINX Kubernetes Gateway:
4746
48-
Before deploying, make sure to update the Deployment spec in `nginx-gateway.yaml` to reference the image you built.
49-
5047
```
5148
kubectl apply -f deploy/manifests/nginx-gateway.yaml
5249
```
@@ -108,3 +105,7 @@ Create a service with type `LoadBalancer` using the appropriate manifest for you
108105
```
109106
nslookup <dns-name>
110107
```
108+
109+
### Use NGINX Kubernetes Gateway
110+
111+
To get started, follow the tutorials in the [examples](../examples/) directory.

docs/running-on-kind.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Running on `kind`
2+
3+
This guide walks you through how to run NGINX Kubernetes Gateway on a [kind](https://kind.sigs.k8s.io/) cluster.
4+
5+
## Prerequisites
6+
7+
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
8+
- [kind](https://kind.sigs.k8s.io/)
9+
10+
## Prepare Cluster
11+
12+
Create a cluster with `kind`. You can follow their [instructions](https://kind.sigs.k8s.io/docs/user/quick-start/#creating-a-cluster), or run the following make command at the root of the repository:
13+
14+
```
15+
make create-kind-cluster
16+
```
17+
18+
## Deploy NGINX Kubernetes Gateway
19+
20+
Follow the [installation](./installation.md) instructions to deploy NGINX Kubernetes Gateway on your Kind cluster.
21+
22+
## Access NGINX Kubernetes Gateway
23+
24+
Forward local ports 8080 and 8443 to ports 80 and 443 of the nginx-gateway Pod:
25+
26+
```
27+
kubectl -n nginx-gateway port-forward <pod-name> 8080:80 8443:443
28+
```
29+
30+
> 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.
31+
32+
## Use NGINX Kubernetes Gateway
33+
To get started, follow the tutorials in the [examples](../examples/) directory.

0 commit comments

Comments
 (0)