Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


rundeck (56) Versions 2.0.5

Installs and configures Rundeck 2.x

cookbook 'rundeck', '= 2.0.5', :supermarket
cookbook 'rundeck', '= 2.0.5'
knife supermarket install rundeck
knife supermarket download rundeck
Quality -%

Rundeck Cookbook

Installs and configures a Rundeck 2.0 server with Chef integration via the chef-rundeck.gem. Projects in rundeck can be dynamiclly configured via data bag items using search. Linux and Windows client nodes are supported. The cookbook has optional support for Active Directory and LDAP.

Build Status



Chef version 0.10.10+ and Ohai 0.6.12+ are required.

Because of the heavy use of search, this recipe will not work with Chef Solo, as it cannot do any searches without a server.

This cookbook relies on multiple data bags. See Data Bag below.


  • Debian 6
  • Ubuntu 12.04
  • RHEL 6
  • Windows 7 Enterprise (managed node)
  • Windows 2008 R2 (managed node)
  • Mac OS X (managed node)

Notes: This cookbook has been tested on the listed platforms. It may work on other platforms with or without modification.
In RHEL / CentOS , SELinux is enabled by default, it blocks the apache mod_proxy , disable or add an exception selinux


  • Java
  • Apache2
  • Sudo
  • Runit



Linux default attributes for all rundeck managed nodes and server

  • node['rundeck']['user'] - Rundeck username (linux), default 'rundeck'
  • node['rundeck']['user_home'] - Rundeck user home directory (linux), default '/home/rundeck'

  • node['rundeck']['rundeck_databag_secure'] - Rundeck secure data bag item for all keys and passwords, default 'secure'

  • node['rundeck']['rundeck_databag'] - Rundeck configuration data bag for secure data, default 'rundeck'

  • node['rundeck']['rundeck_projects_databag'] - Rundeck project configuration data bag. Used for project creationg and chef-rundeck. default 'rundeck_projects'

  • node['rundeck']['session_timeout'] - Number of minutes a rundeck session will last, before having to login again, default '30'

  • node['rundeck']['use_ssl'] - Whether or not to use SSL for the apache vhost, default false

  • node['rundeck']['cert']['name'] - SSL certificate name. Certificate files should be named this .key and .crt, default node['rundeck']['hostname']

  • node['rundeck']['cert']['ca_name'] - SSL CA certificate name. If this and use_ssl are set, a certificate authority file is used in the apache vhost. CA certificate files should be named this .crt, default 'nil'

  • node['rundeck']['cert']['cookbook'] - The cookbook to copy the SSL certificates from, default 'rundeck'

  • node['rundeck']['webcontext'] - The URI portion of the rundeck server, default '/', you can set it to '/rundeck' if your webserver is handling other tasks besides rundeck.

  • node['rundeck']['server_url'] - The URL of the rundeck server, default 'http://#{node['rundeck']['hostname']}#{node['rundeck']['webcontext']}', or 'https://#{node['rundeck']['hostname']}#{node['rundeck']['webcontext']}' if use_ssl is set.

Windows default attributes for all rundeck managed nodes

  • node['rundeck']['windows']['user'] - Windows user to create, default 'rundeck'
  • node['rundeck']['windows']['group'] - Windows user group to add the 'rundeck' user to, default 'Administrators'
  • node['rundeck']['server_url'] - Due to a bug in some cases on rundeck if this is filled out a bad login may occur. Some instances this may need to be set to other values or even nil. This will control the serverUrl in the config.
  • node['rundeck']['log_level'] - Debug level for rundeck (ERR,WARN,INFO,VERBOSE,DEBUG)
  • node['rundeck']['rss_enabled'] - true/false for RSS support


Chef rundeck integration service attributes

  • node['rundeck']['chef_config'] - Chef-Rundeck client configuration, default '/etc/chef/rundeck.rb'

  • node['rundeck']['chef_rundeck_url'] - Chef-Rundeck URL, default 'http://chef.hostdomain:9980'

  • node['rundeck']['chef_rundeck_port'] - Chef-Rundeck binds to port, default '9980'

  • node['rundeck']['chef_rundeck_host'] - Chef-Rundeck binds to address, default ''

  • node['rundeck']['chef_rundeck_cachetime'] - Number of seconds for Chef-Rundeck to cache the answer from the Chef server, default '30'

  • node['rundeck']['chef_rundeck_partial_search'] - Chef-Rundeck enabled to use partial search (Chef 11 only), default 'false'

  • node['rundeck']['chef_webui_url'] - Chef Server Web UI URL, default ''

  • node['rundeck']['chef_url'] - Chef Server API URL, default ''

  • node['rundeck']['project_config'] - Generated project configuration from data bags, default '/etc/chef/chef-rundeck.json'

  • node['rundeck']['chef_rundeck_gem'] - Use a custom version of the chef-rundeck gem (eg. local version), default 'nil' uses the gem repo by default


