Skip to main content

Getting Started with Terraform and Rundeck

Getting Started with Terraform and Rundeck

Terraform is an open-source infrastructure as code software tool created by HashiCorp. Users define and provide data center infrastructure using a declarative configuration language known as HashiCorp Configuration Language, or optionally JSON.

The Rundeck Terraform provideropen in new window allows Terraform to create and configure Projects, Jobs and Keys in Rundeck. The project resource allows Rundeck projects to be managed by Terraform. In Rundeck a project is the container object for a set of jobs and the configuration for which servers those jobs can be run on.


  • This Exercise is build based on the Welcome Projects. Please ensure you have completed the tutorial and have that environment running.
  • Terraform must be installedopen in new window on your local machine. Confirm with terraform -version. Latest version as of writing is 1.0.3.
  • General understanding of using your computers terminal program.


  1. Login as admin to your Welcome Project (same steps Community or Enterprise)
  2. In the upper right corner click the person icon and choose Profile User > Profile
  3. Click the plus (+) next to User API Tokens
  4. Name the token terraform
  5. User can remain admin
  6. Rest of the fields can be blank/defaults.
  7. Click Generate New Token

A box will pop up. Be sure to copy the API Token somewhere before clicking Close. The API token will be used in the next Exercise.

Copy API Token
Copy API Token
terraform {
  required_providers {
    rundeck = {
      source  = "rundeck/rundeck"
      version = "0.4.2"

provider "rundeck" {
  url         = "http://localhost:4440/"
  api_version = "38"
  auth_token  = "your-auth-token"

resource "rundeck_project" "terraform" {
  name        = "terraform"
  description = "Sample Application Created by Terraform Plan"
  ssh_key_storage_path = "${rundeck_private_key.terraform.path}"
  resource_model_source {
    type = "file"
    config = {
      format = "resourcexml"
      # This path is interpreted on the Rundeck server.
      file = "/home/rundeck/resources.xml"
      writable = "true"
      generateFileAutomatically = "true"
  extra_config = {
    "project.label" = "Terraform Example"

resource "rundeck_job" "bounceweb" {
  name              = "Bounce All Web Servers"
  project_name      = "${}"
  node_filter_query = "tags: web"
  description       = "Restart the service daemons on all the web servers"

  command {
    shell_command = "sudo service anvils restart"

resource "rundeck_public_key" "terraform" {
  path         = "terraform/"
  key_material = "ssh-rsa yada-yada-yada"

resource "rundeck_private_key" "terraform" {
  path         = "terraform/id_rsa"
  key_material = "$${file(\"\")}"

data "local_file" "acl" {
  filename = "${path.cwd}/acl.yaml"

resource "rundeck_acl_policy" "example" {
  name = "ExampleAcl.aclpolicy"

  policy = "${data.local_file.acl.content}"

More Information

Link to official Terraform Rundeck Provider Docsopen in new window