Skip to content

Configure Labels and Annotations

This section documents the configuration of labels and annotations for different DX resources.

  • Annotations

    Services and Pods

    To configure annotations for kubernetes services and pods, update your custom-values.yaml file as follows:

    Notes:

    • Additional annotations are not mandatory for a deployment.
    • Ensure you do not overwrite existing DX annotations such as the following:

      meta.helm.sh/release-name
      
      meta.helm.sh/release-namespace
      
    • Sample annotations for core service

      To set annotation KEY1 with value VALUE1 and annotation KEY2 with value VALUE2 on the core service, add the following to your custom-values.yaml file:

      annotations:
        service: 
          core: 
            - key: KEY1
              value: VALUE1
            - key: KEY2
              value: VALUE2
      
    • Sample annotations for core pods

      To set annotation KEY1 with value VALUE1 and annotation KEY2 with value VALUE2 on core pods, add the following to your custom-values.yaml file:

      annotations:
        pod: 
          core: 
            - key: KEY1
              value: VALUE1
            - key: KEY2
              value: VALUE2
      
  • Labels

    Services and Pods

    To configure labels for kubernetes services and pods, update your custom-values.yaml file as follows:

    Notes:

    • Additional labels are not mandatory for a deployment.
    • Ensure that you do not overwrite existing DX Labels such as the following:

      release
      
      helm.sh/chart
      
      app.kubernetes.io/version
      
      app.kubernetes.io/managed-by
      
      app.kubernetes.io/name
      
      app.kubernetes.io/instance
      
    • Sample labels for core services

      To set label KEY1 with value VALUE1 and label KEY2 with value VALUE2 on the core services, add the following to your custom-values.yaml file:

      label:
        service: 
          core: 
            - key: KEY1
              value: VALUE1
            - key: KEY2
              value: VALUE2
      
    • Sample labels for core pods

      To set label KEY1 with value VALUE1 and label KEY2 with value VALUE2 on core pods, add the following to your custom-values.yaml file:

      label:
        pod: 
          core: 
            - key: KEY1
              value: VALUE1
            - key: KEY2
              value: VALUE2
      

      Configure environment variables for DX resources

      This section explains the configuration of environment variables for different DX resources.

Environment variables

To configure environment variables for kubernetes pods, update your custom-values.yaml file as below.

Note

Additional environment values are not mandatory for a deployment.

Sample environment variables for core pods

To set environment variable KEY1 with value VALUE1 and environment variable KEY2 with value VALUE2 on core pods, add the following to your custom-values.yaml file:

  environment:
    pod: 
      core: 
        - name: KEY1
          value: VALUE1
        - name: KEY2
          value: VALUE2

Last update: September 12, 2022