diff --git a/Berksfile.lock b/Berksfile.lock index 6fb0206..77f5d1a 100644 --- a/Berksfile.lock +++ b/Berksfile.lock @@ -1,7 +1,7 @@ DEPENDENCIES - ssh-keys + user-ssh-keys path: . metadata: true GRAPH - ssh-keys (0.1.0) + user-ssh-keys (1.0.0) diff --git a/README.md b/README.md index 014456c..0033833 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ssh-keys-cookbook [![Build Status](https://travis-ci.org/pmsipilot/ssh-keys-cookbook.svg?branch=master)](https://travis-ci.org/pmsipilot/ssh-keys-cookbook) +# user-ssh-keys-cookbook [![Build Status](https://travis-ci.org/pmsipilot/user-ssh-keys-cookbook.svg?branch=master)](https://travis-ci.org/pmsipilot/user-ssh-keys-cookbook) Deploys SSH keys and authorized keys @@ -9,6 +9,8 @@ Deploys SSH keys and authorized keys ## Attributes +The root key of all attributes is `user_ssh_keys`. + | Key | Type | Default | Description | | :---------- |:---------- | :--------- | :---------------------------------------------------- | | `data_bag` | String | `ssh_keys` | Databag where to search for keys | @@ -25,10 +27,10 @@ Deploys SSH keys and authorized keys This cookbook provides one resource: -### `ssh_keys_key` +### `user_ssh_keys_key` ```ruby -ssh_keys_key 'john' do +user_ssh_keys_key 'john' do authorized_keys [ 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmz4D...', 'ssh-rsa sFE5JafGV4UmfxGP5/vpAAADWC8HcoQAyYT...' @@ -55,19 +57,19 @@ A keypais is described as follow: You can use this cookbook in tow ways: -* using the [default](#ssh-keys-default) recipe and providing (attributes)[#attributes] +* using the [default](#user-ssh-keys-default) recipe and providing (attributes)[#attributes] * using the [LWRP](#lwrp) Both methods require you to define a [databag](#databag) to define SSH key pairs. Defining attributes is not required if you only want to use the LWRP. -### ssh-keys::default +### user-ssh-keys::default -Include `ssh-keys` in your node's `run_list`: +Include `user-ssh-keys` in your node's `run_list`: ```json { "run_list": [ - "recipe[ssh-keys]" + "recipe[user-ssh-keys]" ] } ``` diff --git a/attributes/default.rb b/attributes/default.rb index 3ec18b4..7fab40b 100644 --- a/attributes/default.rb +++ b/attributes/default.rb @@ -1,2 +1,2 @@ -default['ssh_keys']['data_bag'] = 'ssh_keys' -default['ssh_keys']['users'] = [] +default['user_ssh_keys']['data_bag'] = 'ssh_keys' +default['user_ssh_keys']['users'] = [] diff --git a/metadata.rb b/metadata.rb index ef20ad9..d095c60 100644 --- a/metadata.rb +++ b/metadata.rb @@ -1,4 +1,4 @@ -name 'ssh-keys' +name 'user-ssh-keys' maintainer 'PMSIpilot' maintainer_email 'support@pmsipilot.com' license 'MIT' diff --git a/recipes/default.rb b/recipes/default.rb index 3a8f305..09c9e76 100644 --- a/recipes/default.rb +++ b/recipes/default.rb @@ -1,5 +1,5 @@ node['ssh_keys']['users'].each do |username, user| - ssh_keys_key username do + user_ssh_keys_key username do authorized_keys user['authorized_keys'] authorized_users user['authorized_users'] data_bag node['ssh_keys']['data_bag'] diff --git a/spec/unit/default_spec.rb b/spec/unit/default_spec.rb index 816a2f6..f9fcf43 100644 --- a/spec/unit/default_spec.rb +++ b/spec/unit/default_spec.rb @@ -1,10 +1,10 @@ require 'spec_helper' -describe 'ssh-keys::default' do +describe 'user-ssh-keys::default' do describe 'Deploys SSH keys' do describe 'With one user' do it 'Throws a ConfigurationError if user does not exist' do - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {} @@ -23,7 +23,7 @@ :keys => [] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {} @@ -46,7 +46,7 @@ :keys => [] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {} @@ -72,7 +72,7 @@ ] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {} @@ -115,7 +115,7 @@ ] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {} @@ -154,7 +154,7 @@ describe 'With multiple users' do it 'Throws a ConfigurationError if user does not exist' do - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => { @@ -182,7 +182,7 @@ :keys => [] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => { @@ -200,7 +200,7 @@ describe 'Add authorized users' do describe 'With one user' do it 'Throws a ConfigurationError if user does not exist in databag' do - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => { @@ -239,7 +239,7 @@ ] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => { @@ -283,7 +283,7 @@ ] }) - chef_run = ChefSpec::SoloRunner.new(step_into: ['ssh_keys_key']) do |node| + chef_run = ChefSpec::SoloRunner.new(step_into: ['user_ssh_keys_key']) do |node| node.set['ssh_keys'] = { :users => { :bob => {