This feature is available in Enterprise Edition only.

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 to explicitly enable or disable the module.

Example of enabling the flant-integration module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: flant-integration
spec:
  enabled: true

Example of disabling the flant-integration module:

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: flant-integration
spec:
  enabled: false

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

Example of the ModuleConfig/flant-integration resource for configuring the module:

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

Parameters

Schema version: 1

  • auxiliaryClusterboolean

    This cluster is auxiliary.

    Default: false

  • clusterTypestring

    Sets the cluster type in exported metrics, disabling automatic detection.

    Allowed values: Cloud, Hybrid, Static

    Example:

    clusterType: Cloud
  • contactsinteger

    The number of contact persons for which we need to charge.

    Default: 0

  • doNotChargeForRockSolidboolean

    Is the RockSolid release channel included in the price, or should we charge for it separately.

    Default: false

  • grafanaAlertsToMadisonEnabledboolean

    In addition to Prometheus, also send all Grafana alerts to Madison.

    Default: false

  • kubeallobject

    Parameters for generating the kubeall registry.

    • kubeall.contextstring

      Which context to use from the specified kubeconfig.

      Default: ""

    • kubeall.hoststring

      Required value

      The hostname on which to run kubectl.

      Example:

      host: hostA
    • kubeall.kubeconfigstring

      The path to the kubeconfig file.

      Default: "/root/.kube/config"

    • kubeall.kubectlstring

      Kubectl command (with sudo if needed).

      Default: "sudo kubectl"

  • licenseKeystring

    Client license key.

  • logs

    Logs parameters or false to disable logs distribution.

    • logs.urlstring

      URL for sending logs in Loki compatible storage.

      Default: "https://connect.deckhouse.io/v1/loki_push"

  • madisonAuthKey

    Key to access Madison alertmanager, or false to disable integration. Leave empty to autogenerate upon registration.

    Use kubectl to reveal generated key:

    kubectl -n d8-system exec deploy/deckhouse -- deckhouse-controller module values flant-integration -o json | jq '.flantIntegration.internal.madisonAuthKey'

    Example:

    madisonAuthKey: abc
  • metrics

    Metrics parameters or false to disable metrics distribution.

    • metrics.urlstring

      URL for sending metrics in Prometheus remote_write format.

      Default: "https://connect.deckhouse.io/v1/remote_write"

  • nodesDiscountinteger

    Discount for nodes as a percentage, without the % symbol. For example: 10, 20, 30.

    Default: 0

  • planIsBoughtAsBundleboolean

    Whether a “package” has been purchased.

    Default: false

Example of configuration

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: flant-integration
spec:
  version: 1
  enabled: true
  settings:
    licenseKey: s6f8766314a9426faa2b3
    madisonAuthKey: abc9ydhshy32plkj
    kubeall:
      host: myproject.kube-master-0
      kubeconfig: /etc/kubernetes/admin.conf