This feature is available in Enterprise Edition only.

The module is not enabled by default in any bundles.

How to explicitly enable the module…

Set the spec.enabled module parameter to true or false in the ModuleConfig/flant-integration 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: flant-integration
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 deploy/deckhouse -c deckhouse -- deckhouse-controller module enable flant-integration

Example of disabling the module:

  • by using the ModuleConfig resource:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: flant-integration
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 deploy/deckhouse -c deckhouse -- deckhouse-controller module disable flant-integration

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

  • auxiliaryCluster
    boolean

    This cluster is auxiliary.

    Default: false

  • clusterType
    string

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

    Allowed values: Cloud, Hybrid, Static

    Example:

    clusterType: Cloud
  • contacts
    integer

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

    Default: 0

  • doNotChargeForRockSolid
    boolean

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

    Default: false

  • grafanaAlertsToMadisonEnabled
    boolean

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

    Default: false

  • kubeall
    object

    Parameters for generating the kubeall registry.

    • kubeall.context
      string

      Which context to use from the specified kubeconfig.

      Default: ""

    • kubeall.host
      string

      Required value

      The hostname on which to run kubectl.

      Example:

      host: hostA
    • kubeall.kubeconfig
      string

      The path to the kubeconfig file.

      Default: "/root/.kube/config"

    • kubeall.kubectl
      string

      Kubectl command (with sudo if needed).

      Default: "sudo kubectl"

  • licenseKey
    string

    Client license key.

  • logs

    Logs parameters or false to disable logs distribution.

    • logs.url
      string

      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.url
      string

      URL for sending metrics in Prometheus remote_write format.

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

  • nodesDiscount
    integer

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

    Default: 0

  • planIsBoughtAsBundle
    boolean

    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
    kubeall:
      host: myproject.kube-master-0
      kubeconfig: /etc/kubernetes/admin.conf