Platform Labeler

Adds labels to Jenkins agents based on characteristics of the operating system running the agent.

Labels commonly include operating system name, version, architecture, and Windows feature update.

On Windows computers, the plugin assigns a label based on the Windows feature update. Feature update labels use a two digit year and a two digit month representation. Common values for Windows feature update are 1809, 1903, 2009, and 2109.

On Linux computers, the plugin uses the output of the lsb_release command if the command is available.

If lsb_release is not installed, labels on Linux agents will be guessed based on values in /etc/os-release. Red Hat Linux 9 and its derivatives intentionally do not deliver lsb_release.

Red Hat Linux agents have another fallback based on /etc/redhat-release.

Agents with an older version of SuSE Linux will fallback to /etc/SuSE-release. Older versions of this plugin might return "sles" or "SUSE LINUX" as OS name. This has been unified to "SUSE" as this is the lsb_release ID since 'SLES 12 SP2'.

When /etc/os-release is used, less detailed labels may be provided because more specific version information is not included in the file. For example:

The types of labels can be configured globally and per agent with the 'Automatic Platform Labels' setting.

To reduce the set of labels defined for an agent, activate 'Automatic Platform Labels' in the Node Properties section and select the desired label types.

The platform labeler plugin supports configuration as code for global configuration and for agent configuration. Here is a global configuration example:

unclassified:
  platformLabelerGlobalConfiguration:
    labelConfig:
      architecture: true
      architectureName: false
      architectureNameVersion: false
      name: true
      nameVersion: false
      osName: true
      version: true
      windowsFeatureUpdate: false

Agent configuration uses a platform labeler node property like this:

jenkins:
  nodes:
  - permanent:
      launcher:
        inbound:
          webSocket: true
      name: "my-windows-agent"
      nodeProperties:
      - platformLabeler:
          labelConfig:
            architecture: true
            architectureName: false
            architectureNameVersion: false
            name: true
            nameVersion: false
            osName: true
            version: true
            windowsFeatureUpdate: false
      remoteFS: "C:\\Users\\Jenkins\\agent"
      retentionStrategy: "always"

Please report issues and enhancements through the Jenkins issue tracker.