main.yml

---
# Group that the Swarm Client user belongs to (must be defined!)
jenkins_config_group: "jenkins"

# User that the Swarm Client service is run under (must be defined!)
jenkins_config_owner: "jenkins"

# URL to the Jenkins controller instance (must be defined!)
jenkins_controller_url: ""

# Path to Java executable. If not defined, `/usr/bin/java` is used on Unix systems and
# `java.exe` is used on Windows, with the assumption that Java will be found in the
# system's default PATH there.
jenkins_java_exe: ""

# The name assigned to this node, which is shown to the user in the Jenkins controller.
# Note that the Jenkins Swarm plugin will append a unique 8-character hexadecimal
# identifier to the end of this value.
jenkins_node_name: "{{ inventory_hostname }}"

# Jenkins plugins.yaml file to parse the Swarm Client plugin version from. Since this file
# is only needed to extract the version number, it is not copied to the host and as such,
# is expected to be in a path on the Ansible control host. This variable is mutually
# exclusive with jenkins_swarm_client_version.
jenkins_plugins_file: ""

# Description shown in the Jenkins node information page for this particular node.
jenkins_swarm_node_description: "{{ inventory_hostname }}"

# Dict of configuration arguments to use when creating the Swarm Client's YAML
# configuration file. For more details on the configuration file, see:
# https://github.com/jenkinsci/swarm-plugin/blob/master/docs/configfile.adoc
jenkins_swarm_config_args: {}

# If defined to a value >0, then serve Prometheus metrics on this port. This requires
# Swarm Client version >=3.24.
jenkins_swarm_prometheus_port: "-1"

# Version of the Jenkins Swarm Client to install. This variable is mutually exclusive with
# jenkins_plugins_file.
jenkins_swarm_client_version: ""

# Jenkins Swarm Client home directory. Should not contain spaces. (must be defined!)
jenkins_swarm_home: ""

# Password for Jenkins service user (only used on Windows).
jenkins_user_password: ""

# If true, create the user and group for jenkins_config_owner/jenkins_config_group. If
# false, then this role assumes that the user and its corresponding group already exist.
swarm_client_create_user: true

# When true, start the Swarm Client service at the end of this role. In some cases, it is
# necessary *not* to start the service right away, in case additional work must be done on
# the node before allowing it to run jobs. To start the service manually, you should do:
# - include_role:
#     name: ableton.jenkins_swarm_client
#     tasks_from: startup.yml
swarm_client_start_service: true

# Defines how the Swarm Client service should be started and managed by Windows. Must be
# one of the following strings:
# - nssm: Use NSSM to create a Windows background service (default).
# - logon_task: Use a scheduled task to start the service when a user logs in. This option
#   may be necessary if you need applications launched by Jenkins to create a GUI window.
#   Note that this option may require you to configure Windows to automatically log in the
#   `jenkins_config_owner` user.
swarm_client_windows_start_type: "nssm"