RunDeck SCM change import automation

The current implementation of RunDeck requires a manual step to "pull" changes made on a given repo into RunDeck either as additional jobs or as job modifications.

This repo offers a solution and allows the automated import of any changes.

Process

1. Ensure that Python3 is installed on the RunDeck server as well as Python3-pip

2. Install the Python requests library through:

   sudo su rundeck
   pip3 install requests
   exit
   

3. Copy the import.py code into a new file, located at a given location on the Rundeck server that can be accessible by the rundeck user.

4. Give the script execute permissions:

   chmod o+x import.py
   

5. Modify the following line in the Test/import.yaml file:

   bash -c 'export RUNDECK_KEY="eXLnU4c3Hx5udUyWJiLX80rGKxQzmvK8" && /home/rundeck/import.py'

Change /home/rundeck/import.py to the location of the file on the server. Also change eXLnU4c3Hx5udUyWJiLX80rGKxQzmvK8 to your API token

7. Manually setup and import the repository, following this guide.

Through the import.py script running every minute, new repo changes will automatically get imported and "synced" with RunDeck.

Testing

A containerised local instance of RunDeck can be run with:

    docker run --name some-rundeck -p 4440:4440 rundeck/rundeck:4.17.1

Navigate to the container's command line through:

    docker exec -it some-rundeck /bin/bash

Follow the process steps referenced above.

To access the web console, navigate to http://localhost:4440 with the credentials:

Username: admin Password: admin