deploy_key cookbook

This is a Chef cookbook to manage deploy_keys on SaaS VCSs. Currently, it supports Bitbucket and Github.

This work is heavily based on the ideas and code of ZippyKid's github-deploy-key cookbook.

Usage

Use this cookbook as a dependency of whatever cookbook will manage your deploy keys.

Declare a deploy_key resource and configure the provider:

deploy_key "app_deploy_key" do
  provider Chef::Provider::DeployKeyGithub
  ...
end

Supported providers:

• Chef::Provider::DeployKeyGithub
• Chef::Provider::DeployKeyBitbucket

Attributes

<table>
<tbody>
<tr>
<th>Attribute</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code>label</code></td>
<td>String</td>
<td>This will be used as both the name of the key pair files and the key label on the provider. Defaults to the <code>name</code> attribute</td>
</tr>
<tr>
<td><code>path</code></td>
<td>String</td>
<td>The directory where the private and public keys are stored</td>
</tr>
<tr>
<td><code>credentials</code></td>
<td>Hash</td>
<td>The credentials used to authenticate on the API - see <a href="#authentication">below</a></td>
</tr>
<tr>
<td><code>repo</code></td>
<td>String</td>
<td>The repository where the deploy key will be installed. Has to be in the format <code>username/repo_slug</code> (e.g.: <code>cassianoleal/cookbook-deploy_key</code>)</td>
</tr>
<tr>
<td><code>owner</code></td>
<td>String</td>
<td>The owner of the key files on disk</td>
</tr>
<tr>
<td><code>group</code></td>
<td>String</td>
<td>The group of the key files on disk</td>
</tr>
</tbody>
</table>

Actions

• :create - Runs ssh-keygen to create a key pair on the designed path;
• :delete - Deletes the key pair from the disk;
• :add - Adds the public key as a deploy key for the repository;
• :remove - Removes the key from the list of deploy keys on the repository

<a id="authentication"></a>Authentication

Authentication can be done either via username/password:

deploy_key "app_deploy_key" do
  provider Chef::Provider::DeployKeyGithub
  credentials({
    :user => 'username@org.com',
    :password => 'very_secure_password'
  })
  ...
end

or OAuth token ( Github | Bitbucket ):

deploy_key "app_deploy_key" do
  provider Chef::Provider::DeployKeyGithub
  credentials({
    :token => 'awesome_and_much_more_secure_token'
  })
  ...
end

A full example

deploy_key "bitbucket_key" do
  provider Chef::Provider::DeployKeyBitbucket
  path '/home/app_user/.ssh'  
  credentials({
    :token => 'my_bitbucket_oauth_token'
  })
  repo 'organization/million_dollar_app'
  owner 'deploy'
  group 'deploy'
  action :nothing
end

Author

Cassiano Leal (cassianoleal@gmail.com | twitter | github)