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

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…

Note that the configOverrides parameter of the InitConfiguration resource is used when installing Deckhouse, not ModuleConfig.

Set the logShipperEnabled: true or logShipperEnabled: false in the configOverrides parameter to explicitly enable or disable the module when installing Deckhouse.

Use the logShipper section of the configOverrides parameter to configure the module when installing Deckhouse.

Set the spec.enabled module parameter to true or false to explicitly enable or disable the module.

Example of enabling the log-shipper module:

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

Example of disabling the log-shipper module:

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

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

Example of the ModuleConfig/log-shipper resource for configuring the module:

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

Parameters

Schema version: 1

  • debugboolean

    Enable or disable agent debug logging. Default: false.

    Default: false

  • nodeSelectorobject

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

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

  • resourcesRequestsobject

    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:
    cpu: 55m
    memory: 256Ki
    • resourcesRequests.modestring

      Required value

      The mode for managing resource requests.

      Default: "VPA"

      Allowed values: VPA, Static

    • resourcesRequests.staticobject

      Static mode settings.

      • resourcesRequests.static.cpu

        Required value

        CPU requests.

        Default: 50m

      • resourcesRequests.static.memory

        Required value

        Memory requests.

        Default: 64Mi

    • resourcesRequests.vpaobject

      Parameters of the VPA mode.

      • resourcesRequests.vpa.cpuobject

        Required value

        CPU-related parameters.

        • resourcesRequests.vpa.cpu.max

          Maximum allowed CPU requests.

          Default: 500m

        • resourcesRequests.vpa.cpu.min

          Minimum allowed CPU requests.

          Default: 50m

      • resourcesRequests.vpa.memoryobject

        Required value

        The amount of memory requested.

        • resourcesRequests.vpa.memory.max

          Maximum allowed memory requests.

          Default: 2048Mi

        • resourcesRequests.vpa.memory.min

          Minimum allowed memory requests.

          Default: 64Mi

      • resourcesRequests.vpa.modestring

        Required value

        The VPA usage mode.

        Default: "Initial"

        Allowed values: Initial, Auto

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

    • tolerations.effectstring
    • tolerations.keystring
    • tolerations.operatorstring
    • tolerations.tolerationSecondsinteger
    • tolerations.valuestring