A Juju charm that deploys and manages a Gateway API integrator on Kubernetes. Gateway API is an official Kubernetes project focused on L4 and L7 routing in Kubernetes. This project represents the next generation of Kubernetes Ingress, Load Balancing, and Service Mesh APIs. From the outset, it has been designed to be generic, expressive, and role-oriented. This charm simplifies deployment and operations of Gateway API Integrator. It allows for deployment on many different Kubernetes platforms, including Canonical K8s.
As such, the charm makes it easy for those looking to take control of their own Gateway API deployment while keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice.
For DevOps or SRE teams this charm will make operating a Gateway API simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing of changes.
For information about how to deploy, integrate, and manage this charm, see the Official gateway-api-integrator charm Documentation.
To begin, refer to the Getting Started tutorial for step-by-step instructions.
The configuration gateway-class sets gateway controller for the Kubernetes resource.
On canonical-k8s, for example, to set it to cilium, run the following
command:
juju config gateway-api-integrator gateway-class=cilium
The certificates relation provides the gateway-api-integrator charm with TLS termination.
- Deploy a TLS provider charm
juju deploy self-signed-certificates
- Integrate the gateway-api-integrator charm with the TLS provider charm
juju integrate gateway-api-integrator self-signed-certificates
- Read more
- [Official webpage] (https://gateway-api.sigs.k8s.io/)
Our documentation is stored in the docs directory and
can be viewed at https://canonical.com/juju/docs/gateway-api-integrator-charm/.
It is based on the Canonical Sphinx Stack and hosted on
Read the Docs. In structuring, the
documentation employs the Diátaxis approach.
You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.
To run the documentation locally before submitting your changes:
cd docs
make runGitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.
You can (and should) run the same checks locally:
make spelling
make linkcheck
make vale
make lint-mdThe Gateway API Integrator Operator is a member of the Ubuntu family. It's an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.