Platform Labeler

CII Best Practices

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.

Intel / AMD x64 (amd64)

Platform OS Name Version Architecture
Alma Linux 8 AlmaLinux 8.10 amd64
Alma Linux 9 AlmaLinux 9.4 amd64
Alpine 3.17 Alpine 3.17.6 amd64
Alpine 3.18 Alpine 3.18.6 amd64
Alpine 3.19 Alpine 3.19.1 amd64
Alpine 3.20 Alpine 3.20.0 amd64
Amazon Linux 2023 Amazon 2023 amd64
Debian 11 Debian 11 amd64
Debian 12 Debian 12 amd64
Debian testing Debian testing amd64
Debian unstable Debian unstable amd64
Fedora 39 Fedora 39 amd64
Fedora 40 Fedora 40 amd64
FreeBSD 13 freebsd 13.2-RELEASE amd64
FreeBSD 14 freebsd 14-RELEASE amd64
openSUSE Leap openSUSE 15.5 amd64
Oracle Linux 8 OracleServer 8.10 amd64
Oracle Linux 9 OracleServer 9.4 amd64
Red Hat Enterprise Linux 8 RedHatEnterprise 8.10 amd64
Red Hat Enterprise Linux 9 RedHatEnterprise 9.4 amd64
Rocky Linux 8 Rocky 8.10 amd64
Rocky Linux 9 Rocky 9.4 amd64
SLES 12 SUSE 12.5 amd64
SLES 15 SUSE 15 amd64
Ubuntu 20 Ubuntu 20.04 amd64
Ubuntu 22 Ubuntu 22.04 amd64
Ubuntu 24 Ubuntu 24.04 amd64
Windows 10 windows 10.0 amd64
Windows Server 2016 WindowsServer2016 10.0 amd64
Windows Server 2019 WindowsServer2019 10.0 amd64
Windows Server 2022 WindowsServer2022 10.0 amd64

ARM 64 bit (aarch64)

Platform OS Name Version Architecture
Ubuntu 24 Ubuntu 24.04 aarch64

ARM 32 bit (arm)

Platform OS Name Version Architecture
Raspberry Pi OS 11 Raspbian 11 arm
Raspberry Pi OS 12 Raspbian 12 arm

IBM System 390 (s390x)

Platform OS Name Version Architecture
Ubuntu 22 Ubuntu 22.04 s390x

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:

Platform Operating System Version Architecture
Debian testing Debian bookworm amd64
Debian unstable Debian bookworm amd64

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.

Configuration as code

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"

Report an Issue

Please report issues and enhancements through the Jenkins issue tracker.