Skip to content

Update installation docs for release branch #1191

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

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Update installation docs for release branch #1191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 10 additions & 25 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,6 @@ page.
> It is possible to run NGF in a different Namespace, although you'll need to make modifications to the installation
> manifests.

1. Clone the repo and change into the `nginx-gateway-fabric` directory:

```shell
git clone https://github.com/nginxinc/nginx-gateway-fabric.git --branch v1.0.0
cd nginx-gateway-fabric
```

1. Check out the latest tag (unless you are installing the `edge` version from the `main` branch):

```shell
git fetch --tags
latestTag=$(git describe --tags `git rev-list --tags --max-count=1`)
git checkout $latestTag
```

1. Install the Gateway API resources from the standard channel (the CRDs and the validating webhook):

```shell
Expand All @@ -58,13 +43,13 @@ page.
1. Deploy the NGINX Gateway Fabric CRDs:

```shell
kubectl apply -f deploy/manifests/crds
kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml
```

1. Deploy the NGINX Gateway Fabric:

```shell
kubectl apply -f deploy/manifests/nginx-gateway.yaml
kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml
```

1. Confirm the NGINX Gateway Fabric is running in `nginx-gateway` namespace:
Expand Down Expand Up @@ -101,7 +86,7 @@ Service sets the status field to the IP address and/or Hostname. If no Service e
Create a Service with type `NodePort`:

```shell
kubectl apply -f deploy/manifests/service/nodeport.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.0.0/deploy/manifests/service/nodeport.yaml
```

A `NodePort` Service will randomly allocate one port on every Node of the cluster. To access NGINX Gateway Fabric,
Expand All @@ -114,7 +99,7 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
- For GCP or Azure:

```shell
kubectl apply -f deploy/manifests/service/loadbalancer.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.0.0/deploy/manifests/service/loadbalancer.yaml
```

Lookup the public IP of the load balancer, which is reported in the `EXTERNAL-IP` column in the output of the
Expand All @@ -129,7 +114,7 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
- For AWS:

```shell
kubectl apply -f deploy/manifests/service/loadbalancer-aws-nlb.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.0.0/deploy/manifests/service/loadbalancer-aws-nlb.yaml
```

In AWS, the NLB DNS name will be reported by Kubernetes in lieu of a public IP in the `EXTERNAL-IP` column. To get the
Expand Down Expand Up @@ -173,15 +158,15 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
Run the following command to upgrade the NGINX Gateway Fabric CRDs:

```shell
kubectl apply -f deploy/manifests/crds
kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml
```

1. Upgrade NGINX Gateway Fabric Deployment

Run the following command to upgrade NGINX Gateway Fabric:

```shell
kubectl apply -f deploy/manifests/nginx-gateway.yaml
kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml
```

### Upgrade NGINX Gateway Fabric using Helm
Expand All @@ -202,7 +187,7 @@ being performed on NGF), you may need to configure delayed termination on the NG

#### Configure Delayed Termination Using Manifests

Edit the `deploy/manifests/nginx-gateway.yaml` to include the following:
Edit the `nginx-gateway.yaml` to include the following:

1. Add `lifecycle` prestop hooks to both the nginx and the nginx-gateway container definitions:

Expand Down Expand Up @@ -250,11 +235,11 @@ To configure delayed termination on the NGF Pod when the deployment method is He
1. Uninstall the NGINX Gateway Fabric:

```shell
kubectl delete -f deploy/manifests/nginx-gateway.yaml
kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml
```

```shell
kubectl delete -f deploy/manifests/crds
kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml
```

1. Uninstall the Gateway API resources from the standard channel (the CRDs and the validating webhook):
Expand Down