Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve dev quickstart guide #733

Merged
merged 2 commits into from
Jun 9, 2023
+8 −8
Merged

Improve dev quickstart guide #733

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f18feb5
Improve dev quickstart guide
pleshakov Jun 9, 2023
9f23e63
bring back whoami
pleshakov Jun 9, 2023
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
16 changes: 8 additions & 8 deletions docs/developer/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To build an NGINX Kubernetes Gateway container image from source run the followi
make TAG=$(whoami) container
```

This will build the docker image and tag it with your user ID, e.g. `docker.io/library/nginx-kubernetes-gateway:user`
This will build the docker image `nginx-kubernetes-gateway:<your-user>`.

## Deploy on Kind

Expand All @@ -59,23 +59,23 @@ This will build the docker image and tag it with your user ID, e.g. `docker.io/l
make create-kind-cluster
```

2. Build the NKG image and load it onto your `kind` cluster:
2. Load the previously built image onto your `kind` cluster:

```shell
make TAG=$(whoami) container
kind load docker-image docker.io/library/nginx-kubernetes-gateway:$(whoami)
kind load docker-image nginx-kubernetes-gateway:$(whoami)
```

3. Modify the image name and image pull policy for the `nginx-gateway` container in the
NKG [deployment manifest](/deploy/manifests/nginx-gateway.yaml). Set the image name to the image you built in
the previous step and the image pull policy to `Never`. Once the changes are made, follow
NKG [deployment manifest](/deploy/manifests/deployment.yaml). Set the image name to the image you built in
the previous step and the image pull policy to `IfNotPresent`, so that Kubernetes will not try to pull it from
the DockerHub. Once the changes are made, follow
the [installation instructions](/docs/installation.md) to install NKG on your `kind` cluster.

Alternatively, you can update the image name and pull policy by using the following command when applying
`nginx-gateway.yaml`:
`deployment.yaml`:

```shell
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 -
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 -
```

### Run Examples
Expand Down