NGINX ingress integrator charm

A Juju charm deploying and managing external access to HTTP/HTTPS services in a Kubernetes cluster through an Nginx Ingress resource. This requires the Kubernetes cluster in question to have an Nginx Ingress Controller already deployed into it.

This charm simplifies exposing services running inside a Kubernetes cluster to external clients. It offers TLS termination as well as easy configuration of a number of advanced features including rate limiting, restricting access to specific client IP source ranges, and OWASP ModSecurity Core Rule Set (CRS).

As such, the charm makes it easy for charm developers to provide external access to their HTTP workloads in Kubernetes by easy integration offered through the charm’s nginx_route library.

For DevOps and SRE teams, providing ingress for charms that support a relation to this charm will be possible through a simple juju integrate command.

In this documentation

Get started

Deploy the NGINX ingress integrator charm

Operations

Upgrade

Security

Overview | Secure an ingress with TLS | Enable OWASP ModSecurity

Integrations

Integrations | Add the nginx-route relation | Support multiple relations

Design

Charm architecture | What is ingress?

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

  • The Tutorial takes you step-by-step through your first deployment of the NGINX ingress integrator charm.

  • The How-to guides cover practical tasks for configuring, integrating, and maintaining your NGINX ingress integrator deployment.

  • Reference provides technical details on the charm architecture and integrations.

  • Explanation includes context and overviews on key topics such as security and ingress.

Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions, and constructive feedback on our documentation. See How to contribute for more information.

If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.

Project and community

The NGINX ingress integrator charm is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback.

Thinking about using the NGINX ingress integrator charm for your next project? Get in touch!