From 9073b5e3f04bf3bab8d0748cb8058ab365ade63d Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 18 Aug 2022 12:11:56 -0600 Subject: [PATCH 01/11] Update README - Add contact information - Add tech specs - Add support info --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 331bfc3bc1..7a6ec76eb0 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,32 @@ 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. -> Warning: This project is actively in development (pre-alpha feature state) and should not be deployed in a production environment. +> Warning: This project is actively in development (beta feature state) and should not be deployed in a production environment. > All APIs, SDKs, designs, and packages are subject to change. -## Run NGINX Kubernetes Gateway +## Getting Started -1. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. -2. [Install](docs/installation.md) NGINX Kubernetes Gateway. -3. Deploy various [examples](examples). +1. [Quick Start on a kind cluster](docs/running-on-kind.md). +2, [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. +3. [Install](docs/installation.md) NGINX Kubernetes Gateway. +4. Deploy various [examples](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.16+ | 1.21.3| + +## Contacts + +We’d like to hear your feedback! If you have any suggestions or experience issues with our Gateway Controller, please create an issue or send a pull request on GitHub. You can contact us directly via kubernetes@nginx.com or on the [NGINX Community Slack](https://nginxcommunity.slack.com/channels/nginx-kubernetes-gateway). + +## Contributing + +Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribute to the project. + +## Support + +NGINX Kubernetes Gateway is not covered by any support contract. \ No newline at end of file From 2f0c2ac50f14718edb08de45fbfe30aeaabb4c16 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Fri, 19 Aug 2022 10:43:50 -0600 Subject: [PATCH 02/11] Add bug and feature templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..8b7c7ba34e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Deploy x to '...' using some.yaml +2. View logs on '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Your environment** +* Version of the NGINX Kubernetes Gateway - release version or a specific commit. The first line of the nginx-gateway container logs includes the commit info. +* Version of Kubernetes +* Kubernetes platform (e.g. Mini-kube or GCP) +* Details on how you expose the NGINX Gateway Pod (e.g. Service of type LoadBalancer or port-forward) +* Logs of NGINX container: `kubectl -n nginx-gateway logs -l app=nginx-gateway -c nginx` +* NGINX Configuration: `kubectl -n nginx-gateway exec -c nginx -- nginx -T` + +**Additional context** +Add any other context about the problem here. Any log files you want to share. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..3ba13e0cec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..da2d3f873e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'proposal' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file From 2bccf52df0477f1d8bf8098e5d3814c660c18f4d Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Fri, 19 Aug 2022 10:52:49 -0600 Subject: [PATCH 03/11] Fix numbering error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a6ec76eb0..5a88590b81 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ NGINX Kubernetes Gateway is an open-source project that provides an implementati ## Getting Started 1. [Quick Start on a kind cluster](docs/running-on-kind.md). -2, [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. +2. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. 3. [Install](docs/installation.md) NGINX Kubernetes Gateway. 4. Deploy various [examples](examples). From c2ed61eea763a3a8b8567cc82d9a07040b1b5755 Mon Sep 17 00:00:00 2001 From: kate-osborn <50597707+kate-osborn@users.noreply.github.com> Date: Fri, 19 Aug 2022 12:35:00 -0600 Subject: [PATCH 04/11] Add slack channel name Co-authored-by: Luca Comellini --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a88590b81..3c3ad07017 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The following table lists the software versions NGINX Kubernetes Gateway support ## Contacts -We’d like to hear your feedback! If you have any suggestions or experience issues with our Gateway Controller, please create an issue or send a pull request on GitHub. You can contact us directly via kubernetes@nginx.com or on the [NGINX Community Slack](https://nginxcommunity.slack.com/channels/nginx-kubernetes-gateway). +We’d like to hear your feedback! If you have any suggestions or experience issues with our Gateway Controller, please create an issue or send a pull request on GitHub. You can contact us directly via kubernetes@nginx.com or on the [NGINX Community Slack](https://nginxcommunity.slack.com/channels/nginx-kubernetes-gateway) in the `#nginx-kubernetes-gateway` channel. ## Contributing From 7e9ba19ffb0f63a0c500487edcd16d0dbb814a3a Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Fri, 19 Aug 2022 13:34:44 -0600 Subject: [PATCH 05/11] Add releases section --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 3c3ad07017..6365c9204c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,27 @@ NGINX Kubernetes Gateway is an open-source project that provides an implementati 3. [Install](docs/installation.md) NGINX Kubernetes Gateway. 4. Deploy various [examples](examples). +## NGINX Kubernetes Gateway Releases + +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 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. + +To use NGINX Kubernetes Gateway, you need to have access to: +* An NGINX Kubernetes Gateway image. +* Installation manifests. +* Documentation and examples. + +It is important that the versions of those things above match. + +The table below summarizes the options regarding the images, manifests, documentation and examples and gives your links to the correct versions: + +| 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). | +| 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. From e7900ab6acd70cd09aac3e026918f6ff622250f0 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Fri, 19 Aug 2022 14:59:58 -0600 Subject: [PATCH 06/11] Remove k8s version from install;update min version --- README.md | 2 +- docs/installation.md | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 6365c9204c..1a999e69c8 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ The following table lists the software versions NGINX Kubernetes Gateway support | NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS | |-|-|-|-| -| 0.1.0 | 0.5.0 | 1.16+ | 1.21.3| +| 0.1.0 | 0.5.0 | 1.19 | 1.21.3| ## Contacts diff --git a/docs/installation.md b/docs/installation.md index f59008c030..bc5c1bc3dd 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -5,7 +5,6 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi ## Prerequisites - [kubectl](https://kubernetes.io/docs/tasks/tools/) -- Kubernetes 1.16+ cluster ## Deploy NGINX Kubernetes Gateway From 997b055d9b967f7e1535f616c38dc122c38eb429 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Fri, 19 Aug 2022 15:05:05 -0600 Subject: [PATCH 07/11] Add plus --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a999e69c8..8884520270 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ The following table lists the software versions NGINX Kubernetes Gateway support | NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS | |-|-|-|-| -| 0.1.0 | 0.5.0 | 1.19 | 1.21.3| +| 0.1.0 | 0.5.0 | 1.19+ | 1.21.3| ## Contacts From 5b280daefbe962e4033c32e51cca25de85e2f79d Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Mon, 22 Aug 2022 09:22:10 -0600 Subject: [PATCH 08/11] Add link to compat doc; Add note to build image --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8884520270..6b51cde6d8 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ 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. +For a list of supported Gateway API resources and features, see the [Gateway API Compatibility](docs/gateway-api-compatibility.md.md) doc. + > Warning: This project is actively in development (beta feature state) and should not be deployed in a production environment. > All APIs, SDKs, designs, and packages are subject to change. ## Getting Started 1. [Quick Start on a kind cluster](docs/running-on-kind.md). -2. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. -3. [Install](docs/installation.md) NGINX Kubernetes Gateway. +2. [Install](docs/installation.md) NGINX Kubernetes Gateway. +3. [Build](docs/building-the-image.md) a custom NGINX Kubernetes Gateway container image from source. + > 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) 4. Deploy various [examples](examples). ## NGINX Kubernetes Gateway Releases From 85da4b21cd0f67ec2d30620f2f7e9f8c28424cf5 Mon Sep 17 00:00:00 2001 From: kate-osborn <50597707+kate-osborn@users.noreply.github.com> Date: Mon, 22 Aug 2022 09:38:28 -0600 Subject: [PATCH 09/11] Reword and fix link in Build step Co-authored-by: Michael Pleshakov --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b51cde6d8..c66816c141 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ For a list of supported Gateway API resources and features, see the [Gateway API 1. [Quick Start on a kind cluster](docs/running-on-kind.md). 2. [Install](docs/installation.md) NGINX Kubernetes Gateway. 3. [Build](docs/building-the-image.md) a custom NGINX Kubernetes Gateway container image from source. - > 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) +3. [Build](docs/building-the-image.md) an NGINX Kubernetes Gateway container image from source or use a pre-built image available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) 4. Deploy various [examples](examples). ## NGINX Kubernetes Gateway Releases From f8d81df67ec0e41437a8b771c526b5054410b6da Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Mon, 22 Aug 2022 10:04:47 -0600 Subject: [PATCH 10/11] Remove repeated line --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index c66816c141..915df82a3a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ For a list of supported Gateway API resources and features, see the [Gateway API 1. [Quick Start on a kind cluster](docs/running-on-kind.md). 2. [Install](docs/installation.md) NGINX Kubernetes Gateway. -3. [Build](docs/building-the-image.md) a custom NGINX Kubernetes Gateway container image from source. 3. [Build](docs/building-the-image.md) an NGINX Kubernetes Gateway container image from source or use a pre-built image available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) 4. Deploy various [examples](examples). From e0c2e1291684ca4ab898cd117b17bca275dc7255 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Mon, 22 Aug 2022 10:07:49 -0600 Subject: [PATCH 11/11] Add period --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 915df82a3a..77654f7e63 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ For a list of supported Gateway API resources and features, see the [Gateway API 1. [Quick Start on a kind cluster](docs/running-on-kind.md). 2. [Install](docs/installation.md) NGINX Kubernetes Gateway. -3. [Build](docs/building-the-image.md) an NGINX Kubernetes Gateway container image from source or use a pre-built image available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) +3. [Build](docs/building-the-image.md) an NGINX Kubernetes Gateway container image from source or use a pre-built image available on [GitHub Container Registry](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway). 4. Deploy various [examples](examples). ## NGINX Kubernetes Gateway Releases