cookbook 'admin-user', '~> 1.1.2'
admin-user (3) Versions 1.1.2 Follow9
Sets up a shared admin user to manage the system
cookbook 'admin-user', '~> 1.1.2', :supermarket
knife supermarket install admin-user
knife supermarket download admin-user
Description
This cookbook is used to set up a single shared admin user on a host, and then set
up a list of SSH keys to log in to it.
NOTE This cookbook does not use search, it simply looks at the contents of a specific data bag
Compatibility
Tested on:
- Ubuntu 10.04
- Ubuntu 12.04
- CentOS 6.3
- CentOS 5.8
with Chef versions 10.18
and 11.04
.
Assumed to work with other Debian and RedHat based distros as well.
Attributes
['admin-user']['user'] = The admin user to create (defaults to "admin")
['admin-user']['group'] = The primary group for the admin user (defaults to "admin")
['admin-user']['data_bag'] = The data bag to load the SSH keys from (defaults to "users")
['admin-user']['authorized_keys'] = List of key names that will be enabled on the host (defaults to all)
Usage
With the default settings, this cookbook assumes that you have a data bag called "users",
with a data bag item called "admin" - the name of the data bag item we look for is the
same at the user defined in ['admin-user']['user']
. The data bag item should look
something like this:
{
"id" : "admin",
"authorized_keys" : {
"jack" : "ssh key for jack goes here",
"jill" : "ssh key for jill goes here"
}
}
By default, the keys listed under "authorized_keys" will all be added for the "admin" user.
Restricting keys
If you only want to allow a subset of users to have access, you can change ['admin-user']['authorized_keys']
to
an array with a list of key names. For the example above, you could set it to ["jack"]
to only copy the SSH
key for "jack", and not "jill".
Development
Please refer to the Readme here
License and Author
Author:: Adam Borocz (on GitHub)
Copyright:: 2013, HipSnip Ltd.
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
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
sudo >= 2.2.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
1.1.2 passed this metric
Contributing File Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.1.2 failed this metric
FC009: Resource attribute not recognised: admin-user/recipes/default.rb:35
FC064: Ensure issues_url is set in metadata: admin-user/metadata.rb:1
FC065: Ensure source_url is set in metadata: admin-user/metadata.rb:1
FC066: Ensure chef_version is set in metadata: admin-user/metadata.rb:1
FC069: Ensure standardized license defined in metadata: admin-user/metadata.rb:1
FC072: Metadata should not contain "attribute" keyword: admin-user/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.1.2 passed this metric
Testing File Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.2 passed this metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.1.2 failed this metric
FC009: Resource attribute not recognised: admin-user/recipes/default.rb:35
FC064: Ensure issues_url is set in metadata: admin-user/metadata.rb:1
FC065: Ensure source_url is set in metadata: admin-user/metadata.rb:1
FC066: Ensure chef_version is set in metadata: admin-user/metadata.rb:1
FC069: Ensure standardized license defined in metadata: admin-user/metadata.rb:1
FC072: Metadata should not contain "attribute" keyword: admin-user/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.1.2 passed this metric
Testing File Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.2 failed this metric
FC064: Ensure issues_url is set in metadata: admin-user/metadata.rb:1
FC065: Ensure source_url is set in metadata: admin-user/metadata.rb:1
FC066: Ensure chef_version is set in metadata: admin-user/metadata.rb:1
FC069: Ensure standardized license defined in metadata: admin-user/metadata.rb:1
FC072: Metadata should not contain "attribute" keyword: admin-user/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.1.2 passed this metric
Testing File Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.2 failed this metric
1.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number