Available in editions:  CE, BE, SE, SE+, EE

The module lifecycle stage: General Availability

The module starts reading logs only if log-pipeline is created. Log-pipeline consists of ClusterLoggingConfig/PodLoggingConfig connected to ClusterLogDestination.

The module has 6 alerts.

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

You may explicitly enable or disable the module in one of the following ways:

  • Via Deckhouse web UI. In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the log-shipper module and enable (or disable) the “Module enabled” toggle. Save changes.

    Example:

    Module enable/disable interface

  • Via Deckhouse CLI (d8).

    Use the d8 system module enable command for enabling, or d8 system module disable command for disabling the module (you need Deckhouse CLI (d8), configured to work with the cluster).

    Example of enabling the module:

    d8 system module enable log-shipper

  • Using ModuleConfig log-shipper.

    Set spec.enabled to true or false in ModuleConfig log-shipper (create it if necessary);

    Example of a manifest to enable module log-shipper:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: log-shipper
spec:
  enabled: true

How to configure the module...

You can configure the module in one of the following ways:

  • Via Deckhouse web UI.

    In the “System” → “System Management” → “Deckhouse” → “Modules” section, open the log-shipper module and enable the “Advanced Settings” switch. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, excluding the settings section. Save the changes.

    Example:

    Module Setup Interface

    You can also edit the ModuleConfig object log-shipper on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module log-shipper) by specifying the schema version in the spec.version parameter and the necessary module parameters in the spec.settings section.

  • Via Deckhouse CLI (d8) (requires Deckhouse CLI (d8) configured to work with the cluster).

    Edit the existing ModuleConfig log-shipper (for more details on configuring Deckhouse, see the documentation) by executing the following command:

    d8 k edit mc log-shipper

    Make the necessary changes in the spec.settings section. If necessary, specify the schema version in the spec.version parameter. Save the changes.

    You can also create a file with manifest for ModuleConfig log-shipper using the example below. Fill in the spec.settings section with the required module parameters. If necessary, specify the schema version in the spec.version parameter.

    Apply the manifest using the following command (indicate the manifest file name):

    d8 k apply -f <FILENAME>

    Example of a manifest for ModuleConfig log-shipper:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: log-shipper
spec:
  version: 2
  enabled: true
  settings: # Module parameters from the "Parameters" section below.

Conversions

The module is configured using the ModuleConfig resource, the schema of which contains a version number. When you apply an old version of the ModuleConfig schema in a cluster, automatic transformations are performed. To manually update the ModuleConfig schema version, the following steps must be completed sequentially for each version :

  • Updates from version 1 to 2:

    Move .settings.resourcesRequests.static.cpu and .settings.resourcesRequests.static.memory to .settings.resourcesRequests.static.requests.

Parameters

Schema version: 2

  • settings
    object
    • settings.debug
      boolean

      Enable or disable agent debug logging. Default: false.

      Default: false

    • settings.nodeSelector
      object

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

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

    • settings.resourcesRequests
      object

      Max amounts of CPU and memory resources that the pod can request when selecting a node.

      If the vertical-pod-autoscaler module is disabled, then these values become the default ones.

      Examples:

      resourcesRequests:
  mode: VPA
  vpa:
    mode: Auto
    cpu:
      min: 50m
      max: 2
    memory:
      min: 256Mi
      max: 2Gi

      resourcesRequests:
  mode: VPA
  vpa:
    mode: Initial
    cpu:
      min: 1
      max: 3000m
    memory:
      min: 1024
      max: 4096

      resourcesRequests:
  mode: Static
  static:
    requests:
      cpu: 55m
      memory: 256Mi
    limits:
      cpu: 2
      memory: 2Gi
      • settings.resourcesRequests.mode
        string

        Required value

        Resource request management mode:

        • Static is a classic one. In it, you explicitly specify requests. The parameters of this mode are defined in the static parameter section;
        • VPA mode uses VPA. You can configure this mode by modifying parameters in the vpa parameter section.

        Default: VPA

        Allowed values: VPA, Static

      • settings.resourcesRequests.static
        object

        Resource request management options for the Static mode.

        • settings.resourcesRequests.static.limits
          object

          Configuring CPU and memory limits.

          • settings.resourcesRequests.static.limits.cpu
            string or number

            Configuring CPU limits.

            Pattern: ^[0-9]+m?$

          • settings.resourcesRequests.static.limits.memory
            string or number

            Configuring memory limits.

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$

        • settings.resourcesRequests.static.requests
          object

          Resource requests settings for pods.

          • settings.resourcesRequests.static.requests.cpu
            string or number

            Configuring CPU requests.

            Pattern: ^[0-9]+m?$

          • settings.resourcesRequests.static.requests.memory
            string or number

            Configuring memory requests.

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$

      • settings.resourcesRequests.vpa
        object

        Resource request management options for the VPA mode.

        • settings.resourcesRequests.vpa.cpu
          object

          Required value

          CPU-related parameters.

          • settings.resourcesRequests.vpa.cpu.max
            string or number

            The maximum value that the VPA can set for the CPU requests.

            Default: 500m

            Pattern: ^[0-9]+m?$

          • settings.resourcesRequests.vpa.cpu.min
            string or number

            The minimum value that the VPA can set for the CPU requests.

            Default: 50m

            Pattern: ^[0-9]+m?$

        • settings.resourcesRequests.vpa.memory
          object

          Required value

          The amount of memory requested.

          • settings.resourcesRequests.vpa.memory.max
            string or number

            The maximum memory requests the VPA can set.

            Default: 2048Mi

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$

          • settings.resourcesRequests.vpa.memory.min
            string or number

            The minimum memory requests the VPA can set.

            Default: 64Mi

            Pattern: ^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$

        • settings.resourcesRequests.vpa.mode
          string

          Required value

          The VPA usage mode.

          Default: Initial

          Allowed values: Initial, Auto

    • settings.tolerations
      array of objects

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

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

      • settings.tolerations.effect
        string
      • settings.tolerations.key
        string
      • settings.tolerations.operator
        string
      • settings.tolerations.tolerationSeconds
        integer
      • settings.tolerations.value
        string