Skip to content

Commit 5b280da

Browse files
author
Kate Osborn
committed
Add link to compat doc; Add note to build image
1 parent 997b055 commit 5b280da

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44

55
NGINX Kubernetes Gateway is an open-source project that provides an implementation of the [Gateway API](https://gateway-api.sigs.k8s.io/) using [NGINX](https://nginx.org/) as the data plane. The goal of this project is to implement the core Gateway APIs -- `Gateway`, `GatewayClass`, `HTTPRoute`, `TCPRoute`, `TLSRoute`, and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy, or API gateway for applications running on Kubernetes. NGINX Kubernetes Gateway is currently under development and supports a subset of the Gateway API.
66

7+
For a list of supported Gateway API resources and features, see the [Gateway API Compatibility](docs/gateway-api-compatibility.md.md) doc.
8+
79
> Warning: This project is actively in development (beta feature state) and should not be deployed in a production environment.
810
> All APIs, SDKs, designs, and packages are subject to change.
911
1012
## Getting Started
1113

1214
1. [Quick Start on a kind cluster](docs/running-on-kind.md).
13-
2. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image.
14-
3. [Install](docs/installation.md) NGINX Kubernetes Gateway.
15+
2. [Install](docs/installation.md) NGINX Kubernetes Gateway.
16+
3. [Build](docs/building-the-image.md) a custom NGINX Kubernetes Gateway container image from source.
17+
> Note: NGINX Kubernetes Gateway container images are also available on [GitHub Container Registry].(https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway)
1518
4. Deploy various [examples](examples).
1619

1720
## NGINX Kubernetes Gateway Releases

0 commit comments

Comments
 (0)