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 diff --git a/README.md b/README.md index 331bfc3bc1..77654f7e63 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,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. -> Warning: This project is actively in development (pre-alpha feature state) and should not be deployed in a production environment. +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. -## Run NGINX Kubernetes Gateway +## Getting Started -1. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image. +1. [Quick Start on a kind cluster](docs/running-on-kind.md). 2. [Install](docs/installation.md) NGINX Kubernetes Gateway. -3. Deploy various [examples](examples). +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 + +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. + +| NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS | +|-|-|-|-| +| 0.1.0 | 0.5.0 | 1.19+ | 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) in the `#nginx-kubernetes-gateway` channel. + +## 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 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