Nginx Ingress Integrator

  • By Tom Haddon
Channel Version Revision Published Runs on
latest/stable 54 54 13 Dec 2022
Ubuntu 20.04
latest/edge 54 54 13 Dec 2022
Ubuntu 22.04 Ubuntu 20.04
juju deploy nginx-ingress-integrator
Show information



In this tutorial, we’ll walk you through the process of deploying the nginx-ingress-integrator charm, relating it to another charm, and inspecting the ingress it creates. We’ll then also look at changing that ingress via a juju configuration update.


You will need:

  • A laptop or desktop running Ubuntu (or you can use a VM).
  • Juju and Microk8s installed. We’ll also want to make sure the ingress add-on is enabled, which we can do by running microk8s enable ingress.

Deploy this charm

To deploy the charm and relate it to the Hello Kubecon charm within a Juju Kubernetes model:

juju deploy nginx-ingress-integrator
juju deploy hello-kubecon
juju relate nginx-ingress-integrator hello-kubecon
# If your cluster has RBAC enabled you'll be prompted to run the following:
juju trust nginx-ingress-integrator --scope cluster

Once the deployment has completed and the “hello-kubecon” workload state in juju status has changed to “active” you test the application in a browser.

To do so, we need to find the IP address of the ingress controller, which we can do by running microk8s kubectl get pods -n ingress -o wide. In my case the output was:

NAME                                      READY   STATUS    RESTARTS       AGE   IP             NODE        NOMINATED NODE   READINESS GATES
nginx-ingress-microk8s-controller-c4vp9   1/1     Running   2 (119s ago)   17h   finistere   <none>           <none>

So now I would edit /etc/hosts on my laptop and add hello-kubecon. I could then open a new browser window and visit http://hello-kubecon.

Inspect the ingress configuration

To inspect the ingress configuration that has been created as a result of these actions, run the following:

juju run-action nginx-ingress-integrator/0 --wait describe-ingresses

This will show something like the following:

  UnitId: nginx-ingress-integrator/0
  id: "2"
    ingresses: |-
      {'api_version': '',
       'items': [{'api_version': None,
                  'kind': None,
                  'metadata': {'annotations': {'': '20m',
                                               '': '/',
                                               '': 'false'},
                               'cluster_name': None,
                               'creation_timestamp': datetime.datetime(2022, 12, 12, 16, 41, 26, tzinfo=tzlocal()),
                               'deletion_grace_period_seconds': None,
                               'deletion_timestamp': None,
                               'finalizers': None,
                               'generate_name': None,
                               'generation': 1,
                               'labels': {'': 'nginx-ingress-integrator'},
                               'managed_fields': [{'api_version': '',
                                                   'fields_type': 'FieldsV1',
                                                   'fields_v1': {'f:metadata': {'f:annotations': {'.': {},
                                                                                                  '': {},
                                                                                                  '': {},
                                                                                                  '': {}}},
                                                                 'f:spec': {'f:ingressClassName': {},
                                                                            'f:rules': {}}},
                                                   'manager': 'OpenAPI-Generator',
                                                   'operation': 'Update',
                                                   'time': datetime.datetime(2022, 12, 12, 16, 41, 26, tzinfo=tzlocal())},
                                                  {'api_version': '',
                                                   'fields_type': 'FieldsV1',
                                                   'fields_v1': {'f:status': {'f:loadBalancer': {'f:ingress': {}}}},
                                                   'manager': 'nginx-ingress-controller',
                                                   'operation': 'Update',
                                                   'time': datetime.datetime(2022, 12, 12, 16, 41, 45, tzinfo=tzlocal())}],
                               'name': 'hello-kubecon-ingress',
                               'namespace': 'ing-test',
                               'owner_references': None,
                               'resource_version': '9123',
                               'self_link': None,
                               'uid': '9dda237a-d903-4031-947d-3a5fd9b4d34e'},
                  'spec': {'default_backend': None,
                           'ingress_class_name': 'public',
                           'rules': [{'host': 'hello-kubecon',
                                      'http': {'paths': [{'backend': {'resource': None,
                                                                      'service': {'name': 'hello-kubecon-service',
                                                                                  'port': {'name': None,
                                                                                           'number': 8080}}},
                                                          'path': '/',
                                                          'path_type': 'Prefix'}]}}],
                           'tls': None},
                  'status': {'load_balancer': {'ingress': [{'hostname': None,
                                                            'ip': ''}]}}}],
       'kind': 'IngressList',
       'metadata': {'_continue': None,
                    'remaining_item_count': None,
                    'resource_version': '9187',
                    'self_link': None}}
  status: completed
    completed: 2022-12-12 16:42:11 +0000 UTC
    enqueued: 2022-12-12 16:42:08 +0000 UTC
    started: 2022-12-12 16:42:11 +0000 UTC

This shows us a number of things including the name of the kubernetes service for our application ('service': {'name': 'hello-kubecon-service'), as well as the port that service is configured with (8080).

We also see a number of annotations that have been set for the ingress:

'metadata': {'annotations': {'': '20m',
                             '': '/',
                             '': 'false'},

Now let’s look at how to change our ingress using Juju configuration.

Change configuration

Looking at the above output we see some default settings for the charm, including': '20m'. The charm controls this via the max-body-size configuration option. We can easily change this by running:

juju config nginx-ingress-integrator max-body-size=10

If we re-run the describe-ingresses action above, we’ll now see that the annotation has been updated to '': '10m'.

Help us improve this documentation

Most of this documentation can be collaboratively discussed and changed on the respective topic in the doc category of the Charmhub forum. See the documentation guidelines if you’d like to contribute.

Last updated 24 days ago. Help improve this document in the forum.