Skip to content

Release 0.6.0 #1021

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 3 commits into from
Aug 31, 2023
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
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ This document includes a curated changelog for each release. We also publish a c
a [GitHub release](https://github.com/nginxinc/nginx-kubernetes-gateway/releases), which, by contrast, is auto-generated
and includes links to all PRs that went into the release.

## Release 0.6.0

*August 31, 2023*

This release adds a Helm chart, dynamic control plane logging, Prometheus metrics, and in-depth guides for various use cases.

FEATURES:

- Helm chart. [PR-840](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/840)
- Use custom nginx container. [PR-934](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/911)
- Support dynamic control plane logging. [PR-943](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/943)
- Support websocket connections. [PR-962](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/962)
- Support Prometheus metrics. [PR-999](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/999)

BUG FIXES:

- Ensure NGINX Kubernetes Gateway has least privileges. [PR-1004](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/1004)

DOCUMENTATION:

- Use case guides: https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs/guides

## Release 0.5.0

*July 17, 2023*
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# variables that should not be overridden by the user
VERSION = edge
VERSION = 0.6.0
GIT_COMMIT = $(shell git rev-parse HEAD || echo "unknown")
DATE = $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
MANIFEST_DIR = $(shell pwd)/deploy/manifests
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a
We publish NGINX Kubernetes Gateway releases on GitHub. See
our [releases page](https://github.com/nginxinc/nginx-kubernetes-gateway/releases).

The latest release is [0.5.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.5.0).
The latest release is [0.6.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.6.0).

The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose
the *edge* version built from the [latest commit](https://github.com/nginxinc/nginx-kubernetes-gateway/commits/main)
Expand All @@ -51,7 +51,7 @@ to the correct versions:

| Version | Description | Image | Installation Manifests | Documentation and Examples |
|----------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Latest release | For experimental use | Use the 0.5.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/examples). |
| Latest release | For experimental use | Use the 0.6.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/examples). |
| Edge | For experimental use and latest features | Use the edge image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/examples). |

## Technical Specifications
Expand All @@ -60,7 +60,8 @@ The following table lists the software versions NGINX Kubernetes Gateway support

| NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS |
|--------------------------|-------------|------------|-----------|
| Edge | 0.8.0 | 1.22+ | 1.25.2 |
| Edge | 0.8.0 | 1.23+ | 1.25.2 |
| 0.6.0 | 0.8.0 | 1.23+ | 1.25.2 |
| 0.5.0 | 0.7.1 | 1.21+ | 1.25.x * |
| 0.4.0 | 0.7.1 | 1.21+ | 1.25.x * |
| 0.3.0 | 0.6.2 | 1.21+ | 1.23.x * |
Expand Down
2 changes: 1 addition & 1 deletion conformance/Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
NKG_TAG = edge
NKG_TAG = 0.6.0
NKG_PREFIX = nginx-kubernetes-gateway
NGINX_IMAGE_NAME = $(NKG_PREFIX)/nginx
GW_API_VERSION ?= 0.8.0
Expand Down
2 changes: 1 addition & 1 deletion conformance/provisioner/provisioner.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ spec:
spec:
serviceAccountName: nginx-gateway-provisioner
containers:
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:0.6.0
imagePullPolicy: Always
name: nginx-gateway-provisioner
securityContext:
Expand Down
10 changes: 5 additions & 5 deletions conformance/provisioner/static-deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
# We only support a single replica for now
replicas: 1
Expand Down Expand Up @@ -38,8 +38,8 @@ spec:
valueFrom:
fieldRef:
fieldPath: metadata.namespace
image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
imagePullPolicy: Always
image: ghcr.io/nginxinc/nginx-kubernetes-gateway:0.6.0
imagePullPolicy: IfNotPresent
name: nginx-gateway
securityContext:
allowPrivilegeEscalation: false
Expand All @@ -58,8 +58,8 @@ spec:
mountPath: /etc/nginx/secrets
- name: nginx-run
mountPath: /var/run/nginx
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway/nginx:edge
imagePullPolicy: Always
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway/nginx:0.6.0
imagePullPolicy: IfNotPresent
name: nginx
ports:
- containerPort: 80
Expand Down
6 changes: 3 additions & 3 deletions deploy/helm-chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: nginx-kubernetes-gateway
description: NGINX Kubernetes Gateway
type: application
version: 0.1.0
appVersion: "edge"
appVersion: "0.6.0"
home: https://github.com/nginxinc/nginx-kubernetes-gateway
icon: https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy/helm-chart/chart-icon.png
icon: https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy/helm-chart/chart-icon.png
sources:
- https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy/helm-chart
- https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy/helm-chart
keywords:
- kubernetes
- gateway
Expand Down
6 changes: 3 additions & 3 deletions deploy/helm-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ To install the chart with the release name `my-release` (`my-release` is the nam
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists):

```shell
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge --create-namespace --wait -n nginx-gateway
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.6.0 --create-namespace --wait -n nginx-gateway
```

### Installing the Chart via Sources

