Skip to content

Commit 16bdfa8

Browse files
authored
Update the docs to point to v1.1.0 (#1730)
1 parent e1ef3d1 commit 16bdfa8

File tree

12 files changed

+24
-23
lines changed

12 files changed

+24
-23
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ GO_LINKER_FLAGS = $(GO_LINKER_FLAGS_OPTIMIZATIONS) $(GO_LINKER_FlAGS_VARS)
2828
PREFIX ?= nginx-gateway-fabric## The name of the NGF image. For example, nginx-gateway-fabric
2929
NGINX_PREFIX ?= $(PREFIX)/nginx## The name of the nginx image. For example: nginx-gateway-fabric/nginx
3030
NGINX_PLUS_PREFIX ?= $(PREFIX)/nginx-plus## The name of the nginx plus image. For example: nginx-gateway-fabric/nginx-plus
31-
TAG ?= $(VERSION:v%=%)## The tag of the image. For example, 0.3.0
31+
TAG ?= $(VERSION:v%=%)## The tag of the image. For example, 1.1.0
3232
TARGET ?= local## The target of the build. Possible values: local and container
3333
KIND_KUBE_CONFIG=$${HOME}/.kube/kind/config## The location of the kind kubeconfig
3434
OUT_DIR ?= $(CURDIR)/build/out## The folder where the binary will be stored

deploy/helm-chart/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: nginx-gateway-fabric
33
description: NGINX Gateway Fabric
44
type: application
5-
version: 1.0.0
5+
version: 1.1.0
66
appVersion: "edge"
77
home: https://github.com/nginxinc/nginx-gateway-fabric
88
icon: https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/deploy/helm-chart/chart-icon.png

site/content/how-to/maintenance/upgrade-apps-without-downtime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For example, an application can be exposed using a routing rule like below:
5757
port: 80
5858
```
5959
60-
{{< note >}}See the [Cafe example](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/examples/cafe-example) for a basic example.{{< /note >}}
60+
{{< note >}}See the [Cafe example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/examples/cafe-example) for a basic example.{{< /note >}}
6161
6262
The upgrade methods in the next sections cover:
6363
@@ -122,4 +122,4 @@ By updating the rule you can further increase the share of traffic the new versi
122122
weight: 1
123123
```
124124

125-
See the [Traffic splitting example](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/examples/traffic-splitting) from our repository.
125+
See the [Traffic splitting example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/examples/traffic-splitting) from our repository.

site/content/how-to/traffic-management/advanced-routing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The goal is to create a set of rules that will result in client requests being s
3434
Begin by deploying the `coffee-v1` and `coffee-v2` applications:
3535

3636
```shell
37-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/examples/advanced-routing/coffee.yaml
37+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.1.0/examples/advanced-routing/coffee.yaml
3838
```
3939

4040
### Deploy the Gateway API Resources for the Coffee Applications
@@ -154,7 +154,7 @@ Let's deploy a different set of applications now called `tea` and `tea-post`. Th
154154
### Deploy the Tea Applications
155155

156156
```shell
157-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/examples/advanced-routing/tea.yaml
157+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.1.0/examples/advanced-routing/tea.yaml
158158
```
159159

160160
### Deploy the HTTPRoute for the Tea Services

site/content/includes/installation/install-gateway-api-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs: "DOCS-1438"
33
---
44

5-
{{<note>}}The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are the correct version as supported by the NGINX Gateway Fabric - [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).{{</note>}}
5+
{{<note>}}The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are the correct version as supported by the NGINX Gateway Fabric - [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.1.0/README.md#technical-specifications).{{</note>}}
66

77
To install the Gateway API resources, run the following:
88

site/content/installation/expose-nginx-gateway-fabric.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This gateway is associated with the NGINX Gateway Fabric through the **gatewayCl
2323
To create a **NodePort** service run the following command:
2424

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

2929
A **NodePort** service allocates a port on every cluster node. Access NGINX Gateway Fabric using any node's IP address and the allocated port.
@@ -37,7 +37,7 @@ To create a **LoadBalancer** service, use the appropriate manifest for your clou
3737
1. Run the following command:
3838

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

4343
2. Lookup the public IP of the load balancer, which is reported in the `EXTERNAL-IP` column in the output of the following command:
@@ -53,7 +53,7 @@ To create a **LoadBalancer** service, use the appropriate manifest for your clou
5353
1. Run the following command:
5454

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

5959
2. In AWS, the NLB (Network Load Balancer) DNS (directory name system) name will be reported by Kubernetes instead of a public IP in the `EXTERNAL-IP` column. To get the DNS name, run:

site/content/installation/installing-ngf/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
265265

266266
## Additional configuration
267267

268-
For a full list of the Helm Chart configuration parameters, read [the NGINX Gateway Fabric Helm Chart](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/deploy/helm-chart/README.md#configuration).
268+
For a full list of the Helm Chart configuration parameters, read [the NGINX Gateway Fabric Helm Chart](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.1.0/deploy/helm-chart/README.md#configuration).
269269

270270
## Next steps
271271

site/content/installation/installing-ngf/manifests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
6161

6262
##### For NGINX Plus
6363

64-
Download the [deployment YAML](https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-plus-gateway.yaml).
64+
Download the [deployment YAML](https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/nginx-plus-gateway.yaml).
6565

6666
Update the `nginx-plus-gateway.yaml` file to include your chosen NGINX Plus image from the F5 Container registry or your custom image.
6767

site/content/installation/ngf-images/building-the-images.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If building the NGINX Plus image, you will also need a valid NGINX Plus license
2828
1. Clone the repo and change into the `nginx-gateway-fabric` directory:
2929

3030
```shell
31-
git clone https://github.com/nginxinc/nginx-gateway-fabric.git
31+
git clone https://github.com/nginxinc/nginx-gateway-fabric.git --branch v1.1.0
3232
cd nginx-gateway-fabric
3333
```
3434

@@ -64,20 +64,20 @@ If building the NGINX Plus image, you will also need a valid NGINX Plus license
6464
```
6565

6666
Set the `PREFIX` variable to the name of the registry you'd like to push the image to. By default, the images will be
67-
named `nginx-gateway-fabric:edge` and `nginx-gateway-fabric/nginx:edge` or `nginx-gateway-fabric/nginx-plus:edge`.
67+
named `nginx-gateway-fabric:1.1.0` and `nginx-gateway-fabric/nginx:1.1.0` or `nginx-gateway-fabric/nginx-plus:1.1.0`.
6868

6969
1. Push the images to your container registry:
7070

7171
```shell
72-
docker push myregistry.example.com/nginx-gateway-fabric:edge
73-
docker push myregistry.example.com/nginx-gateway-fabric/nginx:edge
72+
docker push myregistry.example.com/nginx-gateway-fabric:1.1.0
73+
docker push myregistry.example.com/nginx-gateway-fabric/nginx:1.1.0
7474
```
7575

7676
or
7777

7878
```shell
79-
docker push myregistry.example.com/nginx-gateway-fabric:edge
80-
docker push myregistry.example.com/nginx-gateway-fabric/nginx-plus:edge
79+
docker push myregistry.example.com/nginx-gateway-fabric:1.1.0
80+
docker push myregistry.example.com/nginx-gateway-fabric/nginx-plus:1.1.0
8181
```
8282

8383
Make sure to substitute `myregistry.example.com/nginx-gateway-fabric` with your registry.

site/content/installation/ngf-images/pulling-ngf-image.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ curl https://private-registry.nginx.com/nginx-gateway-fabric/nginx-plus/tags/lis
5252
{
5353
"name": "nginx-gateway-fabric/nginx-plus",
5454
"tags": [
55-
"edge"
55+
"edge",
56+
"nightly"
5657
]
5758
}
5859
```

site/content/installation/running-on-kind.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ kubectl -n nginx-gateway port-forward <pod-name> 8080:80 8443:443
5858

5959
## Getting Started with NGINX Gateway Fabric
6060

61-
Learn how to use NGINX Gateway Fabric by exploring the tutorials in the [examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples) directory. The guides provide practical instructions and scenarios to help you use NGINX Gateway Fabric effectively.
61+
Learn how to use NGINX Gateway Fabric by exploring the tutorials in the [examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/examples) directory. The guides provide practical instructions and scenarios to help you use NGINX Gateway Fabric effectively.

site/content/overview/gateway-architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ NGINX Gateway Fabric is an open source project that provides an implementation o
1919

2020
For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< relref "/overview/gateway-api-compatibility.md" >}}) documentation.
2121

22-
We have more information regarding our [design principles](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/developer/design-principles.md) in the project's GitHub repository.
22+
We have more information regarding our [design principles](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.1.0/docs/developer/design-principles.md) in the project's GitHub repository.
2323

2424
## NGINX Gateway Fabric at a high level
2525

@@ -70,7 +70,7 @@ The following list describes the connections, preceeded by their types in parent
7070

7171
1. (HTTPS)
7272
- Read: _NGF_ reads the _Kubernetes API_ to get the latest versions of the resources in the cluster.
73-
- Write: _NGF_ writes to the _Kubernetes API_ to update the handled resources' statuses and emit events. If there's more than one replica of _NGF_ and [leader election](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/deploy/helm-chart#configuration) is enabled, only the _NGF_ pod that is leading will write statuses to the _Kubernetes API_.
73+
- Write: _NGF_ writes to the _Kubernetes API_ to update the handled resources' statuses and emit events. If there's more than one replica of _NGF_ and [leader election](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/deploy/helm-chart#configuration) is enabled, only the _NGF_ pod that is leading will write statuses to the _Kubernetes API_.
7474
1. (HTTP, HTTPS) _Prometheus_ fetches the `controller-runtime` and NGINX metrics via an HTTP endpoint that _NGF_ exposes (`:9113/metrics` by default). Prometheus is **not** required by NGINX Gateway Fabric, and its endpoint can be turned off.
7575
1. (File I/O)
7676
- Write: _NGF_ generates NGINX _configuration_ based on the cluster resources and writes them as `.conf` files to the mounted `nginx-conf` volume, located at `/etc/nginx/conf.d`. It also writes _TLS certificates_ and _keys_ from [TLS secrets](https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets) referenced in the accepted Gateway resource to the `nginx-secrets` volume at the path `/etc/nginx/secrets`.
@@ -84,7 +84,7 @@ The following list describes the connections, preceeded by their types in parent
8484
1. (File I/O)
8585
- Write: The _NGINX master_ writes to the auxiliary Unix sockets folder, which is located in the `/var/lib/nginx`
8686
directory.
87-
- Read: The _NGINX master_ reads the `nginx.conf` file from the `/etc/nginx` directory. This [file](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/internal/mode/static/nginx/conf/nginx.conf) contains the global and http configuration settings for NGINX. In addition, _NGINX master_ reads the NJS modules referenced in the configuration when it starts or during a reload. NJS modules are stored in the `/usr/lib/nginx/modules` directory.
87+
- Read: The _NGINX master_ reads the `nginx.conf` file from the `/etc/nginx` directory. This [file](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.1.0/internal/mode/static/nginx/conf/nginx.conf) contains the global and http configuration settings for NGINX. In addition, _NGINX master_ reads the NJS modules referenced in the configuration when it starts or during a reload. NJS modules are stored in the `/usr/lib/nginx/modules` directory.
8888
1. (File I/O) The _NGINX master_ sends logs to its _stdout_ and _stderr_, which are collected by the container runtime.
8989
1. (File I/O) An _NGINX worker_ writes logs to its _stdout_ and _stderr_, which are collected by the container runtime.
9090
1. (Signal) The _NGINX master_ controls the [lifecycle of _NGINX workers_](https://nginx.org/en/docs/control.html#reconfiguration) it creates workers with the new configuration and shutdowns workers with the old configuration.

0 commit comments

Comments
 (0)