Attributes that configure and manage the installation of the Rundeck server

  • node['rundeck']['configdir'] - Configuration direcotry, default '/etc/rundeck'
  • node['rundeck']['basedir'] - Rundeck installation directory, default '/var/lib/rundeck'
  • node['rundeck']['datadir'] - Rundeck project directory, default '/var/rundeck'
  • node['rundeck']['deb'] - Package file name to install, used in the building of the URL
  • node['rundeck']['url'] - URL for the deb file to download and install
  • node['rundeck']['checksum'] - Checksum for the deb
  • node['rundeck']['jaas'] - Use built in internal file, (options 'activedirectory', default 'internal')
  • node['rundeck']['default_role'] - Require users to be a memeber of this role for Rundeck access, default 'user'
  • node['rundeck']['hostname'] - VIP or server address for the service, default ''
  • node['rundeck']['port'] - Internal server port for the service, default '4440'
  • node['rundeck']['email'] - Email address, default ''
  • node['rundeck']['restart_on_config_change'] - When true, rundeck will restart on any configuration file change. (even if a job is running) default 'false'

Attributes that configure SMTP settings for email notifications

  • node['rundeck']['mail']['host'] - SMTP server hostname or IP address
  • node['rundeck']['mail']['port'] - SMTP server port (default 25)
  • node['rundeck']['mail']['username'] - SMTP User name (not required)
  • node['rundeck']['mail']['password'] - SMTP User password (not required)

If you want to use encrypted databags for your windows password and/or public/private key pairs generate a secret using:
$ openssl rand -base64 512 | tr -d '\r\n' > rundeck_secret

Distrubute to all sytems that will work with rundeck via a recipe and set the path to that file in the following attribute
* node['rundeck']['secret_file'] - default 'nil'

  • node['rundeck']['rdbms']['enable'] - enable RDBMS support, default 'false'
  • node['rundeck']['rdbms']['type'] - database type, default 'mysql'

Common RDBMS Configuration
* node['rundeck']['rdbms']['location'] - RDBMS server name
* node['rundeck']['rdbms']['dbname'] - database name, default 'rundeckdb'
* node['rundeck']['rdbms']['dbuser'] - database username, default 'rundeckdb'
* node['rundeck']['rdbms']['dbpassword'] - database password
* node['rundeck']['rdbms']['port'] - database port number, default '3306'

Oracle RDBMS Configuration
* node['rundeck']['rdbms']['dialect'] - hibernate database dialect, default 'Oracle10gDialect'

Windows Attributes
* node['rundeck']['windows']['winrm_auth_type'] - winrm authentication type (options 'basic' or 'kerberos', default: 'basic')
* node['rundeck']['windows']['winrm_cert_trust'] - winrm SSL security (options 'all', 'self-signed', 'default' (trusted certs only), default: 'all')
* node['rundeck']['windows']['winrm_hostname_trust'] - winrm hostname security (options 'all', 'strict', 'browser-compatible', default: 'all')
* node['rundeck']['windows']['winrm_protocol'] - winrm protocol to use, either 'http' or 'https'. default: 'https'

