Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nginxinc/kubernetes-ingress

NGINX and NGINX Plus Ingress Controllers for Kubernetes
https://github.com/nginxinc/kubernetes-ingress

docker go golang ingress ingress-controller k8s kubernetes nginx

Last synced: 4 days ago
JSON representation

NGINX and NGINX Plus Ingress Controllers for Kubernetes

Awesome Lists containing this project

README 

        

[![OpenSSFScorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/kubernetes-ingress/badge)](https://api.securityscorecards.dev/projects/github.com/nginxinc/kubernetes-ingress)

[![Regression](https://github.com/nginxinc/kubernetes-ingress/actions/workflows/regression.yml/badge.svg?event=schedule)](https://github.com/nginxinc/kubernetes-ingress/actions/workflows/regression.yml?query=event%3Aschedule)

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fkubernetes-ingress.svg?type=shield)](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fkubernetes-ingress?ref=badge_shield)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/kubernetes-ingress)](https://goreportcard.com/report/github.com/nginxinc/kubernetes-ingress)

[![codecov](https://codecov.io/gh/nginxinc/kubernetes-ingress/branch/main/graph/badge.svg?token=snCn7Y0zC7)](https://codecov.io/gh/nginxinc/kubernetes-ingress)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginxinc/kubernetes-ingress?logo=github&sort=semver)](https://github.com/nginxinc/kubernetes-ingress/releases/latest)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginxinc/kubernetes-ingress?logo=go)

[![Docker Pulls](https://img.shields.io/docker/pulls/nginx/nginx-ingress?logo=docker&logoColor=white)](https://hub.docker.com/r/nginx/nginx-ingress)

![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/nginx/nginx-ingress?logo=docker&logoColor=white&sort=semver)

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/nginx-ingress)](https://artifacthub.io/packages/container/nginx-ingress/kubernetes-ingress)

[![Slack](https://img.shields.io/badge/slack-%23nginx--ingress--controller-green?logo=slack)](https://nginxcommunity.slack.com/channels/nginx-ingress-controller)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

![Commercial Support](https://badgen.net/badge/support/commercial/green?icon=awesome)



# NGINX Ingress Controller



This repo provides an implementation of an Ingress Controller for NGINX and NGINX Plus from the people behind NGINX.



---



## Join The Next Community Call



We value community input and would love to see you at the next community call. At these calls, we discuss PRs by community members as well as issues, discussions and feature requests.



**Microsoft Teams Link**: [KIC - GitHub Issues Triage](https://teams.microsoft.com/l/meetup-join/19%3ameeting_OTRhZjFhMDMtZTQwOC00NDA4LWJiOGItZjhhMmE5NzgyMDY0%40thread.v2/0?context=%7b%22Tid%22%3a%22dd3dfd2f-6a3b-40d1-9be0-bf8327d81c50%22%2c%22Oid%22%3a%22ea616cee-2e02-45f5-8e4c-c24967346491%22%7d)  



**Meeting ID:** `298 140 979 789`



**Passcode:** `jpx5TM`



**Slack**: Join our channel `#nginx-ingress-controller` on the [NGINX Community Slack](https://nginxcommunity.slack.com/channels/nginx-ingress-controller) for updates and discussions.  

**When**: 15:00 GMT / [Convert to your timezone](https://dateful.com/convert/gmt?t=15), every other Monday.



| **Community Call Dates** |

| ------------------------ |

| **2024-10-07**           |

| **2024-10-21**           |

| **2024-11-05**           |

| **2024-11-18**           |

| **2024-12-02**           |

| **2024-12-16**           |



---



NGINX Ingress Controller works with both NGINX and NGINX Plus and supports the standard Ingress features - content-based

routing and TLS/SSL termination.



Additionally, several NGINX and NGINX Plus features are available as extensions to the Ingress resource via annotations

and the ConfigMap resource. In addition to HTTP, NGINX Ingress Controller supports load balancing Websocket, gRPC, TCP

and UDP applications. See

[ConfigMap](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/) and

[Annotations](https://docs.nginx.com/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations/)

docs to learn more about the supported features and customization options.



As an alternative to the Ingress, NGINX Ingress Controller supports the VirtualServer and VirtualServerRoute resources.

They enable use cases not supported with the Ingress resource, such as traffic splitting and advanced content-based

routing. See [VirtualServer and VirtualServerRoute resources

doc](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/).



TCP, UDP and TLS Passthrough load balancing is also supported. See the [TransportServer resource

doc](https://docs.nginx.com/nginx-ingress-controller/configuration/transportserver-resource/).



Read [this doc](https://docs.nginx.com/nginx-ingress-controller/intro/nginx-plus) to learn more about NGINX Ingress

Controller with NGINX Plus.



> **Note**

>

> This project is different from the NGINX Ingress Controller in

[kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx) repo. See [this

doc](https://docs.nginx.com/nginx-ingress-controller/intro/nginx-ingress-controllers) to find out about the key

differences.



## Ingress and Ingress Controller



### What is the Ingress?



The Ingress is a Kubernetes resource that lets you configure an HTTP load balancer for applications running on

Kubernetes, represented by one or more [Services](https://kubernetes.io/docs/concepts/services-networking/service/).

Such a load balancer is necessary to deliver those applications to clients outside of the Kubernetes cluster.



The Ingress resource supports the following features:



- **Content-based routing**:

  - *Host-based routing*. For example, routing requests with the host header `foo.example.com` to one group of services

  and the host header `bar.example.com` to another group.

  - *Path-based routing*. For example, routing requests with the URI that starts with `/serviceA` to service A and

  requests with the URI that starts with `/serviceB` to service B.

- **TLS/SSL termination** for each hostname, such as `foo.example.com`.



See the [Ingress User Guide](https://kubernetes.io/docs/concepts/services-networking/ingress/) to learn more about the

Ingress resource.



### What is the Ingress Controller?



The Ingress Controller is an application that runs in a cluster and configures an HTTP load balancer according to

Ingress resources. The load balancer can be a software load balancer running in the cluster or a hardware or cloud load

balancer running externally. Different load balancers require different Ingress Controller implementations.



In the case of NGINX, the Ingress Controller is deployed in a pod along with the load balancer.



## Getting Started



> **Note**

>

> All documentation should only be used with the latest stable release, indicated on [the releases

> page](https://github.com/nginxinc/kubernetes-ingress/releases) of the GitHub repository.



1. Install NGINX Ingress Controller using the [Helm

   chart](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) or the Kubernetes

   [manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-manifests/).

1. Configure load balancing for a simple web application:

    - Use the Ingress resource. See the [Cafe

      example](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example).

    - Or the VirtualServer resource. See the [Basic

      configuration](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples/custom-resources/basic-configuration)

      example.

1. See additional configuration [examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples).

1. Learn more about all available configuration and customization in the

   [docs](https://docs.nginx.com/nginx-ingress-controller/).



## NGINX Ingress Controller Releases



We publish NGINX Ingress Controller releases on GitHub. See our [releases

page](https://github.com/nginxinc/kubernetes-ingress/releases).



The latest stable release is [3.7.2](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.7.2). For production

use, we recommend that you choose the latest stable release.



The edge version is useful for experimenting with new features that are not yet published in a stable release. To use

it, choose the *edge* version built from the [latest

commit](https://github.com/nginxinc/kubernetes-ingress/commits/main) from the main branch.



To use NGINX Ingress Controller, you need to have access to:



- An NGINX Ingress Controller image.

- Installation manifests or a Helm chart.

- Documentation and examples.



It is important that the versions of those things above match.



The table below summarizes the options regarding the images, Helm chart, manifests, documentation and examples and gives

your links to the correct versions:



| Version | Description |  Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples |

| ------- | ----------- | --------------- | -------------------- | ---------------------------------------| -------------------------- |

| Latest stable release | For production use | Use the 3.7.2 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-ingress-controller-image/). | Use the 3.7.2 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/pulling-ingress-controller-image/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.2/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v3.7.2/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). |

| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/site/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). |



## SBOM (Software Bill of Materials)



We generate SBOMs for the binaries and the Docker images.



### Binaries



The SBOMs for the binaries are available in the releases page. The SBOMs are generated using

[syft](https://github.com/anchore/syft) and are available in SPDX format.



### Docker Images



The SBOMs for the Docker images are available in the [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub

Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public

Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress)

repositories. The SBOMs are generated using [syft](https://github.com/anchore/syft) and stored as an attestation in the

image manifest.



For example to retrieve the SBOM for `linux/amd64` from Docker Hub and analyze it using

[grype](https://github.com/anchore/grype) you can run the following command:



```console

docker buildx imagetools inspect nginx/nginx-ingress:edge --format '{{ json (index .SBOM "linux/amd64").SPDX }}' | grype

```



## Contacts



We’d like to hear your feedback! If you have any suggestions or experience issues with our Ingress Controller, please

create an issue or send a pull request on GitHub. You can contact us directly via [NGINX Community

Slack](https://nginxcommunity.slack.com/channels/nginx-ingress-controller).



## Contributing



If you'd like to contribute to the project, please read our [Contributing guide](CONTRIBUTING.md).



## Support



For NGINX Plus customers NGINX Ingress Controller (when used with NGINX Plus) is covered by the support contract.