Ansible Role Rundeck

This guide explains how to install and set up Rundeck on your machine.

GitHub	GitLab	Downloads	Version

Example Playbook

Here's an example playbook from molecule/default/converge.yml. It's tested with each update and release.

---
- name: Converge
  hosts: all
  become: true
  gather_facts: true

  roles:
    - role: robertdebock.rundeck

Before running this, ensure the machine is ready. In CI (Continuous Integration), this preparation is done using molecule/default/prepare.yml:

---
- name: Prepare
  hosts: all
  become: true
  gather_facts: false

  vars:
    _java_version:
      default: 11
      Debian-12: 17
      Ubuntu-22: 17
    java_version: "{{ _java_version[ansible_distribution ~ '-' ~ ansible_distribution_major_version] | default(_java_version['default']) }}"

  roles:
    - role: robertdebock.bootstrap
    - role: robertdebock.java
    - role: robertdebock.common

For a more detailed explanation and examples, see this link.

Role Variables

Default values for the variables are set in defaults/main.yml:

---
# default settings for Rundeck

# Version of Rundeck to install
rundeck_version: "4.17.3"
rundeck_release_date: 20231113

# Installation directory
rundeck_rdeckbase: /opt/rundeck

# Java memory settings
rundeck_xmx: 4096
rundeck_xms: 256
rundeck_maxmetaspacesize: 128

# Rundeck service settings
rundeck_port: 4440
rundeck_address: "{{ ansible_all_ipv4_addresses[0] | default('127.0.0.1') }}"

# Web context
rundeck_server_web_context: ""

rundeck_config:
  - parameter: server.address
    value: "{{ rundeck_address }}"
  - parameter: grails.serverURL
    value: "{{ rundeck_url }}"
  - parameter: dataSource.url
    value: "jdbc:h2:file:/opt/rundeck/server/data/grailsdb"
#   To connect to MySQL, use these values. Make sure the database is set up.
#   - parameter: dataSource.url
#     value: "jdbc:mysql://myserver/rundeck?autoReconnect=true&useSSL=false"
#   - parameter: dataSource.username
#     value: rundeck
#   - parameter: dataSource.password
#     value: rundeck
#   - parameter: dataSource.driverClassName
#     value: org.mariadb.jdbc.Driver

# Rundeck settings (in "{{ rundeck_rdeckbase }}/etc/framework.properties")
rundeck_framework:
  - parameter: framework.server.hostname
    value: "{{ ansible_fqdn }}"
  - parameter: framework.server.name
    value: "{{ ansible_hostname }}"
  - parameter: framework.projects.dir
    value: "{{ rundeck_rdeckbase }}/projects"
  - parameter: framework.var.dir
    value: "{{ rundeck_rdeckbase }}/var"
  - parameter: framework.logs.dir
    value: "{{ rundeck_rdeckbase }}/var/logs"
  - parameter: framework.rundeck.url
    value: "{{ rundeck_url }}"
  - parameter: framework.ssh-connect-timeout
    value: 0
  - parameter: framework.ssh-command-timeout
    value: 0
  - parameter: framework.rundeck.execution.script.tokenexpansion.enabled
    value: true

# Default users in {{ rundeck_rdeckbase }}/server/config/realm.properties
rundeck_users:
  - username: "admin"
    password: "admin"
    roles: "user,admin"
  - username: "user"
    password: "user"
    roles: "user"

# Rundeck plugins to install
rundeck_plugins: []
# - "https://github.com/Batix/rundeck-ansible-plugin/releases/download/3.1.1/ansible-plugin-3.1.1.jar"

Requirements

• Required pip packages are listed in requirements.txt.

State of Used Roles

The following roles help set up your system. You can prepare your system in other ways if needed.

Requirement	GitHub	GitLab
robertdebock.bootstrap
robertdebock.common
robertdebock.core_dependencies
robertdebock.java
robertdebock.service

Context

This role works well with other compatible roles. For more information, check out the documentation of these roles.

Here’s a visual overview of related roles:

Compatibility

This role has been tested on the following container images:

The minimum Ansible version required is 2.12. Tests have been conducted on:

• The previous version.
• The current version.
• The development version.

If you encounter problems, please report them on GitHub.

License

This project is licensed under the Apache-2.0.

Author Information

Created by robertdebock.

If you find this useful, consider sponsoring me.