Skip to content

Commit 1e2d5dd

Browse files
authored
Improve dev quickstart guide (#733)
Problem: - Out of date (the referenced manifests files were changed). - Instructions have to be modified before using. Solution: - Use the new manifest file. - Simplify instructions so that a developer can just copy paste them without modification.
1 parent 406b8c6 commit 1e2d5dd

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/developer/quickstart.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To build an NGINX Kubernetes Gateway container image from source run the followi
4949
make TAG=$(whoami) container
5050
```
5151
52-
This will build the docker image and tag it with your user ID, e.g. `docker.io/library/nginx-kubernetes-gateway:user`
52+
This will build the docker image `nginx-kubernetes-gateway:<your-user>`.
5353
5454
## Deploy on Kind
5555
@@ -59,23 +59,23 @@ This will build the docker image and tag it with your user ID, e.g. `docker.io/l
5959
make create-kind-cluster
6060
```
6161
62-
2. Build the NKG image and load it onto your `kind` cluster:
62+
2. Load the previously built image onto your `kind` cluster:
6363
6464
```shell
65-
make TAG=$(whoami) container
66-
kind load docker-image docker.io/library/nginx-kubernetes-gateway:$(whoami)
65+
kind load docker-image nginx-kubernetes-gateway:$(whoami)
6766
```
6867
6968
3. Modify the image name and image pull policy for the `nginx-gateway` container in the
70-
NKG [deployment manifest](/deploy/manifests/nginx-gateway.yaml). Set the image name to the image you built in
71-
the previous step and the image pull policy to `Never`. Once the changes are made, follow
69+
NKG [deployment manifest](/deploy/manifests/deployment.yaml). Set the image name to the image you built in
70+
the previous step and the image pull policy to `IfNotPresent`, so that Kubernetes will not try to pull it from
71+
the DockerHub. Once the changes are made, follow
7272
the [installation instructions](/docs/installation.md) to install NKG on your `kind` cluster.
7373
7474
Alternatively, you can update the image name and pull policy by using the following command when applying
75-
`nginx-gateway.yaml`:
75+
`deployment.yaml`:
7676
7777
```shell
78-
cat deploy/manifests/nginx-gateway.yaml | sed "s|image: ghcr.io/nginxinc/nginx-kubernetes-gateway.*|image: docker.io/library/nginx-kubernetes-gateway:<YOUR-TAG>|" | sed "s|imagePullPolicy: Always|imagePullPolicy: Never|" | kubectl apply -f -
78+
cat deploy/manifests/deployment.yaml | sed "s|image: ghcr.io/nginxinc/nginx-kubernetes-gateway.*|image: nginx-kubernetes-gateway:$(whoami)|" | sed "s|imagePullPolicy: Always|imagePullPolicy: IfNotPresent|" | kubectl apply -f -
7979
```
8080
8181
### Run Examples

0 commit comments

Comments
 (0)