Available in editions:  CE, BE, SE, SE+, EE

The module lifecycle stage: General Availability

Pay attention to the global parameter publicDomainTemplate, if you are turning the module on. If the parameter is not specified, the Ingress resources for DKP service components (dashboard, user-auth, grafana, upmeter, etc.) will not be created.

Ingress controllers are configured using the IngressNginxController Custom Resource.

The module has 13 alerts.

The module is enabled by default in the following bundles: Default, Managed. The module is disabled by default in the Minimal bundle.

How to explicitly enable the module…

Set the spec.enabled module parameter to true or false in the ModuleConfig/ingress-nginx resource (create it, if necessary) to explicitly enable or disable the module, or use the deckhouse-controller module command in the d8-system/deckhouse pod.

Example of enabling the module:

  • by using the ModuleConfig resource:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: ingress-nginx
spec:
  enabled: true

  • by using the deckhouse-controller command (you need a kubectl, configured to work with the cluster):

    kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module enable ingress-nginx

Example of disabling the module:

  • by using the ModuleConfig resource:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: ingress-nginx
spec:
  enabled: false

  • by using the deckhouse-controller command (you need a kubectl, configured to work with the cluster):

    kubectl -ti -n d8-system exec svc/deckhouse-leader -c deckhouse -- deckhouse-controller module disable ingress-nginx

Settings

The module is configured using the ModuleConfig custom resource named ingress-nginx (learn more about setting up Deckhouse…).

Example of the ModuleConfig/ingress-nginx resource for configuring the module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: ingress-nginx
spec:
  version: 1
  enabled: true
  settings: # <-- Module parameters from the "Parameters" section below.

Parameters

Schema version: 1

  • settings
    object
    • settings.defaultControllerVersion

      The version of the ingress-nginx controller that is used for all controllers by default if the controllerVersion parameter is omitted in the IngressNginxController CR.

      Default: 1.10

    • settings.highAvailability
      boolean

      Manually enable the high availability mode.

      By default, Deckhouse automatically decides whether to enable the HA mode. Click here to learn more about the HA mode for modules.

      Example:

      highAvailability: true