The dashboard module: configuration

Schema version: 2

• accessLevel

  string

  The level of access to the dashboard if the user-authn module is disabled and no externalAuthentication is configured. See supported values in the user-authz documentation.

  By default, User level is used.

  Use user-authz module settings to configure access if the user-authn module is enabled or externalAuthentication is configured.

  Default: "User"

  Allowed values: User, PrivilegedUser, Editor, Admin, ClusterEditor, ClusterAdmin, SuperAdmin

• auth

  object

  Options related to authentication or authorization in the application.

  • auth.allowScale

    boolean

    Activate ability to scale Deployment and StatefulSet from the web interface.

    This parameter has no effect if the externalAuthentication is enabled.

  • auth.externalAuthentication

    object

    Parameters to enable external authentication based on the NGINX Ingress external-auth mechanism that uses the Nginx auth_request module.

    Note! External authentication is enabled automatically if the user-authn module is enabled.

    • auth.externalAuthentication.authSignInURL

      string

      The URL to redirect the user for authentication (if the authentication service returned a non-200 HTTP response code).

    • auth.externalAuthentication.authURL

      string

      The URL of the authentication service. If the user is authenticated, the service should return an HTTP 200 response code.

    • auth.externalAuthentication.useBearerTokens

      boolean

      The dashboard must use the user ID to work with the Kubernetes API (the authentication service must return the Authorization HTTP header that contains the bearer-token – the dashboard will use this token to make requests to the Kubernetes API server).

      Default value is false.

      Caution! For security reasons, this mode only works if https.mode (global or for a module) is not set to Disabled;

  • auth.whitelistSourceRanges

    array of strings

    The CIDR range for which authentication to access the dashboard is allowed.

• 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
  

• https

  object

  What certificate type to use with the dashboard.

  This parameter completely overrides the global.modules.https settings.

  Examples:

  https:
    mode: CustomCertificate
    customCertificate:
      secretName: foobar
  

  https:
    mode: CertManager
    certManager:
      clusterIssuerName: letsencrypt
  

  • https.certManager

    object
    • https.certManager.clusterIssuerName

      string

      What ClusterIssuer to use for the dashboard. Currently, letsencrypt, letsencrypt-staging, selfsigned are available; also, you can define your own.

      Default: "letsencrypt"

  • https.customCertificate

    object
    • https.customCertificate.secretName

      string

      The name of the Secret in the d8-system namespace to use with the dashboard (this Secret must have the kubernetes.io/tls format).

      Default: "false"

  • https.mode

    string

    The HTTPS usage mode:

    • CertManager — the dashboard will use HTTPS and get a certificate from the ClusterIssuer defined in the certManager.clusterIssuerName parameter.
    • CustomCertificate — the dashboard will use the certificate from the d8-system namespace for HTTPS.
    • Disabled — in this mode, the dashboard works over HTTP only.
    • OnlyInURI — the dashboard will work over HTTP (thinking that there is an external HTTPS load balancer in front of it that terminates HTTPS traffic). All the links in the user-authn will be generated using the HTTPS scheme. Load balancer should provide a redirect from HTTP to HTTPS.

    Allowed values: Disabled, CertManager, CustomCertificate, OnlyInURI

• ingressClass

  string

  The class of the Ingress controller used for the dashboard.

  By default, the modules.ingressClass global value is used.

  Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

• nodeSelector

  object

  The same as in the Pods’ spec.nodeSelector parameter in Kubernetes.

  If the parameter is omitted or false, it will be determined automatically.

• tolerations

  array of objects

  The same as in the Pods’ spec.tolerations parameter in Kubernetes.

  If the parameter is omitted or false, it will be determined automatically.

  • tolerations.effect

    string
  • tolerations.key

    string
  • tolerations.operator

    string
  • tolerations.tolerationSeconds

    integer
  • tolerations.value

    string