managed_chef_server
Deploys and configures the Chef Infra Server in a relatively stateless model. The included policyfiles provide examples of deployment options and the required attributes. You will need to pass
node['chef-server']['accept_license'] = true
for Chef Server 13 and 14.
Recipes
default
Installs the Chef Infra Server in a new deployment, wrapping the Chef-Server cookbook. You will need to use the managed_organization recipe or provide your own organizations recipe to use the other recipes. If you wish to configure your Chef Infra Server to report to Automate you will need to provide the following attributes like so:
node['mcs']['data_collector']['token'] = '1234ABCD5678efjkkPmBsihvwXI='
node['mcs']['data_collector']['root_url'] = 'https://YOURAUTOMATE/data-collector/v0/'
node['mcs']['data_collector']['proxy'] = true
node['mcs']['profiles']['root_url'] = 'https://YOURAUTOMATE'
managed_organization
This creates a managed Chef organization and an org-managing admin user through the appropriate attributes.
restore
Restores the Chef Infra Server in a new deployment, including the default recipe. It looks for the existence of a knife-ec-backup tarball to restore from, configured with the node['mcs']['restore']['file'] attribute. If you are using the managed_organization recipe it will restore your /etc/chef/managed/ORG_NAME/ORG_NAME.keys from the backup.
upgrade
Upgrades the existing Chef Infra Server to a new version with the package provided. The cookbook follows the Chef Infra Server Standalone Upgrade Documentation and will stop the server for the duration of the upgrade and perform the chef-server-ctl cleanup at the end. You may provide the appropriate .RPM or .DEB package via the node['mcs']['upgrade']['package_source'] attribute.
backup
Runs knife ec backup via cron and puts the backups in the node['mcs']['backup']['dir']. The default is 2:30am daily, but you may change the cron schedule via the following attributes.
node['mcs']['backup']['cron']['minute'] = '30'
node['mcs']['backup']['cron']['hour'] = '2'
node['mcs']['backup']['cron']['day'] = '*'
node['mcs']['backup']['cron']['month'] = '*'
node['mcs']['backup']['cron']['weekday'] = '*'
cron
Schedules the Chef client to run on the Chef Infra Server via cron against a provided policyfile archive. This may be set to use --local-mode, for when the Chef client has no other Chef Infra Server to contact. See the example policyfiles/cron.rb and kitchen.yml for reference.
data_bag_loader
The node['mcs']['data_bags']['dir'] is compared against the existing data bags on the server and creates and/or updates them as necessary. If the node['mcs']['data_bags']['prune'] attribute is true then the data bags and their items are deleted if they exist on the server but do not have the requisite JSON files.
legacy_loader
Takes the node['mcs']['cookbooks']['dir'], node['mcs']['environments']['dir'] and node['mcs']['roles']['dir'] directories and loads whatever content is found into the Chef Infra Server organization. If you want to use the same directory for the roles and environments the recipe can distinguish between JSON files. The cookbooks are expected to be tarballs in a directory, they will all be attempted to load via their Berksfile or with knife. For legacy cookbooks with multiple dependencies it may take multiple runs to load everything.
policyfile_loader
Takes the node['mcs']['policyfile']['dir'] and parses any .lock.json files to determine which policyfile archives to load into the local Chef Infra Server. Policies will be assigned to the group designated by the node['mcs']['policyfile']['group'] attribute for the Chef Infra Server (_default is the default). If the policy itself sets the node['mcs']['policyfile']['group'] attribute, the policy will be assigned to that group.
Attributes
The default.rb attributes file documents available settings and tunings.
Custom Resources
Custom resources are used to reduce the complexity of the included recipes.
managed_organization
The :create action will instantiate a Chef Infra Server organization with an internal administrator user. The name properties is the organization. The organization's full_name, email, and password are all optional properties.
managed_chef_server_backup
This resource schedules backups of the Chef Infra Server via cron-style properties (minute, hour, day, month, weekday). The backups are written to the directory and their filenames start with the prefix.
managed_chef_server_cron
This resource requires an archive property specifying the policyfile archive to deploy and use for running via cron.
managed_chef_server_restore
This resource requires a tarball property specifying the knife ec backup tarball to restore from.
cookbook_loader
This resource runs berks or knife against the directory property specifying the source for the cookbook tarballs to keep in sync with the server.
data_bag_loader
This resource works off of the directory property specifying the source for the data bags to keep in sync with the server.
managed_data_bag
This has :create, :prune, :item_create, and :item_prune for managing the data bags available on the server. This custom resource is called from the data_bag_loader resource.
environments_loader
All of the Ruby or JSON environment files in the directory will be loaded onto the Chef Infra Server and updated if they change.
policyfile_loader
This resource looks for policyfile locks and archives in the directory specifying the source, only uploading them if they have been updated.
roles_loader
All of the Ruby or JSON role files in the directory will be loaded onto the Chef Infra Server and updated if they change.
Testing
There is a kitchen.yml that may be used for testing with Vagrant. The kitchen.vagrant.yml may be symlinked as kitchen.local.yml and used with local caches to speed up testing. The following Suites map to separate named run lists in the Policyfile.rb that may be repurposed as necessary, with 15* variants for testing with Chef Infra Client 15 and -12/13/14 indicating Chef Infra Server tests by version. The test directory will need to be populated with downloaded DEB and RPM installers as necessary.
Testing is primarily on CentOS 7, with -ubuntu variants added for the default, restore, upgrade, and everything tests. Some Chef 15 Infra client and Chef Infra Server 12 (deprecated) tests have been removed to reduce the number of tested combinations.
15/16default-12/13/14
Tests simple installation and creation of the managed Chef user and organization.
16backup-13/14
Checks the backup script is in the crontab and backup directories are available. Chef Infra Client 15 and Chef Infra Server 12 removed for efficiency.
16cron-13/14
Checks the chef-client is in the crontab. Chef Infra Client 15 and Chef Infra Server 12 removed for efficiency.
16data_bags-13/14
Adds loading data bags from the included test directory. It restores from a previous data bag backup to ensure pruning and updating work.
16data_collector-13/14
Tests deploying the Chef Infra Server configured to send data to an external Automate deployment.
16legacy-13/14
Adds loading cookbooks, environments and roles from the included test directory.
16policyfile-13/14
Adds loading policyfiles from the included test directory.
15/16restore-12/13/14
Restores the Chef Infra Server from a backup consisting of the everything content. kitchen verify restore ensures the policyfiles were restored properly.
15/16upgrade-12-13/13-14
Installs the Chef Infra Server, loads data bags, loads legacy content, loads policyfiles, and adds backup via cron, then upgrades the installed version of Chef Infra Server. There are upgrades from Chef Infra Server versions 12 to 13 and from 13 to 14.
15/16everything-13/14
Installs the Chef Infra Server, loads data bags, loads legacy content, loads policyfiles, adds backup via cron, and upgrades the installation.
License and Authors
- Author: Matt Ray matt@chef.io
- Copyright 2018-2021, Chef Software, Inc
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.