Installing: configuration

Required value

Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

• cloud.prefixstring

  A prefix of the objects to be created in the cloud.

  Is used, for example, to distinguish objects created for different clusters, to configure routing, etc.

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

• cloud.providerstring

  Required value

  Cloud provider.

  Allowed values: OpenStack, AWS, GCP, Yandex, vSphere, Azure, VCD

Required value

Default: "cluster.local"

Required value

Allowed values: Cloud, Static

Default: "Containerd"

Allowed values: Docker, Containerd, NotManaged

Required value

Allowed values: ClusterConfiguration

Required value

Allowed values: 1.25, 1.26, 1.27, 1.28, 1.29, Automatic

Required value

Default: "24"

This feature is available in enterprise edition only.

• proxy.httpProxystring

  Proxy URL for HTTP requests.

  If necessary, specify the proxy server’s username, password, and port.

  This feature is available in enterprise edition only.

  Pattern: ^https?://([0-9a-zA-Z\.\-\_]+(\:[0-9a-zA-Z\.\-\_]+)?@)?[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?$

  Examples:

  httpProxy: http://proxy.company.my
  

  httpProxy: https://user:password@proxy.company.my:8443
  

• proxy.httpsProxystring

  Proxy URL for HTTPS requests.

  If necessary, specify the proxy server’s username, password, and port.

  This feature is available in enterprise edition only.

  Pattern: ^https?://([0-9a-zA-Z\.\-\_]+(\:[0-9a-zA-Z\.\-\_]+)?@)?[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?$

  Examples:

  httpsProxy: http://proxy.company.my
  

  httpsProxy: https://user:password@proxy.company.my:8443
  

• proxy.noProxyarray of strings

  List of no proxy IP and domain entries.

  For wildcard domains, use a domain name with a dot prefix, e.g., “.example.com”.

  This feature is available in enterprise edition only.

  • Element of the arraystring

    Pattern: ^[a-z0-9\-\./]+$

Required value

Required value

Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

Required value

• deckhouse.bundleDeprecatedstring

  Instead of this parameter, use the bundle parameter of the ModuleConfig ‘deckhouse’.

  The Deckhouse bundle to use in the cluster.

  Default: "Default"

  Allowed values: Minimal, Managed, Default

• deckhouse.configOverridesDeprecatedobject

  Instead of this parameter, use ModuleConfig resources to configure modules.

  Initial Deckhouse configuration.

  Specify here Deckhouse configuration parameters with which it should start after installation.

  The structure specified in the parameter will be used to create a global Deckhouse configuration (moduleConfig global) and module settings (moduleConfig <module-name>).

  Structure format

  configOverrides:
    global:
      ... global parameters section
    <moduleName>Enabled: true|false
    <moduleName>:
      ... the module parameters section
  

  Caution! The module name in camelCase is used to enable/disable the module and specify its settings (for example, userAuthn) in the configOverrides structure. After installing Deckhouse, the moduleConfig resource is used to manage the module with the module name in snake-case (for example, user-authn).

  Example:

  configOverrides:
    global:
      modules:
        publicDomainTemplate: "%s.k8s.company.my"
    linstorEnabled: true
    monitoringPingEnabled: false
    userAuthn:
      publishAPI:
        enable: true
        https:
          mode: Global
    prometheus:
      longtermRetentionDays: 5
  

• deckhouse.devBranchDeprecatedstring

  The parameter is used for development needs. Will be replaced with the CLI-tools.

• deckhouse.imagesRepostring

  Address of a container registry with Deckhouse images.

  Specify it if Deckhouse Enterprise Edition edition or third-party registry (e.g. proxy server in a closed environment) is used.

  The address matches the edition of Deckhouse used. The public container registry address for Deckhouse Enterprise Edition is registry.deckhouse.io/deckhouse/ee.

  Default: "registry.deckhouse.io/deckhouse/ce"

  Pattern: ^[0-9a-zA-Z\.\-]+(\:[0-9]{1,5})?(\/[0-9a-zA-Z\.\-\_\/]+)?$

• deckhouse.logLevelDeprecatedstring

  Instead of this parameter, use the logLevel parameter of the ModuleConfig ‘deckhouse’.

  Deckhouse logging Level.

  Default: "Info"

  Allowed values: Debug, Info, Error

• deckhouse.registryCAstring

  Root CA certificate to validate the container registry’s HTTPS certificate (if self-signed certificates are used).

• deckhouse.registryDockerCfgstring

  A Base64-encoded string from the Docker client configuration file (in Linux it is usually $HOME/.docker/config.json), for accessing a third-party container registry.

  For example, to access the container registry registry.company.my under the user user with the password P@ssw0rd it will be eyJhdXRocyI6eyJyZWdpc3RyeS5jb21wYW55Lm15Ijp7ImF1dGgiOiJkWE5sY2pwUVFITnpkekJ5WkFvPSJ9fX0K (string {"auths":{"registry.company.my":{"auth":"dXNlcjpQQHNzdzByZAo="}}} in Base64).

  Default: "eyJhdXRocyI6IHsgInJlZ2lzdHJ5LmRlY2tob3VzZS5pbyI6IHt9fX0="

• deckhouse.registrySchemestring

  Registry access scheme (HTTP or HTTPS).

  Default: "HTTPS"

  Allowed values: HTTP, HTTPS

• deckhouse.releaseChannelDeprecatedstring

  Instead of this parameter, use the releaseChannel parameter of the ModuleConfig ‘deckhouse’.

  The release channel to use in the cluster.

  Allowed values: Alpha, Beta, EarlyAccess, Stable, RockSolid

Required value

Allowed values: InitConfiguration

Required value

Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

• Element of the arraystring

  Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

  Example:

  192.168.42.0/24
  

Required value

Allowed values: StaticClusterConfiguration