#### Pulling the Chart

```shell
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar --version 0.0.0-edge
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar --version 0.6.0
cd nginx-kubernetes-gateway
```

Expand Down Expand Up @@ -83,7 +83,7 @@ Warning: kubectl apply should be used on resource created by either kubectl crea
To upgrade the release `my-release`, run:

```shell
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge -n nginx-gateway
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.6.0 -n nginx-gateway
```

### Upgrading the Chart from the Sources
Expand Down
8 changes: 4 additions & 4 deletions deploy/helm-chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ nginxGateway:
image:
## The NGINX Kubernetes Gateway image to use
repository: ghcr.io/nginxinc/nginx-kubernetes-gateway
tag: edge
pullPolicy: Always
tag: 0.6.0
pullPolicy: IfNotPresent

nginx:
## The NGINX image to use
image:
repository: ghcr.io/nginxinc/nginx-kubernetes-gateway/nginx
tag: edge
pullPolicy: Always
tag: 0.6.0
pullPolicy: IfNotPresent

serviceAccount:
annotations: {}
Expand Down
20 changes: 10 additions & 10 deletions deploy/manifests/nginx-gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
annotations:
{}
---
Expand All @@ -24,7 +24,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
rules:
- apiGroups:
- ""
Expand Down Expand Up @@ -90,7 +90,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
Expand All @@ -109,7 +109,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
# We only support a single replica for now
replicas: 1
Expand Down Expand Up @@ -142,8 +142,8 @@ spec:
valueFrom:
fieldRef:
fieldPath: metadata.namespace
image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
imagePullPolicy: Always
image: ghcr.io/nginxinc/nginx-kubernetes-gateway:0.6.0
imagePullPolicy: IfNotPresent
name: nginx-gateway
ports:
- name: metrics
Expand All @@ -165,8 +165,8 @@ spec:
mountPath: /etc/nginx/secrets
- name: nginx-run
mountPath: /var/run/nginx
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway/nginx:edge
imagePullPolicy: Always
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway/nginx:0.6.0
imagePullPolicy: IfNotPresent
name: nginx
ports:
- containerPort: 80
Expand Down Expand Up @@ -218,7 +218,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
controllerName: gateway.nginx.org/nginx-gateway-controller
---
Expand All @@ -231,7 +231,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
logging:
level: info
2 changes: 1 addition & 1 deletion deploy/manifests/service/loadbalancer-aws-nlb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
annotations:
service.beta.kubernetes.io/aws-load-balancer-type: nlb
spec:
Expand Down
2 changes: 1 addition & 1 deletion deploy/manifests/service/loadbalancer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
externalTrafficPolicy: Local
type: LoadBalancer
Expand Down
2 changes: 1 addition & 1 deletion deploy/manifests/service/nodeport.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ metadata:
labels:
app.kubernetes.io/name: nginx-gateway
app.kubernetes.io/instance: nginx-gateway
app.kubernetes.io/version: "edge"
app.kubernetes.io/version: "0.6.0"
spec:
type: NodePort
selector:
Expand Down
8 changes: 4 additions & 4 deletions docs/building-the-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ installed on your machine:
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:

```shell
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git --branch v0.6.0
cd nginx-kubernetes-gateway
```

Expand All @@ -39,13 +39,13 @@ installed on your machine:
```

Set the `PREFIX` variable to the name of the registry you'd like to push the image to. By default, the images will be
named `nginx-kubernetes-gateway:edge` and `nginx-kubernetes-gateway/nginx:edge`.
named `nginx-kubernetes-gateway:0.6.0` and `nginx-kubernetes-gateway/nginx:0.6.0`.

1. Push the images to your container registry:

```shell
docker push myregistry.example.com/nginx-kubernetes-gateway:edge
docker push myregistry.example.com/nginx-kubernetes-gateway/nginx:edge
docker push myregistry.example.com/nginx-kubernetes-gateway:0.6.0
docker push myregistry.example.com/nginx-kubernetes-gateway/nginx:0.6.0
```

Make sure to substitute `myregistry.example.com/nginx-kubernetes-gateway` with your registry.
4 changes: 2 additions & 2 deletions docs/guides/advanced-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ and `coffee` applications share the same Gateway.
Begin by deploying the `coffee-v1` and `coffee-v2` applications:

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/main/examples/advanced-routing/coffee.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/v0.6.0/examples/advanced-routing/coffee.yaml
```

### Deploy the Gateway API Resources for the Coffee Applications
Expand Down Expand Up @@ -166,7 +166,7 @@ have their own set of rules, but will still attach to the same Gateway listener
### Deploy the Tea Applications

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/main/examples/advanced-routing/tea.yaml
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-kubernetes-gateway/v0.6.0/examples/advanced-routing/tea.yaml
```

### Deploy the HTTPRoute for the Tea Services
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ page.
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:

```shell
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git
git clone https://github.com/nginxinc/nginx-kubernetes-gateway.git --branch v0.6.0
cd nginx-kubernetes-gateway
```

Expand Down