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

chef-server-populator (17) Versions 1.0.0

Populate chef server with stuff you want

Berkshelf/Librarian
Policyfile
Knife
cookbook 'chef-server-populator', '= 1.0.0'
cookbook 'chef-server-populator', '= 1.0.0', :supermarket
knife cookbook site install chef-server-populator
knife cookbook site download chef-server-populator
README
Dependencies
Changelog
Quality

Chef Server Populator

Creates orgs, clients, and admin users and installs provided public keys. Simplifies managing and recreating Chef Server nodes. Provides backup and restore recipes for complete Chef Server recovery.

New Chef 12 Support

Chef 12 is supported in version 1.0 and above. If you need Chef 11 support, please pin your environment to version 0.4.0.

Usage

When bootstrapping with the chef-server cookbook and chef-solo:

  • Download and unpack chef-server, chef-server-ingredient, packagecloud, and chef-server-populator cookbooks
  • Upload public keys to be used by users, org-validator, and clients (optionally)
  • Create json for organization, user, and (optionally) client(s)
  • Run chef-solo

See the default[:chef_server_populator][:solo_org] and default[:chef_server_populator][:solo_org_user] attribute hashes in attributes/default.rb for the required attribute structure.

When converging with chef-client:

  • Create data bag to hold data bag items with user, org, and client information
  • Create data bag items with user, org, and client information
  • Set data bag related attributes

Applicable attributes:

  • node[:chef_server_populator][:databag] - name of the data bag

Structure of the data bag item:

User: json { "id": user_name", "full_name": "User Name", "email": "name@domain.tld", "chef_server": { "client_key": "public key contents", "type": [ "user" ], "orgs": { "organization": { "enabled": true, "admin": true } } } Note: While users can belong to multiple organizations, and the above hash structure allows you to define multiple associations, the chef-server-populator currently only supports the first organization that is defined in the data bag.

Client: json { "id": client_name", "chef_server": { "client_key": "public key contents", "type": [ client" ], "orgs": [ "organization" ] } } Note: If no organization is specified for a client, it will be added to the default organization. The client enabled and admin settings can be set at the top level of the chef_server hash or in and orgs hash as in the User example.

Org: json { "id": org_name", "full_name": "Organization Name", "chef_server": { "client_key": "public key contents", "type": [ "org" ], "enabled": true } } Restoring from a backup:

  • Set path to restore file with node[:chef_server_populator][:restore][:file]
  • The restore recipe is run if a restore file is set
  • The restore file can be remote or local

When enabling backups:

  • Include chef-server-populator::restore recipe
  • Set backup cron interval with node[:chef_server_populator][:schedule]
  • Optionally set a remote storage location with node[:chef_server_populator][:backup][:remote][:connection]
  • Backups include both a pg_dump of the entire chef database and a tarball of the bookshelf data directory

Extras

Need to use the IP address of the node for a bit, or another name instead of having node[:fqdn]?

  • node[:chef_server_populator][:servername_override]

Keep chef server configured via chef client:

  • node[:chef_server_populator][:chef_server]

If the hash is non-empty, it will write the chef-server dna.json and trigger a reconfigure when ever the attributes are updated.

Known Issues

  • As mentioned above, user and client data bag items currently only support the first organization provided. Multi-org support is forthcoming.
  • Backup and Restore for Chef 12 are not fully tested. The relevant commands have been updated, and as these are full database actions, they are expected to still work. We will be verifying these in the near future.

Examples

Take a look in the examples directory for basic bootstrap templates that will build a new erchef server, using existing keys and client, and register itself, or restore an existing chef server from a backup.

Info

Dependent cookbooks

chef-server >= 3.1.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

v1.0.0

  • Updates to support Chef 12
  • Removes support for Chef 11
  • Adds support for organization creation in solo and client contexts
  • Updates backup/restore recipes for new psql path and new table & field names. (Not fully tested)
  • Replaces many knife and psql commands with native chef-server-clt management commands

v0.4.0

  • Allow for creation of clients, users, or both
  • Store backup configuration in separate JSON file
  • Provide proper retries to account for temporary server unavailability
  • Include full server restart on restore from backup
  • Provide 'latest' backup files along with named files
  • Convert backup script from template to cookbook file
  • Make service restarts more consistent

v0.3.2

  • Add client creation retries to stabilize initial bootstrap
  • Updates to example bootstrap script
  • Add support for backup/restore (thanks @luckymike!)

v0.3.0

  • Include chef-server dependency
  • Update configuration overrides for chef-server
  • Use :endpoint attribute for custom hostname/ip

v0.2.0

  • Provide distinct solo vs. client recipes
  • Client recipe configures dna.json and uses ctl for reconfigure

Foodcritic Metric
            

1.0.0 failed this metric

FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:2
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:3
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:4
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:5
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:7
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:8
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:18
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:22
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:23
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:24
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:26
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:27
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:28
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:29
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:30
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:39
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:45
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:53
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/attributes/default.rb:55
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:18
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:23
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:27
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:33
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:35
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/backups.rb:51
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:3
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:16
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:75
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:98
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:99
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:102
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:103
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:2
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:5
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:11
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:12
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:14
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:16
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:18
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:21
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:22
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:23
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:24
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:29
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:30
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/default.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/default.rb:11
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/org.rb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/org.rb:2
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/org.rb:4
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/org.rb:5
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/org.rb:26
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/premium.rb:4
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:2
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:3
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:5
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:12
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/restore.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:3
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:4
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:12
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:16
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:28
FC002: Avoid string interpolation where not required: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/client.rb:3
FC002: Avoid string interpolation where not required: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/solo.rb:3
FC019: Access node attributes in a consistent manner: /tmp/cook/32889d84ca980551a763d664/chef-server-populator/recipes/configurator.rb:2