Skip to content

Split installation into two docs #193

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 7 commits 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
4 changes: 2 additions & 2 deletions deploy/manifests/nginx-gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ spec:
- name: nginx-config
mountPath: /etc/nginx
containers:
- image: nginx-kubernetes-gateway:edge
imagePullPolicy: IfNotPresent
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
imagePullPolicy: Always
name: nginx-gateway
volumeMounts:
- name: nginx-config
Expand Down
21 changes: 11 additions & 10 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Installation

This guide walks you through how to install NGINX Kubernetes Gateway on a generic Kubernetes cluster.

## Prerequisites

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

## Deploy the Gateway
## Deploy NGINX Kubernetes Gateway

> Note: NGINX Kubernetes Gateway can only run in the `nginx-gateway` namespace. This limitation will be addressed in the future releases.

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.

1. Load the NGINX Kubernetes Gateway image onto your kind cluster:
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:

```
kind load docker-image nginx-kubernetes-gateway:edge
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git
cd nginx-kubernetes-gateway
```

Make sure to substitute the image name with the name of the image you built.

1. Install the Gateway CRDs:

```
Expand All @@ -45,8 +44,6 @@ You can deploy NGINX Kubernetes Gateway on an existing Kubernetes 1.16+ cluster.

1. Deploy the NGINX Kubernetes Gateway:

Before deploying, make sure to update the Deployment spec in `nginx-gateway.yaml` to reference the image you built.

```
kubectl apply -f deploy/manifests/nginx-gateway.yaml
```
Expand Down Expand Up @@ -108,3 +105,7 @@ Create a service with type `LoadBalancer` using the appropriate manifest for you
```
nslookup <dns-name>
```

### Use NGINX Kubernetes Gateway

To get started, follow the tutorials in the [examples](../examples/) directory.
33 changes: 33 additions & 0 deletions docs/running-on-kind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Running on `kind`

This guide walks you through how to run NGINX Kubernetes Gateway on a [kind](https://kind.sigs.k8s.io/) cluster.

## Prerequisites

- [kubectl](https://kubernetes.io/docs/tasks/tools/)
- [kind](https://kind.sigs.k8s.io/)

## Prepare Cluster

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:

```
make create-kind-cluster
```

## Deploy NGINX Kubernetes Gateway

Follow the [installation](./installation.md) instructions to deploy NGINX Kubernetes Gateway on your Kind cluster.

## Access NGINX Kubernetes Gateway

Forward local ports 8080 and 8443 to ports 80 and 443 of the nginx-gateway Pod:

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