The documentation module: configuration

Schema version: 1

• settings

  object
  • settings.auth

    object

    Parameters to authenticate and authorize access to the documentation web interface.

    • settings.auth.allowedUserEmails

      array of strings

      An array of emails of users that can access module’s public web interfaces.

      This parameter is used if the user-authn module is enabled or the externalAuthentication parameter is set.

    • settings.auth.allowedUserGroups

      array of strings

      An array of groups whose users can browse the documentation.

      This parameter is used if the user-authn module is enabled or the externalAuthentication parameter is set.

      Caution! Note that you must add those groups to the appropriate field in the DexProvider config if this module is used together with the user-authn one.

      Default: []

      Examples:

      allowedUserGroups:
      - admin
      - users
      

      allowedUserGroups: []
      

    • settings.auth.externalAuthentication

      object

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

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

      • settings.auth.externalAuthentication.authSignInURL

        string

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

        Default:

        Example:

        authSignInURL: https://$host/dex-authenticator/sign_in
        

      • settings.auth.externalAuthentication.authURL

        string

        The URL of the authentication service.

        If the user is authenticated, the service should return an HTTP 200 response code.

        Default:

        Example:

        authURL: https://documentation-dex-authenticator.d8-system.svc.cluster.local/dex-authenticator/auth
        

  • settings.https

    object

    What certificate type to use.

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

    Examples:

    https:
      mode: Disabled
    

    https:
      mode: OnlyInURI
    

    https:
      mode: CustomCertificate
      customCertificate:
        secretName: foobar
    

    https:
      mode: CertManager
      certManager:
        clusterIssuerName: letsencrypt
    

    • settings.https.certManager

      object

      Parameters for certmanager.

      • settings.https.certManager.clusterIssuerName

        string

        What ClusterIssuer to use for getting an SSL certificate (currently, letsencrypt, letsencrypt-staging, selfsigned are available; also, you can define your own).

        Default: letsencrypt

        Example:

        clusterIssuerName: letsencrypt
        

    • settings.https.customCertificate

      object

      Parameters for custom certificate usage.

      • settings.https.customCertificate.secretName

        string

        The name of the secret in the d8-system namespace to use with the documentation web UI.

        This secret must have the kubernetes.io/tls format.

    • settings.https.mode

      string

      The HTTPS usage mode:

      • CertManager — the web UI is accessed over HTTPS using a certificate obtained from a clusterIssuer specified in the certManager.clusterIssuerName parameter.
      • CustomCertificate — the web UI is accessed over HTTPS using a certificate from the d8-system namespace.
      • Disabled — in this mode, the documentation web UI can only be accessed over HTTP.
      • OnlyInURI — HTTP access with an external HTTPS balancer. The balancer terminates HTTPS, and all links in user-authn are generated with the HTTPS scheme. The balancer must provide redirection from HTTP to HTTPS.

      Default: CertManager

      Allowed values: Disabled, CertManager, CustomCertificate, OnlyInURI

  • settings.ingressClass

    string

    The class of the Ingress controller of the documentation web UI.

    An optional parameter; 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])?)*$

  • settings.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.

    Example:

    nodeSelector:
      disktype: ssd
    

  • settings.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.

    Example:

    tolerations:
    - key: key1
      operator: Equal
      value: value1
      effect: NoSchedule
    

    • settings.tolerations.effect

      string
    • settings.tolerations.key

      string
    • settings.tolerations.operator

      string
    • settings.tolerations.tolerationSeconds

      integer
    • settings.tolerations.value

      string