Skip to content

Update repo files for release 0.2.0 #280

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 2 commits into from
Oct 25, 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
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,38 @@

This document includes a curated changelog for each release. We also publish a changelog as the description of 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.2.0

*October 24, 2022*

This release extends the support of the features of the Gateway API resources.

FEATURES:
* Support the Pod IPs instead of the virtual IP of a Service in the NGINX upstream. Additionally, NGINX Kubernetes Gateway will pick up any changes to the Pod IPs and update the NGINX upstream accordingly. [PR-221](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/221)
* Support the redirect filter in an HTTPRoute rule. [PR-218](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/218)
* Support weights in backendRefs in the HTTPRoute (traffic splitting). [PR-261](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/261)
* Support the ObservedGeneration field in the HTTPRoute status. [PR-254](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/254)

BUG FIXES:
* Do not require the namespace in the `--gateway-ctlr-name` cli argument. [PR-235](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/235)
* Ensure NGINX Kubernetes Gateway exits gracefully during shutdown. [PR-250](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/250)
* Handle query param names in case-sensitive way. [PR-220](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/220)

DEPENDENCIES:
* Use the latest NGINX 1.23 image. [PR-275](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/275)
* Bump sigs.k8s.io/gateway-api from 0.5.0 to 0.5.1 [PR-251](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/251)


COMPATIBILITY:
- The Gateway API version: `0.5.1`
- NGINX version: `1.21.x` *
- Kubernetes version: `1.21+`

\*the installation manifests use the `nginx:1.21` image, which always points to the latest version of 1.21.x releases.

CONTAINER IMAGES:
- Control plane: `ghcr.io/nginxinc/nginx-kubernetes-gateway:0.2.0`

## Release 0.1.0

*August 22, 2022*
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = edge
VERSION = 0.2.0
TAG = $(VERSION)
PREFIX ?= nginx-kubernetes-gateway

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For a list of supported Gateway API resources and features, see the [Gateway API

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.1.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v0.1.0).
The latest release is [0.2.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v0.2.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) from the main branch.

Expand All @@ -35,15 +35,19 @@ The table below summarizes the options regarding the images, manifests, document

| Version | Description | Image | Installation Manifests | Documentation and Examples |
|-|-|-|-|-|
| Latest release | For experimental use | Use the 0.1.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.1.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.1.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.1.0/examples). |
| Latest release | For experimental use | Use the 0.2.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.2.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.2.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.2.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

The following table lists the software versions NGINX Kubernetes Gateway supports.

| NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS |
|-|-|-|-|
| 0.1.0 | 0.5.0 | 1.19+ | 1.21.3|
| Edge | 0.5.1 | 1.21+ | 1.21.x *|
| 0.2.0 | 0.5.1 | 1.21+ | 1.21.x *|
| 0.1.0 | 0.5.0 | 1.19+ | 1.21.3 |

\*the installation manifests use the `nginx:1.21` image, which always points to the latest version of 1.21.x releases.

## Contacts

Expand Down
4 changes: 2 additions & 2 deletions deploy/manifests/nginx-gateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ spec:
- name: nginx-config
mountPath: /etc/nginx
containers:
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:edge
imagePullPolicy: Always
- image: ghcr.io/nginxinc/nginx-kubernetes-gateway:0.2.0
imagePullPolicy: IfNotPresent
name: nginx-gateway
volumeMounts:
- name: nginx-config
Expand Down
6 changes: 3 additions & 3 deletions docs/building-the-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before you can build the NGINX Kubernetes Gateway, make sure you have the follow
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:

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

Expand All @@ -22,12 +22,12 @@ Before you can build the NGINX Kubernetes Gateway, make sure you have the follow
make PREFIX=myregistry.example.com/nginx-kubernetes-gateway container
```

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

1. Push the image to your container registry:

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

Make sure to substitute `myregistry.example.com/nginx-kubernetes-gateway` with your registry.
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi
1. Clone the repo and change into the `nginx-kubernetes-gateway` directory:

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

Expand Down