Ingress configurator charm.

Learn about configurations >

• additional-hostnames | string

  Comma-separated list of additional_hostnames to route to the service. Will be ignored if hostname is not set.

• allow-http | boolean

  If set to true, allows HTTP traffic in addition to HTTPS. Defaults to False. Warning: enabling HTTP is a security risk, make sure you apply the necessary precautions.

• backend-addresses | string

  (integrator mode) Comma-separated list of IP addresses of the backend services. For gateway-route, all IP addresses must be in the same address family (IPv4 or IPv6).

• backend-ports | string

  (integrator mode) Comma-separated list of ports of the backend services. For gateway-route, exactly one port must be provided.

• backend-protocol | string

  The protocol that the backend service speaks. "http" (default) or "https".

• deny-paths | string

  Comma-separated list of URL paths that should not be routed to the service.

• external-grpc-port | int

  (integrator mode) Frontend port to expose gRPC services. If not set, gRPC will be routed through port 443 with HTTPS traffic. Do not set this if the backend is not gRPC.

• header-rewrite-expressions | string

  New line ('\n') separated list of header rewrite expressions. Each header rewrite expression will consist of the header name and the header rewrite expression separated by colon (':'). Example: "X-Forwarded-For:%[src]\nHost:maintenance.domain.com"

• health-check-fall | int

  Number of failed health checks before server is considered down.

• health-check-interval | int

  Interval between health checks in seconds.

• health-check-path | string

  The path to use for server health checks.

• health-check-port | int

  The port to use for http-check.

• health-check-rise | int

  Number of successful health checks before server is considered up.

• hostname | string

  The hostname to route to the backend service.

• http-server-close | boolean

  If set to true, the server will close the connection after each request. This can be useful for certain applications that do not support keep-alive.

• load-balancing-algorithm | string

  Default: leastconn

  Algorithm to use to load balance incoming requests. Can be leastconn, roundrobin, cookie or source

• load-balancing-consistent-hashing | boolean

  Only applies when the algorithm is "source" or "cookie". Use consistent hashing to avoid redirection when servers are added/removed.

• load-balancing-cookie | string

  Only applies with algorithm is "cookie". Cookie name to use for load balancing.

• path-rewrite-expressions | string

  New line ('\n') separated list of path rewrite expressions. Example: "%[path,regsub(^/,/new)]\n%[path,regsub(^/api,/v1)]"

• paths | string

  Comma-separated list of URL paths to route to the service.

• retry-count | int

  Number of times to retry failed requests.

• retry-redispatch | boolean

  Whether to redispatch failed requests to another server.

• tcp-backend-addresses | string

  (integrator mode, TCP) Comma-separated list of IP addresses of the TCP backend.

• tcp-backend-port | int

  (deprecated) (integrator mode, TCP) Port of the TCP backend. This config option is deprecated in favor of tcp-port-mapping.

• tcp-enable-proxy-protocol | boolean

  Whether to enable PROXY protocol when connecting to backend servers. When enabled, HAProxy will send PROXY protocol headers to the backend servers.

• tcp-enforce-tls | boolean

  Default: True

  Whether to enforce TLS for all TCP traffic. When true, all TCP connections must use TLS. Note: tcp-hostname (SNI) cannot be used when this option is disabled.

• tcp-frontend-port | int

  (deprecated) (integrator mode, TCP) Port opened on the haproxy charm. This config option is deprecated in favor of tcp-port-mapping.

• tcp-health-check-db-user | string

  Database user for health checks. Only used when tcp-health-check-type is "mysql" or "postgres".

• tcp-health-check-expect | string

  Expected response string from the health check. Only used when tcp-health-check-type is "generic".

• tcp-health-check-fall | int

  Number of failed health checks before server is considered down.

• tcp-health-check-interval | int

  Interval between health checks in seconds.

• tcp-health-check-rise | int

  Number of successful health checks before server is considered up.

• tcp-health-check-send | string

  String to send in the health check request. Only used when tcp-health-check-type is "generic".

• tcp-health-check-type | string

  Health check type. Can be "generic", "mysql", "postgres", "redis" or "smtp". Use "generic" for custom TCP checks with send/expect strings. Use "mysql" or "postgres" for database-specific checks (requires tcp-health-check-db-user).

• tcp-hostname | string

  Specify the SNI (Server Name Indication).

• tcp-load-balancing-algorithm | string

  Default: leastconn

  Algorithm to use to load balance incoming connections. Can be leastconn, roundrobin or source

• tcp-load-balancing-consistent-hashing | boolean

  Only applies when the algorithm is "source". Use consistent hashing to avoid redirection when servers are added/removed.

• tcp-port-mapping | string

  (integrator mode, TCP) Port range mapping from frontend to backend, in the format '{frontend_start}-{frontend_end}:{backend_start}-{backend_end}' (e.g. '4000-4499:20000-20499'). The frontend range is exposed on the load balancer, and backend ports are computed by adding the offset between the two ranges. Mutually exclusive with tcp-frontend-port and tcp-backend-port. Specifying a single port is also supported, e.g. '4000:20000'.

• tcp-retry-count | int

  Number of times to retry failed connections to the backend.

• tcp-retry-redispatch | boolean

  Whether to redispatch failed connections to another server.

• tcp-timeout-connect | int

  Timeout for client requests to haproxy in seconds.

• tcp-timeout-queue | int

  Timeout for requests waiting in queue in seconds.

• tcp-timeout-server | int

  Timeout for requests from haproxy to backend servers in seconds.

• tcp-tls-terminate | boolean

  Default: True

  Whether to enable TLS termination on the TCP route.

• timeout-connect | int

  Default: 60

  Timeout for client requests to haproxy in seconds.

• timeout-queue | int

  Default: 60

  Timeout for requests waiting in queue in seconds.

• timeout-server | int

  Default: 60

  Timeout for requests from haproxy to backend servers in seconds.