The module lifecycle stage: Generally available version

The module has requirements for installation

For the ServiceWithHealthchecks load balancers you create to work, the following conditions must be met:

  • The network policy of the custom project in which the ServiceWithHealthchecks will be created must include a rule allowing incoming traffic from all pods in the d8-service-with-healthchecks namespace:

    ingress:
- from:
  - namespaceSelector:
      matchLabels:
        kubernetes.io/metadata.name: d8-service-with-healthchecks

    For more information on network policies, see the Configuring Network Policies section.

  • The cluster role used in ClusterRoleBinding and RoleBinding when assigning permissions to users and service accounts for the ServiceWithHealthchecks resource must be extended with the following rules:

    • get
    • list
    • watch
    • create
    • update
    • patch
    • delete.

    For more details, see the section Granting permissions to users and service accounts.

Enabling the module does not automatically replace existing Service resources with ServiceWithHealthchecks resources. To replace existing services with ServiceWithHealthchecks, follow these steps:

  • Create ServiceWithHealthchecks resources with the same names and parameters as the existing Service resources you want to replace. The healthcheck section is optional: add it to enable active health probing, or omit it to publish endpoints based on pod readiness alone, like a plain Service.
  • Delete the Service resources that you want to replace with ServiceWithHealthchecks.

How to explicitly enable or disable 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 service-with-healthchecks 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 service-with-healthchecks

  • Using ModuleConfig service-with-healthchecks.

    Set spec.enabled to true or false in ModuleConfig service-with-healthchecks (create it if necessary).

    Example of a manifest to enable module service-with-healthchecks:

    apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: service-with-healthchecks
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 service-with-healthchecks module and enable the “Advanced Settings” toggle. Fill in the required fields in the “Configuration” tab or specify the module settings in YAML format on the “YAML” tab, without the top-level settings key. Save the changes.

    Example:

    Module settings interface

    You can also edit the ModuleConfig object service-with-healthchecks on the “YAML” tab in the module settings window (“System” → “System Management” → “Deckhouse” → “Modules”, open the module service-with-healthchecks) 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 service-with-healthchecks (for more details on configuring Deckhouse Platform, see the documentation) by executing the following command:

    d8 k edit mc service-with-healthchecks

    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 manifest file for ModuleConfig service-with-healthchecks 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 service-with-healthchecks:

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

How to change the module release channel…

To change the module release channel, follow the steps in How do I change the release channel for a module?.

Requirements

To the Deckhouse Platform version: 1.78 and above.

Parameters

Schema version: 1

  • settings
    object
    • settings.debug
      boolean
      If set, enables debug logging level for the controller and agent, providing more verbose log output including caller information.

      Default: false

    • settings.verboseStatus
      boolean
      If true, the agent will update the lastProbeTime field in the ServiceWithHealthchecks status on every health check (every periodSeconds). This can be useful for debugging but causes high API server load. If false, only state transitions are recorded.

      Default: false