Active Directory/LDAP Attributes
* node['rundeck']['ldap']['provider'] - LDAP server to connect
* node['rundeck']['ldap']['binddn'] - LDAP root bind DN. It will be ignored if node['rundeck']['ldap']['forcebindinglogin'] is true
* node['rundeck']['ldap']['bindpwd'] - LDAP root bind password. It will be ignored if node['rundeck']['ldap']['forcebindinglogin'] is true
* node['rundeck']['ldap']['authenticationmethod'] - LDAP authentication method
* node['rundeck']['ldap']['forcebindinglogin'] - If true, bind as the user is authenticating, if not it bind using the root DN and perform a search to verify the user password
* node['rundeck']['ldap']['userbasedn'] - LDAP base user DN search
* node['rundeck']['ldap']['userrdnattribute'] - LDAP attribute name for user name
* node['rundeck']['ldap']['useridattribute'] - LDAP attribute name to identify user
* node['rundeck']['ldap']['userpasswordattribute'] - LDAP attribute name for user password
* node['rundeck']['ldap']['userobjectclass'] - LDAP object class for user
* node['rundeck']['ldap']['rolebasedn'] - LDAP base role DN search
* node['rundeck']['ldap']['rolenameattribute'] - LDAP attribute name for role name
* node['rundeck']['ldap']['rolememberattribute'] - LDAP attribute name that would contain the users DN
* node['rundeck']['ldap']['['roleusernamememberattribute'] - LDAP attribute name that would contain the users user name. If it set, node['rundeck']['ldap']['rolememberattribute'] will be not used
* node['rundeck']['ldap']['roleobjectclass'] - LDAP object class for group
* node['rundeck']['ldap']['roleprefix'] - Prefix string to remove from role names before returning to the application
* node['rundeck']['ldap']['cachedurationmillis'] - Duration in milliseconds of the cache of an authorization
* node['rundeck']['ldap']['reportstatistics'] - If true, output cache statistics to the log



Includes the rundeck::node_unix or rundeck::node_windows (depedning on platform) recipe to configure rundeck access on the node.


Configures node the for rundeck access. Creates the user specified in node['rundeck']['user'] and manages all SSH keys (see Data Bag below) in the home directory node['rundeck']['user_home']. Default for Debian / Ubuntu systems.


Configures node the for rundeck access. Creates the user specified in node['rundeck']['windows']['user'] and manage the correct group memberships (node['rundeck']['windows']['group']) and passwords (see Data Bag below). Default for Microsoft Windows sytems.


Installs the chef-rundeck sinatra application which allows integration with a Chef server. This recipe can be used on any node including the chef server itself.


Includes rundeck::default

The server recipe sets up Apache as the web front end by default.

The recipe does the following:

  1. Determine if encyrpted data bags are in use
  2. Install rundeck and dependent packages required for the server
  3. Sets up configuration directories
  4. Create SSH keys from data bag
  5. Configure winRM if needed
  6. Ensure 'rundeck' user owns the project directory
  7. Configures and enables the Rundeck web UI via Apache
  8. Starts the Rundeck server service
  9. Configure and register Rundeck projects based on the data bag entries

Data Bags


Create a rundeck data bag that will contain the secrets that will be used to log into the rundeck managed nodes. The data bag can be encyrpted via a secret, if using a encrypted data bag the secret file must be avaiable on each of the managed nodes. Example rundeck data bag item:

  "id": "secure",
  "description": "Rundeck requires credentals to execute on remote nodes",
  "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAt3iZzG ..... -----END RSA PRIVATE KEY-----",
  "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAA ......... f3OC9Jxe/VcFmtelcmQ== rundeck keys",
  "windows_password": "<plain text password>",
  "chef_rundeck_pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAx5t2uL0kAD2 ..... qTzvcb1u87qWh7rnRlHUeDQ+nI7ZBFgJK\n-----END RSA PRIVATE KEY-----"

Generate a public and private key for rundeck to manage nodes via SSH.
$ ssh-keygen -N '' -q -f /tmp/rundeck_rsa
$ cat /tmp/rundeck_rsa | awk '{ printf "%s\\n", $0 }'
W3zEq86o2+hgjwYBJQodBF8H1FOsa\nGjBkfxSrnrze8e6EYC5GV35bY+/tGsxYO/cHUvQXiMAZZIf/dGQK\n-----END RSA PRIVATE KEY-----

Copy the line returned and place in the data bag item as the private_key.

    $ cat /tmp/ | awk '{ printf "%s\\n", $0 }'
    HRM7elQHaqWY2/ rundeck@rundeckserver

Copy the line returned and place in the data bag item as the public_key.

Use knife to create a new client for Chef-Rundeck integration.
$ knife client create -a chef-rundeck -f /tmp/chef-rundeck
$ cat /tmp/chef-rundeck | awk '{ printf "%s\\n", $0 }'
-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAunxd79sbk2RLP6NRFUCf7ptPuSlhTmqPlDXJPcxjCStUoVbX\n9lcIsVH8FenscWtwReqw7ca
yCBfa+Xy7nF/HoPuULDzqIjJccHuJ\ncZC8J0MnQaZvJolodhcCYMK2B6UtRpwmn96oNKsbBBT5WU2f8dEI\n-----END RSA PRIVATE KEY-----\n

Copy the line returned and place in the data bag item as the public_key.

Set a windows password if managing windows systems, the password needs to be in plain text. (see the encryption options for the rundeck data bag)

Rundeck Users

Local Rundeck users are created via the Rundeck data bag item users. Users are added into the "users" hash as in the example below:

"chef_type": "data_bag_item",
"data_bag": "rundeck",
"id": "users",
"description": "Local rundeck users",
"users": {
"admin": {
"groups": [
"password": "secrete"
"apiuser": {
"groups": [
"password": "secrete"

Encrypted Data bag - Rundeck

When using node['rundeck']['secret_file'] you will need to create a secret file for the encryption. Make sure the 'rundeck_secret' file is available on all nodes managed by rundeck.

Generate a secret file with openssl:
$ openssl rand -base64 512 | tr -d '\r\n' > /tmp/rundeck_secret

Generate the encrypted data bag:
$ knife data bag create rundeck secure --secret-file /tmp/rundeck_secret

Rundeck Projects

Create a rundeck_projects data bag that will contain the projects and search strings for the rundeck managed nodes to include by project. Example rundeck_projects data bag item:

  "id": "dev-systems",
  "hostname": "ipaddress",
  "username": "rundeck",
  "pattern": "chef_environment:dev1 OR chef_environment:dev2",
  "description": "These instances are tied to the dev-systems project in Rundeck.",
  "chef_rundeck_url" : "Optional: URL for the chef-rundeck integration endpoint"
  • hostname - attribute in the data bag item json is used when rundeck try to connect to the node (fqdn is the default)
  • username - attribute is the user to authenticate to the node with when rundeck connects
  • pattern - attribute is a search query for nodes to include in to the project in rundeck.
  • chef_rundeck_url - optional attribute is a URL to locate the resource project, if not provided node['chef_rundeck_url'] will be used.
  • project_settings - optional attribute is a map of properties that will be added to the rundeck

Rundeck Role ACL Policy

A default role acl policy is supported out of the box. You can add new acl policy files in to the configuration directory (node['rundeck']['configdir'])

Rundeck role acl policy definitions.

License & Authors

Copyright 2014, Webtrends Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.


  • added more options for LDAP configurations
  • improved the install process for the package option
  • configurable databag names
  • add a users item to rundeck data bag to allow changing of default admin password. This may be encrypted if needed.
  • remove the tie of rundeck username and group
  • chef-client v10 treats platform? as attribute instead of method in attributes file
  • Add supplemental groups to jaas-activedirectory ( This affects default['rundeck']['default_role']
  • bump default rundeck version to 2.3.2-1
  • configurable server url attributes added
  • fixed home dir creation
  • berkshelf and cookbook test updates
  • fixed platform detection for attributes on rhel and chef 10


  • updating to rundeck 2.1.2
  • removing runit from rundeck::server recipe. default init scripts work now!
  • bug fix issue #6
  • removing runit from chef-rundeck recipe. use upstart
  • Berkshelf support added


  • added support to add custom project properties via the rundeck_project databag
  • bug fixes with email settings in
  • update rundeck 2.0.3
  • Added RHEL support (thanks scottymarshall)


  • add smtp configuration to
  • update for chef-rundeck partial searches with chef 11


  • add support for multiple chef-rundeck URL


  • update rundeck 2.0.1
  • update to chef-rundeck 1.0.2
  • added a file
  • added a CONTRIBUTING file
  • adding Travis-CI integration and foodcritic support


  • update rundeck from 1.4 to 1.6


  • Move chef-rundeck URL config into the project data bags for multiple chef-rundeck URLs


  • Add support for windows via winrm


  • Add support for sudo cookbook version 2.0+


  • Add support for relational databases mysql and oracle
  • Fixed path issues and updated to latest deb


  • Address food critic warnings


  • Parameterized the rundeck.rb template


  • Updating chef-rundeck gem.


  • Initial releas

No quality metric results found