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

RSS

users_solo (1) Versions 1.0.2

Creates users from a databag using chef-solo

Berkshelf/Librarian
Policyfile
Knife
cookbook 'users_solo', '~> 1.0.2'
cookbook 'users_solo', '~> 1.0.2', :supermarket
knife cookbook site install users_solo
knife cookbook site download users_solo
README
Dependencies
Quality 44%

Description

Creates users from a databag.

Requirements

Platform

  • Debian, Ubuntu
  • CentOS, Red Hat, Fedora
  • FreeBSD

A data bag populated with user objects must exist. The default data bag in this recipe is "users". See USAGE.

Usage

This cookbook is specific for setting up sysadmin group and users for now.

include_recipe "users_solo::admins"

Use knife to create a data bag for users.

knife data bag create users

Create a user.

knife data bag users bofh
{
  "id": "rgaiser",
  "ssh_keys": ["ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA..."],
  "groups": ["admin"],
  "uid": 2001,
  "shell": "\/bin\/bash",
  "comment": "Roberto Gaiser" 
}

Remove a user, rgaiser.

knife data bag users bofh
{
  "id": "rgaiser",
  "ssh_keys": ["ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA..."],
  "groups": ["admin"],
  "uid": 2001,
  "shell": "\/bin\/bash",
  "comment": "Roberto Gaiser",
  "action": "remove"
}

* Note only user bags with the "action : remove" and a search-able "group" attribute will be purged by the :remove action.

The default recipe makes use of the "users_manage" Lightweight Resource Provider (LWRP), and looks like this:

  users_manage "admin" do
    group_id 2600
    action [ :remove, :create ]
  end

Note this LWRP searches the "users" data bag for the "admin" group attribute, and adds those users to a Unix security group "admin". The only required attribute is group_id, which represents the numeric Unix gid and must be unique. The default action for the LWRP is ":create" only.

If you have different requirements, for example:

  • You want to search a different data bag specific to a role such as mail. You may change the data_bag searched.
    • data_bag "mail"
  • You want to search for a different group attribute named "postmaster". You may change the search_group attribute. This attribute defaults to the LWRP resource name.
    • search_group "postmaster"
  • You want to add the users to a security group other than the lightweight resource name. You may change the group_name attribute. This attribute also defaults to the LWRP resource name.
    • group_name "wheel"
  • Users can have a pre configured numeric GID set on the data bag, otherwise a group with the user login will be created.

Putting these requirements together our recipe might look like this:

  users_manage "postmaster" do
    data_bag "mail"
    group_name "wheel"
    group_id 10
  end

The latest version of knife supports reading data bags from a file and automatically looks in a directory called +data_bags+ in the current directory. The "bag" should be a directory with JSON files of each item. For the above:

mkdir data_bags/users
$EDITOR data_bags/users/bofh.json

Paste the user's public SSH key into the ssh_keys value. Also make sure the uid is unique, and if you're not using bash, that the shell is installed. The default search, and Unix group is sysadmin.

The recipe, by default, will also create the admin group.

The admin group will be created with GID 2600. This may become an attribute at a later date.

The Apache cookbook can set up authentication using OpenIDs, which is set up using the openid key here. See the Opscode 'apache2' cookbook for more information about this.

License and Author

Author:: Roberto Gaiser (rgaiser@mr2tech.com)

Copyright:: 2012, MR2 Tech

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

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

1.0.2 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

1.0.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.0.2 failed this metric

FC016: LWRP does not declare a default action: users_solo/resources/manage.rb:1
FC017: LWRP does not notify when updated: users_solo/providers/manage.rb:25
FC017: LWRP does not notify when updated: users_solo/providers/manage.rb:37
FC047: Attribute assignment does not specify precedence: users_solo/providers/manage.rb:56
FC059: LWRP provider does not declare use_inline_resources: users_solo/providers/manage.rb:1
FC064: Ensure issues_url is set in metadata: users_solo/metadata.rb:1
FC065: Ensure source_url is set in metadata: users_solo/metadata.rb:1
FC066: Ensure chef_version is set in metadata: users_solo/metadata.rb:1
FC069: Ensure standardized license defined in metadata: users_solo/metadata.rb:1
Run with Foodcritic Version 12.2.1 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

1.0.2 passed this metric

No Binaries Metric
            

1.0.2 passed this metric

Publish Metric
            

1.0.2 passed this metric

Supported Platforms Metric
            

1.0.2 passed this metric

Testing File Metric
            

1.0.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.0.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