Deploy a Chef Server, Workstation and Node on Ubuntu 14.04
Updated by Elle Krout
Chef is an automation platform that “turns infrastructure into code,” allowing users to manage and deploy resources across multiple servers, or nodes. Chef allows users to create and download recipes (stored in cookbooks) to automate content and policies on these nodes.
Chef is comprised of a Chef server, one or more workstations, and a number of nodes that are managed by the chef-client installed on each node.
This guide will show users how to create and configure a Chef server, a virtual workstation, and how to bootstrap a node to run the chef-client, all on individual Linodes.
This guide is written for a non-root user. Commands that require elevated privileges are prefixed with
sudo. If you’re not familiar with the
sudocommand, you can check our Users and Groups guide.
- One 4GB Linode to host the Chef server, running Ubuntu 14.04
- Two Linodes of any size to host a workstation and a node, each running Ubuntu 14.04
- Each Linode should be configured by following the Getting Started guide; also consider following the Securing Your Sever guide
- Each Linode needs to be configured to have a valid FQDN
Ensure that all servers are up-to-date:
sudo apt-get update && sudo apt-get upgrade
The Chef Server
The Chef server is the hub of interaction between all workstations and nodes using Chef. Changes made through workstations are uploaded to the Chef server, which is then accessed by the chef-client and used to configure each individual node.
Install the Chef Server
Download the latest Chef server core (12.0.8 at the time of writing):
Install the server:
sudo dpkg -i chef-server-core_*.deb
Remove the download file:
chef-server-ctlcommand to start the Chef server services:
sudo chef-server-ctl reconfigure
Create a User and Organization
In order to link workstations and nodes to the Chef server, an administrator and an organization need to be created with associated RSA private keys. From the home directory, create a
.chefdirectory to store the keys:
Create an administrator. Change
usernameto your desired username,
lastnameto your first and last name,
passwordto a secure password, and
username.pemto your username followed by
sudo chef-server-ctl user-create username firstname lastname email password --filename ~/.chef/username.pem
Create an organization. The
shortnamevalue should be a basic identifier for your organization with no spaces, whereas the
fullnamecan be the full, proper name of the organization. The
usernamerefers to the username made in the step above:
sudo chef-server-ctl org-create shortname fullname --association_user username --filename ~/.chef/shortname.pem
With the Chef server installed and the needed RSA keys generated, you can move on to configuring your workstation, where all major work will be performed for your Chef’s nodes.
Your Chef workstation will be where you create and configure any recipes, cookbooks, attributes, and other changes made to your Chef configurations. Although this can be a local machine of any OS, there is some benefit to keeping a remote server as your workstation since it can be accessed from anywhere.
Setting Up a Workstation
Download the latest Chef Development Kit (0.5.1 at time of writing):
sudo dpkg -i chefdk_*.deb
Remove the install file:
Verify the components of the development kit:
It should output:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
Running verification for component 'berkshelf' Running verification for component 'test-kitchen' Running verification for component 'chef-client' Running verification for component 'chef-dk' Running verification for component 'chefspec' Running verification for component 'rubocop' Running verification for component 'fauxhai' Running verification for component 'knife-spork' Running verification for component 'kitchen-vagrant' Running verification for component 'package installation' ........................ --------------------------------------------- Verification of component 'rubocop' succeeded. Verification of component 'kitchen-vagrant' succeeded. Verification of component 'fauxhai' succeeded. Verification of component 'berkshelf' succeeded. Verification of component 'knife-spork' succeeded. Verification of component 'test-kitchen' succeeded. Verification of component 'chef-dk' succeeded. Verification of component 'chef-client' succeeded. Verification of component 'chefspec' succeeded. Verification of component 'package installation' succeeded.
Generate the chef-repo and move into the newly-created directory:
chef generate repo chef-repo cd chef-repo
Add the RSA Private Keys
The RSA private keys generated when setting up the Chef server will now need to be placed on the workstation. The process behind this will vary depending on if you are using SSH key pair authentication to log into your Linodes.
If you are not using key pair authentication, then copy the file directly off of the Chef Server. replace
userwith your username on the server, and
220.127.116.11with the URL or IP of your Chef Server:
scp firstname.lastname@example.org:~/.chef/*.pem ~/chef-repo/.chef/
If you are using key pair authentication, then from your local terminal copy the .pem files from your server to your workstation using the
userwith the appropriate username, and
18.104.22.168with the URL or IP for your Chef Server and
922.214.171.124with the URL or IP for your workstation:
scp -3 email@example.com:~/.chef/*.pem firstname.lastname@example.org:~/chef-repo/.chef/
Confirm that the files have been copied successfully by listing the contents of the
.pemfiles should be listed.
Add Version Control
The workstation is used to add and edit cookbooks and other configuration files. It is beneficial to implement some form of version control. For this, Git proves to be useful.
sudo apt-get install git
Configure Git by adding your username and email, replacing the needed values:
git config --global user.name yourname git config --global user.email email@example.com
From the chef-repo, initialize the repository:
.chefdirectory to the
echo ".chef" > .gitignore
Add and commit all existing files:
git add . git commit -m "initial commit"
Make sure the directory is clean:
It should output:
nothing to commit, working directory clean
Create a knife configuration file by navigating to your
~/chef-repo/.cheffolder and opening a file named
knife.rbin your chosen text editor.
Copy the following configuration into the
1 2 3 4 5 6 7 8 9
log_level :info log_location STDOUT node_name 'username' client_key '~/chef-repo/.chef/username.pem' validation_client_name 'shortname-validator' validation_key '~/chef-repo/.chef/shortname.pem' chef_server_url 'https://126.96.36.199/organizations/shortname' syntax_check_cache_path '~/chef-repo/.chef/syntax_check_cache' cookbook_path [ '~/chef-repo/cookbooks' ]
Change the following:
- The value for
node_nameshould be the username that was created above.
client_keyto reflect your
.pemfile for your user.
validation_client_nameshould be your organization’s
validation_keypath should be set to the shortname was was defined in the steps above.
- Finally the
chef_server-urlneeds to contain the IP address or URL of your Chef server, with the
shortnamein the file path changed to the shortname defined above.
Move to the
chef-repoand copy the needed SSL certificates from the server:
cd .. knife ssl fetch
knife.rbis set up correctly by running the client list:
knife client list
This command should output the validator name.
With both the server and a workstation configured, it is possible to bootstrap your first node.
Bootstrap a Node
Bootstrapping a node installs the chef-client and validates the node, allowing it to read from the Chef server and make any needed configuration changes picked up by the chef-client in the future.
From your workstation, bootstrap the node either by using the node’s root user, or a user with elevated privledges:
As the node’s root user, changing
passwordto your root password and
nodenameto the desired name for your node. You can leave this off it you would like the name to default to your node’s hostname:
knife bootstrap 188.8.131.52 -x root -P password --node-name nodename
As a user with sudo privileges, change
usernameto the username of a user on the node,
passwordto the user’s password and
nodenameto the desired name for the node. You can leave this off it you would like the name to default to your node’s hostname:
knife bootstrap 184.108.40.206 -x username -P password --sudo --node-name nodename
Confirm that the node has been bootstrapped by listing the nodes:
knife node list
Your new node should be included on the list.
Download a Cookbook (Optional)
When using Chef you will want the chef-client to periodically run on your nodes and pull in any changes pushed to the Chef server. You will also want the
validation.pem file that is uploaded to your node upon bootstrap to be deleted for security purposes. While these things can be done manually, it is often easier and more efficient to set it up as a cookbook.
This section is optional, but provides instructions on downloading a cookbook to your workstation, pushing it to a server, and includes the skeleton of a basic cookbook to expand and experiment with.
From your workstation download the cookbook and dependencies:
knife cookbook site install cron-delvalidate
default.rbfile to examine the default cookbook recipe:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# # Cookbook Name:: cron-delvalidate # Recipe:: Chef-Client Cron & Delete Validation.pem # # cron "clientrun" do minute '0' hour '*/1' command "/usr/bin/chef-client" action :create end file "/etc/chef/validation.pem" do action :delete end
cron "clientrun" dodefines the cron action. It is set to run the chef-client action (
/usr/bin/chef-client) every hour (
*/defining that it’s every hour and not 1AM daily). The
actioncode denotes that Chef is creating a new cronjob.
file "/etc/chef/validation.pem" docalls to the
actiondefines that the file should be removed (
These are two very basic sets of code in Ruby, and provide an example of the code structure that will be used when creating Chef cookbooks. These examples can be edited and expanded as needed.
Add the recipe to your node’s run list, replacing
nodenamewith your node’s name:
knife node run_list add nodename 'recipe[cron-delvalidate::default]'
Push the cookbook to the Chef server:
knife cookbook upload cron-delvalidate
This command is also used when updating cookbooks.
Switch to your bootstrapped node(s) and run the initial chef-client command:
If running the node as a non-root user, append the above command with
The recipes in the run list will be pulled from the server and run. In this instance, it will be the
cron-delvalidaterecipe. This recipe ensures that any cookbooks made, pushed to the Chef Server, and added to the node’s run list will be pulled down to bootstrapped nodes once an hour. This automated step eliminates connecting to the node in the future to pull down changes.
You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.
This guide is published under a CC BY-ND 4.0 license.