Nginx Ingress Integrator

  • By Tom Haddon
Channel Revision Published Runs on
latest/stable 59 27 Mar 2023
Ubuntu 20.04
latest/edge 70 10 May 2023
Ubuntu 20.04
juju deploy nginx-ingress-integrator
Show information


  • additional-hostnames | string

    Comma-separated list of additional hostnames for this ingress to listen on.

  • ingress-class | string

    The ingress class to target for this ingress resource. If your cluster has multiple ingress controllers, this allows you to select the correct one, by setting the ingressClassName field on the ingress resource created by the charm. This value isn't available to be set via the relation as it's a property of the cluster's configuration. If this value is empty, the charm will use whichever ingress class has the "" annotation set to "true". If multiple ingress classes are so configured, no selection will be made. For more details, see: * *

  • limit-rps | int

    Number of requests accepted from a given IP each second. The burst limit is set to this limit multiplied by 5. When clients exceed this limit a 503 error will be returned. Setting this to 0 disables rate-limiting.

  • limit-whitelist | string

    If rate-limiting is set, client IP source ranges to be excluded. The value is a comma-separated list of CIDRs.

  • max-body-size | int

    Default: 20

    Max allowed body-size (for file uploads) in megabytes, set to 0 to disable limits.

  • owasp-modsecurity-crs | boolean

    Enable OWASP ModSecurity Core Rule Set (CRS). A set of generic attack detection rules for use with ModSecurity or compatible web application firewalls. The CRS aims to protect web applications from a wide range of attacks, including the OWASP Top Ten, with a minimum of false alerts. See for more details.

  • owasp-modsecurity-custom-rules | string

    New line ('\n') separated list of custom rules to be added to modsecurity-snippet annotation. Example: "SecAction id:900130,phase:1,nolog,pass,t:none,setvar:tx.crs_exclusions_wordpress=1\n".

  • path-routes | string

    Comma separated list of the routes under the hostname that you wish to map to the relation. Example: "/admin,/portal" will map example.test/admin and example.test/portal only.

  • proxy-read-timeout | int

    Default: 60

    Defines a timeout in seconds for reading a response from the proxied server.

  • retry-errors | string

    Specifies in which cases a request should be retried against the next server. Comma-separated list, e.g. "error,timeout,http_502,http_503,http_504". See for more details. Unrecognised values will be ignored. The nginx default will be used if this config option is set to an empty value.

  • rewrite-enabled | boolean

    Default: True

    Whether requests should be written to the `rewrite-target`

  • rewrite-target | string

    The path to rewrite requests to. If not set, rewrite-target will be "/".

  • service-hostname | string

    The hostname of the service to create an ingress for.

  • service-name | string

    The name of the service to create an ingress for.

  • service-namespace | string

    The namespace of the service to create an ingress for. Will default to the namespace this charm is deployed into.

  • service-port | int

    The port of the service to create an ingress for.

  • tls-secret-name | string

    The name of the TLS secret to use. Leaving this empty will configure an ingress with TLS disabled.

  • whitelist-source-range | string

    Allowed client IP source ranges. The value is a comma separated list of CIDRs.