Nginx Ingress Integrator

Library for the nginx-route relation.

This library contains the require and provide functions for handling the nginx-route interface.

Import require_nginx_route in your charm, with four required keyword arguments:

• charm: (the charm itself)
• service_hostname
• service_name
• service_port

Other optional arguments include:

• additional_hostnames
• backend_protocol
• limit_rps
• limit_whitelist
• max_body_size
• owasp_modsecurity_crs
• owasp_modsecurity_custom_rules
• path_routes
• retry_errors
• rewrite_target
• rewrite_enabled
• service_namespace
• session_cookie_max_age
• tls_secret_name

See the config section for descriptions of each, along with the required type.

As an example, add the following to src/charm.py:

from charms.nginx_ingress_integrator.v0.nginx_route import NginxRouteRequirer

# In your charm's `__init__` method (assuming your app is listening on port 8080).
require_nginx_route(
    charm=self,
    service_hostname=self.app.name,
    service_name=self.app.name,
    service_port=8080
)

And then add the following to metadata.yaml:

requires:
  nginx-route:
    interface: nginx-route

You must require nginx route as part of the __init__ method rather than, for instance, a config-changed event handler, for the relation changed event to be properly handled.

In the example above we're setting service_hostname (which translates to the external hostname for the application when related to nginx-ingress-integrator) to self.app.name here. This ensures by default the charm will be available on the name of the deployed juju application, but can be overridden in a production deployment by setting service-hostname on the nginx-ingress-integrator charm. For example:

juju deploy nginx-ingress-integrator
juju deploy my-charm
juju relate nginx-ingress-integrator my-charm:nginx-route
# The service is now reachable on the ingress IP(s) of your k8s cluster at
# 'http://my-charm'.
juju config nginx-ingress-integrator service-hostname='my-charm.example.com'
# The service is now reachable on the ingress IP(s) of your k8s cluster at
# 'http://my-charm.example.com'.