Skip to content

Commit c08db6e

Browse files
kate-osbornpleshakovlucacome
authored and
Kate Osborn
committed
Update README; Add issue templates (#203)
- Add contact information - Add tech specs - Add support info - Add bug and feature templates Co-authored-by: Michael Pleshakov <pleshakov@users.noreply.github.com> Co-authored-by: Luca Comellini <luca.com@gmail.com> (cherry picked from commit 76f9a81)
1 parent d8bd4b9 commit c08db6e

File tree

5 files changed

+100
-5
lines changed

5 files changed

+100
-5
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Deploy x to '...' using some.yaml
16+
2. View logs on '....'
17+
3. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Your environment**
23+
* 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.
24+
* Version of Kubernetes
25+
* Kubernetes platform (e.g. Mini-kube or GCP)
26+
* Details on how you expose the NGINX Gateway Pod (e.g. Service of type LoadBalancer or port-forward)
27+
* Logs of NGINX container: `kubectl -n nginx-gateway logs -l app=nginx-gateway -c nginx`
28+
* NGINX Configuration: `kubectl -n nginx-gateway exec <gateway-pod> -c nginx -- nginx -T`
29+
30+
**Additional context**
31+
Add any other context about the problem here. Any log files you want to share.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'proposal'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎README.md

Lines changed: 48 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,55 @@
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-
> Warning: This project is actively in development (pre-alpha feature state) and should not be deployed in a production environment.
7+
For a list of supported Gateway API resources and features, see the [Gateway API Compatibility](docs/gateway-api-compatibility.md.md) doc.
8+
9+
> 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
10-
## Run NGINX Kubernetes Gateway
12+
## Getting Started
1113

12-
1. [Build](docs/building-the-image.md) the NGINX Kubernetes Gateway container image.
14+
1. [Quick Start on a kind cluster](docs/running-on-kind.md).
1315
2. [Install](docs/installation.md) NGINX Kubernetes Gateway.
14-
3. Deploy various [examples](examples).
16+
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).
17+
4. Deploy various [examples](examples).
18+
19+
## NGINX Kubernetes Gateway Releases
20+
21+
We publish NGINX Kubernetes Gateway releases on GitHub. See our [releases page](https://github.com/nginxinc/nginx-kubernetes-gateway/releases).
22+
23+
The latest release is [0.1.0](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v0.1.0).
24+
25+
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.
26+
27+
To use NGINX Kubernetes Gateway, you need to have access to:
28+
* An NGINX Kubernetes Gateway image.
29+
* Installation manifests.
30+
* Documentation and examples.
31+
32+
It is important that the versions of those things above match.
33+
34+
The table below summarizes the options regarding the images, manifests, documentation and examples and gives your links to the correct versions:
35+
36+
| Version | Description | Image | Installation Manifests | Documentation and Examples |
37+
|-|-|-|-|-|
38+
| 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). |
39+
| 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). |
40+
## Technical Specifications
41+
42+
The following table lists the software versions NGINX Kubernetes Gateway supports.
43+
44+
| NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS |
45+
|-|-|-|-|
46+
| 0.1.0 | 0.5.0 | 1.19+ | 1.21.3|
47+
48+
## Contacts
49+
50+
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.
51+
52+
## Contributing
53+
54+
Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribute to the project.
55+
56+
## Support
57+
58+
NGINX Kubernetes Gateway is not covered by any support contract.

‎docs/installation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ This guide walks you through how to install NGINX Kubernetes Gateway on a generi
55
## Prerequisites
66

77
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
8-
- Kubernetes 1.16+ cluster
98

109
## Deploy NGINX Kubernetes Gateway
1110

0 commit comments

Comments
 (0)