diff --git a/build_compliance_workstations.sh b/build_compliance_workstations.sh new file mode 100755 index 0000000..26d5361 --- /dev/null +++ b/build_compliance_workstations.sh @@ -0,0 +1,30 @@ +#!/bin/sh +# Builds training instances in EC2 +USAGE="Usage: $0 [number] [name] [department] [contact] [project] [termination-date]" + +AMI_ID=ami-614d7476 + +NUMHOSTS=$1 +NAME=$2 +DEPT=$3 +CONTACT=$4 +PROJECT=$5 +TERM_DATE=$6 + +INSTANCE_TYPE="t2.small" +KEY_NAME=$AWS_KEYPAIR_NAME + +if [ "$#" -ne 6 ]; then + echo $USAGE + exit 1 +fi + +for host in $(aws ec2 run-instances --image-id $AMI_ID --region us-east-1 --count $NUMHOSTS --instance-type $INSTANCE_TYPE --key-name $KEY_NAME --security-group-ids "sg-a1c3b1db" --subnet-id subnet-46b55431 | jq -r ".Instances|.[].InstanceId"); do + echo "Created instance: $host" + echo "Tagging $host with \"$NAME\"" + aws ec2 create-tags --resources $host --tags "Key=Name,Value=\"$NAME\"" + aws ec2 create-tags --resources $host --tags "Key=X-Dept,Value=\"$DEPT\"" + aws ec2 create-tags --resources $host --tags "Key=X-Contact,Value=\"$CONTACT\"" + aws ec2 create-tags --resources $host --tags "Key=X-Project,Value=\"$PROJECT\"" + aws ec2 create-tags --resources $host --tags "Key=X-Termination-Date,Value=\"$TERM_DATE\"" +done diff --git a/compliance-centos.json b/compliance-centos.json index 331c2e9..453c4d3 100644 --- a/compliance-centos.json +++ b/compliance-centos.json @@ -1,9 +1,9 @@ { "variables": { - "aws_access_key": "", - "aws_secret_key": "", - "aws_keypair_name": "training-ec2-keypair", - "aws_keypair_file": "{{env `TRAINING_AWS_KEYPAIR`}}" + "aws_access_key": "{{env `AWS_ACCESS_KEY`}}", + "aws_secret_key": "{{env `AWS_SECRET_KEY`}}", + "aws_keypair_name": "{{env `AWS_KEYPAIR_NAME`}}", + "aws_keypair_file": "{{env `AWS_PRIVATE_KEY_PATH`}}" }, "builders": [{ "type": "amazon-ebs", @@ -14,14 +14,13 @@ "ssh_private_key_file": "{{user `aws_keypair_file`}}", "region": "us-east-1", "instance_type": "m3.medium", - "source_ami": "ami-c10044a4", - "ssh_username": "root", - "ami_name": "Compliance - CentOS 6.7 - 1.0.9" + "source_ami": "ami-6d1c2007", + "ssh_username": "centos", + "ami_name": "Compliance - CentOS 7 - 1.1.1" }], "provisioners": [{ "type": "chef-solo", - "install_command": "curl -L https://www.chef.io/chef/install.sh | {{if .Sudo}}sudo{{end}} bash -s", "cookbook_paths": ["cookbooks"], "run_list": ["workstations::compliance"] diff --git a/compliance-rhel.json b/compliance-rhel.json new file mode 100644 index 0000000..d0328de --- /dev/null +++ b/compliance-rhel.json @@ -0,0 +1,28 @@ +{ + "variables": { + "aws_access_key": "{{env `AWS_ACCESS_KEY`}}", + "aws_secret_key": "{{env `AWS_SECRET_KEY`}}", + "aws_keypair_name": "{{env `AWS_KEYPAIR_NAME`}}", + "aws_keypair_file": "{{env `AWS_PRIVATE_KEY_PATH`}}" + }, + "builders": [{ + "type": "amazon-ebs", + "ssh_pty": true, + "access_key": "{{user `aws_access_key`}}", + "secret_key": "{{user `aws_secret_key`}}", + "ssh_keypair_name": "{{user `aws_keypair_name`}}", + "ssh_private_key_file": "{{user `aws_keypair_file`}}", + "region": "us-east-1", + "instance_type": "m3.medium", + "source_ami": "ami-2051294a", + "ssh_username": "ec2-user", + "ami_name": "Compliance Workshop Workstation (ChefDK 1.0.3)- RedHat 7 - 1.3.1" + }], + + "provisioners": [{ + "type": "chef-solo", + "cookbook_paths": ["cookbooks"], + "run_list": ["workstations::compliance"] + + }] +} diff --git a/cookbooks/compat_resource/CHANGELOG.md b/cookbooks/compat_resource/CHANGELOG.md new file mode 100644 index 0000000..19a097a --- /dev/null +++ b/cookbooks/compat_resource/CHANGELOG.md @@ -0,0 +1,35 @@ +# compat_resource Cookbook CHANGELOG + +This file is used to list changes made in each version of the compat_resource cookbook. + +## 12.14.7 (2016-09-26) +- Update to 12.14.89 Chef +- Fix autoload by applying fix from #106 + +## 12.14.6 (2016-09-20) + +- Update backported codebase to Chef 12.14.77 which brings in yum_repository updates and why-run enabled by default in custom resources + +## 12.14.5 (2016-09-19) + +- Prevent spamming messages in Chefspec runs for cookbooks that depend on compat_resource + +## 12.14.4 (2016-09-19) + +- Fix delayed notifications cloning + +## 12.14.3 (2016-09-12) + +- Fix subscribes notifications + +## 12.14.2 (2016-09-09) + +- Improve documentation +- keep ChefCompat::Resource defined even if we don't load + +## 12.14.1 (2016-09-07) + +- add yum_repository resource from Chef 12.14 +- Update the minimum chef version in the metadata to 12.1 +- Added maintainers files +- suppress constant redef warnings when running chefspec diff --git a/cookbooks/compat_resource/CONTRIBUTING.md b/cookbooks/compat_resource/CONTRIBUTING.md new file mode 100644 index 0000000..ef2f2b8 --- /dev/null +++ b/cookbooks/compat_resource/CONTRIBUTING.md @@ -0,0 +1,2 @@ +Please refer to +https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD diff --git a/cookbooks/compat_resource/MAINTAINERS.md b/cookbooks/compat_resource/MAINTAINERS.md new file mode 100644 index 0000000..5ae0806 --- /dev/null +++ b/cookbooks/compat_resource/MAINTAINERS.md @@ -0,0 +1,16 @@ + + +# Maintainers + +This file lists how this cookbook project is maintained. When making changes to the system, this file tells you who needs to review your patch - you need a review from an existing maintainer for the cookbook to provide a :+1: on your pull request. Additionally, you need to not receive a veto from a Lieutenant or the Project Lead. + +Check out [How Cookbooks are Maintained](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD) for details on the process and how to become a maintainer or the project lead. + +# Project Maintainer +* [Lamont Granquist](https://github.com/lamont-granquist) + +# Maintainers +* [Jennifer Davis](https://github.com/sigje) +* [Tim Smith](https://github.com/tas50) +* [Thom May](https://github.com/thommay) +* [Lamont Granquist](https://github.com/lamont-granquist) diff --git a/cookbooks/compat_resource/README.md b/cookbooks/compat_resource/README.md new file mode 100644 index 0000000..8993835 --- /dev/null +++ b/cookbooks/compat_resource/README.md @@ -0,0 +1,51 @@ +# compat_resource cookbook + +[![Build Status](https://travis-ci.org/chef-cookbooks/compat_resource.svg?branch=master)](https://travis-ci.org/chef-cookbooks/compat_resource) [![Cookbook Version](https://img.shields.io/cookbook/v/compat_resource.svg)](https://supermarket.chef.io/cookbooks/compat_resource) + +This cookbook backports functionality introduced in the latest chef-client releases to any chef-client from 12.1 onwards. This includes [Custom Resource](https://docs.chef.io/custom_resources.html) functionality, notification improvements, as well as new resources added to core chef. It allows for the usage of these new resources in cookbooks without requiring the very latest Chef client release. + +## Backported functionality + +- [Custom Resources](https://docs.chef.io/custom_resources.html) +- [apt_repository](https://docs.chef.io/resource_apt_repository.html) +- [apt_update](https://docs.chef.io/resource_apt_update.html) +- [systemd_unit](https://docs.chef.io/resource_systemd_unit.html) +- [yum_repository](https://docs.chef.io/resource_yum_repository.html) +- [:before notifications](https://docs.chef.io/resources.html#timers) + +## Requirements + +### Platforms + +- All platforms supported by Chef + +### Chef + +- Chef 12.1+ + +### Cookbooks + +- none + +## Usage + +To use this cookbook, put `depends 'compat_resource'` in the metadata.rb of your cookbook. Once this is done, you can use all the new custom resource features to define resources. It Just Works. + +## Custom Resources? + +Curious about how to use custom resources? + +- Docs: +- Slides: + +## License & Authors + +**Author:** John Keiser ([jkeiser@chef.io](mailto:jkeiser@chef.io)) + +**Copyright:** 2015-2016, 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. diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef.rb new file mode 100644 index 0000000..219b05b --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef.rb @@ -0,0 +1,29 @@ +module ChefCompat + module CopiedFromChef + def self.extend_chef_module(chef_module, target) + target.instance_eval do + include chef_module + @chef_module = chef_module + def self.method_missing(name, *args, &block) + @chef_module.send(name, *args, &block) + end + def self.const_missing(name) + @chef_module.const_get(name) + end + end + end + + # This patch to CopiedFromChef's ActionClass is necessary for the include to work + require 'chef/resource' + class Chef < ::Chef + class Resource < ::Chef::Resource + module ActionClass + def self.use_inline_resources + end + def self.include_resource_dsl(include_resource_dsl) + end + end + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/constants.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/constants.rb new file mode 100644 index 0000000..4acd742 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/constants.rb @@ -0,0 +1,47 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/constants' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: John Keiser +# Copyright:: Copyright 2015-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. + +class Chef < (defined?(::Chef) ? ::Chef : Object) + NOT_PASSED = Object.new + def NOT_PASSED.to_s + "NOT_PASSED" + end + + def NOT_PASSED.inspect + to_s + end + NOT_PASSED.freeze +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb new file mode 100644 index 0000000..4fb687e --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb @@ -0,0 +1,40 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/delayed_evaluator' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: John Keiser +# Copyright:: Copyright 2015-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class DelayedEvaluator < (defined?(::Chef::DelayedEvaluator) ? ::Chef::DelayedEvaluator : Proc) + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/core.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/core.rb new file mode 100644 index 0000000..19a054a --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/core.rb @@ -0,0 +1,73 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/dsl/core' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +#-- +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Copyright:: Copyright 2008-2016, 2009-2015 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/dsl/declare_resource" +require "chef_compat/copied_from_chef/chef/dsl/universal" +require "chef_compat/copied_from_chef/chef/mixin/notifying_block" +require "chef_compat/copied_from_chef/chef/mixin/lazy_module_include" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module DSL + CopiedFromChef.extend_chef_module(::Chef::DSL, self) if defined?(::Chef::DSL) + # Part of a family of DSL mixins. + # + # Chef::DSL::Recipe mixes into Recipes and LWRP Providers. + # - this does not target core chef resources and providers. + # - this is restricted to recipe/resource/provider context where a resource collection exists. + # - cookbook authors should typically include modules into here. + # + # Chef::DSL::Core mixes into Recipes, LWRP Providers and Core Providers + # - this adds cores providers on top of the Recipe DSL. + # - this is restricted to recipe/resource/provider context where a resource collection exists. + # - core chef authors should typically include modules into here. + # + # Chef::DSL::Universal mixes into Recipes, LWRP Resources+Providers, Core Resources+Providers, and Attributes files. + # - this adds resources and attributes files. + # - do not add helpers which manipulate the resource collection. + # - this is for general-purpose stuff that is useful nearly everywhere. + # - it also pollutes the namespace of nearly every context, watch out. + # + module Core + CopiedFromChef.extend_chef_module(::Chef::DSL::Core, self) if defined?(::Chef::DSL::Core) + include Chef::DSL::Universal + include Chef::DSL::DeclareResource + include Chef::Mixin::NotifyingBlock + extend Chef::Mixin::LazyModuleInclude + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/declare_resource.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/declare_resource.rb new file mode 100644 index 0000000..9b19232 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/declare_resource.rb @@ -0,0 +1,315 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/dsl/declare_resource' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +#-- +# Author:: Adam Jacob () +# Author:: Christopher Walters +# Copyright:: Copyright 2008-2016, 2009-2015 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module DSL + CopiedFromChef.extend_chef_module(::Chef::DSL, self) if defined?(::Chef::DSL) + module DeclareResource + CopiedFromChef.extend_chef_module(::Chef::DSL::DeclareResource, self) if defined?(::Chef::DSL::DeclareResource) + + # Helper for switching run_contexts. Allows for using :parent or :root in place of + # passing the run_context. Executes the block in the run_context. Returns the return + # value of the passed block. + # + # @param rc [Chef::RunContext,Symbol] Either :root, :parent or a Chef::RunContext + # + # @return return value of the block + # + # @example + # # creates/returns a 'service[foo]' resource in the root run_context + # resource = with_run_context(:root) + # edit_resource(:service, "foo") do + # action :nothing + # end + # end + # + def with_run_context(rc) + raise ArgumentError, "with_run_context is useless without a block" unless block_given? + old_run_context = @run_context + @run_context = + case rc + when Chef::RunContext + rc + when :root + run_context.root_run_context + when :parent + run_context.parent_run_context + else + raise ArgumentError, "bad argument to run_context helper, must be :root, :parent, or a Chef::RunContext" + end + yield + ensure + @run_context = old_run_context + end + + # Lookup a resource in the resource collection by name and delete it. This + # will raise Chef::Exceptions::ResourceNotFound if the resource is not found. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # + # @return [Chef::Resource] The resource + # + # @example + # delete_resource!(:template, '/x/y.txy') + # + def delete_resource!(type, name, run_context: self.run_context) + run_context.resource_collection.delete("#{type}[#{name}]").tap do |resource| + # Purge any pending notifications too. This will not raise an exception + # if there are no notifications. + if resource + run_context.before_notification_collection.delete(resource.declared_key) + run_context.immediate_notification_collection.delete(resource.declared_key) + run_context.delayed_notification_collection.delete(resource.declared_key) + end + end + end + + # Lookup a resource in the resource collection by name and delete it. Returns + # nil if the resource is not found and should not fail. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # + # @return [Chef::Resource] The resource + # + # @example + # delete_resource(:template, '/x/y.txy') + # + def delete_resource(type, name, run_context: self.run_context) + delete_resource!(type, name, run_context: run_context) + rescue Chef::Exceptions::ResourceNotFound + nil + end + + # Lookup a resource in the resource collection by name and edit the resource. If the resource is not + # found this will raise Chef::Exceptions::ResourceNotFound. This is the correct API to use for + # "chef_rewind" functionality. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # @param resource_attrs_block A block that lets you set attributes of the + # resource (it is instance_eval'd on the resource instance). + # + # @return [Chef::Resource] The updated resource + # + # @example + # edit_resource!(:template, '/x/y.txy') do + # cookbook_name: cookbook_name + # end + # + def edit_resource!(type, name, created_at = nil, run_context: self.run_context, &resource_attrs_block) + resource = find_resource!(type, name, run_context: run_context) + if resource_attrs_block + if defined?(new_resource) + resource.instance_exec(new_resource, &resource_attrs_block) + else + resource.instance_exec(&resource_attrs_block) + end + end + resource + end + + # Lookup a resource in the resource collection by name. If it exists, + # return it. If it does not exist, create it. This is a useful function + # for accumulator patterns. In CRUD terminology this is an "upsert" operation and is + # used to assert that the resource must exist with the specified properties. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param created_at [String] The caller of the resource. Use `caller[0]` + # to get the caller of your function. Defaults to the caller of this + # function. + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # @param resource_attrs_block A block that lets you set attributes of the + # resource (it is instance_eval'd on the resource instance). + # + # @return [Chef::Resource] The updated or created resource + # + # @example + # resource = edit_resource(:template, '/x/y.txy') do + # source "y.txy.erb" + # variables {} + # end + # resource.variables.merge!({ home: "/home/klowns" }) + # + def edit_resource(type, name, created_at = nil, run_context: self.run_context, &resource_attrs_block) + edit_resource!(type, name, created_at, run_context: run_context, &resource_attrs_block) + rescue Chef::Exceptions::ResourceNotFound + declare_resource(type, name, created_at, run_context: run_context, &resource_attrs_block) + end + + # Lookup a resource in the resource collection by name. If the resource is not + # found this will raise Chef::Exceptions::ResourceNotFound. This API is identical to the + # resources() call and while it is a synonym it is not intended to deprecate that call. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # + # @return [Chef::Resource] The updated resource + # + # @example + # resource = find_resource!(:template, '/x/y.txy') + # + def find_resource!(type, name, run_context: self.run_context) + raise ArgumentError, "find_resource! does not take a block" if block_given? + run_context.resource_collection.find(type => name) + end + + # Lookup a resource in the resource collection by name. If the resource is not found + # the will be no exception raised and the call will return nil. If a block is given and + # no resource is found it will create the resource using the block, if the resource is + # found then the block will not be applied. The block version is similar to create_if_missing + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # + # @return [Chef::Resource] The updated resource + # + # @example + # if ( find_resource(:template, '/x/y.txy') ) + # # do something + # else + # # don't worry about the error + # end + # + # @example + # # this API can be used to return a resource from an outer run context, and will only create + # # an action :nothing service if one does not already exist. + # resource = with_run_context(:root) do + # find_resource(:service, 'whatever') do + # action :nothing + # end + # end + # + def find_resource(type, name, created_at: nil, run_context: self.run_context, &resource_attrs_block) + find_resource!(type, name, run_context: run_context) + rescue Chef::Exceptions::ResourceNotFound + if resource_attrs_block + declare_resource(type, name, created_at, run_context: run_context, &resource_attrs_block) + end # returns nil otherwise + end + + # Instantiates a resource (via #build_resource), then adds it to the + # resource collection. Note that resource classes are looked up directly, + # so this will create the resource you intended even if the method name + # corresponding to that resource has been overridden. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param created_at [String] The caller of the resource. Use `caller[0]` + # to get the caller of your function. Defaults to the caller of this + # function. + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # @param resource_attrs_block A block that lets you set attributes of the + # resource (it is instance_eval'd on the resource instance). + # + # @return [Chef::Resource] The new resource. + # + # @example + # declare_resource(:file, '/x/y.txy', caller[0]) do + # action :delete + # end + # # Equivalent to + # file '/x/y.txt' do + # action :delete + # end + # + def declare_resource(type, name, created_at = nil, run_context: self.run_context, create_if_missing: false, &resource_attrs_block) + created_at ||= caller[0] + + if create_if_missing + Chef::Log.deprecation "build_resource with a create_if_missing flag is deprecated, use edit_resource instead" + # midly goofy since we call edit_resource only to re-call ourselves, but that's why its deprecated... + return edit_resource(type, name, created_at, run_context: run_context, &resource_attrs_block) + end + + resource = build_resource(type, name, created_at, &resource_attrs_block) + + run_context.resource_collection.insert(resource, resource_type: type, instance_name: name) + resource + end + + # Instantiate a resource of the given +type+ with the given +name+ and + # attributes as given in the +resource_attrs_block+. + # + # The resource is NOT added to the resource collection. + # + # @param type [Symbol] The type of resource (e.g. `:file` or `:package`) + # @param name [String] The name of the resource (e.g. '/x/y.txt' or 'apache2') + # @param created_at [String] The caller of the resource. Use `caller[0]` + # to get the caller of your function. Defaults to the caller of this + # function. + # @param run_context [Chef::RunContext] the run_context of the resource collection to operate on + # @param resource_attrs_block A block that lets you set attributes of the + # resource (it is instance_eval'd on the resource instance). + # + # @return [Chef::Resource] The new resource. + # + # @example + # build_resource(:file, '/x/y.txy', caller[0]) do + # action :delete + # end + # + def build_resource(type, name, created_at = nil, run_context: self.run_context, &resource_attrs_block) + created_at ||= caller[0] + + # this needs to be lazy in order to avoid circular dependencies since ResourceBuilder + # will requires the entire provider+resolver universe + require "chef_compat/copied_from_chef/chef/resource_builder" unless defined?(Chef::ResourceBuilder) + + Chef::ResourceBuilder.new( + type: type, + name: name, + created_at: created_at, + params: @params, + run_context: run_context, + cookbook_name: cookbook_name, + recipe_name: recipe_name, + enclosing_provider: self.is_a?(Chef::Provider) ? self : nil + ).build(&resource_attrs_block) + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/platform_introspection.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/platform_introspection.rb new file mode 100644 index 0000000..7886000 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/platform_introspection.rb @@ -0,0 +1,292 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/dsl/platform_introspection' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Adam Jacob () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module DSL + CopiedFromChef.extend_chef_module(::Chef::DSL, self) if defined?(::Chef::DSL) + + # == Chef::DSL::PlatformIntrospection + # Provides the DSL for platform-dependent switch logic, such as + # #value_for_platform. + module PlatformIntrospection + CopiedFromChef.extend_chef_module(::Chef::DSL::PlatformIntrospection, self) if defined?(::Chef::DSL::PlatformIntrospection) + + # Implementation class for determining platform dependent values + class PlatformDependentValue < (defined?(::Chef::DSL::PlatformIntrospection::PlatformDependentValue) ? ::Chef::DSL::PlatformIntrospection::PlatformDependentValue : Object) + + # Create a platform dependent value object. + # === Arguments + # platform_hash (Hash) a hash of the same structure as Chef::Platform, + # like this: + # { + # :debian => {:default => 'the value for all debian'} + # [:centos, :redhat, :fedora] => {:default => "value for all EL variants"} + # :ubuntu => { :default => "default for ubuntu", '10.04' => "value for 10.04 only"}, + # :default => "the default when nothing else matches" + # } + # * platforms can be specified as Symbols or Strings + # * multiple platforms can be grouped by using an Array as the key + # * values for platforms need to be Hashes of the form: + # {platform_version => value_for_that_version} + # * the exception to the above is the default value, which is given as + # :default => default_value + def initialize(platform_hash) +super if defined?(::Chef::DSL::PlatformIntrospection::PlatformDependentValue) + @values = {} + platform_hash.each { |platforms, value| set(platforms, value) } + end + + def value_for_node(node) + platform, version = node[:platform].to_s, node[:platform_version].to_s + # Check if we match a version constraint via Chef::VersionConstraint::Platform and Chef::Version::Platform + matched_value = match_versions(node) + if @values.key?(platform) && @values[platform].key?(version) + @values[platform][version] + elsif matched_value + matched_value + elsif @values.key?(platform) && @values[platform].key?("default") + @values[platform]["default"] + elsif @values.key?("default") + @values["default"] + else + nil + end + end + + private + + def match_versions(node) + begin + platform, version = node[:platform].to_s, node[:platform_version].to_s + return nil unless @values.key?(platform) + node_version = Chef::Version::Platform.new(version) + key_matches = [] + keys = @values[platform].keys + keys.each do |k| + begin + if Chef::VersionConstraint::Platform.new(k).include?(node_version) + key_matches << k + end + rescue Chef::Exceptions::InvalidVersionConstraint => e + Chef::Log.debug "Caught InvalidVersionConstraint. This means that a key in value_for_platform cannot be interpreted as a Chef::VersionConstraint::Platform." + Chef::Log.debug(e) + end + end + return @values[platform][version] if key_matches.include?(version) + case key_matches.length + when 0 + return nil + when 1 + return @values[platform][key_matches.first] + else + raise "Multiple matches detected for #{platform} with values #{@values}. The matches are: #{key_matches}" + end + rescue Chef::Exceptions::InvalidCookbookVersion => e + # Lets not break because someone passes a weird string like 'default' :) + Chef::Log.debug(e) + Chef::Log.debug "InvalidCookbookVersion exceptions are common and expected here: the generic constraint matcher attempted to match something which is not a constraint. Moving on to next version or constraint" + return nil + rescue Chef::Exceptions::InvalidPlatformVersion => e + Chef::Log.debug "Caught InvalidPlatformVersion, this means that Chef::Version::Platform does not know how to turn #{node_version} into an x.y.z format" + Chef::Log.debug(e) + return nil + end + end + + def set(platforms, value) + if platforms.to_s == "default" + @values["default"] = value + else + assert_valid_platform_values!(platforms, value) + Array(platforms).each { |platform| @values[platform.to_s] = normalize_keys(value) } + value + end + end + + def normalize_keys(hash) + hash.inject({}) do |h, key_value| + keys, value = *key_value + Array(keys).each do |key| + h[key.to_s] = value + end + h + end + end + + def assert_valid_platform_values!(platforms, value) + unless value.kind_of?(Hash) + msg = "platform dependent values must be specified in the format :platform => {:version => value} " + msg << "you gave a value #{value.inspect} for platform(s) #{platforms}" + raise ArgumentError, msg + end + end + end + + # Given a hash similar to the one we use for Platforms, select a value from the hash. Supports + # per platform defaults, along with a single base default. Arrays may be passed as hash keys and + # will be expanded. + # + # === Parameters + # platform_hash:: A platform-style hash. + # + # === Returns + # value:: Whatever the most specific value of the hash is. + def value_for_platform(platform_hash) + PlatformDependentValue.new(platform_hash).value_for_node(node) + end + + # Given a list of platforms, returns true if the current recipe is being run on a node with + # that platform, false otherwise. + # + # === Parameters + # args:: A list of platforms. Each platform can be in string or symbol format. + # + # === Returns + # true:: If the current platform is in the list + # false:: If the current platform is not in the list + def platform?(*args) + has_platform = false + + args.flatten.each do |platform| + has_platform = true if platform.to_s == node[:platform] + end + + has_platform + end + + # Implementation class for determining platform family dependent values + class PlatformFamilyDependentValue < (defined?(::Chef::DSL::PlatformIntrospection::PlatformFamilyDependentValue) ? ::Chef::DSL::PlatformIntrospection::PlatformFamilyDependentValue : Object) + + # Create a platform family dependent value object. + # === Arguments + # platform_family_hash (Hash) a map of platform families to values. + # like this: + # { + # :rhel => "value for all EL variants" + # :fedora => "value for fedora variants fedora and amazon" , + # [:fedora, :rhel] => "value for all known redhat variants" + # :debian => "value for debian variants including debian, ubuntu, mint" , + # :default => "the default when nothing else matches" + # } + # * platform families can be specified as Symbols or Strings + # * multiple platform families can be grouped by using an Array as the key + # * values for platform families can be any object, with no restrictions. Some examples: + # - [:stop, :start] + # - "mysql-devel" + # - { :key => "value" } + def initialize(platform_family_hash) +super if defined?(::Chef::DSL::PlatformIntrospection::PlatformFamilyDependentValue) + @values = {} + @values["default"] = nil + platform_family_hash.each { |platform_families, value| set(platform_families, value) } + end + + def value_for_node(node) + if node.key?(:platform_family) + platform_family = node[:platform_family].to_s + if @values.key?(platform_family) + @values[platform_family] + else + @values["default"] + end + else + @values["default"] + end + end + + private + + def set(platform_family, value) + if platform_family.to_s == "default" + @values["default"] = value + else + Array(platform_family).each { |family| @values[family.to_s] = value } + value + end + end + end + + # Given a hash mapping platform families to values, select a value from the hash. Supports a single + # base default if platform family is not in the map. Arrays may be passed as hash keys and will be + # expanded + # + # === Parameters + # platform_family_hash:: A hash in the form { platform_family_name => value } + # + # === Returns + # value:: Whatever the most specific value of the hash is. + def value_for_platform_family(platform_family_hash) + PlatformFamilyDependentValue.new(platform_family_hash).value_for_node(node) + end + + # Given a list of platform families, returns true if the current recipe is being run on a + # node within that platform family, false otherwise. + # + # === Parameters + # args:: A list of platform families. Each platform family can be in string or symbol format. + # + # === Returns + # true:: if the current node platform family is in the list. + # false:: if the current node platform family is not in the list. + def platform_family?(*args) + args.flatten.any? do |platform_family| + platform_family.to_s == node[:platform_family] + end + end + + # Shamelessly stolen from https://github.com/sethvargo/chef-sugar/blob/master/lib/chef/sugar/docker.rb + # Given a node object, returns whether the node is a docker container. + # + # === Parameters + # node:: [Chef::Node] The node to check. + # + # === Returns + # true:: if the current node is a docker container + # false:: if the current node is not a docker container + def docker?(node = run_context.nil? ? nil : run_context.node) + # Using "File.exist?('/.dockerinit') || File.exist?('/.dockerenv')" makes Travis sad, + # and that makes us sad too. + node && node[:virtualization] && node[:virtualization][:systems] && + node[:virtualization][:systems][:docker] && node[:virtualization][:systems][:docker] == "guest" + end + + end + end +end + +# **DEPRECATED** +# This used to be part of chef/mixin/language. Load the file to activate the deprecation code. +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/recipe.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/recipe.rb new file mode 100644 index 0000000..f896ec7 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/recipe.rb @@ -0,0 +1,37 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/dsl/recipe' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +require "chef_compat/copied_from_chef/chef/dsl/core" +require "chef_compat/copied_from_chef/chef/mixin/lazy_module_include" +class Chef < (defined?(::Chef) ? ::Chef : Object) + module DSL + CopiedFromChef.extend_chef_module(::Chef::DSL, self) if defined?(::Chef::DSL) + module Recipe + CopiedFromChef.extend_chef_module(::Chef::DSL::Recipe, self) if defined?(::Chef::DSL::Recipe) + include Chef::DSL::Core + extend Chef::Mixin::LazyModuleInclude + module FullDSL + CopiedFromChef.extend_chef_module(::Chef::DSL::Recipe::FullDSL, self) if defined?(::Chef::DSL::Recipe::FullDSL) + include Chef::DSL::Recipe + extend Chef::Mixin::LazyModuleInclude + end + end + end +end +require "chef_compat/copied_from_chef/chef/resource" +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/universal.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/universal.rb new file mode 100644 index 0000000..dfd9ce7 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/universal.rb @@ -0,0 +1,70 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/dsl/universal' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +#-- +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Copyright:: Copyright 2008-2016, 2009-2015 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/dsl/platform_introspection" +require "chef_compat/copied_from_chef/chef/mixin/powershell_out" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module DSL + CopiedFromChef.extend_chef_module(::Chef::DSL, self) if defined?(::Chef::DSL) + # Part of a family of DSL mixins. + # + # Chef::DSL::Recipe mixes into Recipes and LWRP Providers. + # - this does not target core chef resources and providers. + # - this is restricted to recipe/resource/provider context where a resource collection exists. + # - cookbook authors should typically include modules into here. + # + # Chef::DSL::Core mixes into Recipes, LWRP Providers and Core Providers + # - this adds cores providers on top of the Recipe DSL. + # - this is restricted to recipe/resource/provider context where a resource collection exists. + # - core chef authors should typically include modules into here. + # + # Chef::DSL::Universal mixes into Recipes, LWRP Resources+Providers, Core Resources+Providers, and Attributes files. + # - this adds resources and attributes files. + # - do not add helpers which manipulate the resource collection. + # - this is for general-purpose stuff that is useful nearly everywhere. + # - it also pollutes the namespace of nearly every context, watch out. + # + module Universal + CopiedFromChef.extend_chef_module(::Chef::DSL::Universal, self) if defined?(::Chef::DSL::Universal) + include Chef::DSL::PlatformIntrospection + include Chef::Mixin::PowershellOut + include Chef::Mixin::ShellOut + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/lazy_module_include.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/lazy_module_include.rb new file mode 100644 index 0000000..a6b5244 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/lazy_module_include.rb @@ -0,0 +1,98 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/mixin/lazy_module_include' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Copyright:: Copyright 2011-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module Mixin + CopiedFromChef.extend_chef_module(::Chef::Mixin, self) if defined?(::Chef::Mixin) + # If you have: + # + # module A + # extend LazyModuleInclude + # end + # + # module B + # include A + # end + # + # module C + # include B + # end + # + # module Monkeypatches + # def monkey + # puts "monkey!" + # end + # end + # + # A.send(:include, Monkeypatches) + # + # Then B and C and any classes that they're included in will also get the #monkey method patched into them. + # + module LazyModuleInclude + CopiedFromChef.extend_chef_module(::Chef::Mixin::LazyModuleInclude, self) if defined?(::Chef::Mixin::LazyModuleInclude) + + # Most of the magick is in this hook which creates a closure over the parent class and then builds an + # "infector" module which infects all descendants and which is responsible for updating the list of + # descendants in the parent class. + def included(klass) + super + parent_klass = self + infector = Module.new do + define_method(:included) do |subklass| + super(subklass) + subklass.extend(infector) + parent_klass.descendants.push(subklass) + end + end + klass.extend(infector) + parent_klass.descendants.push(klass) + end + + def descendants + @descendants ||= [] + end + + def include(*classes) + super + classes.each do |klass| + descendants.each do |descendant| + descendant.send(:include, klass) + end + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/notifying_block.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/notifying_block.rb new file mode 100644 index 0000000..0b90e27 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/notifying_block.rb @@ -0,0 +1,74 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/mixin/notifying_block' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +#-- +# Author:: Lamont Granquist +# Copyright:: Copyright 2010-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module Mixin + CopiedFromChef.extend_chef_module(::Chef::Mixin, self) if defined?(::Chef::Mixin) + module NotifyingBlock + CopiedFromChef.extend_chef_module(::Chef::Mixin::NotifyingBlock, self) if defined?(::Chef::Mixin::NotifyingBlock) + + def notifying_block(&block) + begin + subcontext = subcontext_block(&block) + Chef::Runner.new(subcontext).converge + ensure + # recipes don't have a new_resource + if respond_to?(:new_resource) + if subcontext && subcontext.resource_collection.any?(&:updated?) + new_resource.updated_by_last_action(true) + end + end + end + end + + def subcontext_block(parent_context = nil, &block) + parent_context ||= @run_context + sub_run_context = parent_context.create_child + + begin + outer_run_context = @run_context + @run_context = sub_run_context + instance_eval(&block) + ensure + @run_context = outer_run_context + end + + sub_run_context + end + + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/params_validate.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/params_validate.rb new file mode 100644 index 0000000..0a16147 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/params_validate.rb @@ -0,0 +1,510 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/mixin/params_validate' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Adam Jacob () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. + +require "chef_compat/copied_from_chef/chef/constants" +require "chef_compat/copied_from_chef/chef/property" +require "chef_compat/copied_from_chef/chef/delayed_evaluator" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module Mixin + CopiedFromChef.extend_chef_module(::Chef::Mixin, self) if defined?(::Chef::Mixin) + module ParamsValidate + CopiedFromChef.extend_chef_module(::Chef::Mixin::ParamsValidate, self) if defined?(::Chef::Mixin::ParamsValidate) + # Takes a hash of options, along with a map to validate them. Returns the original + # options hash, plus any changes that might have been made (through things like setting + # default values in the validation map) + # + # For example: + # + # validate({ :one => "neat" }, { :one => { :kind_of => String }}) + # + # Would raise an exception if the value of :one above is not a kind_of? string. Valid + # map options are: + # + # @param opts [Hash] Validation opts. + # @option opts [Object,Array] :is An object, or list of + # objects, that must match the value using Ruby's `===` operator + # (`opts[:is].any? { |v| v === value }`). (See #_pv_is.) + # @option opts [Object,Array] :equal_to An object, or list + # of objects, that must be equal to the value using Ruby's `==` + # operator (`opts[:is].any? { |v| v == value }`) (See #_pv_equal_to.) + # @option opts [Regexp,Array] :regex An object, or + # list of objects, that must match the value with `regex.match(value)`. + # (See #_pv_regex) + # @option opts [Class,Array] :kind_of A class, or + # list of classes, that the value must be an instance of. (See + # #_pv_kind_of.) + # @option opts [Hash] :callbacks A hash of + # messages -> procs, all of which match the value. The proc must + # return a truthy or falsey value (true means it matches). (See + # #_pv_callbacks.) + # @option opts [Symbol,Array] :respond_to A method + # name, or list of method names, the value must respond to. (See + # #_pv_respond_to.) + # @option opts [Symbol,Array] :cannot_be A property, + # or a list of properties, that the value cannot have (such as `:nil` or + # `:empty`). The method with a questionmark at the end is called on the + # value (e.g. `value.empty?`). If the value does not have this method, + # it is considered valid (i.e. if you don't respond to `empty?` we + # assume you are not empty). (See #_pv_cannot_be.) + # @option opts [Proc] :coerce A proc which will be called to + # transform the user input to canonical form. The value is passed in, + # and the transformed value returned as output. Lazy values will *not* + # be passed to this method until after they are evaluated. Called in the + # context of the resource (meaning you can access other properties). + # (See #_pv_coerce.) (See #_pv_coerce.) + # @option opts [Boolean] :required `true` if this property + # must be present and not `nil`; `false` otherwise. This is checked + # after the resource is fully initialized. (See #_pv_required.) + # @option opts [Boolean] :name_property `true` if this + # property defaults to the same value as `name`. Equivalent to + # `default: lazy { name }`, except that #property_is_set? will + # return `true` if the property is set *or* if `name` is set. (See + # #_pv_name_property.) + # @option opts [Boolean] :name_attribute Same as `name_property`. + # @option opts [Object] :default The value this property + # will return if the user does not set one. If this is `lazy`, it will + # be run in the context of the instance (and able to access other + # properties). (See #_pv_default.) + # + def validate(opts, map) + map = map.validation_options if map.is_a?(Property) + + #-- + # validate works by taking the keys in the validation map, assuming it's a hash, and + # looking for _pv_:symbol as methods. Assuming it find them, it calls the right + # one. + #++ + raise ArgumentError, "Options must be a hash" unless opts.kind_of?(Hash) + raise ArgumentError, "Validation Map must be a hash" unless map.kind_of?(Hash) + + map.each do |key, validation| + unless key.kind_of?(Symbol) || key.kind_of?(String) + raise ArgumentError, "Validation map keys must be symbols or strings!" + end + case validation + when true + _pv_required(opts, key) + when false + true + when Hash + validation.each do |check, carg| + check_method = "_pv_#{check}" + if self.respond_to?(check_method, true) + self.send(check_method, opts, key, carg) + else + raise ArgumentError, "Validation map has unknown check: #{check}" + end + end + end + end + opts + end + + def lazy(&block) + DelayedEvaluator.new(&block) + end + + def set_or_return(symbol, value, validation) + property = SetOrReturnProperty.new(name: symbol, **validation) + property.call(self, value) + end + + private + + def explicitly_allows_nil?(key, validation) + validation.has_key?(:is) && _pv_is({ key => nil }, key, validation[:is], raise_error: false) + end + + # Return the value of a parameter, or nil if it doesn't exist. + def _pv_opts_lookup(opts, key) + if opts.has_key?(key.to_s) + opts[key.to_s] + elsif opts.has_key?(key.to_sym) + opts[key.to_sym] + else + nil + end + end + + # Raise an exception if the parameter is not found. + def _pv_required(opts, key, is_required = true, explicitly_allows_nil = false) + if is_required + return true if opts.has_key?(key.to_s) && (explicitly_allows_nil || !opts[key.to_s].nil?) + return true if opts.has_key?(key.to_sym) && (explicitly_allows_nil || !opts[key.to_sym].nil?) + raise Exceptions::ValidationFailed, "Required argument #{key.inspect} is missing!" + end + true + end + + # + # List of things values must be equal to. + # + # Uses Ruby's `==` to evaluate (equal_to == value). At least one must + # match for the value to be valid. + # + # `nil` passes this validation automatically. + # + # @return [Array,nil] List of things values must be equal to, or nil if + # equal_to is unspecified. + # + def _pv_equal_to(opts, key, to_be) + value = _pv_opts_lookup(opts, key) + unless value.nil? + to_be = Array(to_be) + to_be.each do |tb| + return true if value == tb + end + raise Exceptions::ValidationFailed, "Option #{key} must be equal to one of: #{to_be.join(", ")}! You passed #{value.inspect}." + end + end + + # + # List of things values must be instances of. + # + # Uses value.kind_of?(kind_of) to evaluate. At least one must match for + # the value to be valid. + # + # `nil` automatically passes this validation. + # + def _pv_kind_of(opts, key, to_be) + value = _pv_opts_lookup(opts, key) + unless value.nil? + to_be = Array(to_be) + to_be.each do |tb| + return true if value.kind_of?(tb) + end + raise Exceptions::ValidationFailed, "Option #{key} must be a kind of #{to_be}! You passed #{value.inspect}." + end + end + + # + # List of method names values must respond to. + # + # Uses value.respond_to?(respond_to) to evaluate. At least one must match + # for the value to be valid. + # + def _pv_respond_to(opts, key, method_name_list) + value = _pv_opts_lookup(opts, key) + unless value.nil? + Array(method_name_list).each do |method_name| + unless value.respond_to?(method_name) + raise Exceptions::ValidationFailed, "Option #{key} must have a #{method_name} method!" + end + end + end + end + + # + # List of things that must not be true about the value. + # + # Calls `value.?` All responses must be false for the value to be + # valid. + # Values which do not respond to ? are considered valid (because if + # a value doesn't respond to `:readable?`, then it probably isn't + # readable.) + # + # @example + # ```ruby + # property :x, cannot_be: [ :nil, :empty ] + # x [ 1, 2 ] #=> valid + # x 1 #=> valid + # x [] #=> invalid + # x nil #=> invalid + # ``` + # + def _pv_cannot_be(opts, key, predicate_method_base_name) + value = _pv_opts_lookup(opts, key) + if !value.nil? + Array(predicate_method_base_name).each do |method_name| + predicate_method = :"#{method_name}?" + + if value.respond_to?(predicate_method) + if value.send(predicate_method) + raise Exceptions::ValidationFailed, "Option #{key} cannot be #{predicate_method_base_name}" + end + end + end + end + end + + # + # The default value for a property. + # + # When the property is not assigned, this will be used. + # + # If this is a lazy value, it will either be passed the resource as a value, + # or if the lazy proc does not take parameters, it will be run in the + # context of the instance with instance_eval. + # + # @example + # ```ruby + # property :x, default: 10 + # ``` + # + # @example + # ```ruby + # property :x + # property :y, default: lazy { x+2 } + # ``` + # + # @example + # ```ruby + # property :x + # property :y, default: lazy { |r| r.x+2 } + # ``` + # + def _pv_default(opts, key, default_value) + value = _pv_opts_lookup(opts, key) + if value.nil? + default_value = default_value.freeze if !default_value.is_a?(DelayedEvaluator) + opts[key] = default_value + end + end + + # + # List of regexes values that must match. + # + # Uses regex.match() to evaluate. At least one must match for the value to + # be valid. + # + # `nil` passes regex validation automatically. + # + # @example + # ```ruby + # property :x, regex: [ /abc/, /xyz/ ] + # ``` + # + def _pv_regex(opts, key, regex) + value = _pv_opts_lookup(opts, key) + if !value.nil? + Array(regex).flatten.each do |r| + return true if r.match(value.to_s) + end + raise Exceptions::ValidationFailed, "Option #{key}'s value #{value} does not match regular expression #{regex.inspect}" + end + end + + # + # List of procs we pass the value to. + # + # All procs must return true for the value to be valid. If any procs do + # not return true, the key will be used for the message: `"Property x's + # value :y "`. + # + # @example + # ```ruby + # property :x, callbacks: { "is bigger than 10" => proc { |v| v <= 10 }, "is not awesome" => proc { |v| !v.awesome }} + # ``` + # + def _pv_callbacks(opts, key, callbacks) + raise ArgumentError, "Callback list must be a hash!" unless callbacks.kind_of?(Hash) + value = _pv_opts_lookup(opts, key) + if !value.nil? + callbacks.each do |message, zeproc| + unless zeproc.call(value) + raise Exceptions::ValidationFailed, "Option #{key}'s value #{value} #{message}!" + end + end + end + end + + # + # Allows a parameter to default to the value of the resource name. + # + # @example + # ```ruby + # property :x, name_property: true + # ``` + # + def _pv_name_property(opts, key, is_name_property = true) + if is_name_property + if opts[key].nil? + raise CannotValidateStaticallyError, "name_property cannot be evaluated without a resource." if self == Chef::Mixin::ParamsValidate + opts[key] = self.instance_variable_get(:"@name") + end + end + end + alias :_pv_name_attribute :_pv_name_property + + # + # List of valid things values can be. + # + # Uses Ruby's `===` to evaluate (is === value). At least one must match + # for the value to be valid. + # + # If a proc is passed, it is instance_eval'd in the resource, passed the + # value, and must return a truthy or falsey value. + # + # @example Class + # ```ruby + # property :x, String + # x 'valid' #=> valid + # x 1 #=> invalid + # x nil #=> invalid + # + # @example Value + # ```ruby + # property :x, [ :a, :b, :c, nil ] + # x :a #=> valid + # x nil #=> valid + # ``` + # + # @example Regex + # ```ruby + # property :x, /bar/ + # x 'foobar' #=> valid + # x 'foo' #=> invalid + # x nil #=> invalid + # ``` + # + # @example Proc + # ```ruby + # property :x, proc { |x| x > y } + # property :y, default: 2 + # x 3 #=> valid + # x 1 #=> invalid + # ``` + # + # @example Property + # ```ruby + # type = Property.new(is: String) + # property :x, type + # x 'foo' #=> valid + # x 1 #=> invalid + # x nil #=> invalid + # ``` + # + # @example RSpec Matcher + # ```ruby + # include RSpec::Matchers + # property :x, a_string_matching /bar/ + # x 'foobar' #=> valid + # x 'foo' #=> invalid + # x nil #=> invalid + # ``` + # + def _pv_is(opts, key, to_be, raise_error: true) + return true if !opts.has_key?(key.to_s) && !opts.has_key?(key.to_sym) + value = _pv_opts_lookup(opts, key) + to_be = [ to_be ].flatten(1) + errors = [] + passed = to_be.any? do |tb| + case tb + when Proc + raise CannotValidateStaticallyError, "is: proc { } must be evaluated once for each resource" if self == Chef::Mixin::ParamsValidate + instance_exec(value, &tb) + when Property + begin + validate(opts, { key => tb.validation_options }) + true + rescue Exceptions::ValidationFailed + # re-raise immediately if there is only one "is" so we get a better stack + raise if to_be.size == 1 + errors << $! + false + end + else + tb === value + end + end + if passed + true + else + message = "Property #{key} must be one of: #{to_be.map { |v| v.inspect }.join(", ")}! You passed #{value.inspect}." + unless errors.empty? + message << " Errors:\n#{errors.map { |m| "- #{m}" }.join("\n")}" + end + raise Exceptions::ValidationFailed, message + end + end + + # + # Method to mess with a value before it is validated and stored. + # + # Allows you to transform values into a canonical form that is easy to + # work with. + # + # This is passed the value to transform, and is run in the context of the + # instance (so it has access to other resource properties). It must return + # the value that will be stored in the instance. + # + # @example + # ```ruby + # property :x, Integer, coerce: { |v| v.to_i } + # ``` + # + def _pv_coerce(opts, key, coercer) + if opts.has_key?(key.to_s) + raise CannotValidateStaticallyError, "coerce must be evaluated for each resource." if self == Chef::Mixin::ParamsValidate + opts[key.to_s] = instance_exec(opts[key], &coercer) + elsif opts.has_key?(key.to_sym) + raise CannotValidateStaticallyError, "coerce must be evaluated for each resource." if self == Chef::Mixin::ParamsValidate + opts[key.to_sym] = instance_exec(opts[key], &coercer) + end + end + + # We allow Chef::Mixin::ParamsValidate.validate(), but we will raise an + # error if you try to do anything requiring there to be an actual resource. + # This way, you can statically validate things if you have constant validation + # (which is the norm). + extend self + + # Used by #set_or_return to avoid emitting a deprecation warning for + # "value nil" and to keep default stickiness working exactly the same + # @api private + class SetOrReturnProperty < (defined?(::Chef::Mixin::ParamsValidate::SetOrReturnProperty) ? ::Chef::Mixin::ParamsValidate::SetOrReturnProperty : Chef::Property) + def get(resource, nil_set: false) + value = super + # All values are sticky, frozen or not + if !is_set?(resource) + set_value(resource, value) + end + value + end + + def call(resource, value = NOT_PASSED) + # setting to nil does a get + if value.nil? && !explicitly_accepts_nil?(resource) + get(resource, nil_set: true) + else + super + end + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/powershell_out.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/powershell_out.rb new file mode 100644 index 0000000..b6b56f9 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/powershell_out.rb @@ -0,0 +1,117 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/mixin/powershell_out' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +#-- +# Copyright:: Copyright 2015-2016, Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. + + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module Mixin + CopiedFromChef.extend_chef_module(::Chef::Mixin, self) if defined?(::Chef::Mixin) + module PowershellOut + CopiedFromChef.extend_chef_module(::Chef::Mixin::PowershellOut, self) if defined?(::Chef::Mixin::PowershellOut) + include Chef::Mixin::ShellOut + include Chef::Mixin::WindowsArchitectureHelper + + # Run a command under powershell with the same API as shell_out. The + # options hash is extended to take an "architecture" flag which + # can be set to :i386 or :x86_64 to force the windows architecture. + # + # @param script [String] script to run + # @param options [Hash] options hash + # @return [Mixlib::Shellout] mixlib-shellout object + def powershell_out(*command_args) + script = command_args.first + options = command_args.last.is_a?(Hash) ? command_args.last : nil + + run_command_with_os_architecture(script, options) + end + + # Run a command under powershell with the same API as shell_out! + # (raises exceptions on errors) + # + # @param script [String] script to run + # @param options [Hash] options hash + # @return [Mixlib::Shellout] mixlib-shellout object + def powershell_out!(*command_args) + cmd = powershell_out(*command_args) + cmd.error! + cmd + end + + private + + # Helper function to run shell_out and wrap it with the correct + # flags to possibly disable WOW64 redirection (which we often need + # because chef-client runs as a 32-bit app on 64-bit windows). + # + # @param script [String] script to run + # @param options [Hash] options hash + # @return [Mixlib::Shellout] mixlib-shellout object + def run_command_with_os_architecture(script, options) + options ||= {} + options = options.dup + arch = options.delete(:architecture) + + with_os_architecture(nil, architecture: arch) do + shell_out( + build_powershell_command(script), + options + ) + end + end + + # Helper to build a powershell command around the script to run. + # + # @param script [String] script to run + # @retrurn [String] powershell command to execute + def build_powershell_command(script) + flags = [ + # Hides the copyright banner at startup. + "-NoLogo", + # Does not present an interactive prompt to the user. + "-NonInteractive", + # Does not load the Windows PowerShell profile. + "-NoProfile", + # always set the ExecutionPolicy flag + # see http://technet.microsoft.com/en-us/library/ee176961.aspx + "-ExecutionPolicy Unrestricted", + # Powershell will hang if STDIN is redirected + # http://connect.microsoft.com/PowerShell/feedback/details/572313/powershell-exe-can-hang-if-stdin-is-redirected + "-InputFormat None", + ] + + "powershell.exe #{flags.join(' ')} -Command \"#{script.gsub('"', '\"')}\"" + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb new file mode 100644 index 0000000..bdf9f7e --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb @@ -0,0 +1,328 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/mixin/properties' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +require "chef_compat/copied_from_chef/chef/delayed_evaluator" +require "chef_compat/copied_from_chef/chef/mixin/params_validate" +require "chef_compat/copied_from_chef/chef/property" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + module Mixin + CopiedFromChef.extend_chef_module(::Chef::Mixin, self) if defined?(::Chef::Mixin) + module Properties + CopiedFromChef.extend_chef_module(::Chef::Mixin::Properties, self) if defined?(::Chef::Mixin::Properties) + module ClassMethods + CopiedFromChef.extend_chef_module(::Chef::Mixin::Properties::ClassMethods, self) if defined?(::Chef::Mixin::Properties::ClassMethods) + # + # The list of properties defined on this resource. + # + # Everything defined with `property` is in this list. + # + # @param include_superclass [Boolean] `true` to include properties defined + # on superclasses; `false` or `nil` to return the list of properties + # directly on this class. + # + # @return [Hash] The list of property names and types. + # + def properties(include_superclass = true) + if include_superclass + result = {} + ancestors.reverse_each { |c| result.merge!(c.properties(false)) if c.respond_to?(:properties) } + result + else + @properties ||= {} + end + end + + # + # Create a property on this resource class. + # + # If a superclass has this property, or if this property has already been + # defined by this resource, this will *override* the previous value. + # + # @param name [Symbol] The name of the property. + # @param type [Object,Array] The type(s) of this property. + # If present, this is prepended to the `is` validation option. + # @param options [Hash] Validation options. + # @option options [Object,Array] :is An object, or list of + # objects, that must match the value using Ruby's `===` operator + # (`options[:is].any? { |v| v === value }`). + # @option options [Object,Array] :equal_to An object, or list + # of objects, that must be equal to the value using Ruby's `==` + # operator (`options[:is].any? { |v| v == value }`) + # @option options [Regexp,Array] :regex An object, or + # list of objects, that must match the value with `regex.match(value)`. + # @option options [Class,Array] :kind_of A class, or + # list of classes, that the value must be an instance of. + # @option options [Hash] :callbacks A hash of + # messages -> procs, all of which match the value. The proc must + # return a truthy or falsey value (true means it matches). + # @option options [Symbol,Array] :respond_to A method + # name, or list of method names, the value must respond to. + # @option options [Symbol,Array] :cannot_be A property, + # or a list of properties, that the value cannot have (such as `:nil` or + # `:empty`). The method with a questionmark at the end is called on the + # value (e.g. `value.empty?`). If the value does not have this method, + # it is considered valid (i.e. if you don't respond to `empty?` we + # assume you are not empty). + # @option options [Proc] :coerce A proc which will be called to + # transform the user input to canonical form. The value is passed in, + # and the transformed value returned as output. Lazy values will *not* + # be passed to this method until after they are evaluated. Called in the + # context of the resource (meaning you can access other properties). + # @option options [Boolean] :required `true` if this property + # must be present; `false` otherwise. This is checked after the resource + # is fully initialized. + # @option options [Boolean] :name_property `true` if this + # property defaults to the same value as `name`. Equivalent to + # `default: lazy { name }`, except that #property_is_set? will + # return `true` if the property is set *or* if `name` is set. + # @option options [Boolean] :name_attribute Same as `name_property`. + # @option options [Object] :default The value this property + # will return if the user does not set one. If this is `lazy`, it will + # be run in the context of the instance (and able to access other + # properties). + # @option options [Boolean] :desired_state `true` if this property is + # part of desired state. Defaults to `true`. + # @option options [Boolean] :identity `true` if this property + # is part of object identity. Defaults to `false`. + # @option options [Boolean] :sensitive `true` if this property could + # contain sensitive information and whose value should be redacted + # in any resource reporting / auditing output. Defaults to `false`. + # + # @example Bare property + # property :x + # + # @example With just a type + # property :x, String + # + # @example With just options + # property :x, default: 'hi' + # + # @example With type and options + # property :x, String, default: 'hi' + # + def property(name, type = NOT_PASSED, **options) + name = name.to_sym + + options = options.inject({}) { |memo, (key, value)| memo[key.to_sym] = value; memo } + + options[:instance_variable_name] = :"@#{name}" if !options.has_key?(:instance_variable_name) + options[:name] = name + options[:declared_in] = self + + if type == NOT_PASSED + # If a type is not passed, the property derives from the + # superclass property (if any) + if properties.has_key?(name) + property = properties[name].derive(**options) + else + property = property_type(**options) + end + + # If a Property is specified, derive a new one from that. + elsif type.is_a?(Property) || (type.is_a?(Class) && type <= Property) + property = type.derive(**options) + + # If a primitive type was passed, combine it with "is" + else + if options[:is] + options[:is] = ([ type ] + [ options[:is] ]).flatten(1) + else + options[:is] = type + end + property = property_type(**options) + end + + local_properties = properties(false) + local_properties[name] = property + + property.emit_dsl + end + + # + # Create a reusable property type that can be used in multiple properties + # in different resources. + # + # @param options [Hash] Validation options. see #property for + # the list of options. + # + # @example + # property_type(default: 'hi') + # + def property_type(**options) + Property.derive(**options) + end + + # + # Create a lazy value for assignment to a default value. + # + # @param block The block to run when the value is retrieved. + # + # @return [Chef::DelayedEvaluator] The lazy value + # + def lazy(&block) + DelayedEvaluator.new(&block) + end + + # + # Get or set the list of desired state properties for this resource. + # + # State properties are properties that describe the desired state + # of the system, such as file permissions or ownership. + # In general, state properties are properties that could be populated by + # examining the state of the system (e.g., File.stat can tell you the + # permissions on an existing file). Contrarily, properties that are not + # "state properties" usually modify the way Chef itself behaves, for example + # by providing additional options for a package manager to use when + # installing a package. + # + # This list is used by the Chef client auditing system to extract + # information from resources to describe changes made to the system. + # + # This method is unnecessary when declaring properties with `property`; + # properties are added to state_properties by default, and can be turned off + # with `desired_state: false`. + # + # ```ruby + # property :x # part of desired state + # property :y, desired_state: false # not part of desired state + # ``` + # + # @param names [Array] A list of property names to set as desired + # state. + # + # @return [Array] All properties in desired state. + # + def state_properties(*names) + if !names.empty? + names = names.map { |name| name.to_sym }.uniq + + local_properties = properties(false) + # Add new properties to the list. + names.each do |name| + property = properties[name] + if !property + self.property name, instance_variable_name: false, desired_state: true + elsif !property.desired_state? + self.property name, desired_state: true + end + end + + # If state_attrs *excludes* something which is currently desired state, + # mark it as desired_state: false. + local_properties.each do |name, property| + if property.desired_state? && !names.include?(name) + self.property name, desired_state: false + end + end + end + + properties.values.select { |property| property.desired_state? } + end + + # + # Set the identity of this resource to a particular set of properties. + # + # This drives #identity, which returns data that uniquely refers to a given + # resource on the given node (in such a way that it can be correlated + # across Chef runs). + # + # This method is unnecessary when declaring properties with `property`; + # properties can be added to identity during declaration with + # `identity: true`. + # + # ```ruby + # property :x, identity: true # part of identity + # property :y # not part of identity + # ``` + # + # If no properties are marked as identity, "name" is considered the identity. + # + # @param names [Array] A list of property names to set as the identity. + # + # @return [Array] All identity properties. + # + def identity_properties(*names) + if !names.empty? + names = names.map { |name| name.to_sym } + + # Add or change properties that are not part of the identity. + names.each do |name| + property = properties[name] + if !property + self.property name, instance_variable_name: false, identity: true + elsif !property.identity? + self.property name, identity: true + end + end + + # If identity_properties *excludes* something which is currently part of + # the identity, mark it as identity: false. + properties.each do |name, property| + if property.identity? && !names.include?(name) + + self.property name, identity: false + end + end + end + + result = properties.values.select { |property| property.identity? } + result = [ properties[:name] ] if result.empty? + result + end + + def included(other) + other.extend ClassMethods + end + end + + def self.included(other) + other.extend ClassMethods + end + + include Chef::Mixin::ParamsValidate + + # + # Whether this property has been set (or whether it has a default that has + # been retrieved). + # + # @param name [Symbol] The name of the property. + # @return [Boolean] `true` if the property has been set. + # + def property_is_set?(name) + property = self.class.properties[name.to_sym] + raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property + property.is_set?(self) + end + + # + # Clear this property as if it had never been set. It will thereafter return + # the default. + # been retrieved). + # + # @param name [Symbol] The name of the property. + # + def reset_property(name) + property = self.class.properties[name.to_sym] + raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property + property.reset(self) + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/property.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/property.rb new file mode 100644 index 0000000..c09cb0a --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/property.rb @@ -0,0 +1,713 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/property' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: John Keiser +# Copyright:: Copyright 2015-2016, John Keiser. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/delayed_evaluator" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + # + # Type and validation information for a property on a resource. + # + # A property named "x" manipulates the "@x" instance variable on a + # resource. The *presence* of the variable (`instance_variable_defined?(@x)`) + # tells whether the variable is defined; it may have any actual value, + # constrained only by validation. + # + # Properties may have validation, defaults, and coercion, and have full + # support for lazy values. + # + # @see Chef::Resource.property + # @see Chef::DelayedEvaluator + # + class Property < (defined?(::Chef::Property) ? ::Chef::Property : Object) + # + # Create a reusable property type that can be used in multiple properties + # in different resources. + # + # @param options [Hash] Validation options. See Chef::Resource.property for + # the list of options. + # + # @example + # Property.derive(default: 'hi') + # + def self.derive(**options) + new(**options) + end + + # + # Create a new property. + # + # @param options [Hash] Property options, including + # control options here, as well as validation options (see + # Chef::Mixin::ParamsValidate#validate for a description of validation + # options). + # @option options [Symbol] :name The name of this property. + # @option options [Class] :declared_in The class this property comes from. + # @option options [Symbol] :instance_variable_name The instance variable + # tied to this property. Must include a leading `@`. Defaults to `@`. + # `nil` means the property is opaque and not tied to a specific instance + # variable. + # @option options [Boolean] :desired_state `true` if this property is part of desired + # state. Defaults to `true`. + # @option options [Boolean] :identity `true` if this property is part of object + # identity. Defaults to `false`. + # @option options [Boolean] :name_property `true` if this + # property defaults to the same value as `name`. Equivalent to + # `default: lazy { name }`, except that #property_is_set? will + # return `true` if the property is set *or* if `name` is set. + # @option options [Boolean] :nillable `true` opt-in to Chef-13 style behavior where + # attempting to set a nil value will really set a nil value instead of issuing + # a warning and operating like a getter + # @option options [Object] :default The value this property + # will return if the user does not set one. If this is `lazy`, it will + # be run in the context of the instance (and able to access other + # properties) and cached. If not, the value will be frozen with Object#freeze + # to prevent users from modifying it in an instance. + # @option options [Proc] :coerce A proc which will be called to + # transform the user input to canonical form. The value is passed in, + # and the transformed value returned as output. Lazy values will *not* + # be passed to this method until after they are evaluated. Called in the + # context of the resource (meaning you can access other properties). + # @option options [Boolean] :required `true` if this property + # must be present; `false` otherwise. This is checked after the resource + # is fully initialized. + # + def initialize(**options) +super if defined?(::Chef::Property) + options = options.inject({}) { |memo, (key, value)| memo[key.to_sym] = value; memo } + @options = options + options[:name] = options[:name].to_sym if options[:name] + options[:instance_variable_name] = options[:instance_variable_name].to_sym if options[:instance_variable_name] + + # Replace name_attribute with name_property + if options.has_key?(:name_attribute) + # If we have both name_attribute and name_property and they differ, raise an error + if options.has_key?(:name_property) + raise ArgumentError, "Cannot specify both name_property and name_attribute together on property #{self}." + end + # replace name_property with name_attribute in place + options = Hash[options.map { |k, v| k == :name_attribute ? [ :name_property, v ] : [ k, v ] }] + @options = options + end + + # Only pick the first of :default, :name_property and :name_attribute if + # more than one is specified. + if options.has_key?(:default) && options[:name_property] + if options[:default].nil? || options.keys.index(:name_property) < options.keys.index(:default) + options.delete(:default) + preferred_default = :name_property + else + options.delete(:name_property) + preferred_default = :default + end + Chef.log_deprecation("Cannot specify both default and name_property together on property #{self}. Only one (#{preferred_default}) will be obeyed. In Chef 13, this will become an error. Please remove one or the other from the property.") + end + + # Validate the default early, so the user gets a good error message, and + # cache it so we don't do it again if so + begin + # If we can validate it all the way to output, do it. + @stored_default = input_to_stored_value(nil, default, is_default: true) + rescue Chef::Exceptions::CannotValidateStaticallyError + # If the validation is not static (i.e. has procs), we will have to + # coerce and validate the default each time we run + end + end + + def to_s + "#{name || ""}#{declared_in ? " of resource #{declared_in.resource_name}" : ""}" + end + + # + # The name of this property. + # + # @return [String] + # + def name + options[:name] + end + + # + # The class this property was defined in. + # + # @return [Class] + # + def declared_in + options[:declared_in] + end + + # + # The instance variable associated with this property. + # + # Defaults to `@` + # + # @return [Symbol] + # + def instance_variable_name + if options.has_key?(:instance_variable_name) + options[:instance_variable_name] + elsif name + :"@#{name}" + end + end + + # + # The raw default value for this resource. + # + # Does not coerce or validate the default. Does not evaluate lazy values. + # + # Defaults to `lazy { name }` if name_property is true; otherwise defaults to + # `nil` + # + def default + return options[:default] if options.has_key?(:default) + return Chef::DelayedEvaluator.new { name } if name_property? + nil + end + + # + # Whether this is part of the resource's natural identity or not. + # + # @return [Boolean] + # + def identity? + options[:identity] + end + + # + # Whether this is part of desired state or not. + # + # Defaults to true. + # + # @return [Boolean] + # + def desired_state? + return true if !options.has_key?(:desired_state) + options[:desired_state] + end + + # + # Whether this is name_property or not. + # + # @return [Boolean] + # + def name_property? + options[:name_property] + end + + # + # Whether this property has a default value. + # + # @return [Boolean] + # + def has_default? + options.has_key?(:default) || name_property? + end + + # + # Whether this property is required or not. + # + # @return [Boolean] + # + def required? + options[:required] + end + + # + # Whether this property is sensitive or not. + # + # Defaults to false. + # + # @return [Boolean] + # + def sensitive? + options.fetch(:sensitive, false) + end + + # + # Validation options. (See Chef::Mixin::ParamsValidate#validate.) + # + # @return [Hash] + # + def validation_options + @validation_options ||= options.reject do |k, v| + [:declared_in, :name, :instance_variable_name, :desired_state, :identity, :default, :name_property, :coerce, :required, :nillable, :sensitive].include?(k) + end + end + + # + # Handle the property being called. + # + # The base implementation does the property get-or-set: + # + # ```ruby + # resource.myprop # get + # resource.myprop value # set + # ``` + # + # Subclasses may implement this with any arguments they want, as long as + # the corresponding DSL calls it correctly. + # + # @param resource [Chef::Resource] The resource to get the property from. + # @param value The value to set (or NOT_PASSED if it is a get). + # + # @return The current value of the property. If it is a `set`, lazy values + # will be returned without running, validating or coercing. If it is a + # `get`, the non-lazy, coerced, validated value will always be returned. + # + def call(resource, value = NOT_PASSED) + if value == NOT_PASSED + return get(resource) + end + + if value.nil? && !nillable? + # In Chef 12, value(nil) does a *get* instead of a set, so we + # warn if the value would have been changed. In Chef 13, it will be + # equivalent to value = nil. + result = get(resource, nil_set: true) + + # Warn about this becoming a set in Chef 13. + begin + input_to_stored_value(resource, value) + # If nil is valid, and it would change the value, warn that this will change to a set. + if !result.nil? + Chef.log_deprecation("An attempt was made to change #{name} from #{result.inspect} to nil by calling #{name}(nil). In Chef 12, this does a get rather than a set. In Chef 13, this will change to set the value to nil.") + end + rescue Chef::Exceptions::DeprecatedFeatureError + raise + rescue + # If nil is invalid, warn that this will become an error. + Chef.log_deprecation("nil is an invalid value for #{self}. In Chef 13, this warning will change to an error. Error: #{$!}") + end + + result + else + # Anything else, such as myprop(value) is a set + set(resource, value) + end + end + + # + # Get the property value from the resource, handling lazy values, + # defaults, and validation. + # + # - If the property's value is lazy, it is evaluated, coerced and validated. + # - If the property has no value, and is required, raises ValidationFailed. + # - If the property has no value, but has a lazy default, it is evaluated, + # coerced and validated. If the evaluated value is frozen, the resulting + # - If the property has no value, but has a default, the default value + # will be returned and frozen. If the default value is lazy, it will be + # evaluated, coerced and validated, and the result stored in the property. + # - If the property has no value, but is name_property, `resource.name` + # is retrieved, coerced, validated and stored in the property. + # - Otherwise, `nil` is returned. + # + # @param resource [Chef::Resource] The resource to get the property from. + # + # @return The value of the property. + # + # @raise Chef::Exceptions::ValidationFailed If the value is invalid for + # this property, or if the value is required and not set. + # + def get(resource, nil_set: false) + # If it's set, return it (and evaluate any lazy values) + if is_set?(resource) + value = get_value(resource) + value = stored_value_to_output(resource, value) + + else + # We are getting the default value. + + # If the user does something like this: + # + # ``` + # class MyResource < Chef::Resource + # property :content + # action :create do + # file '/x.txt' do + # content content + # end + # end + # end + # ``` + # + # It won't do what they expect. This checks whether you try to *read* + # `content` while we are compiling the resource. + if !nil_set && + resource.respond_to?(:resource_initializing) && + resource.resource_initializing && + resource.respond_to?(:enclosing_provider) && + resource.enclosing_provider && + resource.enclosing_provider.new_resource && + resource.enclosing_provider.new_resource.respond_to?(name) + Chef::Log.warn("#{Chef::Log.caller_location}: property #{name} is declared in both #{resource} and #{resource.enclosing_provider}. Use new_resource.#{name} instead. At #{Chef::Log.caller_location}") + end + + if has_default? + # If we were able to cache the stored_default, grab it. + if defined?(@stored_default) + value = @stored_default + else + # Otherwise, we have to validate it now. + value = input_to_stored_value(resource, default, is_default: true) + end + value = stored_value_to_output(resource, value, is_default: true) + + # If the value is mutable (non-frozen), we set it on the instance + # so that people can mutate it. (All constant default values are + # frozen.) + if !value.frozen? && !value.nil? + set_value(resource, value) + end + + value + + elsif required? + raise Chef::Exceptions::ValidationFailed, "#{name} is required" + end + end + end + + # + # Set the value of this property in the given resource. + # + # Non-lazy values are coerced and validated before being set. Coercion + # and validation of lazy values is delayed until they are first retrieved. + # + # @param resource [Chef::Resource] The resource to set this property in. + # @param value The value to set. + # + # @return The value that was set, after coercion (if lazy, still returns + # the lazy value) + # + # @raise Chef::Exceptions::ValidationFailed If the value is invalid for + # this property. + # + def set(resource, value) + set_value(resource, input_to_stored_value(resource, value)) + end + + # + # Find out whether this property has been set. + # + # This will be true if: + # - The user explicitly set the value + # - The property has a default, and the value was retrieved. + # + # From this point of view, it is worth looking at this as "what does the + # user think this value should be." In order words, if the user grabbed + # the value, even if it was a default, they probably based calculations on + # it. If they based calculations on it and the value changes, the rest of + # the world gets inconsistent. + # + # @param resource [Chef::Resource] The resource to get the property from. + # + # @return [Boolean] + # + def is_set?(resource) + value_is_set?(resource) + end + + # + # Reset the value of this property so that is_set? will return false and the + # default will be returned in the future. + # + # @param resource [Chef::Resource] The resource to get the property from. + # + def reset(resource) + reset_value(resource) + end + + # + # Coerce an input value into canonical form for the property. + # + # After coercion, the value is suitable for storage in the resource. + # You must validate values after coercion, however. + # + # Does no special handling for lazy values. + # + # @param resource [Chef::Resource] The resource we're coercing against + # (to provide context for the coerce). + # @param value The value to coerce. + # + # @return The coerced value. + # + # @raise Chef::Exceptions::ValidationFailed If the value is invalid for + # this property. + # + def coerce(resource, value) + if options.has_key?(:coerce) + # If we have no default value, `nil` is never coerced or validated + unless !has_default? && value.nil? + value = exec_in_resource(resource, options[:coerce], value) + end + end + value + end + + # + # Validate a value. + # + # Calls Chef::Mixin::ParamsValidate#validate with #validation_options as + # options. + # + # @param resource [Chef::Resource] The resource we're validating against + # (to provide context for the validate). + # @param value The value to validate. + # + # @raise Chef::Exceptions::ValidationFailed If the value is invalid for + # this property. + # + def validate(resource, value) + # If we have no default value, `nil` is never coerced or validated + unless value.nil? && !has_default? + if resource + resource.validate({ name => value }, { name => validation_options }) + else + name = self.name || :property_type + Chef::Mixin::ParamsValidate.validate({ name => value }, { name => validation_options }) + end + end + end + + # + # Derive a new Property that is just like this one, except with some added or + # changed options. + # + # @param options [Hash] List of options that would be passed + # to #initialize. + # + # @return [Property] The new property type. + # + def derive(**modified_options) + # Since name_property, name_attribute and default override each other, + # if you specify one of them in modified_options it overrides anything in + # the original options. + options = self.options + if modified_options.has_key?(:name_property) || + modified_options.has_key?(:name_attribute) || + modified_options.has_key?(:default) + options = options.reject { |k, v| k == :name_attribute || k == :name_property || k == :default } + end + self.class.new(options.merge(modified_options)) + end + + # + # Emit the DSL for this property into the resource class (`declared_in`). + # + # Creates a getter and setter for the property. + # + def emit_dsl + # We don't create the getter/setter if it's a custom property; we will + # be using the existing getter/setter to manipulate it instead. + return if !instance_variable_name + + # We prefer this form because the property name won't show up in the + # stack trace if you use `define_method`. + declared_in.class_eval <<-EOM, __FILE__, __LINE__ + 1 + def #{name}(value=NOT_PASSED) + raise "Property #{name} of \#{self} cannot be passed a block! If you meant to create a resource named #{name} instead, you'll need to first rename the property." if block_given? + self.class.properties[#{name.inspect}].call(self, value) + end + def #{name}=(value) + raise "Property #{name} of \#{self} cannot be passed a block! If you meant to create a resource named #{name} instead, you'll need to first rename the property." if block_given? + self.class.properties[#{name.inspect}].set(self, value) + end + EOM + rescue SyntaxError + # If the name is not a valid ruby name, we use define_method. + declared_in.define_method(name) do |value = NOT_PASSED, &block| + raise "Property #{name} of #{self} cannot be passed a block! If you meant to create a resource named #{name} instead, you'll need to first rename the property." if block + self.class.properties[name].call(self, value) + end + declared_in.define_method("#{name}=") do |value, &block| + raise "Property #{name} of #{self} cannot be passed a block! If you meant to create a resource named #{name} instead, you'll need to first rename the property." if block + self.class.properties[name].set(self, value) + end + end + + # + # The options this Property will use for get/set behavior and validation. + # + # @see #initialize for a list of valid options. + # + attr_reader :options + + # + # Find out whether this type accepts nil explicitly. + # + # A type accepts nil explicitly if "is" allows nil, it validates as nil, *and* is not simply + # an empty type. + # + # A type is presumed to accept nil if it does coercion (which must handle nil). + # + # These examples accept nil explicitly: + # ```ruby + # property :a, [ String, nil ] + # property :a, [ String, NilClass ] + # property :a, [ String, proc { |v| v.nil? } ] + # ``` + # + # This does not (because the "is" doesn't exist or doesn't have nil): + # + # ```ruby + # property :x, String + # ``` + # + # These do not, even though nil would validate fine (because they do not + # have "is"): + # + # ```ruby + # property :a + # property :a, equal_to: [ 1, 2, 3, nil ] + # property :a, kind_of: [ String, NilClass ] + # property :a, respond_to: [ ] + # property :a, callbacks: { "a" => proc { |v| v.nil? } } + # ``` + # + # @param resource [Chef::Resource] The resource we're coercing against + # (to provide context for the coerce). + # + # @return [Boolean] Whether this value explicitly accepts nil. + # + # @api private + def explicitly_accepts_nil?(resource) + options.has_key?(:coerce) || + (options.has_key?(:is) && resource.send(:_pv_is, { name => nil }, name, options[:is], raise_error: false)) + end + + # @api private + def get_value(resource) + if instance_variable_name + resource.instance_variable_get(instance_variable_name) + else + resource.send(name) + end + end + + # @api private + def set_value(resource, value) + if instance_variable_name + resource.instance_variable_set(instance_variable_name, value) + else + resource.send(name, value) + end + end + + # @api private + def value_is_set?(resource) + if instance_variable_name + resource.instance_variable_defined?(instance_variable_name) + else + true + end + end + + # @api private + def reset_value(resource) + if instance_variable_name + if value_is_set?(resource) + resource.remove_instance_variable(instance_variable_name) + end + else + raise ArgumentError, "Property #{name} has no instance variable defined and cannot be reset" + end + end + + private + + def exec_in_resource(resource, proc, *args) + if resource + if proc.arity > args.size + value = proc.call(resource, *args) + else + value = resource.instance_exec(*args, &proc) + end + else + # If we don't have a resource yet, we can't exec in resource! + raise Chef::Exceptions::CannotValidateStaticallyError, "Cannot validate or coerce without a resource" + end + end + + def input_to_stored_value(resource, value, is_default: false) + unless value.is_a?(DelayedEvaluator) + value = coerce_and_validate(resource, value, is_default: is_default) + end + value + end + + def stored_value_to_output(resource, value, is_default: false) + # Crack open lazy values before giving the result to the user + if value.is_a?(DelayedEvaluator) + value = exec_in_resource(resource, value) + value = coerce_and_validate(resource, value, is_default: is_default) + end + value + end + + # Coerces and validates the value. If the value is a default, it will warn + # the user that invalid defaults are bad mmkay, and return it as if it were + # valid. + def coerce_and_validate(resource, value, is_default: false) + result = coerce(resource, value) + begin + # If the input is from a default, we need to emit an invalid default warning on validate. + validate(resource, result) + rescue Chef::Exceptions::CannotValidateStaticallyError + # This one gets re-raised + raise + rescue + # Anything else is just an invalid default: in those cases, we just + # warn and return the (possibly coerced) value to the user. + if is_default + if value.nil? + Chef.log_deprecation("Default value nil is invalid for property #{self}. Possible fixes: 1. Remove 'default: nil' if nil means 'undefined'. 2. Set a valid default value if there is a reasonable one. 3. Allow nil as a valid value of your property (for example, 'property #{name.inspect}, [ String, nil ], default: nil'). Error: #{$!}") + else + Chef.log_deprecation("Default value #{value.inspect} is invalid for property #{self}. In Chef 13 this will become an error: #{$!}.") + end + else + raise + end + end + + result + end + + def nillable? + !!options[:nillable] + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider.rb new file mode 100644 index 0000000..7ccf87b --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider.rb @@ -0,0 +1,164 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +require "chef_compat/copied_from_chef/chef/dsl/core" +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + include Chef::DSL::Core + attr_accessor :action + def initialize(new_resource, run_context) +super if defined?(::Chef::Provider) + @new_resource = new_resource + @action = action + @current_resource = nil + @run_context = run_context + @converge_actions = nil + + @recipe_name = nil + @cookbook_name = nil + self.class.include_resource_dsl_module(new_resource) + end + def converge_if_changed(*properties, &converge_block) + if !converge_block + raise ArgumentError, "converge_if_changed must be passed a block!" + end + + properties = new_resource.class.state_properties.map { |p| p.name } if properties.empty? + properties = properties.map { |p| p.to_sym } + if current_resource + # Collect the list of modified properties + specified_properties = properties.select { |property| new_resource.property_is_set?(property) } + modified = specified_properties.select { |p| new_resource.send(p) != current_resource.send(p) } + if modified.empty? + properties_str = if sensitive + specified_properties.join(", ") + else + specified_properties.map { |p| "#{p}=#{new_resource.send(p).inspect}" }.join(", ") + end + Chef::Log.debug("Skipping update of #{new_resource}: has not changed any of the specified properties #{properties_str}.") + return false + end + + # Print the pretty green text and run the block + property_size = modified.map { |p| p.size }.max + modified.map! do |p| + properties_str = if sensitive + "(suppressed sensitive property)" + else + "#{new_resource.send(p).inspect} (was #{current_resource.send(p).inspect})" + end + " set #{p.to_s.ljust(property_size)} to #{properties_str}" + end + converge_by([ "update #{current_resource.identity}" ] + modified, &converge_block) + + else + # The resource doesn't exist. Mark that we are *creating* this, and + # write down any properties we are setting. + property_size = properties.map { |p| p.size }.max + created = properties.map do |property| + default = " (default value)" unless new_resource.property_is_set?(property) + properties_str = if sensitive + "(suppressed sensitive property)" + else + new_resource.send(property).inspect + end + " set #{property.to_s.ljust(property_size)} to #{properties_str}#{default}" + end + + converge_by([ "create #{new_resource.identity}" ] + created, &converge_block) + end + true + end + def self.include_resource_dsl(include_resource_dsl) + @include_resource_dsl = include_resource_dsl + end + def self.include_resource_dsl_module(resource) + if @include_resource_dsl && !defined?(@included_resource_dsl_module) + provider_class = self + @included_resource_dsl_module = Module.new do + extend Forwardable + define_singleton_method(:to_s) { "forwarder module for #{provider_class}" } + define_singleton_method(:inspect) { to_s } + # Add a delegator for each explicit property that will get the *current* value + # of the property by default instead of the *actual* value. + resource.class.properties.each do |name, property| + class_eval(<<-EOM, __FILE__, __LINE__) + def #{name}(*args, &block) + # If no arguments were passed, we process "get" by defaulting + # the value to current_resource, not new_resource. This helps + # avoid issues where resources accidentally overwrite perfectly + # valid stuff with default values. + if args.empty? && !block + if !new_resource.property_is_set?(__method__) && current_resource + return current_resource.public_send(__method__) + end + end + new_resource.public_send(__method__, *args, &block) + end + EOM + end + dsl_methods = + resource.class.public_instance_methods + + resource.class.protected_instance_methods - + provider_class.instance_methods - + resource.class.properties.keys + def_delegators(:new_resource, *dsl_methods) + end + include @included_resource_dsl_module + end + end + def self.use_inline_resources + extend InlineResources::ClassMethods + include InlineResources + end + module InlineResources + CopiedFromChef.extend_chef_module(::Chef::Provider::InlineResources, self) if defined?(::Chef::Provider::InlineResources) + def compile_and_converge_action(&block) + old_run_context = run_context + @run_context = run_context.create_child + return_value = instance_eval(&block) + Chef::Runner.new(run_context).converge + return_value + ensure + if run_context.resource_collection.any? { |r| r.updated? } + new_resource.updated_by_last_action(true) + end + @run_context = old_run_context + end + module ClassMethods + CopiedFromChef.extend_chef_module(::Chef::Provider::InlineResources::ClassMethods, self) if defined?(::Chef::Provider::InlineResources::ClassMethods) + def action(name, &block) + # We need the block directly in a method so that `super` works + define_method("compile_action_#{name}", &block) + # We try hard to use `def` because define_method doesn't show the method name in the stack. + begin + class_eval <<-EOM + def action_#{name} + compile_and_converge_action { compile_action_#{name} } + end + EOM + rescue SyntaxError + define_method("action_#{name}") { send("compile_action_#{name}") } + end + end + end + end + protected + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_repository.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_repository.rb new file mode 100644 index 0000000..ccc07c4 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_repository.rb @@ -0,0 +1,269 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider/apt_repository' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" +require "chef_compat/copied_from_chef/chef/dsl/declare_resource" +require "chef_compat/copied_from_chef/chef/provider/noop" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + class AptRepository < (defined?(::Chef::Provider::AptRepository) ? ::Chef::Provider::AptRepository : Chef::Provider) + use_inline_resources + + include Chef::Mixin::ShellOut + extend Chef::Mixin::Which + + provides :apt_repository do + which("apt-get") + end + + def whyrun_supported? + true + end + + def load_current_resource + end + + action :add do + unless new_resource.key.nil? + if is_key_id?(new_resource.key) && !has_cookbook_file?(new_resource.key) + install_key_from_keyserver + else + install_key_from_uri + end + end + + declare_resource(:execute, "apt-cache gencaches") do + ignore_failure true + action :nothing + end + + declare_resource(:apt_update, new_resource.name) do + ignore_failure true + action :nothing + end + + components = if is_ppa_url?(new_resource.uri) && new_resource.components.empty? + "main" + else + new_resource.components + end + + repo = build_repo( + new_resource.uri, + new_resource.distribution, + components, + new_resource.trusted, + new_resource.arch, + new_resource.deb_src + ) + + declare_resource(:file, "/etc/apt/sources.list.d/#{new_resource.name}.list") do + owner "root" + group "root" + mode "0644" + content repo + sensitive new_resource.sensitive + action :create + notifies :run, "execute[apt-cache gencaches]", :immediately + notifies :update, "apt_update[#{new_resource.name}]", :immediately if new_resource.cache_rebuild + end + end + + action :remove do + if ::File.exist?("/etc/apt/sources.list.d/#{new_resource.name}.list") + converge_by "Removing #{new_resource.name} repository from /etc/apt/sources.list.d/" do + declare_resource(:file, "/etc/apt/sources.list.d/#{new_resource.name}.list") do + sensitive new_resource.sensitive + action :delete + notifies :update, "apt_update[#{new_resource.name}]", :immediately if new_resource.cache_rebuild + end + + declare_resource(:apt_update, new_resource.name) do + ignore_failure true + action :nothing + end + + end + end + end + + def is_key_id?(id) + id = id[2..-1] if id.start_with?("0x") + id =~ /^\h+$/ && [8, 16, 40].include?(id.length) + end + + def extract_fingerprints_from_cmd(cmd) + so = shell_out(cmd) + so.run_command + so.stdout.split(/\n/).map do |t| + if z = t.match(/^ +Key fingerprint = ([0-9A-F ]+)/) + z[1].split.join + end + end.compact + end + + def key_is_valid?(cmd, key) + valid = true + + so = shell_out(cmd) + so.run_command + so.stdout.split(/\n/).map do |t| + if t =~ %r{^\/#{key}.*\[expired: .*\]$} + Chef::Log.debug "Found expired key: #{t}" + valid = false + break + end + end + + Chef::Log.debug "key #{key} #{valid ? "is valid" : "is not valid"}" + valid + end + + def cookbook_name + new_resource.cookbook || new_resource.cookbook_name + end + + def has_cookbook_file?(fn) + run_context.has_cookbook_file_in_cookbook?(cookbook_name, fn) + end + + def no_new_keys?(file) + installed_keys = extract_fingerprints_from_cmd("apt-key finger") + proposed_keys = extract_fingerprints_from_cmd("gpg --with-fingerprint #{file}") + (installed_keys & proposed_keys).sort == proposed_keys.sort + end + + def install_key_from_uri + key_name = new_resource.key.gsub(/[^0-9A-Za-z\-]/, "_") + cached_keyfile = ::File.join(Chef::Config[:file_cache_path], key_name) + type = if new_resource.key.start_with?("http") + :remote_file + elsif has_cookbook_file?(new_resource.key) + :cookbook_file + else + raise Chef::Exceptions::FileNotFound, "Cannot locate key file" + end + + declare_resource(type, cached_keyfile) do + source new_resource.key + mode "0644" + sensitive new_resource.sensitive + action :create + end + + raise "The key #{cached_keyfile} is invalid and cannot be used to verify an apt repository." unless key_is_valid?("gpg #{cached_keyfile}", "") + + declare_resource(:execute, "apt-key add #{cached_keyfile}") do + sensitive new_resource.sensitive + action :run + not_if do + no_new_keys?(cached_keyfile) + end + notifies :run, "execute[apt-cache gencaches]", :immediately + end + end + + def install_key_from_keyserver(key = new_resource.key, keyserver = new_resource.keyserver) + cmd = "apt-key adv --recv" + cmd << " --keyserver-options http-proxy=#{new_resource.key_proxy}" if new_resource.key_proxy + cmd << " --keyserver " + cmd << if keyserver.start_with?("hkp://") + keyserver + else + "hkp://#{keyserver}:80" + end + + cmd << " #{key}" + + declare_resource(:execute, "install-key #{key}") do + command cmd + sensitive new_resource.sensitive + not_if do + present = extract_fingerprints_from_cmd("apt-key finger").any? do |fp| + fp.end_with? key.upcase + end + present && key_is_valid?("apt-key list", key.upcase) + end + notifies :run, "execute[apt-cache gencaches]", :immediately + end + + raise "The key #{key} is invalid and cannot be used to verify an apt repository." unless key_is_valid?("apt-key list", key.upcase) + end + + def install_ppa_key(owner, repo) + url = "https://launchpad.net/api/1.0/~#{owner}/+archive/#{repo}" + key_id = Chef::HTTP::Simple.new(url).get("signing_key_fingerprint").delete('"') + install_key_from_keyserver(key_id, "keyserver.ubuntu.com") + rescue Net::HTTPServerException => e + raise "Could not access Launchpad ppa API: #{e.message}" + end + + def is_ppa_url?(url) + url.start_with?("ppa:") + end + + def make_ppa_url(ppa) + return unless is_ppa_url?(ppa) + owner, repo = ppa[4..-1].split("/") + repo ||= "ppa" + + install_ppa_key(owner, repo) + "http://ppa.launchpad.net/#{owner}/#{repo}/ubuntu" + end + + def build_repo(uri, distribution, components, trusted, arch, add_src = false) + uri = make_ppa_url(uri) if is_ppa_url?(uri) + + uri = '"' + uri + '"' unless uri.start_with?("'", '"') + components = Array(components).join(" ") + options = [] + options << "arch=#{arch}" if arch + options << "trusted=yes" if trusted + optstr = unless options.empty? + "[" + options.join(" ") + "]" + end + info = [ optstr, uri, distribution, components ].compact.join(" ") + repo = "deb #{info}\n" + repo << "deb-src #{info}\n" if add_src + repo + end + end + end +end + +Chef::Provider::Noop.provides :apt_repository +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_update.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_update.rb new file mode 100644 index 0000000..677cb57 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_update.rb @@ -0,0 +1,105 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider/apt_update' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/provider" +require "chef_compat/copied_from_chef/chef/provider/noop" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + class AptUpdate < (defined?(::Chef::Provider::AptUpdate) ? ::Chef::Provider::AptUpdate : Chef::Provider) + use_inline_resources + + extend Chef::Mixin::Which + + provides :apt_update do + which("apt-get") + end + + APT_CONF_DIR = "/etc/apt/apt.conf.d" + STAMP_DIR = "/var/lib/apt/periodic" + + def whyrun_supported? + true + end + + def load_current_resource + end + + action :periodic do + if !apt_up_to_date? + converge_by "update new lists of packages" do + do_update + end + end + end + + action :update do + converge_by "force update new lists of packages" do + do_update + end + end + + private + + # Determines whether we need to run `apt-get update` + # + # @return [Boolean] + def apt_up_to_date? + ::File.exist?("#{STAMP_DIR}/update-success-stamp") && + ::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency + end + + def do_update + [STAMP_DIR, APT_CONF_DIR].each do |d| + declare_resource(:directory, d) do + recursive true + end + end + + declare_resource(:file, "#{APT_CONF_DIR}/15update-stamp") do + content "APT::Update::Post-Invoke-Success {\"touch #{STAMP_DIR}/update-success-stamp 2>/dev/null || true\";};\n" + action :create_if_missing + end + + declare_resource(:execute, "apt-get -q update") + end + + end + end +end + +Chef::Provider::Noop.provides :apt_update +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/noop.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/noop.rb new file mode 100644 index 0000000..87c34e6 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/noop.rb @@ -0,0 +1,56 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider/noop' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + class Noop < (defined?(::Chef::Provider::Noop) ? ::Chef::Provider::Noop : Chef::Provider) + def load_current_resource; end + + def respond_to_missing?(method_sym, include_private = false) + method_sym.to_s.start_with?("action_") || super + end + + def method_missing(method_sym, *arguments, &block) + if method_sym.to_s =~ /^action_/ + Chef::Log.debug("NoOp-ing for #{method_sym}") + else + super + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/systemd_unit.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/systemd_unit.rb new file mode 100644 index 0000000..1024cb8 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/systemd_unit.rb @@ -0,0 +1,253 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider/systemd_unit' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Nathan Williams () +# Copyright:: Copyright 2016, Nathan Williams +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/provider" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + class SystemdUnit < (defined?(::Chef::Provider::SystemdUnit) ? ::Chef::Provider::SystemdUnit : Chef::Provider) + include Chef::Mixin::Which + include Chef::Mixin::ShellOut + + provides :systemd_unit, os: "linux" + + def load_current_resource + @current_resource = Chef::Resource::SystemdUnit.new(new_resource.name) + + current_resource.content(::File.read(unit_path)) if ::File.exist?(unit_path) + current_resource.user(new_resource.user) + current_resource.enabled(enabled?) + current_resource.active(active?) + current_resource.masked(masked?) + current_resource.static(static?) + current_resource.triggers_reload(new_resource.triggers_reload) + + current_resource + end + + def define_resource_requirements + super + + requirements.assert(:create) do |a| + a.assertion { IniParse.parse(new_resource.to_ini) } + a.failure_message "Unit content is not valid INI text" + end + end + + def action_create + if current_resource.content != new_resource.to_ini + converge_by("creating unit: #{new_resource.name}") do + manage_unit_file(:create) + daemon_reload if new_resource.triggers_reload + end + end + end + + def action_delete + if ::File.exist?(unit_path) + converge_by("deleting unit: #{new_resource.name}") do + manage_unit_file(:delete) + daemon_reload if new_resource.triggers_reload + end + end + end + + def action_enable + if current_resource.static + Chef::Log.debug("#{new_resource.name} is a static unit, enabling is a NOP.") + end + + unless current_resource.enabled || current_resource.static + converge_by("enabling unit: #{new_resource.name}") do + systemctl_execute!(:enable, new_resource.name) + end + end + end + + def action_disable + if current_resource.static + Chef::Log.debug("#{new_resource.name} is a static unit, disabling is a NOP.") + end + + if current_resource.enabled && !current_resource.static + converge_by("disabling unit: #{new_resource.name}") do + systemctl_execute!(:disable, new_resource.name) + end + end + end + + def action_mask + unless current_resource.masked + converge_by("masking unit: #{new_resource.name}") do + systemctl_execute!(:mask, new_resource.name) + end + end + end + + def action_unmask + if current_resource.masked + converge_by("unmasking unit: #{new_resource.name}") do + systemctl_execute!(:unmask, new_resource.name) + end + end + end + + def action_start + unless current_resource.active + converge_by("starting unit: #{new_resource.name}") do + systemctl_execute!(:start, new_resource.name) + end + end + end + + def action_stop + if current_resource.active + converge_by("stopping unit: #{new_resource.name}") do + systemctl_execute!(:stop, new_resource.name) + end + end + end + + def action_restart + converge_by("restarting unit: #{new_resource.name}") do + systemctl_execute!(:restart, new_resource.name) + end + end + + def action_reload + if current_resource.active + converge_by("reloading unit: #{new_resource.name}") do + systemctl_execute!(:reload, new_resource.name) + end + else + Chef::Log.debug("#{new_resource.name} is not active, skipping reload.") + end + end + + def action_try_restart + converge_by("try-restarting unit: #{new_resource.name}") do + systemctl_execute!("try-restart", new_resource.name) + end + end + + def action_reload_or_restart + converge_by("reload-or-restarting unit: #{new_resource.name}") do + systemctl_execute!("reload-or-restart", new_resource.name) + end + end + + def action_reload_or_try_restart + converge_by("reload-or-try-restarting unit: #{new_resource.name}") do + systemctl_execute!("reload-or-try-restart", new_resource.name) + end + end + + def active? + systemctl_execute("is-active", new_resource.name).exitstatus == 0 + end + + def enabled? + systemctl_execute("is-enabled", new_resource.name).exitstatus == 0 + end + + def masked? + systemctl_execute(:status, new_resource.name).stdout.include?("masked") + end + + def static? + systemctl_execute("is-enabled", new_resource.name).stdout.include?("static") + end + + private + + def unit_path + if new_resource.user + "/etc/systemd/user/#{new_resource.name}" + else + "/etc/systemd/system/#{new_resource.name}" + end + end + + def manage_unit_file(action = :nothing) + Chef::Resource::File.new(unit_path, run_context).tap do |f| + f.owner "root" + f.group "root" + f.mode "0644" + f.content new_resource.to_ini + end.run_action(action) + end + + def daemon_reload + shell_out_with_systems_locale!("#{systemctl_path} daemon-reload") + end + + def systemctl_execute!(action, unit) + shell_out_with_systems_locale!("#{systemctl_cmd} #{action} #{unit}", systemctl_opts) + end + + def systemctl_execute(action, unit) + shell_out("#{systemctl_cmd} #{action} #{unit}", systemctl_opts) + end + + def systemctl_cmd + @systemctl_cmd ||= "#{systemctl_path} #{systemctl_args}" + end + + def systemctl_path + @systemctl_path ||= which("systemctl") + end + + def systemctl_args + @systemctl_args ||= new_resource.user ? "--user" : "--system" + end + + def systemctl_opts + @systemctl_opts ||= + if new_resource.user + { + :user => new_resource.user, + :environment => { + "DBUS_SESSION_BUS_ADDRESS" => "unix:path=/run/user/#{node['etc']['passwd'][new_resource.user]['uid']}/bus", + }, + } + else + {} + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/yum_repository.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/yum_repository.rb new file mode 100644 index 0000000..bfe415e --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/yum_repository.rb @@ -0,0 +1,137 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/provider/yum_repository' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" +require "chef_compat/copied_from_chef/chef/dsl/declare_resource" +require "chef_compat/copied_from_chef/chef/provider/noop" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Provider < (defined?(::Chef::Provider) ? ::Chef::Provider : Object) + class YumRepository < (defined?(::Chef::Provider::YumRepository) ? ::Chef::Provider::YumRepository : Chef::Provider) + use_inline_resources + + extend Chef::Mixin::Which + + provides :yum_repository do + which "yum" + end + + def whyrun_supported?; true; end + + def load_current_resource; end + + action :create do + declare_resource(:template, "/etc/yum.repos.d/#{new_resource.repositoryid}.repo") do + if template_available?(new_resource.source) + source new_resource.source + else + source ::File.expand_path("../support/yum_repo.erb", __FILE__) + local true + end + sensitive new_resource.sensitive + variables(config: new_resource) + mode new_resource.mode + if new_resource.make_cache + notifies :run, "execute[yum clean metadata #{new_resource.repositoryid}]", :immediately if new_resource.clean_metadata || new_resource.clean_headers + notifies :run, "execute[yum-makecache-#{new_resource.repositoryid}]", :immediately + notifies :create, "ruby_block[yum-cache-reload-#{new_resource.repositoryid}]", :immediately + end + end + + declare_resource(:execute, "yum clean metadata #{new_resource.repositoryid}") do + command "yum clean metadata --disablerepo=* --enablerepo=#{new_resource.repositoryid}" + action :nothing + end + + # get the metadata for this repo only + declare_resource(:execute, "yum-makecache-#{new_resource.repositoryid}") do + command "yum -q -y makecache --disablerepo=* --enablerepo=#{new_resource.repositoryid}" + action :nothing + only_if { new_resource.enabled } + end + + # reload internal Chef yum cache + declare_resource(:ruby_block, "yum-cache-reload-#{new_resource.repositoryid}") do + block { Chef::Provider::Package::Yum::YumCache.instance.reload } + action :nothing + end + end + + action :delete do + declare_resource(:file, "/etc/yum.repos.d/#{new_resource.repositoryid}.repo") do + action :delete + notifies :run, "execute[yum clean all #{new_resource.repositoryid}]", :immediately + notifies :create, "ruby_block[yum-cache-reload-#{new_resource.repositoryid}]", :immediately + end + + declare_resource(:execute, "yum clean all #{new_resource.repositoryid}") do + command "yum clean all --disablerepo=* --enablerepo=#{new_resource.repositoryid}" + only_if "yum repolist | grep -P '^#{new_resource.repositoryid}([ \t]|$)'" + action :nothing + end + + declare_resource(:ruby_block, "yum-cache-reload-#{new_resource.repositoryid}") do + block { Chef::Provider::Package::Yum::YumCache.instance.reload } + action :nothing + end + end + + action :makecache do + declare_resource(:execute, "yum-makecache-#{new_resource.repositoryid}") do + command "yum -q -y makecache --disablerepo=* --enablerepo=#{new_resource.repositoryid}" + action :run + only_if { new_resource.enabled } + end + + declare_resource(:ruby_block, "yum-cache-reload-#{new_resource.repositoryid}") do + block { Chef::Provider::Package::Yum::YumCache.instance.reload } + action :run + end + end + + alias_method :action_add, :action_create + alias_method :action_remove, :action_delete + + def template_available?(path) + !path.nil? && run_context.has_template_in_cookbook?(new_resource.cookbook_name, path) + end + + end + end +end + +Chef::Provider::Noop.provides :yum_repository +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource.rb new file mode 100644 index 0000000..e5c9a14 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource.rb @@ -0,0 +1,214 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +require "chef_compat/copied_from_chef/chef/resource/action_class" +require "chef_compat/copied_from_chef/chef/provider" +require "chef_compat/copied_from_chef/chef/mixin/properties" +require "chef_compat/copied_from_chef/chef/dsl/universal" +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object) + include Chef::Mixin::Properties + property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(", ") : v.to_s }, desired_state: false + def initialize(name, run_context = nil) +super if defined?(::Chef::Resource) + name(name) unless name.nil? + @run_context = run_context + @noop = nil + @before = nil + @params = Hash.new + @provider = nil + @allowed_actions = self.class.allowed_actions.to_a + @action = self.class.default_action + @updated = false + @updated_by_last_action = false + @supports = {} + @ignore_failure = false + @retries = 0 + @retry_delay = 2 + @not_if = [] + @only_if = [] + @source_line = nil + # We would like to raise an error when the user gives us a guard + # interpreter and a ruby_block to the guard. In order to achieve this + # we need to understand when the user overrides the default guard + # interpreter. Therefore we store the default separately in a different + # attribute. + @guard_interpreter = nil + @default_guard_interpreter = :default + @elapsed_time = 0 + @sensitive = false + end + def action(arg = nil) + if arg + arg = Array(arg).map(&:to_sym) + arg.each do |action| + validate( + { action: action }, + { action: { kind_of: Symbol, equal_to: allowed_actions } } + ) + end + @action = arg + else + @action + end + end + alias_method :action=, :action + class UnresolvedSubscribes < (defined?(::Chef::Resource::UnresolvedSubscribes) ? ::Chef::Resource::UnresolvedSubscribes : self) + alias_method :to_s, :name + alias_method :declared_key, :name + end + def state_for_resource_reporter + state = {} + state_properties = self.class.state_properties + state_properties.each do |property| + if property.identity? || property.is_set?(self) + state[property.name] = property.sensitive? ? "*sensitive value suppressed*" : send(property.name) + end + end + state + end + alias_method :state, :state_for_resource_reporter + def identity + result = {} + identity_properties = self.class.identity_properties + identity_properties.each do |property| + result[property.name] = send(property.name) + end + return result.values.first if identity_properties.size == 1 + result + end + attr_reader :resource_initializing + def resource_initializing=(value) + if value + @resource_initializing = true + else + remove_instance_variable(:@resource_initializing) + end + end + def to_hash + # Grab all current state, then any other ivars (backcompat) + result = {} + self.class.state_properties.each do |p| + result[p.name] = p.get(self) + end + safe_ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS + safe_ivars.each do |iv| + key = iv.to_s.sub(/^@/, "").to_sym + next if result.has_key?(key) + result[key] = instance_variable_get(iv) + end + result + end + def self.identity_property(name = nil) + result = identity_properties(*Array(name)) + if result.size > 1 + raise Chef::Exceptions::MultipleIdentityError, "identity_property cannot be called on an object with more than one identity property (#{result.map { |r| r.name }.join(", ")})." + end + result.first + end + attr_accessor :allowed_actions + def allowed_actions(value = NOT_PASSED) + if value != NOT_PASSED + self.allowed_actions = value + end + @allowed_actions + end + def resource_name + @resource_name || self.class.resource_name + end + def self.use_automatic_resource_name + automatic_name = convert_to_snake_case(self.name.split("::")[-1]) + resource_name automatic_name + end + def self.allowed_actions(*actions) + @allowed_actions ||= + if superclass.respond_to?(:allowed_actions) + superclass.allowed_actions.dup + else + [ :nothing ] + end + @allowed_actions |= actions.flatten + end + def self.allowed_actions=(value) + @allowed_actions = value.uniq + end + def self.default_action(action_name = NOT_PASSED) + unless action_name.equal?(NOT_PASSED) + @default_action = Array(action_name).map(&:to_sym) + self.allowed_actions |= @default_action + end + + if @default_action + @default_action + elsif superclass.respond_to?(:default_action) + superclass.default_action + else + [:nothing] + end + end + def self.default_action=(action_name) + default_action action_name + end + def self.action(action, &recipe_block) + action = action.to_sym + declare_action_class + action_class.action(action, &recipe_block) + self.allowed_actions += [ action ] + default_action action if Array(default_action) == [:nothing] + end + def self.load_current_value(&load_block) + define_method(:load_current_value!, &load_block) + end + def current_value_does_not_exist! + raise Chef::Exceptions::CurrentValueDoesNotExist + end + def self.action_class(&block) + return @action_class if @action_class && !block + # If the superclass needed one, then we need one as well. + if block || (superclass.respond_to?(:action_class) && superclass.action_class) + @action_class = declare_action_class(&block) + end + @action_class + end + def self.declare_action_class(&block) + @action_class ||= begin + if superclass.respond_to?(:action_class) + base_provider = superclass.action_class + end + base_provider ||= Chef::Provider + + resource_class = self + Class.new(base_provider) do + include ActionClass + self.resource_class = resource_class + end + end + @action_class.class_eval(&block) if block + @action_class + end + FORBIDDEN_IVARS = [:@run_context, :@not_if, :@only_if, :@enclosing_provider] + HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider] + class << self + end + @@sorted_descendants = nil + module DeprecatedLWRPClass + CopiedFromChef.extend_chef_module(::Chef::Resource::DeprecatedLWRPClass, self) if defined?(::Chef::Resource::DeprecatedLWRPClass) + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/action_class.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/action_class.rb new file mode 100644 index 0000000..20ff8e5 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/action_class.rb @@ -0,0 +1,114 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource/action_class' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: John Keiser ("} action #{action ? action.inspect : ""}" + end + + def whyrun_supported? + true + end + + # + # If load_current_value! is defined on the resource, use that. + # + def load_current_resource + if new_resource.respond_to?(:load_current_value!) + # dup the resource and then reset desired-state properties. + current_resource = new_resource.dup + + # We clear desired state in the copy, because it is supposed to be actual state. + # We keep identity properties and non-desired-state, which are assumed to be + # "control" values like `recurse: true` + current_resource.class.properties.each do |name, property| + if property.desired_state? && !property.identity? && !property.name_property? + property.reset(current_resource) + end + end + + # Call the actual load_current_value! method. If it raises + # CurrentValueDoesNotExist, set current_resource to `nil`. + begin + # If the user specifies load_current_value do |desired_resource|, we + # pass in the desired resource as well as the current one. + if current_resource.method(:load_current_value!).arity > 0 + current_resource.load_current_value!(new_resource) + else + current_resource.load_current_value! + end + rescue Chef::Exceptions::CurrentValueDoesNotExist + current_resource = nil + end + end + + @current_resource = current_resource + end + + def self.included(other) + other.extend(ClassMethods) + other.use_inline_resources + other.include_resource_dsl true + end + + module ClassMethods + CopiedFromChef.extend_chef_module(::Chef::Resource::ActionClass::ClassMethods, self) if defined?(::Chef::Resource::ActionClass::ClassMethods) + # + # The Chef::Resource class this ActionClass was declared against. + # + # @return [Class] The Chef::Resource class this ActionClass was declared against. + # + attr_accessor :resource_class + + def to_s + "#{resource_class} action provider" + end + + def inspect + to_s + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_repository.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_repository.rb new file mode 100644 index 0000000..1580fad --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_repository.rb @@ -0,0 +1,66 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource/apt_repository' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object) + class AptRepository < (defined?(::Chef::Resource::AptRepository) ? ::Chef::Resource::AptRepository : Chef::Resource) + resource_name :apt_repository + provides :apt_repository + + property :repo_name, String, name_property: true + property :uri, String + property :distribution, [ String, nil, false ], default: lazy { node["lsb"]["codename"] }, nillable: true, coerce: proc { |x| x ? x : nil } + property :components, Array, default: [] + property :arch, [String, nil, false], default: nil, nillable: true, coerce: proc { |x| x ? x : nil } + property :trusted, [TrueClass, FalseClass], default: false + # whether or not to add the repository as a source repo, too + property :deb_src, [TrueClass, FalseClass], default: false + property :keyserver, [String, nil, false], default: "keyserver.ubuntu.com", nillable: true, coerce: proc { |x| x ? x : nil } + property :key, [String, nil, false], default: nil, nillable: true, coerce: proc { |x| x ? x : nil } + property :key_proxy, [String, nil, false], default: nil, nillable: true, coerce: proc { |x| x ? x : nil } + + property :cookbook, [String, nil, false], default: nil, desired_state: false, nillable: true, coerce: proc { |x| x ? x : nil } + property :cache_rebuild, [TrueClass, FalseClass], default: true, desired_state: false + property :sensitive, [TrueClass, FalseClass], default: false, desired_state: false + + default_action :add + allowed_actions :add, :remove + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_update.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_update.rb new file mode 100644 index 0000000..31f5dc3 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_update.rb @@ -0,0 +1,52 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource/apt_update' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object) + class AptUpdate < (defined?(::Chef::Resource::AptUpdate) ? ::Chef::Resource::AptUpdate : Chef::Resource) + resource_name :apt_update + provides :apt_update, os: "linux" + + property :frequency, Integer, default: 86_400 + + default_action :periodic + allowed_actions :update, :periodic + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/systemd_unit.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/systemd_unit.rb new file mode 100644 index 0000000..5f9f458 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/systemd_unit.rb @@ -0,0 +1,81 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource/systemd_unit' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Nathan Williams () +# Copyright:: Copyright 2016, Nathan Williams +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object) + class SystemdUnit < (defined?(::Chef::Resource::SystemdUnit) ? ::Chef::Resource::SystemdUnit : Chef::Resource) + resource_name :systemd_unit + + default_action :nothing + allowed_actions :create, :delete, + :enable, :disable, + :mask, :unmask, + :start, :stop, + :restart, :reload, + :try_restart, :reload_or_restart, + :reload_or_try_restart + + property :enabled, [TrueClass, FalseClass] + property :active, [TrueClass, FalseClass] + property :masked, [TrueClass, FalseClass] + property :static, [TrueClass, FalseClass] + property :user, String, desired_state: false + property :content, [String, Hash] + property :triggers_reload, [TrueClass, FalseClass], + default: true, desired_state: false + + def to_ini + case content + when Hash + IniParse.gen do |doc| + content.each_pair do |sect, opts| + doc.section(sect) do |section| + opts.each_pair do |opt, val| + section.option(opt, val) + end + end + end + end.to_s + else + content.to_s + end + end + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/yum_repository.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/yum_repository.rb new file mode 100644 index 0000000..278211b --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/yum_repository.rb @@ -0,0 +1,98 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource/yum_repository' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Thom May () +# Copyright:: Copyright (c) 2016 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef_compat/copied_from_chef/chef/resource" + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class Resource < (defined?(::Chef::Resource) ? ::Chef::Resource : Object) + class YumRepository < (defined?(::Chef::Resource::YumRepository) ? ::Chef::Resource::YumRepository : Chef::Resource) + resource_name :yum_repository + provides :yum_repository + + # http://linux.die.net/man/5/yum.conf + property :baseurl, String, regex: /.*/ + property :cost, String, regex: /^\d+$/ + property :clean_headers, [TrueClass, FalseClass], default: false # deprecated + property :clean_metadata, [TrueClass, FalseClass], default: true + property :description, String, regex: /.*/, default: "Yum Repository" + property :enabled, [TrueClass, FalseClass], default: true + property :enablegroups, [TrueClass, FalseClass] + property :exclude, String, regex: /.*/ + property :failovermethod, String, equal_to: %w{priority roundrobin} + property :fastestmirror_enabled, [TrueClass, FalseClass] + property :gpgcheck, [TrueClass, FalseClass], default: true + property :gpgkey, [String, Array], regex: /.*/ + property :http_caching, String, equal_to: %w{packages all none} + property :include_config, String, regex: /.*/ + property :includepkgs, String, regex: /.*/ + property :keepalive, [TrueClass, FalseClass] + property :make_cache, [TrueClass, FalseClass], default: true + property :max_retries, [String, Integer] + property :metadata_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/, /never/] + property :mirrorexpire, String, regex: /.*/ + property :mirrorlist, String, regex: /.*/ + property :mirror_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/] + property :mirrorlist_expire, String, regex: [/^\d+$/, /^\d+[mhd]$/] + property :mode, default: "0644" + property :priority, String, regex: /^(\d?[0-9]|[0-9][0-9])$/ + property :proxy, String, regex: /.*/ + property :proxy_username, String, regex: /.*/ + property :proxy_password, String, regex: /.*/ + property :username, String, regex: /.*/ + property :password, String, regex: /.*/ + property :repo_gpgcheck, [TrueClass, FalseClass] + property :report_instanceid, [TrueClass, FalseClass] + property :repositoryid, String, regex: /.*/, name_attribute: true + property :sensitive, [TrueClass, FalseClass], default: false + property :skip_if_unavailable, [TrueClass, FalseClass] + property :source, String, regex: /.*/ + property :sslcacert, String, regex: /.*/ + property :sslclientcert, String, regex: /.*/ + property :sslclientkey, String, regex: /.*/ + property :sslverify, [TrueClass, FalseClass] + property :timeout, String, regex: /^\d+$/ + property :options, Hash + + default_action :create + allowed_actions :create, :remove, :makecache, :add, :delete + + # provide compatibility with the yum cookbook < 3.0 properties + alias_method :url, :baseurl + alias_method :keyurl, :gpgkey + end + end +end +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource_builder.rb b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource_builder.rb new file mode 100644 index 0000000..688e856 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource_builder.rb @@ -0,0 +1,174 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +begin + require 'chef/resource_builder' +rescue LoadError; end + +require 'chef_compat/copied_from_chef' +class Chef +module ::ChefCompat +module CopiedFromChef +# +# Author:: Lamont Granquist () +# Copyright:: Copyright 2015-2016, Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +# NOTE: this was extracted from the Recipe DSL mixin, relevant specs are in spec/unit/recipe_spec.rb + +class Chef < (defined?(::Chef) ? ::Chef : Object) + class ResourceBuilder < (defined?(::Chef::ResourceBuilder) ? ::Chef::ResourceBuilder : Object) + attr_reader :type + attr_reader :name + attr_reader :created_at + attr_reader :params + attr_reader :run_context + attr_reader :cookbook_name + attr_reader :recipe_name + attr_reader :enclosing_provider + attr_reader :resource + + # FIXME (ruby-2.1 syntax): most of these are mandatory + def initialize(type: nil, name: nil, created_at: nil, params: nil, run_context: nil, cookbook_name: nil, recipe_name: nil, enclosing_provider: nil) +super if defined?(::Chef::ResourceBuilder) + @type = type + @name = name + @created_at = created_at + @params = params + @run_context = run_context + @cookbook_name = cookbook_name + @recipe_name = recipe_name + @enclosing_provider = enclosing_provider + end + + def build(&block) + raise ArgumentError, "You must supply a name when declaring a #{type} resource" if name.nil? + + @resource = resource_class.new(name, run_context) + if resource.resource_name.nil? + raise Chef::Exceptions::InvalidResourceSpecification, "#{resource}.resource_name is `nil`! Did you forget to put `provides :blah` or `resource_name :blah` in your resource class?" + end + resource.source_line = created_at + resource.declared_type = type + + # If we have a resource like this one, we want to steal its state + # This behavior is very counter-intuitive and should be removed. + # See CHEF-3694, https://tickets.opscode.com/browse/CHEF-3694 + # Moved to this location to resolve CHEF-5052, https://tickets.opscode.com/browse/CHEF-5052 + if prior_resource + resource.load_from(prior_resource) + end + + resource.cookbook_name = cookbook_name + resource.recipe_name = recipe_name + # Determine whether this resource is being created in the context of an enclosing Provider + resource.enclosing_provider = enclosing_provider + + # XXX: this is required for definition params inside of the scope of a + # subresource to work correctly. + resource.params = params + + # Evaluate resource attribute DSL + if block_given? + resource.resource_initializing = true + begin + resource.instance_eval(&block) + ensure + resource.resource_initializing = false + end + end + + # emit a cloned resource warning if it is warranted + if prior_resource + if is_trivial_resource?(prior_resource) && identicalish_resources?(prior_resource, resource) + emit_harmless_cloning_debug + else + emit_cloned_resource_warning + end + end + + # Run optional resource hook + resource.after_created + + resource + end + + private + + def resource_class + # Checks the new platform => short_name => resource mapping initially + # then fall back to the older approach (Chef::Resource.const_get) for + # backward compatibility + @resource_class ||= Chef::Resource.resource_for_node(type, run_context.node) + end + + def is_trivial_resource?(resource) + trivial_resource = resource_class.new(name, run_context) + # force un-lazy the name property on the created trivial resource + name_property = resource_class.properties.find { |sym, p| p.name_property? } + trivial_resource.send(name_property[0]) unless name_property.nil? + identicalish_resources?(trivial_resource, resource) + end + + # this is an equality test specific to checking for 3694 cloning warnings + def identicalish_resources?(first, second) + skipped_ivars = [ :@source_line, :@cookbook_name, :@recipe_name, :@params, :@elapsed_time, :@declared_type ] + checked_ivars = ( first.instance_variables | second.instance_variables ) - skipped_ivars + non_matching_ivars = checked_ivars.reject do |iv| + if iv == :@action && ( [first.instance_variable_get(iv)].flatten == [:nothing] || [second.instance_variable_get(iv)].flatten == [:nothing] ) + # :nothing action on either side of the comparison always matches + true + else + first.instance_variable_get(iv) == second.instance_variable_get(iv) + end + end + Chef::Log.debug("ivars which did not match with the prior resource: #{non_matching_ivars}") + non_matching_ivars.empty? + end + + def emit_cloned_resource_warning + message = "Cloning resource attributes for #{resource} from prior resource (CHEF-3694)" + message << "\nPrevious #{prior_resource}: #{prior_resource.source_line}" if prior_resource.source_line + message << "\nCurrent #{resource}: #{resource.source_line}" if resource.source_line + Chef.log_deprecation(message) + end + + def emit_harmless_cloning_debug + Chef::Log.debug("Harmless resource cloning from #{prior_resource}:#{prior_resource.source_line} to #{resource}:#{resource.source_line}") + end + + def prior_resource + @prior_resource ||= + begin + key = "#{type}[#{name}]" + run_context.resource_collection.lookup_local(key) + rescue Chef::Exceptions::ResourceNotFound + nil + end + end + + end +end + +require "chef_compat/copied_from_chef/chef/resource" +end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/mixin/properties.rb b/cookbooks/compat_resource/files/lib/chef_compat/mixin/properties.rb new file mode 100644 index 0000000..a3920d1 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/mixin/properties.rb @@ -0,0 +1,8 @@ +require 'chef_compat/monkeypatches' +require 'chef_compat/copied_from_chef/chef/mixin/properties' + +module ChefCompat + module Mixin + Properties = ChefCompat::CopiedFromChef::Chef::Mixin::Properties + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches.rb new file mode 100644 index 0000000..9ac83e8 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches.rb @@ -0,0 +1,41 @@ +class Chef + class RunContext + class ChildRunContext < RunContext + # magic that lets us re-parse the ChildRunContext without erroring due to + # cheffish and chef-provisioning hooks having been loaded (on old versions of + # chef-client without the lazy hooks for those gems) + @__skip_method_checking = true + end + end +end + +# fix to quiet constant redefined warnings +if defined?(Chef::RunContext::ChildRunContext::CHILD_STATE) + Chef::RunContext::ChildRunContext.send(:remove_const, :CHILD_STATE) +end + +require 'chef_compat/monkeypatches/chef' +require 'chef_compat/monkeypatches/chef/exceptions' +require 'chef_compat/monkeypatches/chef/log' +require 'chef_compat/monkeypatches/chef/node' +require 'chef_compat/monkeypatches/chef/mixin/params_validate' +require 'chef_compat/monkeypatches/chef/property' +require 'chef_compat/monkeypatches/chef/provider' +require 'chef_compat/monkeypatches/chef/recipe' # copied from chef +require 'chef_compat/monkeypatches/chef/recipe_hook' +require 'chef_compat/monkeypatches/chef/resource' +require 'chef_compat/monkeypatches/chef/resource_builder' +require 'chef_compat/monkeypatches/chef/resource/lwrp_base' +require 'chef_compat/monkeypatches/chef/resource_collection' +require 'chef_compat/monkeypatches/chef/resource_collection/resource_list' +require 'chef_compat/monkeypatches/chef/resource_collection/resource_set' +require 'chef_compat/monkeypatches/chef/run_context' # copied from chef +require 'chef_compat/monkeypatches/chef/runner' # copied from chef + +# fix for Chef::RunContext instance that has already been created +ObjectSpace.each_object(Chef::RunContext) do |run_context| + run_context.node.run_context = run_context + run_context.instance_variable_set(:@loaded_recipes_hash, {}) + run_context.instance_variable_set(:@loaded_attributes_hash, {}) + run_context.initialize_child_state +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef.rb new file mode 100644 index 0000000..9669f6a --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef.rb @@ -0,0 +1,33 @@ +class Chef + NOT_PASSED = Object.new if !defined?(NOT_PASSED) + # Earlier versions of Chef didn't have this message + module ChefCompatDeprecation + def log_deprecation(message, location=nil) + if !location + # Pick the first caller that is *not* part of the Chef or ChefCompat gem, + # that's the thing the user wrote. + chef_compat_gem_path = File.expand_path("../../..", __FILE__) + chef_gem_path = File.expand_path("../..",::Chef::Resource.instance_method(:initialize).source_location[0]) + caller(0..10).each do |c| + if !c.start_with?(chef_gem_path) && !c.start_with?(chef_compat_gem_path) + location = c + break + end + end + end + + begin + super + # Bleagh. `super_method` doesn't exist on older rubies and I haven't + # figured out a way to check for its existence otherwise. + rescue NoMethodError + Chef::Log.warn(message) + end + end + end + + class<= 12.5 && Chef::VERSION.to_f <= 12.8 + require 'chef/mixin/params_validate' + class Chef + module Mixin + module ParamsValidate + class SetOrReturnProperty < Chef::Property + # 12.9 introduced a new optional parameter to `get()` to avoid a nil-set warning. + # When their method gets called with 2 args, we need to ignore and call with 1. + alias_method :_original_get2, :get + def get(resource, *args) + _original_get2(resource) + end + end + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/node.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/node.rb new file mode 100644 index 0000000..93379b0 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/node.rb @@ -0,0 +1,9 @@ +class Chef + class Node + unless method_defined?(:set_cookbook_attribute) + def set_cookbook_attribute + # this implementation deliberately left blank - we don't need to do anything we just need to not fail + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/property.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/property.rb new file mode 100644 index 0000000..2308d32 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/property.rb @@ -0,0 +1,15 @@ +# 12.9 introduced a new optional parameter to `get()` to avoid a nil-set warning. +# We need to mimick it here. +if Chef::VERSION.to_f >= 12.5 && Chef::VERSION.to_f <= 12.8 + require 'chef/property' + class Chef + class Property + # 12.9 introduced a new optional parameter to `get()` to avoid a nil-set warning. + # When their method gets called with 2 args, we need to ignore and call with 1. + alias_method :_original_get, :get + def get(resource, *args) + _original_get(resource) + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/provider.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/provider.rb new file mode 100644 index 0000000..591cedb --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/provider.rb @@ -0,0 +1,65 @@ +require 'chef/provider' +require 'chef/provider/lwrp_base' + +class Chef::Provider + if !defined?(InlineResources) + InlineResources = Chef::Provider::LWRPBase::InlineResources + end + module InlineResources + require 'chef/dsl/recipe' + require 'chef/dsl/platform_introspection' + require 'chef/dsl/data_query' + require 'chef/dsl/include_recipe' + include Chef::DSL::Recipe + include Chef::DSL::PlatformIntrospection + include Chef::DSL::DataQuery + include Chef::DSL::IncludeRecipe + + unless Chef::Provider::InlineResources::ClassMethods.instance_method(:action).source_location[0] =~ /chefspec/ + # Don't override action if chefspec is doing its thing + module ::ChefCompat + module Monkeypatches + module InlineResources + module ClassMethods + def action(name, &block) + super(name) { send("compile_action_#{name}") } + # We put the action in its own method so that super() works. + define_method("compile_action_#{name}", &block) + end + end + end + end + end + module ClassMethods + prepend ChefCompat::Monkeypatches::InlineResources::ClassMethods + end + end + end +end + + +class Chef + class Provider + class LWRPBase < Provider + if defined?(InlineResources) + module InlineResources + # since we upgrade the Chef::Runner and Chef::RunContext globally to >= 12.14 style classes, we need to also + # fix the use_inline_resources LWRPBase wrapper that creates a sub-resource collection with the ugpraded code + # from the Chef::Provider subclasses that do similar things in post-12.5 chef. + def recipe_eval_with_update_check(&block) + old_run_context = run_context + @run_context = run_context.create_child + return_value = instance_eval(&block) + Chef::Runner.new(run_context).converge + return_value + ensure + if run_context.resource_collection.any? { |r| r.updated? } + new_resource.updated_by_last_action(true) + end + @run_context = old_run_context + end + end + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe.rb new file mode 100644 index 0000000..e15ad56 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe.rb @@ -0,0 +1,118 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +if Gem::Requirement.new('< 12.16.14').satisfied_by?(Gem::Version.new(Chef::VERSION)) +#-- +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef/dsl/recipe" +require "chef/mixin/from_file" +require "chef/mixin/deprecation" + +class Chef + # == Chef::Recipe + # A Recipe object is the context in which Chef recipes are evaluated. + class Recipe + attr_accessor :cookbook_name, :recipe_name, :recipe, :params, :run_context + + include Chef::DSL::Recipe + + include Chef::Mixin::FromFile + include Chef::Mixin::Deprecation + + # Parses a potentially fully-qualified recipe name into its + # cookbook name and recipe short name. + # + # For example: + # "aws::elastic_ip" returns [:aws, "elastic_ip"] + # "aws" returns [:aws, "default"] + # "::elastic_ip" returns [ current_cookbook, "elastic_ip" ] + #-- + # TODO: Duplicates functionality of RunListItem + def self.parse_recipe_name(recipe_name, current_cookbook: nil) + case recipe_name + when /(.+?)::(.+)/ + [ $1.to_sym, $2 ] + when /^::(.+)/ + raise "current_cookbook is nil, cannot resolve #{recipe_name}" if current_cookbook.nil? + [ current_cookbook.to_sym, $1 ] + else + [ recipe_name.to_sym, "default" ] + end + end + + def initialize(cookbook_name, recipe_name, run_context) + @cookbook_name = cookbook_name + @recipe_name = recipe_name + @run_context = run_context + # TODO: 5/19/2010 cw/tim: determine whether this can be removed + @params = Hash.new + end + + # Used in DSL mixins + def node + run_context.node + end + + # Used by the DSL to look up resources when executing in the context of a + # recipe. + def resources(*args) + run_context.resource_collection.find(*args) + end + + # This was moved to Chef::Node#tag, redirecting here for compatibility + def tag(*tags) + run_context.node.tag(*tags) + end + + # Returns true if the node is tagged with *all* of the supplied +tags+. + # + # === Parameters + # tags:: A list of tags + # + # === Returns + # true:: If all the parameters are present + # false:: If any of the parameters are missing + def tagged?(*tags) + tags.each do |tag| + return false unless run_context.node.tags.include?(tag) + end + true + end + + # Removes the list of tags from the node. + # + # === Parameters + # tags:: A list of tags + # + # === Returns + # tags:: The current list of run_context.node.tags + def untag(*tags) + tags.each do |tag| + run_context.node.tags.delete(tag) + end + end + end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe_hook.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe_hook.rb new file mode 100644 index 0000000..24aa20f --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe_hook.rb @@ -0,0 +1,20 @@ +require 'chef/recipe' +require 'chef_compat/recipe' + +class Chef::Recipe + # If the cookbook depends on compat_resource, create a ChefCompat::Recipe object + # instead of Chef::Recipe, for the extra goodies. + def self.new(cookbook_name, recipe_name, run_context) + if run_context && + cookbook_name && + recipe_name && + run_context.cookbook_collection && + run_context.cookbook_collection[cookbook_name] && + run_context.cookbook_collection[cookbook_name].metadata.dependencies.has_key?('compat_resource') && + self != ::ChefCompat::Recipe + ::ChefCompat::Recipe.new(cookbook_name, recipe_name, run_context) + else + super + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb new file mode 100644 index 0000000..ef7c068 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb @@ -0,0 +1,129 @@ +# this is NOT an AUTOGENERATED file + +require 'chef/resource' + +class Chef + class Resource + + class UnresolvedSubscribes < self + # The full key ise given as the name in {Resource#subscribes} + alias_method :to_s, :name + alias_method :declared_key, :name + end + + # + # Force a delayed notification into this resource's run_context. + # + # This should most likely be paired with action :nothing + # + # @param arg [Array[Symbol], Symbol] A list of actions (e.g. `:create`) + # + def delayed_action(arg) + arg = Array(arg).map(&:to_sym) + arg.map do |action| + validate( + { action: action }, + { action: { kind_of: Symbol, equal_to: allowed_actions } } + ) + # the resource effectively sends a delayed notification to itself + run_context.add_delayed_action(Notification.new(self, action, self)) + end + end + + def subscribes(action, resources, timing = :delayed) + resources = [resources].flatten + resources.each do |resource| + if resource.is_a?(String) + resource = UnresolvedSubscribes.new(resource, run_context) + end + if resource.run_context.nil? + resource.run_context = run_context + end + resource.notifies(action, self, timing) + end + true + end + + def notifies(action, resource_spec, timing = :delayed) + # when using old-style resources(:template => "/foo.txt") style, you + # could end up with multiple resources. + validate_resource_spec!(resource_spec) + + resources = [ resource_spec ].flatten + resources.each do |resource| + + case timing.to_s + when "delayed" + notifies_delayed(action, resource) + when "immediate", "immediately" + notifies_immediately(action, resource) + when "before" + notifies_before(action, resource) + else + raise ArgumentError, "invalid timing: #{timing} for notifies(#{action}, #{resources.inspect}, #{timing}) resource #{self} "\ + "Valid timings are: :delayed, :immediate, :immediately, :before" + end + end + + true + end + + # + # Iterates over all immediate and delayed notifications, calling + # resolve_resource_reference on each in turn, causing them to + # resolve lazy/forward references. + def resolve_notification_references + run_context.before_notifications(self).each { |n| + n.resolve_resource_reference(run_context.resource_collection) + } + run_context.immediate_notifications(self).each { |n| + n.resolve_resource_reference(run_context.resource_collection) + } + run_context.delayed_notifications(self).each {|n| + n.resolve_resource_reference(run_context.resource_collection) + } + end + + # Helper for #notifies + def notifies_before(action, resource_spec) + run_context.notifies_before(Notification.new(resource_spec, action, self)) + end + + # Helper for #notifies + def notifies_immediately(action, resource_spec) + run_context.notifies_immediately(Notification.new(resource_spec, action, self)) + end + + # Helper for #notifies + def notifies_delayed(action, resource_spec) + run_context.notifies_delayed(Notification.new(resource_spec, action, self)) + end + + # + # Get the current actual value of this resource. + # + # This does not cache--a new value will be returned each time. + # + # @return A new copy of the resource, with values filled in from the actual + # current value. + # + def current_value + provider = provider_for_action(Array(action).first) + if provider.whyrun_mode? && !provider.whyrun_supported? + raise "Cannot retrieve #{self.class.current_resource} in why-run mode: #{provider} does not support why-run" + end + provider.load_current_resource + provider.current_resource + end + + # These methods are necessary for new resources to initialize old ones properly + attr_reader :resource_initializing + def resource_initializing=(value) + if value + @resource_initializing = value + else + remove_instance_variable(:@resource_initializing) + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb new file mode 100644 index 0000000..5f098fd --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb @@ -0,0 +1,60 @@ +require 'chef_compat/resource/lwrp_base' +require 'chef/resource/lwrp_base' + +module ChefCompat + module Monkeypatches + # + # NOTE: LOTS OF METAPROGRAMMING HERE. NOT FOR FAINT OF HEART. + # + + # Add an empty module to Class so we can temporarily override it in build_from_file + module Class + end + class<<::Class + prepend(ChefCompat::Monkeypatches::Class) + end + + module Chef + module Resource + module LWRPBase + def build_from_file(cookbook_name, filename, run_context) + # If the cookbook this LWRP is from depends on compat_resource, fix its LWRPs up real good + if run_context.cookbook_collection[cookbook_name].metadata.dependencies.has_key?('compat_resource') + # All cookbooks do Class.new(Chef::Resource::LWRPBase). Change Class.new + # temporarily to translate Chef::Resource::LWRPBase to ChefCompat::Resource + ChefCompat::Monkeypatches::Class.module_eval do + def new(*args, &block) + # Trick it! Use ChefCompat::Resource instead of Chef::Resource::LWRPBase + if args == [ ::Chef::Resource::LWRPBase ] + ChefCompat::Monkeypatches::Class.module_eval do + remove_method(:new) if method_defined?(:new) + end + args = [ ChefCompat::Resource::LWRPBase ] + end + super(*args, &block) + end + end + + begin + + # Call the actual build_from_file + super + + ensure + class<) +# Copyright:: Copyright 2015-2016, Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +# XXX: we now have two copies of this file in the compat_resource cookbook. I'm uncertain if this is a +# bug or a feature, and I suspect it is actually a feature. The point of this file is that for all +# resources and cookbooks the global Chef::ResourceBuilder class must be upgraded to at least the +# 12.10.24 version. The point of the other copy is that for compat_resource cookbooks all their +# resources should be using the lastest version that has been sync'd. So these two files should +# diverge as times goes on. I believe that is the correct behavior and that we want to have both +# files in this cookbook. + +# NOTE: this was extracted from the Recipe DSL mixin, relevant specs are in spec/unit/recipe_spec.rb + +if Gem::Requirement.new("< 12.10.24").satisfied_by?(Gem::Version.new(Chef::VERSION)) + begin + require 'chef/resource_builder' + # we use the LoadError this creates on early 12.x to not monkeypatch chef client versions that don't have Chef::ResourceBuilder + # (it is lazily included and doesn't appear until compile time so we can't resolve the symbol during library loading) + + class Chef + class ResourceBuilder + attr_reader :type + attr_reader :name + attr_reader :created_at + attr_reader :params + attr_reader :run_context + attr_reader :cookbook_name + attr_reader :recipe_name + attr_reader :enclosing_provider + attr_reader :resource + + # FIXME (ruby-2.1 syntax): most of these are mandatory + def initialize(type:nil, name:nil, created_at: nil, params: nil, run_context: nil, cookbook_name: nil, recipe_name: nil, enclosing_provider: nil) + @type = type + @name = name + @created_at = created_at + @params = params + @run_context = run_context + @cookbook_name = cookbook_name + @recipe_name = recipe_name + @enclosing_provider = enclosing_provider + end + + def build(&block) + raise ArgumentError, "You must supply a name when declaring a #{type} resource" if name.nil? + + @resource = resource_class.new(name, run_context) + if resource.resource_name.nil? + raise Chef::Exceptions::InvalidResourceSpecification, "#{resource}.resource_name is `nil`! Did you forget to put `provides :blah` or `resource_name :blah` in your resource class?" + end + resource.source_line = created_at + resource.declared_type = type + + # If we have a resource like this one, we want to steal its state + # This behavior is very counter-intuitive and should be removed. + # See CHEF-3694, https://tickets.opscode.com/browse/CHEF-3694 + # Moved to this location to resolve CHEF-5052, https://tickets.opscode.com/browse/CHEF-5052 + if prior_resource + resource.load_from(prior_resource) + end + + resource.cookbook_name = cookbook_name + resource.recipe_name = recipe_name + # Determine whether this resource is being created in the context of an enclosing Provider + resource.enclosing_provider = enclosing_provider + + # XXX: this is required for definition params inside of the scope of a + # subresource to work correctly. + resource.params = params + + # Evaluate resource attribute DSL + if block_given? + resource.resource_initializing = true + begin + resource.instance_eval(&block) + ensure + resource.resource_initializing = false + end + end + + # emit a cloned resource warning if it is warranted + if prior_resource + if is_trivial_resource?(prior_resource) && identicalish_resources?(prior_resource, resource) + emit_harmless_cloning_debug + else + emit_cloned_resource_warning + end + end + + # Run optional resource hook + resource.after_created + + resource + end + + private + + def resource_class + # Checks the new platform => short_name => resource mapping initially + # then fall back to the older approach (Chef::Resource.const_get) for + # backward compatibility + @resource_class ||= Chef::Resource.resource_for_node(type, run_context.node) + end + + def is_trivial_resource?(resource) + identicalish_resources?(resource_class.new(name, run_context), resource) + end + + # this is an equality test specific to checking for 3694 cloning warnings + def identicalish_resources?(first, second) + skipped_ivars = [ :@source_line, :@cookbook_name, :@recipe_name, :@params, :@elapsed_time, :@declared_type ] + checked_ivars = ( first.instance_variables | second.instance_variables ) - skipped_ivars + non_matching_ivars = checked_ivars.reject do |iv| + if iv == :@action && ( [first.instance_variable_get(iv)].flatten == [:nothing] || [second.instance_variable_get(iv)].flatten == [:nothing] ) + # :nothing action on either side of the comparison always matches + true + else + first.instance_variable_get(iv) == second.instance_variable_get(iv) + end + end + Chef::Log.debug("ivars which did not match with the prior resource: #{non_matching_ivars}") + non_matching_ivars.empty? + end + + def emit_cloned_resource_warning + Chef::Log.warn("Cloning resource attributes for #{resource} from prior resource (CHEF-3694)") + Chef::Log.warn("Previous #{prior_resource}: #{prior_resource.source_line}") if prior_resource.source_line + Chef::Log.warn("Current #{resource}: #{resource.source_line}") if resource.source_line + end + + def emit_harmless_cloning_debug + Chef::Log.debug("Harmless resource cloning from #{prior_resource}:#{prior_resource.source_line} to #{resource}:#{resource.source_line}") + end + + def prior_resource + @prior_resource ||= + begin + key = "#{type}[#{name}]" + run_context.resource_collection.lookup_local(key) + rescue Chef::Exceptions::ResourceNotFound + nil + end + end + + end + end + rescue LoadError + # cool we're just on early chef 12.x, nothing to do -- we don't have to worry because there's also not parent_run_context pointer, so we don't have to + # use lookup_local to avoid resource cloning shit out of the parent run_context. the resource collection's lookup() method will always use lookup_local + # over lookup_recursive. + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection.rb new file mode 100644 index 0000000..4f07489 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection.rb @@ -0,0 +1,103 @@ +# +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef/resource_collection/resource_set" +require "chef/resource_collection/resource_list" +require "chef/resource_collection" +require "chef/exceptions" + +module ChefCompat + module Monkeypatches + module Chef + module ResourceCollection + module RecursiveNotificationLookup + # + # Copied verbatim from Chef 12.10.24 + # + attr_accessor :run_context + + def initialize(run_context = nil) + super() + @run_context = run_context + end + + def lookup_local(key) + resource_set.lookup(key) + end + + def find_local(*args) + resource_set.find(*args) + end + + def lookup(key) + if run_context.nil? + lookup_local(key) + else + lookup_recursive(run_context, key) + end + end + + def find(*args) + if run_context.nil? + find_local(*args) + else + find_recursive(run_context, *args) + end + end + + private + + def lookup_recursive(rc, key) + rc.resource_collection.send(:resource_set).lookup(key) + rescue ::Chef::Exceptions::ResourceNotFound + raise if !rc.respond_to?(:parent_run_context) || rc.parent_run_context.nil? + lookup_recursive(rc.parent_run_context, key) + end + + def find_recursive(rc, *args) + rc.resource_collection.send(:resource_set).find(*args) + rescue ::Chef::Exceptions::ResourceNotFound + raise if !rc.respond_to?(:parent_run_context) || rc.parent_run_context.nil? + find_recursive(rc.parent_run_context, *args) + end + end + + module DeleteResources + # + # Copied verbatim from Chef 12.10.24 + # + def delete(key) + resource_list.delete(key) + resource_set.delete(key) + end + end + end + end + end +end + + +class Chef::ResourceCollection + unless method_defined?(:lookup_local) + prepend ChefCompat::Monkeypatches::Chef::ResourceCollection::RecursiveNotificationLookup + end + unless method_defined?(:delete) + prepend ChefCompat::Monkeypatches::Chef::ResourceCollection::DeleteResources + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb new file mode 100644 index 0000000..dfbd442 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb @@ -0,0 +1,49 @@ +# +# Author:: Tyler Ball () +# Copyright:: Copyright 2014-2016, Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef/resource_collection/resource_list" +require "chef/exceptions" + +module ChefCompat + module Monkeypatches + module Chef + module ResourceCollection + module ResourceList + module DeleteResource + # Copied verbatim from Chef 12.10.4 + def delete(key) + raise ArgumentError, "Must pass a Chef::Resource or String to delete" unless key.is_a?(String) || key.is_a?(Chef::Resource) + key = key.to_s + ret = @resources.reject! { |r| r.to_s == key } + if ret.nil? + raise ::Chef::Exceptions::ResourceNotFound, "Cannot find a resource matching #{key} (did you define it first?)" + end + ret + end + end + end + end + end + end +end + +class Chef::ResourceCollection::ResourceList + unless method_defined?(:delete) + prepend ChefCompat::Monkeypatches::Chef::ResourceCollection::ResourceList::DeleteResource + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb new file mode 100644 index 0000000..bcead10 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb @@ -0,0 +1,49 @@ +# +# Author:: Tyler Ball () +# Copyright:: Copyright 2014-2016, Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef/resource_collection/resource_list" +require "chef/exceptions" + +module ChefCompat + module Monkeypatches + module Chef + module ResourceCollection + module ResourceSet + module DeleteResource + def delete(key) + raise ArgumentError, "Must pass a Chef::Resource or String to delete" unless key.is_a?(String) || key.is_a?(Chef::Resource) + key = key.to_s + res = @resources_by_key.delete(key) + + if res == @resources_by_key.default + raise Chef::Exceptions::ResourceNotFound, "Cannot find a resource matching #{key} (did you define it first?)" + end + res + end + end + end + end + end + end +end + +class Chef::ResourceCollection::ResourceSet + unless method_defined?(:delete) + prepend ChefCompat::Monkeypatches::Chef::ResourceCollection::ResourceSet::DeleteResource + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/run_context.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/run_context.rb new file mode 100644 index 0000000..27a11d2 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/run_context.rb @@ -0,0 +1,691 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +if Gem::Requirement.new('< 12.16.14').satisfied_by?(Gem::Version.new(Chef::VERSION)) +# +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Author:: Tim Hinderliter () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. + +require "chef/resource_collection" +require "chef/cookbook_version" +require "chef/node" +require "chef/role" +require "chef/log" +require "chef/recipe" +require "chef/run_context/cookbook_compiler" +require "chef/event_dispatch/events_output_stream" +require "forwardable" + +class Chef + + # == Chef::RunContext + # Value object that loads and tracks the context of a Chef run + class RunContext + # + # Global state + # + + # + # The node for this run + # + # @return [Chef::Node] + # + attr_reader :node + + # + # The set of cookbooks involved in this run + # + # @return [Chef::CookbookCollection] + # + attr_reader :cookbook_collection + + # + # Resource Definitions for this run. Populated when the files in + # +definitions/+ are evaluated (this is triggered by #load). + # + # @return [Array[Chef::ResourceDefinition]] + # + attr_reader :definitions + + # + # Event dispatcher for this run. + # + # @return [Chef::EventDispatch::Dispatcher] + # + attr_reader :events + + # + # Hash of factoids for a reboot request. + # + # @return [Hash] + # + attr_accessor :reboot_info + + # + # Scoped state + # + + # + # The parent run context. + # + # @return [Chef::RunContext] The parent run context, or `nil` if this is the + # root context. + # + attr_reader :parent_run_context + + # + # The root run context. + # + # @return [Chef::RunContext] The root run context. + # + def root_run_context + rc = self + rc = rc.parent_run_context until rc.parent_run_context.nil? + rc + end + + # + # The collection of resources intended to be converged (and able to be + # notified). + # + # @return [Chef::ResourceCollection] + # + # @see CookbookCompiler + # + attr_reader :resource_collection + + # + # The list of control groups to execute during the audit phase + # + attr_reader :audits + + # + # Notification handling + # + + # + # A Hash containing the before notifications triggered by resources + # during the converge phase of the chef run. + # + # @return [Hash[String, Array[Chef::Resource::Notification]]] A hash from + # => + # + attr_reader :before_notification_collection + + # + # A Hash containing the immediate notifications triggered by resources + # during the converge phase of the chef run. + # + # @return [Hash[String, Array[Chef::Resource::Notification]]] A hash from + # => + # + attr_reader :immediate_notification_collection + + # + # A Hash containing the delayed (end of run) notifications triggered by + # resources during the converge phase of the chef run. + # + # @return [Hash[String, Array[Chef::Resource::Notification]]] A hash from + # => + # + attr_reader :delayed_notification_collection + + # + # An Array containing the delayed (end of run) notifications triggered by + # resources during the converge phase of the chef run. + # + # @return [Array[Chef::Resource::Notification]] An array of notification objects + # + attr_reader :delayed_actions + + # Creates a new Chef::RunContext object and populates its fields. This object gets + # used by the Chef Server to generate a fully compiled recipe list for a node. + # + # @param node [Chef::Node] The node to run against. + # @param cookbook_collection [Chef::CookbookCollection] The cookbooks + # involved in this run. + # @param events [EventDispatch::Dispatcher] The event dispatcher for this + # run. + # + def initialize(node, cookbook_collection, events) + @node = node + @cookbook_collection = cookbook_collection + @events = events + + node.run_context = self + node.set_cookbook_attribute + + @definitions = Hash.new + @loaded_recipes_hash = {} + @loaded_attributes_hash = {} + @reboot_info = {} + @cookbook_compiler = nil + @delayed_actions = [] + + initialize_child_state + end + + # + # Triggers the compile phase of the chef run. + # + # @param run_list_expansion [Chef::RunList::RunListExpansion] The run list. + # @see Chef::RunContext::CookbookCompiler + # + def load(run_list_expansion) + @cookbook_compiler = CookbookCompiler.new(self, run_list_expansion, events) + cookbook_compiler.compile + end + + # + # Initialize state that applies to both Chef::RunContext and Chef::ChildRunContext + # + def initialize_child_state + @audits = {} + @resource_collection = Chef::ResourceCollection.new(self) + @before_notification_collection = Hash.new { |h, k| h[k] = [] } + @immediate_notification_collection = Hash.new { |h, k| h[k] = [] } + @delayed_notification_collection = Hash.new { |h, k| h[k] = [] } + @delayed_actions = [] + end + + # + # Adds an before notification to the +before_notification_collection+. + # + # @param [Chef::Resource::Notification] The notification to add. + # + def notifies_before(notification) + # Note for the future, notification.notifying_resource may be an instance + # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} + # with a string value. + before_notification_collection[notification.notifying_resource.declared_key] << notification + end + + # + # Adds an immediate notification to the +immediate_notification_collection+. + # + # @param [Chef::Resource::Notification] The notification to add. + # + def notifies_immediately(notification) + # Note for the future, notification.notifying_resource may be an instance + # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} + # with a string value. + immediate_notification_collection[notification.notifying_resource.declared_key] << notification + end + + # + # Adds a delayed notification to the +delayed_notification_collection+. + # + # @param [Chef::Resource::Notification] The notification to add. + # + def notifies_delayed(notification) + # Note for the future, notification.notifying_resource may be an instance + # of Chef::Resource::UnresolvedSubscribes when calling {Resource#subscribes} + # with a string value. + delayed_notification_collection[notification.notifying_resource.declared_key] << notification + end + + # + # Adds a delayed action to the +delayed_actions+. + # + def add_delayed_action(notification) + if delayed_actions.any? { |existing_notification| existing_notification.duplicates?(notification) } + Chef::Log.info( "#{notification.notifying_resource} not queuing delayed action #{notification.action} on #{notification.resource}"\ + " (delayed), as it's already been queued") + else + delayed_actions << notification + end + end + + # + # Get the list of before notifications sent by the given resource. + # + # @return [Array[Notification]] + # + def before_notifications(resource) + return before_notification_collection[resource.declared_key] + end + + # + # Get the list of immediate notifications sent by the given resource. + # + # @return [Array[Notification]] + # + def immediate_notifications(resource) + return immediate_notification_collection[resource.declared_key] + end + + # + # Get the list of delayed (end of run) notifications sent by the given + # resource. + # + # @return [Array[Notification]] + # + def delayed_notifications(resource) + return delayed_notification_collection[resource.declared_key] + end + + # + # Cookbook and recipe loading + # + + # + # Evaluates the recipes +recipe_names+. Used by DSL::IncludeRecipe + # + # @param recipe_names [Array[String]] The list of recipe names (e.g. + # 'my_cookbook' or 'my_cookbook::my_resource'). + # @param current_cookbook The cookbook we are currently running in. + # + # @see DSL::IncludeRecipe#include_recipe + # + def include_recipe(*recipe_names, current_cookbook: nil) + result_recipes = Array.new + recipe_names.flatten.each do |recipe_name| + if result = load_recipe(recipe_name, current_cookbook: current_cookbook) + result_recipes << result + end + end + result_recipes + end + + # + # Evaluates the recipe +recipe_name+. Used by DSL::IncludeRecipe + # + # TODO I am sort of confused why we have both this and include_recipe ... + # I don't see anything different beyond accepting and returning an + # array of recipes. + # + # @param recipe_names [Array[String]] The recipe name (e.g 'my_cookbook' or + # 'my_cookbook::my_resource'). + # @param current_cookbook The cookbook we are currently running in. + # + # @return A truthy value if the load occurred; `false` if already loaded. + # + # @see DSL::IncludeRecipe#load_recipe + # + def load_recipe(recipe_name, current_cookbook: nil) + Chef::Log.debug("Loading recipe #{recipe_name} via include_recipe") + + cookbook_name, recipe_short_name = Chef::Recipe.parse_recipe_name(recipe_name, current_cookbook: current_cookbook) + + if unreachable_cookbook?(cookbook_name) # CHEF-4367 + Chef::Log.warn(<<-ERROR_MESSAGE) +MissingCookbookDependency: +Recipe `#{recipe_name}` is not in the run_list, and cookbook '#{cookbook_name}' +is not a dependency of any cookbook in the run_list. To load this recipe, +first add a dependency on cookbook '#{cookbook_name}' in the cookbook you're +including it from in that cookbook's metadata. +ERROR_MESSAGE + end + + if loaded_fully_qualified_recipe?(cookbook_name, recipe_short_name) + Chef::Log.debug("I am not loading #{recipe_name}, because I have already seen it.") + false + else + loaded_recipe(cookbook_name, recipe_short_name) + node.loaded_recipe(cookbook_name, recipe_short_name) + cookbook = cookbook_collection[cookbook_name] + cookbook.load_recipe(recipe_short_name, self) + end + end + + # + # Load the given recipe from a filename. + # + # @param recipe_file [String] The recipe filename. + # + # @return [Chef::Recipe] The loaded recipe. + # + # @raise [Chef::Exceptions::RecipeNotFound] If the file does not exist. + # + def load_recipe_file(recipe_file) + if !File.exist?(recipe_file) + raise Chef::Exceptions::RecipeNotFound, "could not find recipe file #{recipe_file}" + end + + Chef::Log.debug("Loading recipe file #{recipe_file}") + recipe = Chef::Recipe.new("@recipe_files", recipe_file, self) + recipe.from_file(recipe_file) + recipe + end + + # + # Look up an attribute filename. + # + # @param cookbook_name [String] The cookbook name of the attribute file. + # @param attr_file_name [String] The attribute file's name (not path). + # + # @return [String] The filename. + # + # @see DSL::IncludeAttribute#include_attribute + # + # @raise [Chef::Exceptions::CookbookNotFound] If the cookbook could not be found. + # @raise [Chef::Exceptions::AttributeNotFound] If the attribute file could not be found. + # + def resolve_attribute(cookbook_name, attr_file_name) + cookbook = cookbook_collection[cookbook_name] + raise Chef::Exceptions::CookbookNotFound, "could not find cookbook #{cookbook_name} while loading attribute #{name}" unless cookbook + + attribute_filename = cookbook.attribute_filenames_by_short_filename[attr_file_name] + raise Chef::Exceptions::AttributeNotFound, "could not find filename for attribute #{attr_file_name} in cookbook #{cookbook_name}" unless attribute_filename + + attribute_filename + end + + # + # A list of all recipes that have been loaded. + # + # This is stored internally as a Hash, so ordering is predictable. + # + # TODO is the above statement true in a 1.9+ ruby world? Is it relevant? + # + # @return [Array[String]] A list of recipes in fully qualified form, e.g. + # the recipe "nginx" will be given as "nginx::default". + # + # @see #loaded_recipe? To determine if a particular recipe has been loaded. + # + def loaded_recipes + loaded_recipes_hash.keys + end + + # + # A list of all attributes files that have been loaded. + # + # Stored internally using a Hash, so order is predictable. + # + # TODO is the above statement true in a 1.9+ ruby world? Is it relevant? + # + # @return [Array[String]] A list of attribute file names in fully qualified + # form, e.g. the "nginx" will be given as "nginx::default". + # + def loaded_attributes + loaded_attributes_hash.keys + end + + # + # Find out if a given recipe has been loaded. + # + # @param cookbook [String] Cookbook name. + # @param recipe [String] Recipe name. + # + # @return [Boolean] `true` if the recipe has been loaded, `false` otherwise. + # + def loaded_fully_qualified_recipe?(cookbook, recipe) + loaded_recipes_hash.has_key?("#{cookbook}::#{recipe}") + end + + # + # Find out if a given recipe has been loaded. + # + # @param recipe [String] Recipe name. "nginx" and "nginx::default" yield + # the same results. + # + # @return [Boolean] `true` if the recipe has been loaded, `false` otherwise. + # + def loaded_recipe?(recipe) + cookbook, recipe_name = Chef::Recipe.parse_recipe_name(recipe) + loaded_fully_qualified_recipe?(cookbook, recipe_name) + end + + # + # Mark a given recipe as having been loaded. + # + # @param cookbook [String] Cookbook name. + # @param recipe [String] Recipe name. + # + def loaded_recipe(cookbook, recipe) + loaded_recipes_hash["#{cookbook}::#{recipe}"] = true + end + + # + # Find out if a given attribute file has been loaded. + # + # @param cookbook [String] Cookbook name. + # @param attribute_file [String] Attribute file name. + # + # @return [Boolean] `true` if the recipe has been loaded, `false` otherwise. + # + def loaded_fully_qualified_attribute?(cookbook, attribute_file) + loaded_attributes_hash.has_key?("#{cookbook}::#{attribute_file}") + end + + # + # Mark a given attribute file as having been loaded. + # + # @param cookbook [String] Cookbook name. + # @param attribute_file [String] Attribute file name. + # + def loaded_attribute(cookbook, attribute_file) + loaded_attributes_hash["#{cookbook}::#{attribute_file}"] = true + end + + ## + # Cookbook File Introspection + + # + # Find out if the cookbook has the given template. + # + # @param cookbook [String] Cookbook name. + # @param template_name [String] Template name. + # + # @return [Boolean] `true` if the template is in the cookbook, `false` + # otherwise. + # @see Chef::CookbookVersion#has_template_for_node? + # + def has_template_in_cookbook?(cookbook, template_name) + cookbook = cookbook_collection[cookbook] + cookbook.has_template_for_node?(node, template_name) + end + + # + # Find out if the cookbook has the given file. + # + # @param cookbook [String] Cookbook name. + # @param cb_file_name [String] File name. + # + # @return [Boolean] `true` if the file is in the cookbook, `false` + # otherwise. + # @see Chef::CookbookVersion#has_cookbook_file_for_node? + # + def has_cookbook_file_in_cookbook?(cookbook, cb_file_name) + cookbook = cookbook_collection[cookbook] + cookbook.has_cookbook_file_for_node?(node, cb_file_name) + end + + # + # Find out whether the given cookbook is in the cookbook dependency graph. + # + # @param cookbook_name [String] Cookbook name. + # + # @return [Boolean] `true` if the cookbook is reachable, `false` otherwise. + # + # @see Chef::CookbookCompiler#unreachable_cookbook? + def unreachable_cookbook?(cookbook_name) + cookbook_compiler.unreachable_cookbook?(cookbook_name) + end + + # + # Open a stream object that can be printed into and will dispatch to events + # + # @param name [String] The name of the stream. + # @param options [Hash] Other options for the stream. + # + # @return [EventDispatch::EventsOutputStream] The created stream. + # + # @yield If a block is passed, it will be run and the stream will be closed + # afterwards. + # @yieldparam stream [EventDispatch::EventsOutputStream] The created stream. + # + def open_stream(name: nil, **options) + stream = EventDispatch::EventsOutputStream.new(events, name: name, **options) + if block_given? + begin + yield stream + ensure + stream.close + end + else + stream + end + end + + # there are options for how to handle multiple calls to these functions: + # 1. first call always wins (never change reboot_info once set). + # 2. last call always wins (happily change reboot_info whenever). + # 3. raise an exception on the first conflict. + # 4. disable reboot after this run if anyone ever calls :cancel. + # 5. raise an exception on any second call. + # 6. ? + def request_reboot(reboot_info) + Chef::Log.info "Changing reboot status from #{self.reboot_info.inspect} to #{reboot_info.inspect}" + @reboot_info = reboot_info + end + + def cancel_reboot + Chef::Log.info "Changing reboot status from #{reboot_info.inspect} to {}" + @reboot_info = {} + end + + def reboot_requested? + reboot_info.size > 0 + end + + # + # Create a child RunContext. + # + def create_child + ChildRunContext.new(self) + end + + # @api private + attr_writer :resource_collection + + protected + + attr_reader :cookbook_compiler + attr_reader :loaded_attributes_hash + attr_reader :loaded_recipes_hash + + module Deprecated + ### + # These need to be settable so deploy can run a resource_collection + # independent of any cookbooks via +recipe_eval+ + def audits=(value) + Chef.log_deprecation("Setting run_context.audits will be removed in a future Chef. Use run_context.create_child to create a new RunContext instead.") + @audits = value + end + + def immediate_notification_collection=(value) + Chef.log_deprecation("Setting run_context.immediate_notification_collection will be removed in a future Chef. Use run_context.create_child to create a new RunContext instead.") + @immediate_notification_collection = value + end + + def delayed_notification_collection=(value) + Chef.log_deprecation("Setting run_context.delayed_notification_collection will be removed in a future Chef. Use run_context.create_child to create a new RunContext instead.") + @delayed_notification_collection = value + end + end + prepend Deprecated + + # + # A child run context. Delegates all root context calls to its parent. + # + # @api private + # + class ChildRunContext < RunContext + extend Forwardable + def_delegators :parent_run_context, *%w{ + cancel_reboot + config + cookbook_collection + cookbook_compiler + definitions + events + has_cookbook_file_in_cookbook? + has_template_in_cookbook? + load + loaded_attribute + loaded_attributes + loaded_attributes_hash + loaded_fully_qualified_attribute? + loaded_fully_qualified_recipe? + loaded_recipe + loaded_recipe? + loaded_recipes + loaded_recipes_hash + node + open_stream + reboot_info + reboot_info= + reboot_requested? + request_reboot + resolve_attribute + unreachable_cookbook? + } + + def initialize(parent_run_context) + @parent_run_context = parent_run_context + + # We don't call super, because we don't bother initializing stuff we're + # going to delegate to the parent anyway. Just initialize things that + # every instance needs. + initialize_child_state + end + + CHILD_STATE = %w{ + audits + audits= + create_child + add_delayed_action + delayed_actions + delayed_notification_collection + delayed_notification_collection= + delayed_notifications + immediate_notification_collection + immediate_notification_collection= + immediate_notifications + before_notification_collection + before_notifications + include_recipe + initialize_child_state + load_recipe + load_recipe_file + notifies_before + notifies_immediately + notifies_delayed + parent_run_context + root_run_context + resource_collection + resource_collection= + }.map { |x| x.to_sym } + + # Verify that we didn't miss any methods + unless @__skip_method_checking # hook specifically for compat_resource + missing_methods = superclass.instance_methods(false) - instance_methods(false) - CHILD_STATE + if !missing_methods.empty? + raise "ERROR: not all methods of RunContext accounted for in ChildRunContext! All methods must be marked as child methods with CHILD_STATE or delegated to the parent_run_context. Missing #{missing_methods.join(", ")}." + end + end + end + end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/runner.rb b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/runner.rb new file mode 100644 index 0000000..39fb616 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/runner.rb @@ -0,0 +1,153 @@ +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# +# THIS IS A FILE AUTOGENERATED BY 'rake update' DO NOT EDIT!!!! +# +# NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE +# + +if Gem::Requirement.new('< 12.16.14').satisfied_by?(Gem::Version.new(Chef::VERSION)) +#-- +# Author:: Adam Jacob () +# Author:: Christopher Walters () +# Author:: Tim Hinderliter () +# Copyright:: Copyright 2008-2016, Chef Software Inc. +# License:: Apache License, Version 2.0 +# +# 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. +# + +require "chef/exceptions" +require "chef/mixin/params_validate" +require "chef/node" +require "chef/resource_collection" + +class Chef + # == Chef::Runner + # This class is responsible for executing the steps in a Chef run. + class Runner + + attr_reader :run_context + + include Chef::Mixin::ParamsValidate + + def initialize(run_context) + @run_context = run_context + end + + def delayed_actions + @run_context.delayed_actions + end + + def events + @run_context.events + end + + # Determine the appropriate provider for the given resource, then + # execute it. + def run_action(resource, action, notification_type = nil, notifying_resource = nil) + # If there are any before notifications, why-run the resource + # and notify anyone who needs notifying + before_notifications = run_context.before_notifications(resource) || [] + unless before_notifications.empty? + forced_why_run do + Chef::Log.info("#{resource} running why-run #{action} action to support before action") + resource.run_action(action, notification_type, notifying_resource) + end + + if resource.updated_by_last_action? + before_notifications.each do |notification| + Chef::Log.info("#{resource} sending #{notification.action} action to #{notification.resource} (before)") + run_action(notification.resource, notification.action, :before, resource) + end + resource.updated_by_last_action(false) + end + end + + # Actually run the action for realsies + resource.run_action(action, notification_type, notifying_resource) + + # Execute any immediate and queue up any delayed notifications + # associated with the resource, but only if it was updated *this time* + # we ran an action on it. + if resource.updated_by_last_action? + run_context.immediate_notifications(resource).each do |notification| + Chef::Log.info("#{resource} sending #{notification.action} action to #{notification.resource} (immediate)") + run_action(notification.resource, notification.action, :immediate, resource) + end + + run_context.delayed_notifications(resource).each do |notification| + # send the notification to the run_context of the receiving resource + notification.resource.run_context.add_delayed_action(notification) + end + end + end + + # Iterates over the +resource_collection+ in the +run_context+ calling + # +run_action+ for each resource in turn. + def converge + # Resolve all lazy/forward references in notifications + run_context.resource_collection.each do |resource| + resource.resolve_notification_references + end + + # Execute each resource. + run_context.resource_collection.execute_each_resource do |resource| + Array(resource.action).each { |action| run_action(resource, action) } + end + + rescue Exception => e + Chef::Log.info "Running queued delayed notifications before re-raising exception" + run_delayed_notifications(e) + else + run_delayed_notifications(nil) + true + end + + private + + # Run all our :delayed actions + def run_delayed_notifications(error = nil) + collected_failures = Exceptions::MultipleFailures.new + collected_failures.client_run_failure(error) unless error.nil? + delayed_actions.each do |notification| + result = run_delayed_notification(notification) + if result.kind_of?(Exception) + collected_failures.notification_failure(result) + end + end + collected_failures.raise! + end + + def run_delayed_notification(notification) + Chef::Log.info( "#{notification.notifying_resource} sending #{notification.action}"\ + " action to #{notification.resource} (delayed)") + # Struct of resource/action to call + run_action(notification.resource, notification.action, :delayed) + true + rescue Exception => e + e + end + + # helper to run a block of code with why_run forced to true and then restore it correctly + def forced_why_run + saved = Chef::Config[:why_run] + Chef::Config[:why_run] = true + yield + ensure + Chef::Config[:why_run] = saved + end + + end +end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/property.rb b/cookbooks/compat_resource/files/lib/chef_compat/property.rb new file mode 100644 index 0000000..be21113 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/property.rb @@ -0,0 +1,6 @@ +require 'chef_compat/copied_from_chef/chef/property' + +module ChefCompat + class Property < ChefCompat::CopiedFromChef::Chef::Property + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/recipe.rb b/cookbooks/compat_resource/files/lib/chef_compat/recipe.rb new file mode 100644 index 0000000..86e39d9 --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/recipe.rb @@ -0,0 +1,8 @@ +require 'chef/recipe' +require 'chef_compat/copied_from_chef/chef/dsl/recipe' + +module ChefCompat + class Recipe < Chef::Recipe + include ChefCompat::CopiedFromChef::Chef::DSL::Recipe::FullDSL + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/resource.rb b/cookbooks/compat_resource/files/lib/chef_compat/resource.rb new file mode 100644 index 0000000..bcf0fdb --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/resource.rb @@ -0,0 +1,56 @@ +require 'chef_compat/monkeypatches' +require 'chef_compat/copied_from_chef/chef/resource' + +# We do NOT want action defined if chefspec is engaged +if Chef::Provider::InlineResources::ClassMethods.instance_method(:action).source_location[0] =~ /chefspec/ + ChefCompat::CopiedFromChef::Chef::Provider::InlineResources::ClassMethods.instance_eval do + remove_method(:action) + end +end + +module ChefCompat + class Resource < ChefCompat::CopiedFromChef::Chef::Resource + def initialize(*args, &block) + super + # @resource_name is used in earlier Chef versions + @resource_name = self.class.resource_name + end + # Things we'll need to define ourselves: + # 1. provider + # 2. resource_name + + def provider(*args, &block) + super || self.class.action_class + end + def provider=(arg) + provider(arg) + end + + if !respond_to?(:resource_name) + def self.resource_name(name=Chef::NOT_PASSED) + # Setter + if name != Chef::NOT_PASSED + # remove_canonical_dsl + + # Set the resource_name and call provides + if name + name = name.to_sym + # If our class is not already providing this name, provide it. + # Commented out: use of resource_name and provides will need to be + # mutually exclusive in this world, generally. + # if !Chef::ResourceResolver.includes_handler?(name, self) + provides name#, canonical: true + # end + @resource_name = name + else + @resource_name = nil + end + end + @resource_name + end + def self.resource_name=(name) + resource_name(name) + end + end + end +end diff --git a/cookbooks/compat_resource/files/lib/chef_compat/resource/lwrp_base.rb b/cookbooks/compat_resource/files/lib/chef_compat/resource/lwrp_base.rb new file mode 100644 index 0000000..2ebb98f --- /dev/null +++ b/cookbooks/compat_resource/files/lib/chef_compat/resource/lwrp_base.rb @@ -0,0 +1,44 @@ +require 'chef_compat/resource' +require 'chef_compat/copied_from_chef/chef/resource' +require 'chef/mixin/convert_to_class_name' +require 'chef/mixin/from_file' + +module ChefCompat + class Resource < ChefCompat::CopiedFromChef::Chef::Resource + class LWRPBase < ChefCompat::Resource + class<= 12.0").satisfied_by?(Gem::Version.new(Chef::VERSION)) + + require 'chef_compat/resource' + require 'chef_compat/property' + require 'chef_compat/mixin/properties' + +else + + class Chef + class Resource + def self.property(args, &block) + raise_chef_11_error + end + + def self.resource_name(args, &block) + raise_chef_11_error + end + + def self.action(args, &block) + raise_chef_11_error + end + + def self.raise_chef_11_error + raise "This resource is written with Chef 12.5 custom resources, and requires at least Chef 12.0 used with the compat_resource cookbook, it will not work with Chef 11.x clients, and those users must pin their cookbooks to older versions or upgrade." + end + end + end + +end diff --git a/cookbooks/compat_resource/libraries/autoload.rb b/cookbooks/compat_resource/libraries/autoload.rb new file mode 100644 index 0000000..db52cfc --- /dev/null +++ b/cookbooks/compat_resource/libraries/autoload.rb @@ -0,0 +1,31 @@ +unless Gem::Requirement.new(">= 12.0").satisfied_by?(Gem::Version.new(Chef::VERSION)) + raise "This resource is written with Chef 12.5 custom resources, and requires at least Chef 12.0 used with the compat_resource cookbook, it will not work with Chef 11.x clients, and those users must pin their cookbooks to older versions or upgrade." +end + +# If users are on old verisons of ChefDK which activates an (old) gem via cheffish before this cookbook loads, then +# we just try to monkeypatch over the top of a monkeypatch. Its possible that we have checks in this cookbook which +# will defeat that purpose and fail to monkeypatch on top of monkeypatches -- in which case those checks should be +# removed -- this cookbook needs to win when it gets into a fight with the old gem versions. +if Gem.loaded_specs["compat_resource"] + Chef.log_deprecation "using compat_resource as a gem is deprecated; please update cheffish and chef-provisioning gems (or use the latest Chef/ChefDK packages) or else manually pin your compat_resource cookbook version to the same version as the gem you are using to remove this warning" +end + +# we want to not pollute the libpath with our files until after we've done the version check +require_relative '../files/lib/chef_upstream_version' + +# on any chef client later than the one we were based off of we just turn into a no-op +if Gem::Requirement.new("< #{ChefCompat::CHEF_UPSTREAM_VERSION}").satisfied_by?(Gem::Version.new(Chef::VERSION)) + Chef::Log.debug "loading compat_resource based on chef-version #{ChefCompat::CHEF_UPSTREAM_VERSION} over chef version #{Gem::Version.new(Chef::VERSION)}" + $LOAD_PATH.unshift(File.expand_path("../files/lib", File.dirname(__FILE__))) + require 'compat_resource' +else + Chef::Log.debug "NOT LOADING compat_resource based on chef-version #{ChefCompat::CHEF_UPSTREAM_VERSION} over chef version #{Gem::Version.new(Chef::VERSION)}" + unless defined?(ChefCompat::Resource) && defined?(ChefCompat::Mixin::Properties) + module ChefCompat + Resource = Chef::Resource + module Mixin + Properties = Chef::Mixin::Properties + end + end + end +end diff --git a/cookbooks/compat_resource/metadata.json b/cookbooks/compat_resource/metadata.json new file mode 100644 index 0000000..7bacbae --- /dev/null +++ b/cookbooks/compat_resource/metadata.json @@ -0,0 +1 @@ +{"name":"compat_resource","version":"12.16.1","description":"Brings the modern custom resource syntax to earlier Chef 12 releases prior to 12.5","long_description":"# compat_resource cookbook\n\n[![Build Status](https://travis-ci.org/chef-cookbooks/compat_resource.svg?branch=master)](https://travis-ci.org/chef-cookbooks/compat_resource) [![Cookbook Version](https://img.shields.io/cookbook/v/compat_resource.svg)](https://supermarket.chef.io/cookbooks/compat_resource)\n\nThis cookbook backports functionality introduced in the latest chef-client releases to any chef-client from 12.1 onwards. This includes [Custom Resource](https://docs.chef.io/custom_resources.html) functionality, notification improvements, as well as new resources added to core chef. It allows for the usage of these new resources in cookbooks without requiring the very latest Chef client release.\n\n## Backported functionality\n\n- [Custom Resources](https://docs.chef.io/custom_resources.html)\n- [apt_repository](https://docs.chef.io/resource_apt_repository.html)\n- [apt_update](https://docs.chef.io/resource_apt_update.html)\n- [systemd_unit](https://docs.chef.io/resource_systemd_unit.html)\n- [yum_repository](https://docs.chef.io/resource_yum_repository.html)\n- [:before notifications](https://docs.chef.io/resources.html#timers)\n\n## Requirements\n\n### Platforms\n\n- All platforms supported by Chef\n\n### Chef\n\n- Chef 12.1+\n\n### Cookbooks\n\n- none\n\n## Usage\n\nTo use this cookbook, put `depends 'compat_resource'` in the metadata.rb of your cookbook. Once this is done, you can use all the new custom resource features to define resources. It Just Works.\n\n## Custom Resources?\n\nCurious about how to use custom resources?\n\n- Docs: \n- Slides: \n\n## License & Authors\n\n**Author:** John Keiser ([jkeiser@chef.io](mailto:jkeiser@chef.io))\n\n**Copyright:** 2015-2016, 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\n\n```\nhttp://www.apache.org/licenses/LICENSE-2.0\n```\n\nUnless 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.\n","maintainer":"Lamont Granquist","maintainer_email":"lamont@chef.io","license":"Apache 2.0","platforms":{},"dependencies":{},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{}} \ No newline at end of file diff --git a/cookbooks/docker/.foodcritic b/cookbooks/docker/.foodcritic new file mode 100644 index 0000000..913f038 --- /dev/null +++ b/cookbooks/docker/.foodcritic @@ -0,0 +1 @@ +~FC005 diff --git a/cookbooks/docker/CHANGELOG.md b/cookbooks/docker/CHANGELOG.md new file mode 100644 index 0000000..da5e0d7 --- /dev/null +++ b/cookbooks/docker/CHANGELOG.md @@ -0,0 +1,1578 @@ +# Docker Cookbook Changelog + +This file is used to list changes made in each version of the docker cookbook. + +## 2.9.8 (2016-11-08) +- Fixed a typo in an error message +- Enable tarball install through docker_service +- option log_opt is defined as --log-opt value1 --log-opt value2 instead of --log-opt=value1 --log-opt=value2 +- Depend on a working compat_resource cookbook + +## 2.9.7 (2016-10-14) +- Require the most recent compat_resource +- Get foodcritic passing +- Update the Rakefile and use cookstyle +- Use cookstyle in Travis +- Add matchers for docker_installation_tarball + +## v2.9.6 +- entrypoint not entry_point README +- dockerd binary on 1.12+ for upstart +- fix docker.socket for systemd + +## v2.9.5 +- bumping docker-api gem + +## v2.9.4 +- Switch to the dockerd binary on 1.12+ +- Add links to resources overview list + +## v2.9.3 +- add uts_mode support for docker_container provider (#730) + +## v2.9.2 +- adding feature ReadonlyRootfs +- bumping docker version to 1.11.2 +- removing etcd, fails tests for xenial and swarm will have it builtin in 1.12 + +## v2.9.1 +- implement userns_mode for containers + +## v2.9.0 +- Feature - docker_installation_tarball resource +- Patch - Adding missing http_proxy support to rhel/sysvinit +- Patch #705 - Avoid installing docker-api gem in ChefSpec + +## v2.8.0 +- Feature - User namespace configuration capability for docker_service + +## v2.7.1 + +- Updated test matrix in the readme to reflect reality + +## v2.7.0 + +- Initial support for Ubuntu 16.04 +- Initial support for Fedora 22 / 23 + +## v2.6.8 + +- notifies need to restart service immediately to prevent containers from stopping +- bumping docker-api version 1.28.0 +- adding tests for image load + +## v2.6.7 + +- only wait for running state if detached +- updating systemd template and bugfix for socket + +## v2.6.6 + +- refactor of docker-wait-ready + +## v2.6.5 + +- need a guard around docker_socket incase it isn't set + +## v2.6.4 + +- passing parsed socket file to init script +- removing unused action remove_link + +## v2.6.3 + +- Implements load action for images + +## v2.6.2 + +- Include init support for oracle platform + +## v2.6.1 + +- Add support for docker_container image property with custom repository port +- Resolve restarting container races +- New resource docker_exec + +## v2.6.0 + +- :insecure_registry in the docker_service provider can now be a string or array +- scientific and oracle have been added to the metadata as supported platforms +- The effect of -1 on memory_swap has been clarified in the readme +- Tests have been updated to run faster using trap vs. nc +- Checksums for new Docker releases have been added + +## v2.5.9 + +- Depend on compat_resource >= 12.9.0 + +## v2.5.8 + +- Setting desired_state: true for volumes / binds properties +- Now redeploy container on volume change. +- Change :restart action behavior to :run containers if they don't exist yet. + +## v2.5.7 + +- Remove vendored gems in favor of chef_gem install +- Extending available log_driver options + +## v2.5.6 + +- Adding no_proxy to Upstart defaults template + +## v2.5.5 + +- Fixing up various default: nil warnings + +## v2.5.4 + +- Allowing nil as type possibility for docker_service :package_options +- property + +## v2.5.3 + +- Adding ChefSpec.define_matcher for all resources + +## v2.5.2 + +- Setting log_driver and log_opts to desired_state: false + +## v2.5.1 + +- package_options property to pass options to underlying package resource + +## v2.5.0 + +- Defaulting installation version to 1.10.0 +- Documenting docker_network resource in README +- Documenting docker_volume resource in README + +## v2.4.26 + +- Adding docker_volume resource + +## v2.4.25 + +- Various fixes to docker_network around subsequent runs +- Utilizing property coersion and converge_if_changed + +## v2.4.24 + +- Avoiding restart loops in chef-client 12.4.3 +- Using delayed notifications for service restarts + +## v2.4.23 + +- Getting rid of Chef 13 deprecation warning +- returning nil in default_tls_cert_path + +## v2.4.22 + +- Revamped systemd resources to use package native unit files +- Using /etc/systemd/system to override settings + +## v2.4.21 + +- Revamped sysvinit resources to use package native scripts.a +- Using /etc/sysconfig on rhel and /etc/default on Debian +- Ubuntu 12.04 now uses Upstart +- Debian Wheezy support +- Fixed install_method validation + +## v2.4.20 + +- Temporarily disabling validate_install_method + +## v2.4.19 + +- Adding docker_tag force property + +## v2.4.18 + +- Fixing broken version / install_method validation check + +## v2.4.17 + +- Re-doing service_manager_upstart implementation +- Using package native init config and utilizing /etc/default + +## v2.4.16 + +- Adding validation proc for docker_service.version to throw error +- when specifying version with script installations + +## v2.4.15 + +- fixing raiseure -> failure typo in docker_container validation +- Patching vendored docker-api-1.26.0 +- + +## v2.4.14 + +- Updating .gitignore and re-adding vendored docker-api gem + +## v2.4.13 + +- stricter conditionals on container validation +- updating vendored docker-api gem to 1.26.0 +- setting default Docker installation version to 1.9.1 +- updating inspec for service-execute +- updating inspec for service-sysvinit +- updating inspec for service-upstart +- updating inspec for service-systemd +- removing unused serverspec suites + +## v2.4.12 + +- Set default docker_container.exposed_port to empty Hash + +## v2.4.11 + +- Updating metadata to use compat_resource ~> 12.7.1 + +## v2.4.10 + +- (re)adding host property to docker_network + +## v2.4.9 + +- using require_relative to load files +- specifying resource_name instead of use_automatic_resource_name + +## v2.4.8 + +- removing duplicate :tls properties +- removing instances of 'default: nil' +- depending on 'compat_resource', '~> 12.5.26' + +## v2.4.7 + +- Using Gem::Version to handle semantic verisoning and be compatible for ≥ 1.10 +- v2.4.6 + +-------------------------------------------------------------------------------- + +- 613 - Fix docker_container redeploys with bad link array ordering + +## v2.4.5 + +- Fix coerce_volumes in case current value is a Chef::Node::ImmutableArray +- Adding tests for binds alias to volumes + +## v2.4.4 + +- Updating vendored docker-api to 1.25.0 +- Adding experimental docker_network resource + +## v2.4.3 + +- Setting docker_container property defaults to match Docker CLI +- Reverting image-id hack +- Adding disable-legacy-registry + +## v2.4.2 + +- Unifying volumes and binds properties on docker_container resource +- Should use "volumes" everywhere now. Aliased method for backward compatibility. + +## v2.4.1 + +- Various fixes in wait-ready loops: +- 598 - systemd manager return value check for docker-wait-ready +- 600 - execute manager last iteration check fix. + +## v2.4.0 + +- Adding support for pid_mode and ipc_mode to docker_container + +## v2.3.23 + +- Changing bridge property validation to String + +## v2.3.22 + +- using parsed_hostname to force nil value to Docker API when +- network_mode is host + +## v2.3.21 + +- reverting hostname coerce + +## v2.3.20 + +- adding coerce_hostname +- Fixing github issues #542 and #572 + +## v2.3.19 + +switching systemd unit MountFlags from slave to private + +## v2.3.18 + +- removing detach/autoremove conflict check + +## v2.3.17 + +- Reverting gem loading trickery. Reverting to LOAD_PATH.push + +## v2.3.16 + +- Adding validation checking for detach / autoremove property +- conflicts + +## v2.3.15 + +- Loading vendored gems the same way chef_gem would. +- Resolving Chef provisioning conflicts + +## v2.3.14 + +- Supporting Upstart for Linux Mint + +## v2.3.13 + +- Updating compat_resource dep to >=12.5.23 + +## v2.3.12 + +- Pinning compat_resource version to 12.5.14 to avoid warning + +## v2.3.11 + +- Using LOAD_PATH.push instead of LOAD_PATH.unshift for vendored gems + +## v2.3.10 + +- Fix method name for pidfile in docker_service_manager_execute + +## v2.3.9 + +- Adding Linux Mint to helpers_installation_package + +## v2.3.8 + +- 582 using symbols in excon opts +- Resolves 458 + +## v2.3.7 + +- 574 - updating docker to 1.9.1 +- 575 - remove nil values from container create hash +- 576 - updating centos to 7.1 +- 577 - check for conflicting properties +- 578 - Update docker_container library documentation on timeouts +- 579 - suggest adding kill_after on a failed action stop + +## v2.3.6 + +- 573 adding support for port range + +## v2.3.5 + +- fixing desired_state on docker_container force property + +## v2.3.4 + +- Fixing up ports logic +- Supporting multiple ip/ports + +## v2.3.3 + +- vendoring docker-api-1.24.1 + +## v2.3.2 + +- vendoring docker-api-1.24.0 +- setting desired_state:false for tls properties + +## v2.3.1 + +- Support for multiple docker_service instances with docker_service_manager_upstart +- Support for multiple docker_service instances with docker_service_manager_systemd + +## v2.3.0 + +- Support for multiple docker_service instances with docker_service_manager_sysvinit + +## v2.2.11 + +- Support for multiple docker_service instances with docker_service_manager_execute + +## v2.2.10 + +- 565 - Add support for --exec-opt to docker daemon +- 566 - Rename cluster-opts to cluster-opt + +## v2.2.9 + +- 560 - Add cluster-store options to docker daemon + +## v2.2.8 + +- 559 - setting tls and tls_verify should to nil by default + +## v2.2.7 + +- Supporting Docker ENV variables without explicitly setting +- per-resource host TLS information +- Serverspec -> inspec fixes + +## v2.2.6 + +- Docker 1.9 support +- Updates to pull_image id checking +- Updates default_network_mode calculation + +## v2.2.5 + +- Updating metadata to depend on compat_resource >= 12.5.14 + +## v2.2.4 + +- More minor fixes to Upstart script template + +## v2.2.3 + +- Minor fix to Upstart script template + +## v2.2.2 + +- Upstart script now waits for all filesystems instead of just local-filesystems + +## v2.2.1 + +- marking attach_ properties desired_state: false + +## v2.2.0 + +- Switching docker_installation method to auto +- Cleaning up some old Chef::Provider namespace cruft + +## v2.1.23 + +- Adding docker_service auto_restart property. Defaulting to false. + +## v2.1.22 + +- Updating README with docker_installation and docker_service_manager resources +- Adding "desired_state: false" to docker_installation properties + +## v2.1.21 + +- Refactoring docker_service into docker_service_manager_whatever +- Fixing bug in coerce_daemon_labels +- Fixes to resources-171 suite serverspec + +## v2.1.20 + +- Fixing docker_installation_script resource + +## v2.1.19 + +- Various cruft cleanup in service templates. +- Explicitly enabling ipv4 forwarding in execute provider +- docker_service_sysvinit test suite +- docker_service_upstart test suite +- docker_service_systemd test suite + +## v2.1.18 + +- Kitchen refactoring +- docker_service_execute bug fixes + +## v2.1.17 + +- Fixing merge meant for v2.1.16 + +## v2.1.16 + +- Adding install_method property to select docker_installation resource +- Using docker_installation_binary by default +- Fixing up serverspec for pre-182 resource test recipes + +## v2.1.15 + +- Updates to README around kill_after property on :stop action +- Updates to various test containers to handle SIGKILL properly + +## v2.1.14 + +- Fixing missing property regression in docker_service + +## v2.1.13 + +- Fixing up independent of docker_installation_binary resource, adding +- kitchen suites and serverspec tests + +## v2.1.12 + +- 531 - Bugfix for invalid parameters in docker_container :stop +- action + +## v2.1.11 + +- Fixing LocalJumpError in docker_container + +## v2.1.10 + +- Adding 'desired_state: false' to various timeouts + +## v2.1.9 + +- Refactoring: Moving remote file installation method into +- docker_installation_binary resource + +## v2.1.8 + +- Refactoring: Removing classes from the Chef::Resource namespace + +## v2.1.7 + +- Fixing connection information in docker_container and helpers_base +- Refactoring .kitchen.yml tests + +## v2.1.6 + +- Enabling TLS options for docker_container and docker_image +- Various test fixes + +## v2.1.5 + +- 528 - Don't enable https connection scheme if not using TLS + +## v2.1.4 + +- 517 - Disallowing nil value for Docker command + +## v2.1.3 + +- 514 - Fixing coerce and comparison logic in exposed_ports and +- volumes to prevent unwanted restarts + +## v2.1.2 + +- Adding why_run support + +## v2.1.1 + +- 511 - fix container wait state checking +- 512 - wait for registry ports to be open in test recipe +- 519 - updating README to include labels#511 - fix container + +## v2.1.0 + +- Changing docker_container default action to :run from +- :run_if_missing. + +## v2.0.4 + +- 504 - stop and start should wait for the container to complete +- 506 - restart to use the api endpoint + +## v2.0.3 + +- Allowing nil for docker_registry properties + +## v2.0.2 + +- Fixing LocalJumpError caused by next instead of return helper methods + +## v2.0.1 + +- 491 - Return best host for docker to connect +- 495 - iptables opts shouldn't be forced to true/false +- 497 - Removing property_is_set so timeout pick up defaults + +## v2.0.0 + +- Converted resources from LWRP to Chef 12.5 Custom Resources +- Added dependency on compat_resource cookbook, works back to 12.0.0 +- Various fixes around sysvinit scripts in docker_service +- Total backwards compatibility with recipes written for chef-docker 1.x + +## v1.0.49 + +- Handling NilClass error on docker_image default creds handling + +## v1.0.48 + +- Adding a 20 try timeout to the docker_wait_ready block + +## v1.0.47 + +- 484 - Fall back to creds for index.docker.io on image pull + +## v1.0.46 + +- 438 - Adding per-resource host property to docker_image and +- docker_container + +## v1.0.45 + +- Allow :redeploy on missing containers +- TLS fixes +- Updating sysvinit script to use docker_opts + +## v1.0.44 + +- Adding Label support for docker_container + +## v1.0.43 + +- Switching docker_service sysvinit provider from ::Insserv to ::Debian + +## v1.0.42 + +- Fix for docker_service to allow setting icc to false +- Get chefspec happy on latest nightly chefdk again +- Accepting both String and Array for default_ulimit + +## v1.0.41 + +- Refactoring broken sysvinit scripts +- 421 - Adding docker-wait-ready blocks +- Discovered TLS verification is broken. Disabling for now. + +## v1.0.40 + +- Fixing broken Chef::Provider::DockerService::Execute + +## v1.0.39 + +- Various fixes around sysvinit + +## v1.0.38 + +- docker_container - enabling Docker CLI syntax for ulimits + +## v1.0.37 + +- Adding tests for #416 + +## v1.0.36 + +- Replacing docker_log helper function with docker_service.logfile + +## v1.0.35 + +- Creating DockerHelpers::Service namespace and moving appropriate methods into it. +- Start of load_current_resource implementation for docker_service for #423 + +## v1.0.34 + +- notifying new_resource to restart when updating docker_bin + +## v1.0.33 + +- Registry authentication fixes and slight docker_image refactor +- Updates for foodcritic and travis + +## v1.0.32 + +- 451 Changed default docker_container memory_swap to prevent unwanted redeploys. + +## v1.0.31 + +- 447 - Fix for log-config driver type +- 448 - Fix unwanted redeploys due to calculation of exposed_port changes. +- 450 - Treat docker_container volumes attribute as unmanaged to prevent redeploys + +## v1.0.30 + +- 427 - Qualify port bindings with protocol even when implicitly tcp. +- 443 - Added docker_container log_driver and log_opts attributes. +- Changing docker_image read_timeout default to 60 +- Misc cleanup for README and Gemfile + +## v1.0.29 + +- 432 Fixing :redeploy so it returns the container the correct state +- (create vs run) +- Fixing blank variable interpolation in tmpfiles.d/docker.conf + +## v1.0.28 + +- Adding journald gelf and fluentd to logging driver whitelist +- Allow specifying multiple DNS servers for docker_service + +## v1.0.27 + +- Cleaning up code duplication across docker_service init templates + +## v1.0.26 + +- switching from get.docker.io to get.docker.com + +## v1.0.25 + +- Updating checksum in specs for 1.8.2 +- Downloading over https +- Removing nonexistent action :enable from docker_service + +## v1.0.24 + +- 410 - Fixing Dockerfile override behavior for hostname and ulimits +- on api 1.9 +- Upgrading to Docker 1.8.2 for default version + +## v1.0.23 + +- Fixing Dockerfile / resource override behavior for working_dir + +## v1.0.22 + +- Removed patch authentication header to bundled docker-api gem +- Moved credential reset logic into image provider + +## v1.0.21 + +- 379 and #356 - patching vendored docker-api gem authentication headers + +## v1.0.20 + +- Handling the situation where USER COMMAND ENV and ENTRYPOINT are set in +- an image build, but not in a docker_container resource + +## v1.0.19 + +- Raising error on authentication error in docker_registry +- Allowing an array for storage_opts in docker_service +- Fixing parsed_checksum in docker_service +- Fixing entrypoint parsing in docker_container + +## v1.0.18 + +- Removing leftover log resources used for debugging in development + +## v1.0.17 + +- Fixing up regressions in older Docker API versions introduced in cookbook release 1.0.15 +- _ Adding @api_version instance variable +- Adding serialized_log_config +- Adding parsed_network_mode + +## v1.0.16 + +- Adding CIDR support for docker_service bip property + +## v1.0.15 + +- 309 - Adding bits to enable container re-deployment when properties change + +## v1.0.14 + +- Adding api read and write timeouts + +## v1.0.13 + +- Fixing docker_service CLI argument generation for log-driver mtu and pidfile + +## v1.0.12 + +- Fixing platform_family string (redhat -> rhel) in docker_service sysvinit provider + +## v1.0.11 + +- Renaming retries to api_retries to not conflict with Chef::Resource + +## v1.0.10 + +- Accepting userland-proxy flag +- Fix bug in parsed_storage_driver method +- Correcting usage of ip_forwarding flag +- Let Docker pick --log-level instead of defaulting to :info + +## v1.0.9 + +- Fixing Upstart respawn limit + +## v1.0.8 + +- 382 - Fixing docker_service to accept an array for storage_opt + +## v1.0.7 + +- 381 - Removing prepended whitespace in DOCKER_OPTS + +## v1.0.6 + +- 369 - Fixing up HostConfig.NetworkMode to work as expected + +## v1.0.5 + +- 241 - Only updating docker_image resource on :pull if new bits were pulled +- on tag (useful for latest) +- Changing docker_image default action to :pull + +## v1.0.4 + +- 368 - Fixing port property to be kind_of [String, Array] +- Adding missing detach property. Defaulting to false. + +## v1.0.3 + +- 366 - Using docker_kernel instead of docker_arch in parsed_checksum + +## v1.0.2 + +- 365 - Fix logic for parsing an array of hosts +- 363 - Allow an array for port property + +## v1.0.1 + +- Switching docker_service default TLS setting to false to it works +- out of the box + +## v1.0.0 + +- vendoring the docker-api rubygem +- docker_image and docker_container resources now use speak to the +- Docker Remote API instead of shelling out +- docker_containers must now have unique names +- "volumes" property now acts like the VOLUMES directive in a Dockerfile +- added "binds" property for local mounting +- standardizing on "repo" and "tag" as components of an image +- identifier + +## v0.43.0 (2015-07-28) + +- Updating README to reflect docker_image and docker_tag reality +- Implementing rm, noprune, nocache and force on docker_image + +## v0.42.0 (2015-07-28) + +- removing docker_image :load and :tag action +- adding docker_tag resource +- renaming docker_tag image_name property to :repo; creating alias +- implementing docker_image :push action + +## v0.41.0 (2015-07-26) + +- vendoring docker-api rubygem +- beginning work to convert docker_image to use native API instead of shelling out +- changing docker_image default action to :pull_if_missing +- removing some deprecated interfaces + +## v0.40.3 (2015-07-14) + +- remove --no-trunc from docker container status in sysvinit script +- 334 - docker_container tag property (issue 320) +- 331 - docker_container ulimit property +- 328 - Upstart job respawn status detection +- 326 - Upstart job restart behavior fix sysvinit script examples +- 236 - README#324 - Reference DOCKER_OPTS Amazon Linux#325 + +## v0.40.2 (2015-07-14) + +- Support for older Chef versions + +## v0.40.1 (2015-07-08) + +- Changing host property to kind_of Array + +## v0.40.0 (2015-06-29) + +Important changes with this release: + +- MAJOR INTERFACE CHANGE +- Recipes replaced with docker_service resource* +- Removing a ton of dependencies +- Storage backends, kernel module loading, etc should now be handled externally +- Updating for Docker 1.6.2 +- Preferring binary install method to OS packages + +IMPORTANT + +- attributes/ will be removed in the next release. +- most are currently non-functional +- All options will be driven through resource properties + +## v0.37.0 + +Please note some important changes with this release: + +- The sysconfig DOCKER_OPTS improvement in [#250] can potentially change the behavior of that environment variable as it now allows shell interpolation of any embedded variables. This should not affect most environments. If your DOCKER_OPTS does contains any expected `$`, please escape via `\$` for previous behavior or be sure it will behave as expected before upgrading. +- The daemon restart option (which is deprecated) has been defaulted to `nil` instead of `false` when `node['docker']['container_init_type']` is set to prevent issues with container restart policies. If you're dependent on the daemon option, please be sure to update your `node['docker']['restart']` appropriately. +- This release also defaults systemd docker host to `fd://` to match upstream, enabling socket activation properly. Adjust `node['docker']['host']` if necessary. +- Bugfix: [#239]: Upstart: install inotify tools only once (avoid CHEF-3694 warning) (thanks jperville) +- Bugfix: [#240]: Fixed dead service containers not being restarted on docker_container :run (thanks jperville) +- Bugfix: [#244]: Made docker_container action :remove remove the actual upstart service file (thanks jperville) +- Bugfix: [#246]: Lengthen shell_out timeout as workaround for slow docker_container action stop (thanks jperville) +- Bugfix: [#258]: Fix checking docker container status on debian (thanks fxposter) +- Bugfix: [#260]: Fix accidental port changing when using systemd templates (thanks fxposter) +- Bugfix: [#266]: Get tests working on master (thanks tduffield) +- Bugfix: [#267]: Replace outdated testcontainerd (thanks tduffield) +- Bugfix: [#269]: Fix tests on Travis by following Rubocop style guidelines (container LWRP) (thanks fxposter) +- Bugfix: [#280] / [#281]: Fix port handling when omitted in container LWRP (thanks databus23) +- Bugfix: [#284] / [#285]: runit finish script to stop a container (thanks xmik) +- Bugfix: [#288][]: Fix docker.socket unit for RHEL7 (thanks databus23) +- Bugfix: [#292]: readme formatting fix (thanks wormzer) +- Improvement: [#208]: Add CentOS/RHEL 7 support (thanks dermusikman and intoximeters) +- Improvement: [#232]: Added support for insecure-registry docker daemon option (thanks jperville) +- Improvement: [#233] / [#234]: Added support for registry-mirror docker daemon option (thanks jperville and tarnfeld) +- Improvement: [#237]: Deprecate the restart daemon option (thanks jperville) +- Improvement: [#238]: Added docker_container restart attribute (thanks jperville) +- Improvement: [#242]: Added docker_container action :create (thanks jperville) +- Improvement: [#245]: Add a Gitter chat badge to README.md (thanks tduffield) +- Improvement: [#250]: Use double-quotes for DOCKER_OPTS (thanks rchekaluk) +- Improvement: [#259]: Use registry on image inspection (thanks fxposter) +- Improvement: [#263]: Add additional_host attribute to container resource (thanks fxposter) +- Improvement: [#264] / [#265]: Access keyserver.ubuntu.com on port 80 (thanks sauraus) +- Improvement: [#268]: Updated the /etc/init/docker.conf template (thanks jperville) +- Improvement: [#276]: Added support for docker options device and cap-add (thanks hvolkmer) +- Improvement: [#279]: Allow docker_container memory to have String value (eg. memory='1G') (thanks jperville) +- Improvement: [#287]: redhat 7 does not need the epel repository (thanks databus23) +- Improvement: [#289]: Update systemd service/socket files (from upstream) (thanks databus23) +- Improvement: [#296]: Default systemd to fd:// as well as use upstream MountFlags=slave and LimitCORE=infinity +- Improvement: [#297]: Update docker daemon SysV init scripts with upstream improvements +- Improvement: [#298]: Further deprecate daemon restart flag by default, which interferes with restart policies + +# 0.36.0 + +- Bugfix: [#181]: Fixed remove_link action (thanks jperville). +- Bugfix: [#185]: Fix for non idempotent run action on docker_container (thanks bplunkert). +- Bugfix: [#188]: Applied temporary workaround to address the libcgmanager error to users running LXC on Ubuntu 14.04. +- Bugfix: [#196]: Address Helpers module naming conflict (thanks sethrosenblum). +- Bugfix: [#200]: Fix how service actions are handled by docker_container resource (thanks brianhartsock). +- Bugfix: [#202]: Correctly check for the kernel.release version on Debian (thanks Tritlo, paweloczadly). +- Bugfix: [#203]: Fix pull notifications for tagged images (thanks hobofan). +- Bugfix: [#205]: Fix current_resource.name assignments in docker_container provider (thanks jperville). +- Bugfix: [#206]: Fixes to container name detection (thanks jperville). +- Enhancement: [#217]: Explicitly set key and keyserver for docker apt repository (thanks sethrosenblum). +- Improvement: Pull in init script changes from upstream for sysv and systemd. +- Bugfix: [#219]: Explicitly set Upstart provider for Ubuntu 14.04 and 14.10 (thanks methodx). +- Improvement: [#220]: Create graph directory if it is specified (thanks jontg). +- Bugfix: [#224]: Fix runit container template to properly use exec (thanks waisbrot). +- Bugfix: Appropriately check for LXC when using the binary recipe on Fedora. +- Bugfix: Implement workaround for docker/docker#2702 on Ubuntu 14.10. +- Enhancement: [#221]: Added NO_PROXY support (thanks jperville). +- Various Test Suite Modifications + + - Enhancement: [#192]: Allow image tags in serverspec matching (thanks bplunkert). + - Bugfix: [#223]: Convert a few occurrences of old 'should' rspec syntax to 'expect' (thanks jperville). + - Disable a few platforms that are experiencing bugs unrelated to core functionality. + - Address ChefSpec 4.1 deprecation warnings. + - Update Berksfile to reference supermarket.getchef.com instead of api.berkshelf.com + +# 0.35.2 + +- Bugfix: [#171]: Default Ubuntu 14.04 to Docker PPA +- Bugfix: [#175]: Do not set --selinux-enabled in opts unless explicitly defined for older versions +- Bugfix: [#176]: Use docker host attribute in docker_container Upstart inotifywait + +# 0.35.1 + +- Bugfix: [#172]: Generate no cidfile by default, even when deploying as service +- Bugfix: [#173]: Updated docker upstart script (should fix service docker restart) + +# 0.35.0 + +After a long personal hiatus (sorry!), this is the last minor release before 1.0 of the cookbook. If you can handle the Docker port number change and don't use anything deprecated, upgrading to 1.0.X from 0.35.X of the cookbook should be very easy. + +This release has a bunch of changes and hasn't been fully tested yet. Wanted to get it out there for broad testing. Please use caution! + +Major kudos to @tduffield for the [#147] PR, which includes: + +- Binary Installation + + - Added missing dependency resolution for using the binary. + +- Dependency Checks + + - Added `docker::dep_check` that will take an action if certain dependencies are not met. + + - `node[docker][alert_on_error_action] = :fatal` will kill the chef run and print the error message. + - `node[docker][alert_on_error_action] = :warn` will print the error message but continue with the chef run. There is no guarantee that it will succeed though. + +- KitchenCI + + - Copied MiniTests to ServerSpec Tests + - Added new platforms (Debian 7.4) + - Changed provisioner from chef-solo to chef-zero + - Removed Ubuntu 12.10 because it is not supported by Docker and the Kernel is bad and fails all the tests. + - Removed tests for the source recipe. The dotcloud/docker repo actually doesn't build any Go deliverables. + + - I think that the source recipe needs to be completely refactored. + +Other awesome work merged: + +- [#142]: Bugfix: Redeploy breaks when a link is present +- [#139]/[#153]/[#154]/[#156]/[#157]: Bugfix: container/image ID given as nil, fixes deprecated -notrunc +- [#164]: Bugfix: Removing a container should also remove its cidfile +- [#166]: Bugfix: Fix docker_inspect_id for Docker 1.0+ +- [#158]/[#160]/[#165]: Bugfix: Fix NameError when displaying error messages for timed-out commands +- [#169]: Bugfix: Specify Upstart as service provider for cgroup on Ubuntu 14.04 (workaround for CHEF-5276, fixed in Chef 11.14) +- [#137]/[#138]: Enhancement: Experimental Ubuntu 14.04 LTS support +- [#144]: Enhancement: Experimental Amazon linux support +- [#150]/[#152]: Enhancement: Add net attribute, deprecate networking +- [#168]: Enhancement: Allow override of package name +- [#161]: Enhancement: Add minitest case for SysV service +- [#149]: Enhancement: Add --selinux-enabled daemon flag +- Enhancement: container LWRP remove_link and remove_volume actions +- Enhancement: Add storage-opt daemon flag +- Enhancement: Add Docker 0.11.0, 0.11.1, 0.12.0, 1.0.0, 1.0.1 binary checksums + +# 0.34.2 + +- [#141]: Bugfix/Enhancement: Fix and enhance docker_image pull/push behavior with Docker 0.10 + + - Removes deprecated --registry and --tag CLI args from docker_image pull + - Adds support for registry attribute usage in docker_image pull and push + - Adds support for tag attribute usage in docker_image push + +# 0.34.1 + +- [#134]: Bugfix: Fix docker_registry login handling, fixes #114 + +# 0.34.0 + +Attributes now available for all docker daemon flags as well as system IP forwarding. + +- REMOVED: container_dns_ attributes (use replacement dns_ attributes on daemon for all containers or docker_container dns* attributes instead) +- DEPRECATED: bind_* attributes to match docker terminology (use host attribute instead) +- Bugfix: [#132]: Do Not Explicitly Set storage_driver Attribute +- Bugfix: [#133]: Remove explicit false defaults in resources +- Bugfix: [#114]: Error executing action login on resource docker_registry +- Enhancement: [#115]: Add IP forwarding attributes +- Enhancement: [#116]: Docker 0.10.0: Add --no-prune to docker rmi +- Enhancement: [#117]: Docker 0.10.0: Add --output flag to docker save (as well as tag support) +- Enhancement: [#118]: Docker 0.10.0: Add --input flag to docker load +- Enhancement: [#119]: Docker 0.10.0: Add support for --env-file to load environment variables from files +- Enhancement: [#120]: Docker 0.10.0: Deprecate docker insert +- Enhancement: [#123]: Add docker kill --signal +- Enhancement: [#124]: Add all docker daemon options as attributes +- Enhancement: [#125]: Use dns* attributes to set docker daemon options, not defaults per-container +- Enhancement: [#128]: Add checksum attribute for binary downloads +- Enhancement: [#126]: Set long option names for specified docker daemon options +- Enhancement: [#127]: Use a helper function to specify single line docker daemon options + +# 0.33.1 + +- Bugfix: [#112]: Defines runner methods for ChefSpec matchers +- Bugfix: [#113]: [D-15] Fedora 19 installs Docker 0.8.1, does not have the -G or -e flag + +# 0.33.0 + +This release deprecates AUFS/device-mapper handling from chef-docker, but provides backwards compatibility by still including the default recipe of the new cookbooks. Please update your dependencies, Github watching/issues, and recipes to reflect the two new community cookbooks: + +- aufs: [aufs on community site](http://community.opscode.com/cookbooks/aufs) / [chef-aufs on Github](https://github.com/bflad/chef-aufs) +- device-mapper: [device-mapper on community site](http://community.opscode.com/cookbooks/device-mapper) / [chef-device-mapper on Github](https://github.com/bflad/chef-device-mapper) +- Bugfix: [#109]: Remove on lxc-net start from docker Upstart +- Enhancement: [#88]: Migrate AUFS logic to separate cookbook +- Enhancement: [#90]: Migrate device-mapper logic to separate cookbook +- Enhancement: [#110]: Add docker Upstart pre-start script and limits configuration +- Enhancement: [#105]: Add --label for docker run +- Enhancement: [#106]: Add --opt for docker run +- Enhancement: [#107]: Add --networking for docker run +- Enhancement: [#108]: Add --dns-search for docker run +- Enhancement: [#104]: Add TMPDIR +- Enhancement: [#111]: Add DOCKER_LOGFILE configuration +- Enhancement: container_dns* attributes to set --dns and --dns-search for all containers + +# 0.32.2 + +- Bugfix: [#101]: Explicitly install lxc on Ubuntu (when lxc is exec_driver; continue to fully support LXC as a default installation path since its been since Docker 0.1) +- Bugfix: [#103]: Fix host argument (in docker run) + +# 0.32.1 + +- Bugfix: [#98]: Ensure Ruby 1.8 syntax is supported +- Bugfix: Skip empty Array values in cli_args helper + +# 0.32.0 + +_If you're using CentOS/RHEL with EPEL, upcoming docker-io 0.9.0 package upgrade can be tracked at [Bugzilla 1074880](https://bugzilla.redhat.com/show_bug.cgi?id=1074880)_ + +This release includes Docker 0.9.0 changes and defaults, such as setting exec_driver to libcontainer ("native"), setting -rm on docker build, double dash arguments on the CLI, additional flags, etc. + +- DEPRECATED: Rename storage_type attribute to storage_driver to [match Docker terminology](http://docs.docker.io/en/latest/reference/commandline/cli/#daemon) (storage_type will be removed in chef-docker 1.0) +- DEPRECATED: Rename virtualization_type attribute to exec_driver to [match Docker terminology](http://docs.docker.io/en/latest/reference/commandline/cli/#daemon) (virtualization_type will be removed in chef-docker 1.0) +- Bugfix: [#80]: Use double dashed arguments on CLI +- Bugfix: Surround String values on CLI with quotes +- Enhancement: [#77]: Improved docker ps handling +- Enhancement: [#78]: Docker 0.9.0: Make --rm the default for docker build +- Enhancement: [#81]: Docker 0.9.0: Add a -G option to specify the group which unix sockets belong +- Enhancement: [#82]: Docker 0.9.0: Add -f flag to docker rm to force removal of running containers +- Enhancement: Add -f flag for docker rmi to force removal of images +- Enhancement: [#83]: Docker 0.9.0: Add DOCKER_RAMDISK environment variable to make Docker work when the root is on a ramdisk +- Enhancement: [#84]: Docker 0.9.0: Add -e flag for execution driver +- Enhancement: [#85]: Docker 0.9.0: Default to libcontainer +- Enhancement: [#86]: Add Chefspec LWRP matchers + +# 0.31.0 + +Lots of init love this release. Now supporting runit. + +Please note change of storage_type attribute from devmapper to devicemapper (and associated recipe name change) to match docker's name for the driver. + +Cookbook now automatically adds -s option to init configurations if storage_type is defined, which is it by default. If you were specifying -s in the options attribute, you no longer need to do so. In my quick testing, docker daemon doesn't seem to mind if -s is specified twice on startup, although you'll probably want to get rid of the extra specification. + +I've also dropped the LANG= and LC_ALL= locale environment settings from the Upstart job configuration. Its not specified in the default docker job. Please open an issue in docker project and here if for some reason this is actually necessary. + +- Bugfix: Match devicemapper storage_type attribute to match docker driver name (along with recipe name) +- Enhancement: [#72]: Add initial runit init_type +- Enhancement: [#60]: Automatically set docker -d -s from storage_type attribute +- Enhancement: Simplify default/sysconfig file into one template (docker.sysconfig.erb) and source into SysV/Upstart init configurations +- Enhancement: Add Debian docker daemon SysV init template + +# 0.30.2 + +- Bugfix: [#68]: Fix CommandTimeout handling in LWRPs +- Bugfix: [#67]: Fix argument order to pull when tag specified + +# 0.30.1 + +Public or private registry login should now correctly occur and login once per credentials change. + +- Bugfix: [#64]: Correct CLI ordering of registry login +- Bugfix: [#65]: login command skipped in registry provider +- Enhancement: registry provider current resource attributes loaded from .dockercfg + +# 0.30.0 + +Awesome work by [@jcrobak] to close out two issues ([#49] and [#52]) with [#62]. Note change below in image build action. + +- Bugfix: [#52]: return codes of docker commands not verified +- Bugfix: Add missing pull_if_missing action to image resource +- Enhancement: [#56]: Switch build action to build_if_missing, build action now builds each run (be careful with image growth!) +- Enhancement: [#59]: Add Mac OS X installation support +- Enhancement: [#49]: Add docker_cmd_timeout attribute and daemon verification +- Enhancement: [#58]: Add container redeploy action +- Enhancement: [#63]: Add group_members attribute and group recipe to manage docker group + +# 0.29.0 + +- Enhancement: [#57]: Implement id checking when determining current_resource + + - Added to both container and image LWRPs + +- Enhancement: Set created and status attributes for current container resources (for handlers, wrappers, etc.) + +- Enhancement: Set created and virtual_size attributes for image resource (for handlers, wrappers, etc.) + +# 0.28.0 + +- Enhancement: [#55]: image LWRP pull action now attempts pull every run (use pull_if_missing action for old behavior) + +# 0.27.1 + +- Bugfix: [#51]: container LWRP current_resource attribute matching should also depend on container_name + +# 0.27.0 + +- Enhancement: [#48]: Accept FalseClass CLI arguments (also explicitly declare =true for TrueClass CLI arguments) + +# 0.26.0 + +- Bugfix: Add SysV init script for binary installs +- Enhancement: Add storage_type and virtualization_type attributes +- Enhancement: Initial devmapper support for binary installs on CentOS/Ubuntu +- Enhancement: [#47] Debian-specific container SysV init script +- Enhancement: [#46] Add rm attribute for build action on image LWRP +- Enhancement: Add no_cache attribute for build action on image LWRP + +# 0.25.1 + +- Bugfix: [#44] Add missing run attribute for commit action on container LWRP + +# 0.25.0 + +- DEPRECATED: image LWRP dockerfile, image_url, and path attributes (replaced with source attribute) +- Bugfix: Use docker_cmd for container LWRP remove and restart actions +- Enhancement: Add registry LWRP with login action +- Enhancement: Standardize on "smart" and reusable destination and source attributes for container and image LWRPs to define paths/URLs for various operations +- Enhancement: Add commit, cp, export, and kill actions to container LWRP +- Enhancement: Add insert, load, push, save, and tag actions to image LWRP +- Enhancement: Add local file and directory support to import action of image LWRP +- Enhancement: Add Array support to container LWRP link attribute +- Enhancement: Cleaned up LWRP documentation + +# 0.24.2 + +- Bugfix: [#43] Better formatting for container LWRP debug logging + +# 0.24.1 + +- Bugfix: Explicitly declare depends and supports in metadata +- Bugfix: Handle container run action if container exists but isn't running + +# 0.24.0 + +- Bugfix: [#42] fix(upstart): Install inotify-tools if using upstart +- Enhancement: [#38] Allow a user to specify a custom template for their container init configuration + +# 0.23.1 + +- Bugfix: [#39] Fix NoMethodError bugs in docker::aufs recipe + +# 0.23.0 + +- Bugfix: Default oracle init_type to sysv +- Enhancement: Experimental Debian 7 package support +- Enhancement: Use new yum-epel cookbook instead of yum::epel recipe +- Enhancement: Use `value_for_platform` where applicable in attributes, requires Chef 11 + +# 0.22.0 + +- Enhancement: [#35] Use kernel release for package name on saucy and newer +- Enhancement: [#37] dont include aufs recipe on ubuntu 13.10 and up; don't require docker::lxc for package installs + +# 0.21.0 + +- Enhancement: [#31] More helpful cmd_timeout error messages and catchable exceptions for container (`Chef::Provider::Docker::Container::CommandTimeout`) and image (`Chef::Provider::Docker::Image::CommandTimeout`) LWRPs + +# 0.20.0 + +- Enhancement: Default to package install_type only on distros with known packages +- Enhancement: Initial Oracle 6 platform support via binary install_type + + - + - + +- Enhancement: Split out lxc recipe for default platform lxc handling + +- Enhancement: Create cgroups recipe for default platform cgroups handling + +# 0.19.1 + +- Bugfix: [#30] apt-get throws exit code 100 when upgrading docker + +# 0.19.0 + +- Enhancement: Add `node['docker']['version']` attribute to handle version for all install_type (recommended you switch to this) +- Enhancement: `default['docker']['binary']['version']` attribute uses `node['docker']['version']` if set +- Enhancement: Add version handling to package recipe + +# 0.18.1 + +- Bugfix: Remove ExecStartPost from systemd service to match change in docker-io-0.7.0-13 + +# 0.18.0 + +- Enhancement: CentOS/RHEL 6 package support via EPEL repository +- Enhancement: Fedora 19/20 package support now in updates (stable) repository +- Enhancement: sysv recipe and init_type + +# 0.17.0 + +- Removed: configuration recipe (see bugfix below) +- Removed: config_dir attribute (see bugfix below) +- Bugfix: Revert back to specifying HTTP_PROXY and "DOCKER_OPTS" natively in systemd/Upstart (mostly to fix up systemd support) +- Bugfix: Add systemctl --system daemon-reload handling to systemd service template +- Bugfix: Add || true to container systemd/Upstart pre-start in case already running +- Bugfix: Locale environment already handled automatically by systemd +- Enhancement: Switch Fedora package installation from goldmann-docker to Fedora updates-testing repository +- Enhancement: Switch container LWRPs to named containers on Fedora since now supported +- Enhancement: Update docker systemd service contents from docker-io-0.7.0-12.fc20 + + - Add: Wants/After firewalld.service + - Add: ExecStartPost firewall-cmd + - Remove: ExecStartPost iptables commands + +# 0.16.0 + +- Bugfix: Remove protocol from docker systemd ListenStreams +- Bugfix: Lengthen shell_out timeout for stop action in container LWRP to workaround Fedora being slow +- Enhancement: Add service creation to container LWRP by default + + - Please thoroughly test before putting into production! + - `set['docker']['container_init_type'] = false` or add `init_type false` for the LWRP to disable this behavior + +- Enhancement: Add configuration recipe with template + +- Enhancement: Add container_cmd_timeout attribute to easily set global container LWRP cmd_timeout default + +- Enhancement: Add image_cmd_timeout attribute to easily set global image LWRP cmd_timeout default + +- Enhancement: Add cookbook attribute to container LWRP + +- Enhancement: Add init_type attribute to container LWRP + +- Enhancement: Add locale support for Fedora + +- Enhancement: Fail Chef run if `docker run` command errors + +# 0.15.0 + +- Enhancement: Fedora 19/20 package support via [Goldmann docker repo](http://goldmann.fedorapeople.org/repos/docker/) +- Enhancement: docker.service / docker.socket systemd support +- Enhancement: Add `node['docker']['init_type']` attribute for controlling init system + +# 0.14.0 + +- Bugfix: [#27] Only use command to determine running container if provided +- Bugfix: [#28] Upstart requires full stop and start of service instead of restart if job configuration changes while already running. Note even `initctl reload-configuration` isn't working as expected from +- Enhancement: [#26] Add ability to set package action + +# 0.13.0 + +- Bugfix: Move LWRP updated_on_last_action(true) calls so only triggered when something actually gets updated +- Enhancement: Add container LWRP wait action +- Enhancement: Add attach and stdin args to container LWRP start action +- Enhancement: Add link arg to container LWRP remove action +- Enhancement: Use cmd_timeout in container LWRP stop action arguments + +# 0.12.0 + +- Bugfix: Add default bind_uri (nil) to default attributes +- Enhancement: [#24] bind_socket attribute added + +# 0.11.0 + +- DEPRACATION: container LWRP Fixnum port attribute: use full String notation from Docker documentation in port attribute instead +- DEPRACATION: container LWRP public_port attribute: use port attribute instead +- Enhancement: Additional container LWRP attributes: + + - cidfile + - container_name + - cpu_shares + - dns + - expose + - link + - lxc_conf + - publish_exposed_ports + - remove_automatically + - volumes_from + +- Enhancement: Support Array in container LWRP attributes: + + - env + - port + - volume + +# 0.10.1 + +- Bugfix: Set default cmd_timeout in image LWRP to 300 instead of 60 because downloading images can take awhile +- Enhancement: Change docker_test Dockerfile FROM to already downloaded busybox image instead of ubuntu +- Enhancement: Add vagrant-cachier to Vagrantfile + +Other behind the scenes changes: + +- Made cookbook code Rubocop compliant +- Move licensing information to LICENSE file +- Updated .travis.yml and Gemfile + +# 0.10.0 + +- Enhancement: [#22] cmd_timeout, path (image LWRP), working_directory (container LWRP) LWRP attributes +- Bugfix: [#25] Install Go environment only when installing from source + +# 0.9.1 + +- Fix to upstart recipe to not restart service constantly (only on initial install and changes) + +# 0.9.0 + +- image LWRP now supports non-stdin build and import actions (thanks [@wingrunr21]!) + +# 0.8.1 + +- Fix in aufs recipe for FC048 Prefer Mixlib::ShellOut + +# 0.8.0 + +Lots of community contributions this release -- thanks! + +- image LWRP now supports builds via Dockerfile +- Additional privileged, public_port, and stdin parameters for container LWRP +- Support specifying binary version for installation +- Fix upstart configuration customization when installing via Apt packages +- Default to Golang 1.1 + +# 0.7.1 + +- Use HTTPS for Apt repository + +# 0.7.0 + +- Update APT repository information for Docker 0.6+ + +# 0.6.2 + +- Change Upstart config to start on runlevels [2345] instead of just 3 + +# 0.6.1 + +- Change env HTTP_PROXY to export HTTP_PROXY in Upstart configuration + +# 0.6.0 + +- Add bind_uri and options attributes + +# 0.5.0 + +- Add http_proxy attribute + +# 0.4.0 + +- Docker now provides precise/quantal/raring distributions for their PPA +- Tested Ubuntu 13.04 support + +# 0.3.0 + +- Initial `container` LWRP + +# 0.2.0 + +- Initial `image` LWRP + +# 0.1.0 + +- Initial release + +[#22]: https://github.com/bflad/chef-docker/issues/22 +[#24]: https://github.com/bflad/chef-docker/issues/24 +[#25]: https://github.com/bflad/chef-docker/issues/25 +[#26]: https://github.com/bflad/chef-docker/issues/26 +[#27]: https://github.com/bflad/chef-docker/issues/27 +[#28]: https://github.com/bflad/chef-docker/issues/28 +[#30]: https://github.com/bflad/chef-docker/issues/30 +[#31]: https://github.com/bflad/chef-docker/issues/31 +[#35]: https://github.com/bflad/chef-docker/issues/35 +[#37]: https://github.com/bflad/chef-docker/issues/37 +[#38]: https://github.com/bflad/chef-docker/issues/38 +[#39]: https://github.com/bflad/chef-docker/issues/39 +[#42]: https://github.com/bflad/chef-docker/issues/42 +[#43]: https://github.com/bflad/chef-docker/issues/43 +[#44]: https://github.com/bflad/chef-docker/issues/44 +[#46]: https://github.com/bflad/chef-docker/issues/46 +[#47]: https://github.com/bflad/chef-docker/issues/47 +[#48]: https://github.com/bflad/chef-docker/issues/48 +[#49]: https://github.com/bflad/chef-docker/issues/49 +[#51]: https://github.com/bflad/chef-docker/issues/51 +[#52]: https://github.com/bflad/chef-docker/issues/52 +[#55]: https://github.com/bflad/chef-docker/issues/55 +[#56]: https://github.com/bflad/chef-docker/issues/56 +[#57]: https://github.com/bflad/chef-docker/issues/57 +[#58]: https://github.com/bflad/chef-docker/issues/58 +[#59]: https://github.com/bflad/chef-docker/issues/59 +[#60]: https://github.com/bflad/chef-docker/issues/60 +[#62]: https://github.com/bflad/chef-docker/issues/62 +[#63]: https://github.com/bflad/chef-docker/issues/63 +[#64]: https://github.com/bflad/chef-docker/issues/64 +[#65]: https://github.com/bflad/chef-docker/issues/65 +[#67]: https://github.com/bflad/chef-docker/issues/67 +[#68]: https://github.com/bflad/chef-docker/issues/68 +[#72]: https://github.com/bflad/chef-docker/issues/72 +[#77]: https://github.com/bflad/chef-docker/issues/77 +[#78]: https://github.com/bflad/chef-docker/issues/78 +[#80]: https://github.com/bflad/chef-docker/issues/80 +[#81]: https://github.com/bflad/chef-docker/issues/81 +[#82]: https://github.com/bflad/chef-docker/issues/82 +[#83]: https://github.com/bflad/chef-docker/issues/83 +[#84]: https://github.com/bflad/chef-docker/issues/84 +[#85]: https://github.com/bflad/chef-docker/issues/85 +[#86]: https://github.com/bflad/chef-docker/issues/86 +[#88]: https://github.com/bflad/chef-docker/issues/88 +[#89]: https://github.com/bflad/chef-docker/issues/89 +[#90]: https://github.com/bflad/chef-docker/issues/90 +[#91]: https://github.com/bflad/chef-docker/issues/91 +[#98]: https://github.com/bflad/chef-docker/issues/98 +[#101]: https://github.com/bflad/chef-docker/issues/101 +[#103]: https://github.com/bflad/chef-docker/issues/103 +[#104]: https://github.com/bflad/chef-docker/issues/104 +[#105]: https://github.com/bflad/chef-docker/issues/105 +[#106]: https://github.com/bflad/chef-docker/issues/106 +[#107]: https://github.com/bflad/chef-docker/issues/107 +[#108]: https://github.com/bflad/chef-docker/issues/108 +[#109]: https://github.com/bflad/chef-docker/issues/109 +[#110]: https://github.com/bflad/chef-docker/issues/110 +[#111]: https://github.com/bflad/chef-docker/issues/111 +[#112]: https://github.com/bflad/chef-docker/issues/112 +[#113]: https://github.com/bflad/chef-docker/issues/113 +[#114]: https://github.com/bflad/chef-docker/issues/114 +[#115]: https://github.com/bflad/chef-docker/issues/115 +[#116]: https://github.com/bflad/chef-docker/issues/116 +[#117]: https://github.com/bflad/chef-docker/issues/117 +[#118]: https://github.com/bflad/chef-docker/issues/118 +[#119]: https://github.com/bflad/chef-docker/issues/119 +[#120]: https://github.com/bflad/chef-docker/issues/120 +[#123]: https://github.com/bflad/chef-docker/issues/123 +[#124]: https://github.com/bflad/chef-docker/issues/124 +[#125]: https://github.com/bflad/chef-docker/issues/125 +[#126]: https://github.com/bflad/chef-docker/issues/126 +[#127]: https://github.com/bflad/chef-docker/issues/127 +[#128]: https://github.com/bflad/chef-docker/issues/128 +[#132]: https://github.com/bflad/chef-docker/issues/132 +[#133]: https://github.com/bflad/chef-docker/issues/133 +[#134]: https://github.com/bflad/chef-docker/issues/134 +[#137]: https://github.com/bflad/chef-docker/issues/137 +[#138]: https://github.com/bflad/chef-docker/issues/138 +[#139]: https://github.com/bflad/chef-docker/issues/139 +[#141]: https://github.com/bflad/chef-docker/issues/141 +[#142]: https://github.com/bflad/chef-docker/issues/142 +[#144]: https://github.com/bflad/chef-docker/issues/144 +[#147]: https://github.com/bflad/chef-docker/issues/147 +[#149]: https://github.com/bflad/chef-docker/issues/149 +[#150]: https://github.com/bflad/chef-docker/issues/150 +[#152]: https://github.com/bflad/chef-docker/issues/152 +[#153]: https://github.com/bflad/chef-docker/issues/153 +[#154]: https://github.com/bflad/chef-docker/issues/154 +[#156]: https://github.com/bflad/chef-docker/issues/156 +[#157]: https://github.com/bflad/chef-docker/issues/157 +[#158]: https://github.com/bflad/chef-docker/issues/158 +[#160]: https://github.com/bflad/chef-docker/issues/160 +[#161]: https://github.com/bflad/chef-docker/issues/161 +[#164]: https://github.com/bflad/chef-docker/issues/164 +[#165]: https://github.com/bflad/chef-docker/issues/165 +[#166]: https://github.com/bflad/chef-docker/issues/166 +[#168]: https://github.com/bflad/chef-docker/issues/168 +[#169]: https://github.com/bflad/chef-docker/issues/169 +[#171]: https://github.com/bflad/chef-docker/issues/171 +[#172]: https://github.com/bflad/chef-docker/issues/172 +[#173]: https://github.com/bflad/chef-docker/issues/173 +[#175]: https://github.com/bflad/chef-docker/issues/175 +[#176]: https://github.com/bflad/chef-docker/issues/176 +[#181]: https://github.com/bflad/chef-docker/issues/181 +[#185]: https://github.com/bflad/chef-docker/issues/185 +[#188]: https://github.com/bflad/chef-docker/issues/188 +[#192]: https://github.com/bflad/chef-docker/issues/192 +[#196]: https://github.com/bflad/chef-docker/issues/196 +[#200]: https://github.com/bflad/chef-docker/issues/200 +[#202]: https://github.com/bflad/chef-docker/issues/202 +[#203]: https://github.com/bflad/chef-docker/issues/203 +[#205]: https://github.com/bflad/chef-docker/issues/205 +[#206]: https://github.com/bflad/chef-docker/issues/206 +[#208]: https://github.com/bflad/chef-docker/issues/208 +[#217]: https://github.com/bflad/chef-docker/issues/217 +[#219]: https://github.com/bflad/chef-docker/issues/219 +[#220]: https://github.com/bflad/chef-docker/issues/220 +[#221]: https://github.com/bflad/chef-docker/issues/221 +[#223]: https://github.com/bflad/chef-docker/issues/223 +[#224]: https://github.com/bflad/chef-docker/issues/224 +[#232]: https://github.com/bflad/chef-docker/issues/232 +[#233]: https://github.com/bflad/chef-docker/issues/233 +[#234]: https://github.com/bflad/chef-docker/issues/234 +[#237]: https://github.com/bflad/chef-docker/issues/237 +[#238]: https://github.com/bflad/chef-docker/issues/238 +[#239]: https://github.com/bflad/chef-docker/issues/239 +[#240]: https://github.com/bflad/chef-docker/issues/240 +[#242]: https://github.com/bflad/chef-docker/issues/242 +[#244]: https://github.com/bflad/chef-docker/issues/244 +[#245]: https://github.com/bflad/chef-docker/issues/245 +[#246]: https://github.com/bflad/chef-docker/issues/246 +[#250]: https://github.com/bflad/chef-docker/issues/250 +[#258]: https://github.com/bflad/chef-docker/issues/258 +[#259]: https://github.com/bflad/chef-docker/issues/259 +[#260]: https://github.com/bflad/chef-docker/issues/260 +[#263]: https://github.com/bflad/chef-docker/issues/263 +[#264]: https://github.com/bflad/chef-docker/issues/264 +[#265]: https://github.com/bflad/chef-docker/issues/265 +[#266]: https://github.com/bflad/chef-docker/issues/266 +[#267]: https://github.com/bflad/chef-docker/issues/267 +[#268]: https://github.com/bflad/chef-docker/issues/268 +[#269]: https://github.com/bflad/chef-docker/issues/269 +[#276]: https://github.com/bflad/chef-docker/issues/276 +[#279]: https://github.com/bflad/chef-docker/issues/279 +[#280]: https://github.com/bflad/chef-docker/issues/280 +[#281]: https://github.com/bflad/chef-docker/issues/281 +[#284]: https://github.com/bflad/chef-docker/issues/284 +[#285]: https://github.com/bflad/chef-docker/issues/285 +[#287]: https://github.com/bflad/chef-docker/issues/287 +[#289]: https://github.com/bflad/chef-docker/issues/289 +[#292]: https://github.com/bflad/chef-docker/issues/292 +[#296]: https://github.com/bflad/chef-docker/issues/296 +[#297]: https://github.com/bflad/chef-docker/issues/297 +[#298]: https://github.com/bflad/chef-docker/issues/298 +[@jcrobak]: https://github.com/jcrobak +[@wingrunr21]: https://github.com/wingrunr21 diff --git a/cookbooks/docker/CONTRIBUTING.md b/cookbooks/docker/CONTRIBUTING.md new file mode 100644 index 0000000..ef2f2b8 --- /dev/null +++ b/cookbooks/docker/CONTRIBUTING.md @@ -0,0 +1,2 @@ +Please refer to +https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD diff --git a/cookbooks/docker/MAINTAINERS.md b/cookbooks/docker/MAINTAINERS.md new file mode 100644 index 0000000..a7645b9 --- /dev/null +++ b/cookbooks/docker/MAINTAINERS.md @@ -0,0 +1,20 @@ + + +# Maintainers + +This file lists how this cookbook project is maintained. When making changes to the system, this file tells you who needs to review your patch - you need a review from an existing maintainer for the cookbook to provide a :+1: on your pull request. Additionally, you need to not receive a veto from a Lieutenant or the Project Lead. + +Check out [How Cookbooks are Maintained](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD) for details on the process and how to become a maintainer or the project lead. + +# Project Maintainer +* [Sean OMeara](https://github.com/someara) + +# Maintainers +* [Jennifer Davis](https://github.com/sigje) +* [Sean OMeara](https://github.com/someara) +* [Tim Smith](https://github.com/tas50) +* [Thom May](https://github.com/thommay) +* [Anthony Scalisi](https://github.com/scalp42) +* [Chase Bolt](https://github.com/chasebolt) +* [Brian Flad](https://github.com/bflad) +* [Tom Duffield](https://github.com/tduffield) diff --git a/cookbooks/docker/README.md b/cookbooks/docker/README.md new file mode 100644 index 0000000..eb16226 --- /dev/null +++ b/cookbooks/docker/README.md @@ -0,0 +1,1274 @@ +# Docker Cookbook + +[![Build Status](https://travis-ci.org/chef-cookbooks/docker.svg?branch=master)](https://travis-ci.org/chef-cookbooks/docker) [![Cookbook Version](https://img.shields.io/cookbook/v/docker.svg)](https://supermarket.chef.io/cookbooks/docker) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/someara/chef-docker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +The Docker Cookbook is a library cookbook that provides custom resources for use in recipes. + +## Scope + +This cookbook is concerned with the [Docker](http://docker.io) container engine as distributed by Docker, Inc. It does not address Docker ecosystem tooling or prerequisite technology such as cgroups or aufs. + +## Requirements + +- Chef 12.5.x or higher. Chef 11 is NOT SUPPORTED, please do not open issues about it. +- Ruby 2.1 or higher (preferably, the Chef full-stack installer) +- Network accessible web server hosting the docker binary. +- SELinux permissive/disabled if CentOS [Docker Issue #15498](https://github.com/docker/docker/issues/15498) + +## Platform Support + +The following platforms have been tested with Test Kitchen: You may be able to get it working on other platforms, with appropriate configuration of cgroups and storage back ends. + +``` +|--------------+-------+-------+-------|--------|--------| +| | 1.7.1 | 1.8.3 | 1.9.1 | 1.10.3 | 1.11.1 | +|--------------+-------+-------+-------|--------|--------| +| debian-7 | X | X | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| debian-8 | X | X | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| centos-7 | X | X | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| fedora-23 | | | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| ubuntu-12.04 | X | X | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| ubuntu-14.04 | X | X | X | X | X | +|--------------+-------+-------+-------|--------|--------| +| ubuntu-16.04 | | | | | X | +|--------------+-------+-------+-------|--------|--------| +``` + +## Cookbook Dependencies + +- [compat_resource](https://supermarket.chef.io/cookbooks/compat_resource) + +## Usage + +- Add `depends 'docker', '~> 2.0'` to your cookbook's metadata.rb +- Use the resources shipped in cookbook in a recipe, the same way you'd use core Chef resources (file, template, directory, package, etc). + +```ruby +docker_service 'default' do + action [:create, :start] +end + +docker_image 'busybox' do + action :pull +end + +docker_container 'an-echo-server' do + repo 'busybox' + port '1234:1234' + command "nc -ll -p 1234 -e /bin/cat" +end +``` + +## Test Cookbooks as Examples + +The cookbooks ran under test-kitchen make excellent usage examples. + +The test recipes are found at: + +```ruby +test/cookbooks/docker_test/ +``` + +## Cgroups, Execution and Storage drivers + +Beginning in chef-docker 1.0, support for LXC execution driver has been removed in favor of native. Cgroups and storage drivers are now loosely coupled dependencies and should be configured using other cookbooks if needed. + +Storage drivers can be selected with the `storage_driver` property on the `docker_service` resource like this: + +```ruby +docker_service 'default' do + storage_driver 'zfs' +end +``` + +Configuration of the backing storage driver, including kernel module loading, is out of scope for this cookbook. + +## Resources Overview + +- [docker_service](#docker_service): composite resource that uses docker_installation and docker_service_manager + +- [docker_installation](#docker_installation): automatically select an installation method + +- [docker_service_manager](#docker_service_manager): automatically selects a service manager + +- [docker_installation_binary](#docker_installation_binary): copies a pre-compiled docker binary onto disk + +- [docker_installation_script](#docker_installation_script): curl | bash + +- [docker_installation_package](#docker_installation_package): package 'docker-engine' + +- [docker_service_manager_execute](#docker_service_manager_execute): manage docker daemon with Chef + +- [docker_service_manager_sysvinit](#docker_service_manager_sysvinit): manage docker daemon with a sysvinit script + +- [docker_service_manager_upstart](#docker_service_manager_upstart): manage docker daemon with upstart script + +- [docker_service_manager_systemd](#docker_service_manager_systemd): manage docker daemon with systemd unit files + +- [docker_image](#docker_image): image/repository operations + +- [docker_container](#docker_container): container operations + +- [docker_tag](#docker_tag): image tagging operations + +- [docker_registry](#docker_registry): registry operations + +- [docker_network](#docker_network): network operations + +- [docker_volume](#docker_volume): volume operations + +## Getting Started + +Here's a quick example of pulling the latest image and running a container with exposed ports. + +```ruby +# Pull latest image +docker_image 'nginx' do + tag 'latest' + action :pull + notifies :redeploy, 'docker_container[my_nginx]' +end + +# Run container exposing ports +docker_container 'my_nginx' do + repo 'nginx' + tag 'latest' + port '80:80' + host_name 'www' + domain_name 'computers.biz' + env 'FOO=bar' + volumes [ '/some/local/files/:/etc/nginx/conf.d' ] +end +``` + +You might run a private registry and multiple Docker hosts. + +```ruby +# Login to private registry +docker_registry 'https://registry.computers.biz/' do + username 'shipper' + password 'iloveshipping' + email 'shipper@computers.biz' +end + +# Pull tagged image +docker_image 'registry.computers.biz:443/my_project/my_container' do + tag 'latest' + action :pull + host 'tcp://host-1.computers.biz:2376' +end + +# Run container +docker_container 'crowsnest' do + repo 'registry.computers.biz:443/my_project/my_container' + tag 'latest' + host 'tcp://host-2.computers.biz:2376' + tls_verify true + tls_ca_cert "/path/to/ca.pem" + tls_client_cert "/path/to/cert.pem" + tls_client_key "/path/to/key.pem" + action :run +end +``` + +You can manipulate Docker volumes and networks + +```ruby +docker_network 'my_network' do + subnet '10.9.8.0/24' + gateway '10.9.8.1' +end + +docker_volume 'my_volume' do + action :create +end + +docker_container 'my_container' do + repo 'alpine' + tag '3.1' + command "nc -ll -p 1234 -e /bin/cat" + volumes 'my_volume:/my_data' + network_mode 'my_network' + action :run +end +``` + +See full documentation for each resource and action below for more information. + +## Resources Details + +## docker_installation + +The `docker_installation` resource auto-selects one of the below resources with the provider resolution system. + +### Example + +```ruby +docker_installation 'default' do + repo 'test' + action :create +end +``` + +## docker_installation_binary + +The `docker_installation_binary` resource copies the precompiled Go binary onto the disk. It exists to help run older Docker versions. It should not be used in production, especially with devicemapper. + +### Example + +```ruby +docker_installation_binary 'default' do + version '1.8.2' + source 'https://my.computers.biz/dist/docker' + checksum '97a3f5924b0b831a310efa8bf0a4c91956cd6387c4a8667d27e2b2dd3da67e4d' + action :create +end +``` + +### Properties + +- `version` - The desired version of docker. Used to calculate source. +- `source` - Path to network accessible Docker binary. Ignores version +- `checksum` - SHA-256 + +## docker_installation_tarball + +The `docker_installation_tarball` resource copies the precompiled Go binary tarball onto the disk. It exists to help run newer Docker versions from 1.11.0 onwards. It should not be used in production, especially with devicemapper. + +### Example + +```ruby +docker_installation_tarball 'default' do + version '1.11.0' + source 'https://my.computers.biz/dist/docker.tgz' + checksum '97a3f5924b0b831a310efa8bf0a4c91956cd6387c4a8667d27e2b2dd3da67e4d' + action :create +end +``` + +### Properties + +- `version` - The desired version of docker. Used to calculate source. +- `source` - Path to network accessible Docker binary tarball. Ignores version +- `checksum` - SHA-256 + +## docker_installation_script + +The `docker_installation_script` resource runs the script hosted by Docker, Inc at . It configures package repositories and installs a dynamically compiled binary. + +### Example + +```ruby +docker_installation_script 'default' do + repo 'main' + script_url 'https://my.computers.biz/dist/scripts/docker.sh' + action :create +end +``` + +### Properties + +- `repo` - One of 'main', 'test', or 'experimental'. Used to calculate script_url in its absense. Defaults to 'main' +- `script_url` - 'URL of script to pipe into /bin/sh as root. + +## docker_installation_package + +The `docker_installation_package` resource uses the system package manager to install Docker. It relies on the pre-configuration of the system's package repositories. The `chef-yum-docker` and `chef-apt-docker` Supermarket cookbooks are used to do this in test-kitchen. + +This is the recommended production installation method. + +### Example + +```ruby +docker_installation_package 'default' do + version '1.8.3' + action :create + package_options %q|--force-yes -o Dpkg::Options::='--force-confold' -o Dpkg::Options::='--force-all'| # if Ubuntu for example +end +``` + +### Properties + +- `version` - Used to calculate package_version string +- `package_version` - Manually specify the package version string +- `package_name` - Name of package to install. Defaults to 'docker-engine' +- `package_options` - Manually specify additional options, like apt-get directives for example + +## docker_service_manager + +The `docker_service_manager` resource auto-selects a strategy from the `docker_service_manager_*` group of resources based on platform and version. The `docker_service` family share a common set of properties. + +### Example + +```ruby +docker_service_manager 'default' do + action :start +end +``` + +## docker_service_manager_execute + +### Example + +```ruby +docker_service_manager_execute 'default' do + action :start +end +``` + +## docker_service_manager_sysvinit + +### Example + +```ruby +docker_service_manager_sysvinit 'default' do + host 'unix:///var/run/docker.sock' + action :stop +end +``` + +## docker_service_manager_upstart + +### Example + +```ruby +docker_service_manager_upstart 'default' do + host ['unix:///var/run/docker.sock', 'tcp://127.0.0.1:2376'] + action :start +end +``` + +## docker_service_manager_systemd + +### Example + +```ruby +docker_service_manager_systemd 'default' do + host ['unix:///var/run/docker.sock', 'tcp://127.0.0.1:2376'] + tls_verify true + tls_ca_cert "/path/to/ca.pem" + tls_server_cert "/path/to/server.pem" + tls_server_key "/path/to/server-key.pem" + tls_client_cert "/path/to/cert.pem" + tls_client_key "/path/to/key.pem" + action :start +end +``` + +## docker_service + +The `docker_service`: resource is a composite resource that uses `docker_installation` and `docker_service_manager` resources. + +- The `:create` action uses a `docker_installation` +- The `:delete` action uses a `docker_installation` +- The `:start` action uses a `docker_service_manager` +- The `:stop` action uses a `docker_service_manager` + +The service management strategy for the host platform is dynamically chosen based on platform, but can be overridden. + +### Example + +```ruby +docker_service 'tls_test:2376' do + host [ "tcp://#{node['ipaddress']}:2376", 'unix:///var/run/docker.sock' ] + tls_verify true + tls_ca_cert '/path/to/ca.pem' + tls_server_cert '/path/to/server.pem' + tls_server_key '/path/to/server-key.pem' + tls_client_cert '/path/to/client.pem' + tls_client_key '/path/to/client-key.pem' + action [:create, :start] +end +``` + +WARNING - When creating multiple `docker_service` resources on the same machine, you will need to specify unique graph properties to avoid unexpected behavior and possible data corruption. + +### Properties + +The `docker_service` resource property list mostly corresponds to the options found in the [Docker Command Line Reference](https://docs.docker.com/reference/commandline/cli/) + +- `source` - URL to the pre-compiled Docker binary used for installation. Defaults to a calculated URL based on kernel version, Docker version, and platform arch. By default, this will try to get to "". +- `version` - Docker version to install +- `checksum` - sha256 checksum of Docker binary +- `instance` - Identity for `docker_service` resource. Defaults to name. Mostly unimportant for the 1.0 version because of its singleton status. | String | nil +- `api_cors_header` - Set CORS headers in the remote API +- `bridge` - Attach containers to a network bridge +- `bip` - Specify network bridge IP +- `debug` - Enable debug mode +- `cluster_store` - Cluster store to use +- `cluster_advertise` - Ip and port that this daemon should advertise to the cluster +- `cluster_store_opts` - Cluster store options +- `daemon` - Enable daemon mode +- `dns` - DNS server(s) to use +- `dns_search` - DNS search domains to use +- `exec_driver` - Exec driver to use +- `fixed_cidr` - IPv4 subnet for fixed IPs +- `fixed_cidr_v6` - IPv6 subnet for fixed IPs +- `group` - Posix group for the unix socket +- `graph` - Root of the Docker runtime - Effectively, the "data directory" +- `host` - Daemon socket(s) to connect to - `tcp://host:port`, `unix:///path/to/socket`, `fd://*` or `fd://socketfd` +- `icc` - Enable inter-container communication +- `insecure_registry` - Enable insecure registry communication +- `ip` - Default IP when binding container ports +- `ip_forward` - Enable ip forwarding +- `ipv4_forward` - Enable net.ipv4.ip_forward +- `ipv6_forward` - Enable net.ipv6.ip_forward +- `ip_masq` - Enable IP masquerading +- `iptables` - Enable addition of iptables rules +- `ipv6` - Enable IPv6 networking +- `log_level` - Set the logging level +- `labels` A string or array to set metadata on the daemon in the form ['foo:bar', 'hello:world']` +- `log_driver` - Container's logging driver (json-file/syslog/journald/gelf/fluentd/none) +- `log_opts` - Container's logging driver options (driver-specific) +- `mtu` - Set the containers network MTU +- `pidfile` - Path to use for daemon PID file +- `registry_mirror` - Preferred Docker registry mirror +- `storage_driver` - Storage driver to use +- `selinux_enabled` - Enable selinux support +- `storage_opts` - Set storage driver options +- `tls` - Use TLS; implied by --tlsverify. Defaults to ENV['DOCKER_TLS'] if set +- `tls_verify` - Use TLS and verify the remote. Defaults to ENV['DOCKER_TLS_VERIFY'] if set +- `tls_ca_cert` - Trust certs signed only by this CA. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_server_cert` - Path to TLS certificate file for docker service +- `tls_server_key` - Path to TLS key file for docker service +- `tls_client_cert` - Path to TLS certificate file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_client_key` - Path to TLS key file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `default_ulimit` - Set default ulimit settings for containers +- `http_proxy` - ENV variable set before for Docker daemon starts +- `https_proxy` - ENV variable set before for Docker daemon starts +- `no_proxy` - ENV variable set before for Docker daemon starts +- `tmpdir` - ENV variable set before for Docker daemon starts +- `logfile` - Location of Docker daemon log file +- `userland_proxy`- Enables or disables docker-proxy +- `disable_legacy_registry` - Do not contact legacy registries +- `userns_remap` - Enable user namespace remapping options - `default`, `uid`, `uid:gid`, `username`, `username:groupname` (see: [Docker User Namespaces](see: https://docs.docker.com/v1.10/engine/reference/commandline/daemon/#daemon-user-namespace-options)) + +##### Miscellaneous Options +- `misc_opts` - Pass the docker daemon any other options bypassing flag validation, supplied as `--flag=value` + +### Actions + +- `:create` - Lays the Docker bits out on disk +- `:delete` - Removes the Docker bits from the disk +- `:start` - Makes sure the service provider is set up properly and start it +- `:stop` - Stops the service +- `:restart` - Restarts the service + +### `docker_service` implementations + +- `docker_service_execute` - The simplest docker_service. Just starts a process. Fire and forget. + +- `docker_service_sysvinit` - Uses a SystemV init script to manage the service state. + +- `docker_service_upstart` - Uses an Upstart script to manage the service state. + +- `docker_service_systemd` - Uses an Systemd unit file to manage the service state. NOTE: This does NOT enable systemd socket activation. + +## docker_image + +The `docker_image` is responsible for managing Docker image pulls, builds, and deletions. It speaks directly to the [Docker remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.20/). + +### Examples + +- default action, default properties + + ```ruby + docker_image 'hello-world' + ``` + +- non-default name attribute + + ```ruby + docker_image "Tom's container" do + repo 'tduffield/testcontainerd' + action :pull + end + ``` + +- pull every time + + ```ruby + docker_image 'busybox' do + action :pull + end + ``` + +- specify a tag + + ```ruby + docker_image 'alpine' do + tag '3.1' + end + ``` + +- specify read/write timeouts + + ```ruby + docker_image 'alpine' do + read_timeout 60 + write_timeout 60 + end + ``` + +```ruby +docker_image 'vbatts/slackware' do + action :remove +end +``` + +- save + + ```ruby + docker_image 'save hello-world' do + repo 'hello-world' + destination '/tmp/hello-world.tar' + not_if { ::File.exist?('/tmp/hello-world.tar') } + action :save + end + ``` + +- build from a Dockerfile on every chef-client run + + ```ruby + docker_image 'image_1' do + tag 'v0.1.0' + source '/src/myproject/container1/Dockerfile' + action :build + end + ``` + +- build from a directory, only if image is missing + + ```ruby + docker_image 'image_2' do + tag 'v0.1.0' + source '/src/myproject/container2' + action :build_if_missing + end + ``` + +- build from a tarball NOTE: this is not an "export" tarball generated from an an image save. The contents should be a Dockerfile, and anything it references to COPY or ADD + +```ruby +docker_image 'image_3' do + tag 'v0.1.0' + source '/tmp/image_3.tar' + action :build +end +``` + +```ruby +docker_image 'hello-again' do + tag 'v0.1.0' + source '/tmp/hello-world.tar' + action :import +end +``` + +- push + + ```ruby + docker_image 'my.computers.biz:5043/someara/hello-again' do + action :push + end + ``` + +- Connect to an external docker daemon and pull an image + +```ruby +docker_image 'alpine' do + host 'tcp://127.0.0.1:2376' + tag '2.7' +end +``` + +### Properties + +The `docker_image` resource properties mostly corresponds to the [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.20/#2-2-images) as driven by the [Swipley docker-api Ruby gem](https://github.com/swipely/docker-api) + +A `docker_image`'s full identifier is a string in the form "\:\". There is some nuance around naming using the public +registry vs a private one. + +- `repo` - aka `image_name` - The first half of a Docker image's identity. This is a string in the form: `registry:port/owner/image_name`. If the `registry:port` portion is left off, Docker will implicitly use the Docker public registry. "Official Images" omit the owner part. This means a repo id can look as short as `busybox`, `alpine`, or `centos`, to refer to official images on the public registry, and as long as `my.computers.biz:5043/what/ever` to refer to custom images on an private registry. Often you'll see something like `someara/chef` to refer to private images on the public registry. - Defaults to resource name. +- `tag` - The second half of a Docker image's identity. - Defaults to `latest` +- `source` - Path to input for the `:import`, `:build` and `:build_if_missing` actions. For building, this can be a Dockerfile, a tarball containing a Dockerfile in its root, or a directory containing a Dockerfile. For import, this should be a tarball containing Docker formatted image, as generated with `:save`. +- `destination` - Path for output from the `:save` action. +- `force` - A force boolean used in various actions - Defaults to false +- `nocache` - Used in `:build` operations. - Defaults to false +- `noprune` - Used in `:remove` operations - Defaults to false +- `rm` - Remove intermediate containers after a successful build (default behavior) - Defaults to `true` +- `read_timeout` - May need to increase for long image builds/pulls +- `write_timeout` - May need to increase for long image builds/pulls +- `host` - A string containing the host the API should communicate with. Defaults to ENV['DOCKER_HOST'] if set +- `tls` - Use TLS; implied by --tlsverify. Defaults to ENV['DOCKER_TLS'] if set +- `tls_verify` - Use TLS and verify the remote. Defaults to ENV['DOCKER_TLS_VERIFY'] if set +- `tls_ca_cert` - Trust certs signed only by this CA. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_client_cert` - Path to TLS certificate file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_client_key` - Path to TLS key file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set + +### Actions + +The following actions are available for a `docker_image` resource. Defaults to `pull_if_missing` + +- `:pull` - Pulls an image from the registry +- `:pull_if_missing` - Pulls an image from the registry, only if it missing +- `:build` - Builds an image from a Dockerfile, directory, or tarball +- `:build_if_missing` - Same build, but only if it is missing +- `:save` - Exports an image to a tarball at `destination` +- `:import` - Imports an image from a tarball at `destination` +- `:remove` - Removes (untags) an image +- `:push` - Pushes an image to the registry + +## docker_tag + +Docker tags work very much like hard links in a Unix filesystem. They are just references to an existing image. Therefore, the docker_tag resource has taken inspiration from the Chef `link` resource. + +### Examples + +```ruby +docker_tag 'private repo tag for hello-again:1.0.1' do + target_repo 'hello-again' + target_tag 'v0.1.0' + to_repo 'localhost:5043/someara/hello-again' + to_tag 'latest' + action :tag +end +``` + +### Properties + +- `target_repo` - The repo half of the source image identifier. +- `target_tag` - The tag half of the source image identifier. +- `to_repo` - The repo half of the new image identifier +- `to_tag`- The tag half of the new image identifier + +### Actions + +- `:tag` - Tags the image + +## docker_container + +The `docker_container` is responsible for managing Docker container actions. It speaks directly to the [Docker remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.20/). + +Containers are process oriented, and move through an event cycle. Thanks to [Glider Labs](http://gliderlabs.com/) for this excellent diagram. ![alt tag](http://gliderlabs.com/images/docker_events.png) + +### Examples + +- Create a container without starting it. + +```ruby +docker_container 'hello-world' do + command '/hello' + action :create +end +``` + +- This command will exit succesfully. This will happen on every chef-client run. + +```ruby +docker_container 'busybox_ls' do + repo 'busybox' + command 'ls -la /' + action :run +end +``` + +- The :run_if_missing action will only run once. It is the default action. + +```ruby +docker_container 'alpine_ls' do + repo 'alpine' + tag '3.1' + command 'ls -la /' + action :run_if_missing +end +``` + +- Set environment variables in a container + +```ruby +docker_container 'env' do + repo 'debian' + env ['PATH=/usr/bin', 'FOO=bar'] + command 'env' + action :run_if_missing +end +``` + +- This process remains running between chef-client runs, :run will do nothing on subsequent converges. + +```ruby +docker_container 'an_echo_server' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 7 -e /bin/cat' + port '7:7' + action :run +end +``` + +- Let docker pick the host port + +```ruby +docker_container 'another_echo_server' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 7 -e /bin/cat' + port '7' + action :run +end +``` + +- Specify the udp protocol + +```ruby +docker_container 'an_udp_echo_server' do + repo 'alpine' + tag '3.1' + command 'nc -ul -p 7 -e /bin/cat' + port '5007:7/udp' + action :run +end +``` + +- Kill a container + +```ruby +docker_container 'bill' do + action :kill +end +``` + +- Stop a container + +```ruby +docker_container 'hammer_time' do + action :stop +end +``` + +- Force-stop a container after 30 seconds + +```ruby +docker_container 'hammer_time' do + kill_after 30 + action :stop +end +``` + +- Pause a container + +```ruby +docker_container 'red_light' do + action :pause +end +``` + +- Unpause a container + +```ruby +docker_container 'green_light' do + action :unpause +end +``` + +- Restart a container + +```ruby +docker_container 'restarter' do + action :restart +end +``` + +- Delete a container + +```ruby +docker_container 'deleteme' do + remove_volumes true + action :delete +end +``` + +- Redeploy a container + +```ruby +docker_container 'redeployer' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 7777 -e /bin/cat' + port '7' + action :run +end + +execute 'redeploy redeployer' do + notifies :redeploy, 'docker_container[redeployer]', :immediately + action :run +end +``` + +- Bind mount local directories + +```ruby +docker_container 'bind_mounter' do + repo 'busybox' + command 'ls -la /bits /more-bits' + volumes ['/hostbits:/bits', '/more-hostbits:/more-bits'] + action :run_if_missing +end +``` + +- Mount volumes from another container + +```ruby +docker_container 'chef_container' do + command 'true' + volumes '/opt/chef' + action :create +end + +docker_container 'ohai_debian' do + command '/opt/chef/embedded/bin/ohai platform' + repo 'debian' + volumes_from 'chef_container' +end +``` + +- Set a container's entrypoint + +```ruby +docker_container 'ohai_again_debian' do + repo 'debian' + volumes_from 'chef_container' + entrypoint '/opt/chef/embedded/bin/ohai' + command 'platform' + action :run_if_missing +end +``` + +- Automatically remove a container after it exits + +```ruby +docker_container 'sean_was_here' do + command "touch /opt/chef/sean_was_here-#{Time.new.strftime('%Y%m%d%H%M')}" + repo 'debian' + volumes_from 'chef_container' + autoremove true + action :run +end +``` + +- Grant NET_ADMIN rights to a container + +```ruby +docker_container 'cap_add_net_admin' do + repo 'debian' + command 'bash -c "ip addr add 10.9.8.7/24 brd + dev eth0 label eth0:0 ; ip addr list"' + cap_add 'NET_ADMIN' + action :run_if_missing +end +``` + +- Revoke MKNOD rights to a container + + ```ruby + docker_container 'cap_drop_mknod' do + repo 'debian' + command 'bash -c "mknod -m 444 /dev/urandom2 c 1 9 ; ls -la /dev/urandom2"' + cap_drop 'MKNOD' + action :run_if_missing + end + ``` + +- Set a container's hostname and domainname + +```ruby +docker_container 'fqdn' do + repo 'debian' + command 'hostname -f' + host_name 'computers' + domain_name 'biz' + action :run_if_missing +end +``` + +- Set a container's DNS resolution + +```ruby +docker_container 'dns' do + repo 'debian' + command 'cat /etc/resolv.conf' + host_name 'computers' + dns ['4.3.2.1', '1.2.3.4'] + dns_search ['computers.biz', 'chef.io'] + action :run_if_missing +end +``` + +- Add extra hosts to a container's `/etc/hosts` + +```ruby +docker_container 'extra_hosts' do + repo 'debian' + command 'cat /etc/hosts' + extra_hosts ['east:4.3.2.1', 'west:1.2.3.4'] + action :run_if_missing +end +``` + +- Manage container's restart_policy + +```ruby +docker_container 'try_try_again' do + repo 'alpine' + tag '3.1' + command 'grep asdasdasd /etc/passwd' + restart_policy 'on-failure' + restart_maximum_retry_count 2 + action :run_if_missing +end + +docker_container 'reboot_survivor' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 123 -e /bin/cat' + port '123' + restart_policy 'always' + action :run_if_missing +end +``` + +- Manage container links + +```ruby +docker_container 'link_source' do + repo 'alpine' + tag '3.1' + env ['FOO=bar', 'BIZ=baz'] + command 'nc -ll -p 321 -e /bin/cat' + port '321' + action :run_if_missing +end + +docker_container 'link_target_1' do + repo 'alpine' + tag '3.1' + env ['ASD=asd'] + command 'ping -c 1 hello' + links ['link_source:hello'] + action :run_if_missing +end + +docker_container 'link_target_2' do + repo 'alpine' + tag '3.1' + command 'env' + links ['link_source:hello'] + action :run_if_missing +end + +execute 'redeploy_link_source' do + command 'touch /marker_container_redeploy_link_source' + creates '/marker_container_redeploy_link_source' + notifies :redeploy, 'docker_container[link_source]', :immediately + notifies :redeploy, 'docker_container[link_target_1]', :immediately + notifies :redeploy, 'docker_container[link_target_2]', :immediately + action :run +end +``` + +- Mutate a container between chef-client runs + +```ruby +docker_tag 'mutator_from_busybox' do + target_repo 'busybox' + target_tag 'latest' + to_repo 'someara/mutator' + target_tag 'latest' +end + +docker_container 'mutator' do + repo 'someara/mutator' + tag 'latest' + command "sh -c 'touch /mutator-`date +\"%Y-%m-%d_%H-%M-%S\"`'" + outfile '/mutator.tar' + force true + action :run_if_missing +end + +execute 'commit mutator' do + command 'true' + notifies :commit, 'docker_container[mutator]', :immediately + notifies :export, 'docker_container[mutator]', :immediately + notifies :redeploy, 'docker_container[mutator]', :immediately + action :run +end +``` + +- Specify read/write timeouts + +```ruby +docker_container 'api_timeouts' do + repo 'alpine' + read_timeout 60 + write_timeout 60 +end +``` + +- Specify a custom logging driver and its options + +```ruby +docker_container 'syslogger' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 780 -e /bin/cat' + log_driver 'syslog' + log_opts 'syslog-tag=container-syslogger' +end +``` + +- Connect to an external docker daemon and create a container + +```ruby +docker_container 'external_daemon' do + repo 'alpine' + host 'tcp://1.2.3.4:2376' + action :create +end +``` + +### Properties + +Most `docker_container` properties are the `snake_case` version of the `CamelCase` keys found in the [Docker Remote Api](https://docs.docker.com/reference/api/docker_remote_api_v1.20/) + +- `container_name` - The name of the container. Defaults to the name of the `docker_container` resource. +- `repo` - aka `image_name`. The first half of a the complete identifier for a Docker Image. +- `tag` - The second half of a Docker image's identity. - Defaults to `latest`. +- `command` - The command to run when starting the container. +- `autoremove` - Boolean - Automatically delete a container when it's command exits. Defaults to `false`. +- `volumes` - An array of volume bindings for this container. Each volume binding is a string in one of these forms: `container_path` to create a new volume for the container. `host_path:container_path` to bind-mount a host path into the container. `host_path:container_path:ro` to make the bind-mount read-only inside the container. +- `cap_add` - An array Linux Capabilities (`man 7 capabilities`) to add to grant the container beyond what it normally gets. +- `cap_drop` - An array Linux Capabilities (`man 7 capabilities`) to revoke that the container normally has. +- `cpu_shares` - An integer value containing the CPU Shares for the container. +- `devices` - A Hash of devices to add to the container. +- `dns` - An array of DNS servers the container will use for name resolution. +- `dns_search` - An array of domains the container will search for name resolution. +- `domain_name` - Set's the container's dnsdomainname as returned by the `dnsdomainname` command. +- `entrypoint` - Set the entry point for the container as a string or an array of strings. +- `env` - Set environment variables in the container in the form `['FOO=bar', 'BIZ=baz']` +- `extra_hosts` - An array of hosts to add to the container's `/etc/hosts` in the form `['host_a:10.9.8.7', 'host_b:10.9.8.6']` +- `force` - A boolean to use in container operations that support a `force` option. Defaults to `false` +- `host` - A string containing the host the API should communicate with. Defaults to ENV['DOCKER_HOST'] if set +- `host_name` - The hostname for the container. +- `labels` A string, array, or hash to set metadata on the container in the form ['foo:bar', 'hello:world']` +- `links` - An array of source container/alias pairs to link the container to in the form `[container_a:www', container_b:db']` +- `log_driver` - Sets a custom logging driver for the container (json-file/syslog/journald/gelf/fluentd/none). +- `log_opts` - Configures the above logging driver options (driver-specific). +- `mac_address` - The mac address for the container to use. +- `memory` - Memory limit in bytes. +- `memory_swap` - Total memory limit (memory + swap); set `-1` to disable swap limit (unlimited). You must use this with memory and make the swap value larger than memory. +- `network_disabled` - Boolean to disable networking. Defaults to `false`. +- `network_mode` - Sets the networking mode for the container. One of `bridge`, `host`, `container`. +- `open_stdin` - Boolean value, opens stdin. Defaults to `false`. +- `outfile` - The path to write the file when using `:export` action. +- `port` - The port configuration to use in the container. Matches the syntax used by the `docker` CLI tool. +- `privileged` - Boolean to start the container in privileged more. Defaults to `false` +- `publish_all_ports` - Allocates a random host port for all of a container's exposed ports. +- `remove_volumes` - A boolean to clean up "dangling" volumes when removing the last container with a reference to it. Default to `false` to match the Docker CLI behavior. +- `restart_policy` - One of `no`, `on-failure`, `unless-stopped`, or `always`. Use `always` if you want a service container to survive a Dockerhost reboot. Defaults to `no`. +- `restart_maximum_retry_count` - Maximum number of restarts to try when `restart_policy` is `on-failure`. Defaults to an ever increasing delay (double the previous delay, starting at 100mS), to prevent flooding the server. +- `security_opts` - A list of string values to customize labels for MLS systems, such as SELinux. +- `signal` - The signal to send when using the `:kill` action. Defaults to `SIGTERM`. +- `tty` - Boolean value to allocate a pseudo-TTY. Defaults to `false`. +- `user` - A string value specifying the user inside the container. +- `volumes` - An Array of paths inside the container to expose. Does the same thing as the `VOLUME` directive in a Dockerfile, but works on container creation. +- `volumes_from` - A list of volumes to inherit from another container. Specified in the form `[:]` +- `working_dir` - A string specifying the working directory for commands to run in. +- `read_timeout` - May need to increase for commits or exports that are slow +- `write_timeout` - May need to increase for commits or exports that are slow +- `kill_after` - Number of seconds to wait before killing the container. Defaults to wait indefinitely; eventually will hit read_timeout limit. +- `timeout` - Seconds to wait for an attached container to return +- `tls` - Use TLS; implied by --tlsverify. Defaults to ENV['DOCKER_TLS'] if set +- `tls_verify` - Use TLS and verify the remote. Defaults to ENV['DOCKER_TLS_VERIFY'] if set +- `tls_ca_cert` - Trust certs signed only by this CA. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_client_cert` - Path to TLS certificate file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `tls_client_key` - Path to TLS key file for docker cli. Defaults to ENV['DOCKER_CERT_PATH'] if set +- `userns_mode` - Modify the user namespace mode - Defaults to `nil`, example option: `host` +- `pid_mode` - Set the PID (Process) Namespace mode for the container. `host`: use the host's PID namespace inside the container. +- `ipc_mode` - Set the IPC mode for the container - Defaults to `nil`, example option: `host` +- `uts_mode` - Set the UTS namespace mode for the container. The UTS namespace is for setting the hostname and the domain that is visible to running processes in that namespace. By default, all containers, including those with `--network=host`, have their own UTS namespace. The host setting will result in the container using the same UTS namespace as the host. Note that --hostname is invalid in host UTS mode. +- `ro_rootfs` - Mount the container's root filesystem as read only. Defaults to `false` + +### Actions + +- `:create` - Creates the container but does not start it. Useful for Volume containers. +- `:start` - Starts the container. Useful for containers that run jobs.. command that exit. +- `:run` - The default action. Both `:create` and `:start` the container in one action. Redeploys the container on resource change. +- `:run_if_missing` - Runs a container only once. +- `:stop` - Stops the container. +- `:restart` - Stops the starts the container. +- `:kill` - Send a signal to the container process. Defaults to `SIGKILL`. +- `:pause` - Pauses the container. +- `:unpause` - Unpauses the container. +- `:delete` - Deletes the container. +- `:redeploy` - Deletes and runs the container. + +## docker_registry + +The `docker_registry` resource is responsible for managing the connection auth information to a Docker registry. + +### docker_registry action :login + +- Log into or register with public registry: + +```ruby +docker_registry 'https://index.docker.io/v1/' do + username 'publicme' + password 'hope_this_is_in_encrypted_databag' + email 'publicme@computers.biz' +end +``` + +Log into private registry with optional port: + +```ruby +docker_registry 'my local registry' do + serveraddress 'https://registry.computers.biz:8443/' + username 'privateme' + password 'still_hope_this_is_in_encrypted_databag' + email 'privateme@computers.biz' +end +``` + +## docker_network + +The `docker_network` resource is responsible for managing Docker named networks. Usage of `overlay` driver requires the `docker_service` to be configured to use a distributed key/value store like `etcd`, `consul`, or `zookeeper`. + +### docker_network action :create + +```ruby +docker_network 'my_network' do + subnet '192.168.88.0/24' + gateway '192.168.88.1' + action :create +end + +docker_container 'echo-base' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 1337 -e /bin/cat' + port '1337' + network_mode 'my_network' + action :run +end +``` + +### Properties + +- `driver` - The network driver to use. Defaults to `bridge`, other options include `overlay`. +- `subnet` - Specify the subnet(s) for the network. Ex: `192.168.0.0/16` +- `gateway` - Specify the gateway(s) for the network. Ex: `192.168.0.1` +- `ip_range` - Specify a range of IPs to allocate for containers. Ex: `192.168.1.0/24` +- `aux_address` - Auxillary addresses for the network. Ex: `['a=192.168.1.5', 'b=192.168.1.6']` + +### Example + +```ruby +docker_network 'network_g' do + driver 'overlay' + subnet ['192.168.0.0/16', '192.170.0.0/16'] + gateway ['192.168.0.100', '192.170.0.100'] + ip_range '192.168.1.0/24' + aux_address ['a=192.168.1.5', 'b=192.168.1.6', 'a=192.170.1.5', 'b=192.170.1.6'] +end +``` + +### Actions + +- `:create` - create a network +- `:delete` - create a network + +## docker_volume + +The `docker_volume` resource is responsible for managing Docker named volumes. + +### docker_volume action :create + +```ruby +docker_volume 'hello' do + action :create +end + +docker_container 'file_writer' do + repo 'alpine' + tag '3.1' + volumes 'hello:/hello' + command 'touch /hello/sean_was_here' + action :run_if_missing +end +``` + +### Actions + +- `:create` - create a network +- `:remove` - create a network + +## docker_execute + +The `docker_execute` resource allows you to execute commands inside of a running container. + +### Examples + +```ruby +docker_exec 'touch_it' do + container 'busybox_exec' + command ['touch', '/tmp/onefile'] +end +``` + +### Properties + +- `host` - Daemon socket(s) to connect to - `tcp://host:port`, `unix:///path/to/socket`, `fd://*` or `fd://socketfd`. +- `command` - A command structured as an Array similar to `CMD` in a Dockerfile. +- `container` - Name of the container to execute the command in. +- `timeout`- Seconds to wait for an attached container to return. Defaults to 60 seconds. + +### Actions + +- `:run` - Runs the command + +## Testing and Development + +- Full development and testing workflow with Test Kitchen and friends: + + + + +## Contributing + +Please see contributing information in: + + + + +## Maintainers + +- Sean OMeara ([sean@sean.io](mailto:sean@sean.io)) +- Brian Flad ([bflad417@gmail.com](mailto:bflad417@gmail.com)) +- Tom Duffield () +- Fletcher Nichol ([fnichol@nichol.ca](mailto:fnichol@nichol.ca)) +- Chase Bolt ([chase.bolt@gmail.com](mailto:chase.bolt@gmail.com)) + +## License + +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. diff --git a/cookbooks/docker/libraries/_autoload.rb b/cookbooks/docker/libraries/_autoload.rb new file mode 100644 index 0000000..8f1a2a1 --- /dev/null +++ b/cookbooks/docker/libraries/_autoload.rb @@ -0,0 +1,13 @@ +begin + gem 'docker-api', '= 1.31.0' +rescue LoadError + unless defined?(ChefSpec) + run_context = Chef::RunContext.new(Chef::Node.new, {}, Chef::EventDispatch::Dispatcher.new) + + require 'chef/resource/chef_gem' + + docker = Chef::Resource::ChefGem.new('docker-api', run_context) + docker.version '= 1.31.0' + docker.run_action(:install) + end +end diff --git a/cookbooks/docker/libraries/docker_base.rb b/cookbooks/docker/libraries/docker_base.rb new file mode 100644 index 0000000..8514b2f --- /dev/null +++ b/cookbooks/docker/libraries/docker_base.rb @@ -0,0 +1,89 @@ +module DockerCookbook + class DockerBase < ChefCompat::Resource + require_relative 'helpers_auth' + require_relative 'helpers_base' + + include DockerHelpers::Base + + ######### + # Classes + ######### + + class UnorderedArray < Array + def ==(other) + # If I (desired env) am a subset of the current env, let == return true + other.is_a?(Array) && all? { |val| other.include?(val) } + end + end + + class ShellCommandString < String + def ==(other) + other.is_a?(String) && Shellwords.shellwords(self) == Shellwords.shellwords(other) + end + end + + class PartialHash < Hash + def ==(other) + other.is_a?(Hash) && all? { |key, val| other.key?(key) && other[key] == val } + end + end + + ################ + # Type Constants + # + # These will be used when declaring resource property types in the + # docker_service, docker_container, and docker_image resource. + # + ################ + + ArrayType = property_type( + is: [Array, nil], + coerce: proc { |v| v.nil? ? nil : Array(v) } + ) unless defined?(ArrayType) + + Boolean = property_type( + is: [true, false], + default: false + ) unless defined?(Boolean) + + NonEmptyArray = property_type( + is: [Array, nil], + coerce: proc { |v| Array(v).empty? ? nil : Array(v) } + ) unless defined?(NonEmptyArray) + + ShellCommand = property_type( + is: [String], + coerce: proc { |v| coerce_shell_command(v) } + ) unless defined?(ShellCommand) + + UnorderedArrayType = property_type( + is: [UnorderedArray, nil], + coerce: proc { |v| v.nil? ? nil : UnorderedArray.new(Array(v)) } + ) unless defined?(UnorderedArrayType) + + PartialHashType = property_type( + is: [PartialHash, nil], + coerce: proc { |v| v.nil? ? nil : PartialHash[v] } + ) unless defined?(PartialHashType) + + ##################### + # Resource properties + ##################### + + property :api_retries, Fixnum, default: 3, desired_state: false + property :read_timeout, [Fixnum, nil], default: 60, desired_state: false + property :write_timeout, [Fixnum, nil], desired_state: false + + property :tls, [Boolean, nil], default: lazy { default_tls }, desired_state: false + property :tls_verify, [Boolean, nil], default: lazy { default_tls_verify }, desired_state: false + property :tls_ca_cert, [String, nil], default: lazy { default_tls_cert_path('ca') }, desired_state: false + property :tls_server_cert, [String, nil], desired_state: false + property :tls_server_key, [String, nil], desired_state: false + property :tls_client_cert, [String, nil], default: lazy { default_tls_cert_path('cert') }, desired_state: false + property :tls_client_key, [String, nil], default: lazy { default_tls_cert_path('key') }, desired_state: false + + declare_action_class.class_eval do + include DockerHelpers::Authentication + end + end +end diff --git a/cookbooks/docker/libraries/docker_container.rb b/cookbooks/docker/libraries/docker_container.rb new file mode 100644 index 0000000..4190ec4 --- /dev/null +++ b/cookbooks/docker/libraries/docker_container.rb @@ -0,0 +1,398 @@ +module DockerCookbook + class DockerContainer < DockerBase + require 'docker' + require 'shellwords' + require_relative 'helpers_container' + + include DockerHelpers::Container + + resource_name :docker_container + + ########################################################### + # In Chef 12.5 and later, we no longer have to use separate + # classes for resource and providers. Instead, we have + # everything in a single class. + # + # For the purposes of my own sanity, I'm going to place all the + # "resource" related bits at the top of the files, and the + # providerish bits at the bottom. + # + # + # Methods for default values and coersion are found in + # helpers_container.rb + ########################################################### + + # ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~ + # Begin classic Chef "resource" section + # ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~ + + # The non-standard types Boolean, ArrayType, ShellCommand, etc + # are found in the DockerBase class. + property :container_name, String, name_property: true + property :repo, String, default: lazy { container_name } + property :tag, String, default: 'latest' + property :command, ShellCommand + property :attach_stderr, Boolean, default: false, desired_state: false + property :attach_stdin, Boolean, default: false, desired_state: false + property :attach_stdout, Boolean, default: false, desired_state: false + property :autoremove, Boolean, desired_state: false + property :cap_add, NonEmptyArray + property :cap_drop, NonEmptyArray + property :cgroup_parent, String, default: '' + property :cpu_shares, [Fixnum, nil], default: 0 + property :cpuset_cpus, String, default: '' + property :detach, Boolean, default: true, desired_state: false + property :devices, Array, default: [] + property :dns, Array, default: [] + property :dns_search, Array, default: [] + property :domain_name, String, default: '' + property :entrypoint, ShellCommand + property :env, UnorderedArrayType, default: [] + property :extra_hosts, NonEmptyArray + property :exposed_ports, PartialHashType, default: {} + property :force, Boolean, desired_state: false + property :host, [String, nil], default: lazy { default_host }, desired_state: false + property :hostname, String + property :ipc_mode, String, default: '' + property :labels, [String, Array, Hash], default: {}, coerce: proc { |v| coerce_labels(v) } + property :links, UnorderedArrayType, coerce: proc { |v| coerce_links(v) } + property :log_driver, %w( json-file syslog journald gelf fluentd awslogs splunk none ), default: 'json-file', desired_state: false + property :log_opts, [Hash, nil], coerce: proc { |v| coerce_log_opts(v) }, desired_state: false + property :mac_address, String + property :memory, Fixnum, default: 0 + property :memory_swap, Fixnum, default: 0 + property :network_disabled, Boolean, default: false + property :network_mode, [String, NilClass], default: lazy { default_network_mode } + property :open_stdin, Boolean, default: false, desired_state: false + property :outfile, [String, NilClass] + property :port_bindings, PartialHashType, default: {} + property :pid_mode, String, default: '' + property :privileged, Boolean, default: false + property :publish_all_ports, Boolean, default: false + property :remove_volumes, Boolean + property :restart_maximum_retry_count, Fixnum, default: 0 + property :restart_policy, String, default: 'no' + property :ro_rootfs, Boolean, default: false + property :security_opts, [String, ArrayType] + property :signal, String, default: 'SIGTERM' + property :stdin_once, Boolean, default: false, desired_state: false + property :timeout, [Fixnum, nil], desired_state: false + property :tty, Boolean, default: false + property :ulimits, [Array, nil], coerce: proc { |v| coerce_ulimits(v) } + property :user, String, default: '' + property :userns_mode, String, default: '' + property :uts_mode, String, default: '' + property :volumes, PartialHashType, default: {}, coerce: proc { |v| coerce_volumes(v) } + property :volumes_from, ArrayType + property :working_dir, [String, NilClass], default: '' + + # Used to store the bind property since binds is an alias to volumes + property :volumes_binds, Array + + # Used to store the state of the Docker container + property :container, Docker::Container, desired_state: false + + # Used by :stop action. If the container takes longer than this + # many seconds to stop, kill itinstead. -1 (the default) means + # never kill the container. + property :kill_after, Numeric, default: -1, desired_state: false + + alias cmd command + alias additional_host extra_hosts + alias rm autoremove + alias remove_automatically autoremove + alias host_name hostname + alias domainname domain_name + alias dnssearch dns_search + alias restart_maximum_retries restart_maximum_retry_count + alias volume volumes + alias binds volumes + alias volume_from volumes_from + alias destination outfile + alias workdir working_dir + + # ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~ + # Begin classic Chef "provider" section + # ~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~=~ + + ######################################################## + # Load Current Value + ######################################################## + + load_current_value do + # Grab the container and assign the container property + begin + with_retries { container Docker::Container.get(container_name, {}, connection) } + rescue Docker::Error::NotFoundError + current_value_does_not_exist! + end + + # Go through everything in the container and set corresponding properties: + # c.info['Config']['ExposedPorts'] -> exposed_ports + (container.info['Config'].to_a + container.info['HostConfig'].to_a).each do |key, value| + next if value.nil? || key == 'RestartPolicy' || key == 'Binds' + + # Image => image + # Set exposed_ports = ExposedPorts (etc.) + property_name = to_snake_case(key) + public_send(property_name, value) if respond_to?(property_name) + end + + # these are a special case for us because our names differ from theirs + restart_policy container.info['HostConfig']['RestartPolicy']['Name'] + restart_maximum_retry_count container.info['HostConfig']['RestartPolicy']['MaximumRetryCount'] + volumes_binds container.info['HostConfig']['Binds'] + end + + ######### + # Actions + ######### + + # Super handy visual reference! + # http://gliderlabs.com/images/docker_events.png + + default_action :run + + declare_action_class.class_eval do + def whyrun_supported? + true + end + + def call_action(action) + send("action_#{action}") + load_current_resource + end + + def state + current_resource ? current_resource.state : {} + end + end + + def validate_container_create + if property_is_set?(:restart_policy) && + restart_policy != 'no' && + restart_policy != 'always' && + restart_policy != 'unless-stopped' && + restart_policy != 'on-failure' + raise Chef::Exceptions::ValidationFailed, 'restart_policy must be either no, always, unless-stopped, or on-failure.' + end + + if autoremove == true && (property_is_set?(:restart_policy) && restart_policy != 'no') + raise Chef::Exceptions::ValidationFailed, 'Conflicting options restart_policy and autoremove.' + end + + if detach == true && + ( + attach_stderr == true || + attach_stdin == true || + attach_stdout == true || + stdin_once == true + ) + raise Chef::Exceptions::ValidationFailed, 'Conflicting options detach, attach_stderr, attach_stdin, attach_stdout, stdin_once.' + end + + if network_mode == 'host' && + ( + !(hostname.nil? || hostname.empty?) || + !(dns.nil? || dns.empty?) || + !(dns_search.nil? || dns_search.empty?) || + !(mac_address.nil? || mac_address.empty?) || + !(extra_hosts.nil? || extra_hosts.empty?) + ) + raise Chef::Exceptions::ValidationFailed, 'Cannot specify hostname, dns, dns_search, mac_address, or extra_hosts when network_mode is host.' + end + + if network_mode == 'container' && + ( + !(hostname.nil? || hostname.empty?) || + !(dns.nil? || dns.empty?) || + !(dns_search.nil? || dns_search.empty?) || + !(mac_address.nil? || mac_address.empty?) || + !(extra_hosts.nil? || extra_hosts.empty?) || + !(exposed_ports.nil? || exposed_ports.empty?) || + !(port_bindings.nil? || port_bindings.empty?) || + !(publish_all_ports.nil? || publish_all_ports.empty?) || + !port.nil? + ) + raise Chef::Exceptions::ValidationFailed, 'Cannot specify hostname, dns, dns_search, mac_address, extra_hosts, exposed_ports, port_bindings, publish_all_ports, port when network_mode is container.' + end + end + + def parsed_hostname + return nil if network_mode == 'host' + hostname + end + + action :create do + validate_container_create + + converge_if_changed do + action_delete + + with_retries do + config = { + 'name' => container_name, + 'Image' => "#{repo}:#{tag}", + 'Labels' => labels, + 'Cmd' => to_shellwords(command), + 'AttachStderr' => attach_stderr, + 'AttachStdin' => attach_stdin, + 'AttachStdout' => attach_stdout, + 'Domainname' => domain_name, + 'Entrypoint' => to_shellwords(entrypoint), + 'Env' => env, + 'ExposedPorts' => exposed_ports, + 'Hostname' => parsed_hostname, + 'MacAddress' => mac_address, + 'NetworkDisabled' => network_disabled, + 'OpenStdin' => open_stdin, + 'StdinOnce' => stdin_once, + 'Tty' => tty, + 'User' => user, + 'Volumes' => volumes, + 'WorkingDir' => working_dir, + 'HostConfig' => { + 'Binds' => volumes_binds, + 'CapAdd' => cap_add, + 'CapDrop' => cap_drop, + 'CgroupParent' => cgroup_parent, + 'CpuShares' => cpu_shares, + 'CpusetCpus' => cpuset_cpus, + 'Devices' => devices, + 'Dns' => dns, + 'DnsSearch' => dns_search, + 'ExtraHosts' => extra_hosts, + 'IpcMode' => ipc_mode, + 'Links' => links, + 'LogConfig' => log_config, + 'Memory' => memory, + 'MemorySwap' => memory_swap, + 'NetworkMode' => network_mode, + 'Privileged' => privileged, + 'PidMode' => pid_mode, + 'PortBindings' => port_bindings, + 'PublishAllPorts' => publish_all_ports, + 'RestartPolicy' => { + 'Name' => restart_policy, + 'MaximumRetryCount' => restart_maximum_retry_count + }, + 'ReadonlyRootfs' => ro_rootfs, + 'Ulimits' => ulimits_to_hash, + 'UsernsMode' => userns_mode, + 'UTSMode' => uts_mode, + 'VolumesFrom' => volumes_from + } + } + Docker::Container.create(config, connection) + end + end + end + + action :start do + return if state['Restarting'] + return if state['Running'] + converge_by "starting #{container_name}" do + with_retries do + container.start + timeout ? container.wait(timeout) : container.wait unless detach + end + wait_running_state(true) if detach + end + end + + action :stop do + return unless state['Running'] + kill_after_str = " (will kill after #{kill_after}s)" if kill_after != -1 + converge_by "stopping #{container_name} #{kill_after_str}" do + begin + with_retries do + container.stop!('timeout' => kill_after) + wait_running_state(false) + end + rescue Docker::Error::TimeoutError + raise Docker::Error::TimeoutError, "Container failed to stop, consider adding kill_after to the container #{container_name}" + end + end + end + + action :kill do + return unless state['Running'] + converge_by "killing #{container_name}" do + with_retries { container.kill(signal: signal) } + end + end + + action :run do + validate_container_create + call_action(:create) + call_action(:start) + call_action(:delete) if autoremove + end + + action :run_if_missing do + return if current_resource + call_action(:run) + end + + action :pause do + return if state['Paused'] + converge_by "pausing #{container_name}" do + with_retries { container.pause } + end + end + + action :unpause do + return if current_resource && !state['Paused'] + converge_by "unpausing #{container_name}" do + with_retries { container.unpause } + end + end + + action :restart do + kill_after_str = " (will kill after #{kill_after}s)" if kill_after != -1 + converge_by "restarting #{container_name} #{kill_after_str}" do + current_resource ? container.restart('timeout' => kill_after) : call_action(:run) + end + end + + action :redeploy do + validate_container_create + + # never start containers resulting from a previous action :create #432 + should_create = state['Running'] == false && state['StartedAt'] == '0001-01-01T00:00:00Z' + call_action(:delete) + call_action(should_create ? :create : :run) + end + + action :delete do + return unless current_resource + call_action(:unpause) + call_action(:stop) + converge_by "deleting #{container_name}" do + with_retries { container.delete(force: force, v: remove_volumes) } + end + end + + action :remove do + call_action(:delete) + end + + action :commit do + converge_by "committing #{container_name}" do + with_retries do + new_image = container.commit + new_image.tag('repo' => repo, 'tag' => tag, 'force' => force) + end + end + end + + action :export do + raise "Please set outfile property on #{container_name}" if outfile.nil? + converge_by "exporting #{container_name}" do + with_retries do + ::File.open(outfile, 'w') { |f| container.export { |chunk| f.write(chunk) } } + end + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_exec.rb b/cookbooks/docker/libraries/docker_exec.rb new file mode 100644 index 0000000..0491d0d --- /dev/null +++ b/cookbooks/docker/libraries/docker_exec.rb @@ -0,0 +1,21 @@ +module DockerCookbook + class DockerExec < DockerBase + resource_name :docker_exec + + property :host, [String, nil], default: lazy { default_host } + property :command, Array + property :container, String + property :timeout, Numeric, default: 60 + + property :container_obj, Docker::Container, desired_state: false + + alias cmd command + + action :run do + converge_by "executing #{command} on #{container}" do + with_retries { container_obj Docker::Container.get(container, {}, connection) } + container_obj.exec(command, wait: timeout) + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_image.rb b/cookbooks/docker/libraries/docker_image.rb new file mode 100644 index 0000000..8455194 --- /dev/null +++ b/cookbooks/docker/libraries/docker_image.rb @@ -0,0 +1,94 @@ +module DockerCookbook + class DockerImage < DockerBase + require 'docker' + require_relative 'helpers_image' + + resource_name :docker_image + + # Modify the default of read_timeout from 60 to 120 + property :read_timeout, default: 120, desired_state: false + + # https://docs.docker.com/reference/api/docker_remote_api_v1.20/ + property :destination, [String, nil] + property :force, Boolean, default: false + property :host, [String, nil], default: lazy { default_host }, desired_state: false + property :nocache, Boolean, default: false + property :noprune, Boolean, default: false + property :repo, String, name_property: true + property :rm, Boolean, default: true + property :source, String + property :tag, String, default: 'latest' + + alias image repo + alias image_name repo + alias no_cache nocache + alias no_prune noprune + + ######### + # Actions + ######### + + default_action :pull + + declare_action_class.class_eval do + include DockerHelpers::Image + def whyrun_supported? + true + end + end + + action :build do + converge_by "Build image #{image_identifier}" do + build_image + end + end + + action :build_if_missing do + return if Docker::Image.exist?(image_identifier, {}, connection) + action_build + end + + action :import do + return if Docker::Image.exist?(image_identifier, {}, connection) + converge_by "Import image #{image_identifier}" do + import_image + end + end + + action :pull do + # We already did the work, but we need to report what we did! + converge_by "Pull image #{image_identifier}" do + end if pull_image + end + + action :pull_if_missing do + return if Docker::Image.exist?(image_identifier, {}, connection) + action_pull + end + + action :push do + converge_by "Push image #{image_identifier}" do + push_image + end + end + + action :remove do + return unless Docker::Image.exist?(image_identifier, {}, connection) + converge_by "Remove image #{image_identifier}" do + remove_image + end + end + + action :save do + converge_by "Save image #{image_identifier}" do + save_image + end + end + + action :load do + converge_by "load image #{image_identifier}" do + load_image + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_installation_binary.rb b/cookbooks/docker/libraries/docker_installation_binary.rb new file mode 100644 index 0000000..041dab4 --- /dev/null +++ b/cookbooks/docker/libraries/docker_installation_binary.rb @@ -0,0 +1,40 @@ +module DockerCookbook + class DockerInstallationBinary < DockerBase + require_relative 'helpers_installation_binary' + + include DockerHelpers::InstallationBinary + + ##################### + # Resource properties + ##################### + resource_name :docker_installation_binary + + property :checksum, String, default: lazy { default_checksum }, desired_state: false + property :source, String, default: lazy { default_source }, desired_state: false + property :version, String, default: lazy { default_version }, desired_state: false + + default_action :create + + ######### + # Actions + ######### + + action :create do + # Pull a precompiled binary off the network + remote_file docker_bin do + source new_resource.source + checksum new_resource.checksum + owner 'root' + group 'root' + mode '0755' + action :create + end + end + + action :delete do + file docker_bin do + action :delete + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_installation_package.rb b/cookbooks/docker/libraries/docker_installation_package.rb new file mode 100644 index 0000000..254c7da --- /dev/null +++ b/cookbooks/docker/libraries/docker_installation_package.rb @@ -0,0 +1,30 @@ +module DockerCookbook + class DockerInstallationPackage < DockerBase + require_relative 'helpers_installation_package' + + include DockerHelpers::InstallationPackage + + # Resource properties + resource_name :docker_installation_package + + property :package_name, String, default: 'docker-engine', desired_state: false + property :package_version, String, default: lazy { version_string(version) }, desired_state: false + property :version, String, default: lazy { default_docker_version }, desired_state: false + property :package_options, String, desired_state: false + + # Actions + action :create do + package package_name do + version package_version + options package_options + action :install + end + end + + action :delete do + package package_name do + action :remove + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_installation_script.rb b/cookbooks/docker/libraries/docker_installation_script.rb new file mode 100644 index 0000000..305031a --- /dev/null +++ b/cookbooks/docker/libraries/docker_installation_script.rb @@ -0,0 +1,51 @@ +module DockerCookbook + class DockerInstallationScript < DockerBase + ##################### + # Resource properties + ##################### + resource_name :docker_installation_script + + provides :docker_installation, os: 'linux' + + property :repo, %w(main test experimental), default: 'main', desired_state: false + property :script_url, String, default: lazy { default_script_url }, desired_state: false + + default_action :create + + ################ + # helper methods + ################ + + def default_script_url + case repo + when 'main' + 'https://get.docker.com/' + when 'test' + 'https://test.docker.com/' + when 'experimental' + 'https://experimental.docker.com/' + end + end + + ######### + # Actions + ######### + + action :create do + package 'curl' do + action :install + end + + execute 'install docker' do + command "curl -sSL #{script_url} | sh" + creates '/usr/bin/docker' + end + end + + action :delete do + package 'docker-engine' do + action :remove + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_installation_tarball.rb b/cookbooks/docker/libraries/docker_installation_tarball.rb new file mode 100644 index 0000000..d9b1d31 --- /dev/null +++ b/cookbooks/docker/libraries/docker_installation_tarball.rb @@ -0,0 +1,47 @@ +module DockerCookbook + class DockerInstallationTarball < DockerBase + require_relative 'helpers_installation_tarball' + + include DockerHelpers::InstallationTarball + + ##################### + # Resource properties + ##################### + resource_name :docker_installation_tarball + + property :checksum, String, default: lazy { default_checksum }, desired_state: false + property :source, String, default: lazy { default_source }, desired_state: false + property :version, String, default: lazy { default_version }, desired_state: false + + default_action :create + + ######### + # Actions + ######### + + action :create do + # Pull a precompiled binary off the network + remote_file docker_tarball do + source new_resource.source + checksum new_resource.checksum + owner 'root' + group 'root' + mode '0755' + action :create + notifies :run, 'execute[extract tarball]', :immediately + end + + execute 'extract tarball' do + action :nothing + command "tar -xzf #{docker_tarball} --strip-components=1 -C #{docker_bin_prefix}" + creates docker_bin + end + end + + action :delete do + file docker_bin do + action :delete + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_network.rb b/cookbooks/docker/libraries/docker_network.rb new file mode 100644 index 0000000..f745bf7 --- /dev/null +++ b/cookbooks/docker/libraries/docker_network.rb @@ -0,0 +1,109 @@ +module DockerCookbook + class DockerNetwork < DockerBase + require 'docker' + require_relative 'helpers_network' + include DockerHelpers::Network + + resource_name :docker_network + + property :auxiliary_addresses, [String, Array, nil], coerce: proc { |v| coerce_auxiliary_addresses(v) } + property :container, ArrayType, desired_state: false + property :driver, String + property :driver_opts, PartialHashType + property :gateway, [String, Array, nil], coerce: proc { |v| coerce_gateway(v) } + property :host, [String, nil], default: lazy { default_host }, desired_state: false + property :id, String + property :ip_range, [String, Array, nil], coerce: proc { |v| coerce_ip_range(v) } + property :ipam_driver, String + property :network, Docker::Network, desired_state: false + property :network_name, String, name_property: true + property :subnet, [String, Array, nil], coerce: proc { |v| coerce_subnet(v) } + + alias aux_address auxiliary_addresses + + load_current_value do + begin + with_retries { network Docker::Network.get(network_name, {}, connection) } + rescue Docker::Error::NotFoundError + current_value_does_not_exist! + end + + aux_addr_ray = [] + gateway_ray = [] + ip_range_ray = [] + subnet_ray = [] + + network.info['IPAM']['Config'].to_a.each do |conf| + conf.each do |key, value| + case key + when 'AuxiliaryAddresses' + aux_addr_ray << value + when 'Gateway' + gateway_ray << value + when 'IPRange' + ip_range_ray << value + when 'Subnet' + subnet_ray << value + end + end + end + + auxiliary_addresses aux_addr_ray + gateway gateway_ray + ip_range ip_range_ray + subnet subnet_ray + + driver network.info['Driver'] + driver_opts network.info['Options'] + end + + action :create do + converge_if_changed do + action_delete + + with_retries do + options = {} + options['Driver'] = driver if driver + options['Options'] = driver_opts if driver_opts + ipam_options = consolidate_ipam(subnet, ip_range, gateway, aux_address) + options['IPAM'] = { 'Config' => ipam_options } unless ipam_options.empty? + options['IPAM']['Driver'] = ipam_driver if ipam_driver + Docker::Network.create(network_name, options) + end + end + end + + action :delete do + return unless current_resource + converge_by "deleting #{network_name}" do + with_retries do + network.delete + end + end + end + + action :remove do + action_delete + end + + action :connect do + return unless current_resource + return unless container + converge_if_changed do + with_retries do + network.connect(container) + end + end + end + + action :disconnect do + return unless current_resource + return unless container + converge_if_changed do + with_retries do + network.disconnect(container) + end + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_registry.rb b/cookbooks/docker/libraries/docker_registry.rb new file mode 100644 index 0000000..419ee9b --- /dev/null +++ b/cookbooks/docker/libraries/docker_registry.rb @@ -0,0 +1,41 @@ +module DockerCookbook + class DockerRegistry < DockerBase + require 'docker' + require_relative 'helpers_auth' + + resource_name :docker_registry + + property :email, [String, nil] + property :password, [String, nil] + property :serveraddress, [String, nil], name_property: true + property :username, [String, nil] + + action :login do + tries = api_retries + + registry_host = parse_registry_host(serveraddress) + + (node.run_state['docker_auth'] ||= {})[registry_host] = { + 'serveraddress' => registry_host, + 'username' => username, + 'password' => password, + 'email' => email + } + + begin + Docker.connection.post( + '/auth', {}, + body: node.run_state['docker_auth'][registry_host].to_json + ) + rescue Docker::Error::ServerError, Docker::Error::UnauthorizedError + if (tries -= 1).zero? + raise Docker::Error::AuthenticationError, "#{username} failed to authenticate with #{serveraddress}" + else + retry + end + end + + true + end + end +end diff --git a/cookbooks/docker/libraries/docker_service.rb b/cookbooks/docker/libraries/docker_service.rb new file mode 100644 index 0000000..10725c2 --- /dev/null +++ b/cookbooks/docker/libraries/docker_service.rb @@ -0,0 +1,129 @@ +module DockerCookbook + require_relative 'docker_service_base' + + class DockerService < DockerServiceBase + resource_name :docker_service + + # register with the resource resolution system + provides :docker_service + + # installation type and service_manager + property :install_method, %w(binary script package tarball none auto), default: 'auto', desired_state: false + property :service_manager, %w(execute sysvinit upstart systemd auto), default: 'auto', desired_state: false + + # docker_installation_script + property :repo, desired_state: false + property :script_url, String, desired_state: false + + # docker_installation_binary and tarball + property :checksum, String, desired_state: false + property :docker_bin, String, desired_state: false + property :source, String, desired_state: false + + # docker_installation_package + property :package_version, String, desired_state: false + + # binary, package and tarball + property :version, String, desired_state: false + property :package_options, [String, nil], desired_state: false + + ################ + # Helper Methods + ################ + def validate_install_method + if property_is_set?(:version) && + install_method != 'binary' && + install_method != 'package' && + install_method != 'tarball' + raise Chef::Exceptions::ValidationFailed, 'Version property only supported for binary, package and tarball installation methods' + end + end + + def copy_properties_to(to, *properties) + properties = self.class.properties.keys if properties.empty? + properties.each do |p| + # If the property is set on from, and exists on to, set the + # property on to + if to.class.properties.include?(p) && property_is_set?(p) + to.send(p, send(p)) + end + end + end + + action_class.class_eval do + def installation(&block) + case install_method + when 'auto' + install = docker_installation(name, &block) + when 'binary' + install = docker_installation_binary(name, &block) + when 'script' + install = docker_installation_script(name, &block) + when 'package' + install = docker_installation_package(name, &block) + when 'tarball' + install = docker_installation_tarball(name, &block) + when 'none' + Chef::Log.info('Skipping Docker installation. Assuming it was handled previously.') + return + end + copy_properties_to(install) + install + end + + def svc_manager(&block) + case service_manager + when 'auto' + svc = docker_service_manager(name, &block) + when 'execute' + svc = docker_service_manager_execute(name, &block) + when 'sysvinit' + svc = docker_service_manager_sysvinit(name, &block) + when 'upstart' + svc = docker_service_manager_upstart(name, &block) + when 'systemd' + svc = docker_service_manager_systemd(name, &block) + end + copy_properties_to(svc) + svc + end + end + + ######### + # Actions + ######### + + action :create do + validate_install_method + + installation do + action :create + notifies :restart, new_resource, :immediately + end + end + + action :delete do + installation do + action :delete + end + end + + action :start do + svc_manager do + action :start + end + end + + action :stop do + svc_manager do + action :stop + end + end + + action :restart do + svc_manager do + action :restart + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_base.rb b/cookbooks/docker/libraries/docker_service_base.rb new file mode 100644 index 0000000..8e250c0 --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_base.rb @@ -0,0 +1,117 @@ +module DockerCookbook + class DockerServiceBase < DockerBase + ################ + # Helper Methods + ################ + require 'docker' + require_relative 'helpers_service' + include DockerHelpers::Service + + ##################### + # resource properties + ##################### + + resource_name :docker_service_base + + # register with the resource resolution system + provides :docker_service_manager + + # daemon management + property :instance, String, name_property: true, required: true, desired_state: false + property :auto_restart, Boolean, default: false + property :api_cors_header, [String, nil] + property :bridge, [String, nil] + property :bip, [IPV4_ADDR, IPV4_CIDR, IPV6_ADDR, IPV6_CIDR, nil] + property :cluster_store, [String, nil] + property :cluster_advertise, [String, nil] + property :cluster_store_opts, ArrayType + property :debug, [Boolean, nil] + property :daemon, Boolean, default: true + property :dns, ArrayType + property :dns_search, [Array, nil] + property :exec_driver, ['native', 'lxc', nil] + property :exec_opts, ArrayType + property :fixed_cidr, [String, nil] + property :fixed_cidr_v6, [String, nil] + property :group, [String, nil] + property :graph, [String, nil] + property :host, [String, Array], coerce: proc { |v| coerce_host(v) } + property :icc, [Boolean, nil] + property :insecure_registry, [Array, String, nil], coerce: proc { |v| coerce_insecure_registry(v) } + property :ip, [IPV4_ADDR, IPV6_ADDR, nil] + property :ip_forward, [Boolean, nil] + property :ipv4_forward, Boolean, default: true + property :ipv6_forward, Boolean, default: true + property :ip_masq, [Boolean, nil] + property :iptables, [Boolean, nil] + property :ipv6, [Boolean, nil] + property :log_level, [:debug, :info, :warn, :error, :fatal, nil] + property :labels, [String, Array], coerce: proc { |v| coerce_daemon_labels(v) }, desired_state: false + property :log_driver, %w( json-file syslog journald gelf fluentd awslogs splunk none ) + property :log_opts, ArrayType + property :mtu, [String, nil] + property :pidfile, String, default: lazy { "/var/run/#{docker_name}.pid" } + property :registry_mirror, [String, nil] + property :storage_driver, ArrayType + property :selinux_enabled, [Boolean, nil] + property :storage_opts, ArrayType + property :default_ulimit, ArrayType + property :userland_proxy, [Boolean, nil] + property :disable_legacy_registry, [Boolean, nil] + property :userns_remap, [String, nil] + + # These are unvalidated daemon arguments passed in as a string. + property :misc_opts, [String, nil] + + # environment variables to set before running daemon + property :http_proxy, [String, nil] + property :https_proxy, [String, nil] + property :no_proxy, [String, nil] + property :tmpdir, [String, nil] + + # logging + property :logfile, String, default: '/var/log/docker.log' + + # docker-wait-ready timeout + property :service_timeout, Integer, default: 20 + + allowed_actions :start, :stop, :restart + + alias label labels + alias tlscacert tls_ca_cert + alias tlscert tls_server_cert + alias tlskey tls_server_key + alias tlsverify tls_verify + alias run_group group + + declare_action_class.class_eval do + def libexec_dir + return '/usr/libexec/docker' if node['platform_family'] == 'rhel' + '/usr/lib/docker' + end + + def create_docker_wait_ready + directory libexec_dir do + owner 'root' + group 'root' + mode '0755' + action :create + end + + template "#{libexec_dir}/#{docker_name}-wait-ready" do + source 'default/docker-wait-ready.erb' + owner 'root' + group 'root' + mode '0755' + variables( + docker_cmd: docker_cmd, + libexec_dir: libexec_dir, + service_timeout: service_timeout + ) + cookbook 'docker' + action :create + end + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_manager_execute.rb b/cookbooks/docker/libraries/docker_service_manager_execute.rb new file mode 100644 index 0000000..4202f10 --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_manager_execute.rb @@ -0,0 +1,54 @@ +module DockerCookbook + class DockerServiceManagerExecute < DockerServiceBase + resource_name :docker_service_manager_execute + + provides :docker_service_manager, os: 'linux' + + # Start the service + action :start do + # enable ipv4 forwarding + execute 'enable net.ipv4.conf.all.forwarding' do + command '/sbin/sysctl net.ipv4.conf.all.forwarding=1' + not_if '/sbin/sysctl -q -n net.ipv4.conf.all.forwarding | grep ^1$' + action :run + end + + # enable ipv6 forwarding + execute 'enable net.ipv6.conf.all.forwarding' do + command '/sbin/sysctl net.ipv6.conf.all.forwarding=1' + not_if '/sbin/sysctl -q -n net.ipv6.conf.all.forwarding | grep ^1$' + action :run + end + + # Go doesn't support detaching processes natively, so we have + # to manually fork it from the shell with & + # https://github.com/docker/docker/issues/2758 + bash "start docker #{name}" do + code "#{docker_daemon_cmd} >> #{logfile} 2>&1 &" + environment 'HTTP_PROXY' => http_proxy, + 'HTTPS_PROXY' => https_proxy, + 'NO_PROXY' => no_proxy, + 'TMPDIR' => tmpdir + not_if "ps -ef | grep -v grep | grep #{Shellwords.escape(docker_daemon_cmd)}" + action :run + end + + create_docker_wait_ready + execute 'docker-wait-ready' do + command "#{libexec_dir}/#{docker_name}-wait-ready" + end + end + + action :stop do + execute "stop docker #{name}" do + command "kill `cat #{pidfile}`" + only_if "#{docker_cmd} ps | head -n 1 | grep ^CONTAINER" + end + end + + action :restart do + action_stop + action_start + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_manager_systemd.rb b/cookbooks/docker/libraries/docker_service_manager_systemd.rb new file mode 100644 index 0000000..2342d44 --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_manager_systemd.rb @@ -0,0 +1,116 @@ +module DockerCookbook + class DockerServiceManagerSystemd < DockerServiceBase + resource_name :docker_service_manager_systemd + + provides :docker_service_manager, platform: 'fedora' + + provides :docker_service_manager, platform: %w(redhat centos scientific oracle) do |node| # ~FC005 + node['platform_version'].to_f >= 7.0 + end + + provides :docker_service_manager, platform: 'debian' do |node| + node['platform_version'].to_f >= 8.0 + end + + provides :docker_service_manager, platform: 'ubuntu' do |node| + node['platform_version'].to_f >= 15.04 + end + + action :start do + create_docker_wait_ready + + # stock systemd unit file + template "/lib/systemd/system/#{docker_name}.service" do + source 'systemd/docker.service.erb' + owner 'root' + group 'root' + mode '0644' + variables( + docker_name: docker_name, + docker_socket: connect_socket.sub(%r{unix://|fd://}, '') + ) + cookbook 'docker' + action :create + not_if { docker_name == 'default' && ::File.exist?('/lib/systemd/system/docker.service') } + end + + # stock systemd socket file + template "/lib/systemd/system/#{docker_name}.socket" do + source 'systemd/docker.socket.erb' + owner 'root' + group 'root' + mode '0644' + variables( + docker_name: docker_name, + docker_socket: connect_socket.sub(%r{unix://|fd://}, '') + ) + cookbook 'docker' + action :create + not_if { docker_name == 'default' && ::File.exist?('/lib/systemd/system/docker.socket') } + end + + # this overrides the main systemd unit file + template "/etc/systemd/system/#{docker_name}.service" do + source 'systemd/docker.service-override.erb' + owner 'root' + group 'root' + mode '0644' + variables( + config: new_resource, + docker_daemon_cmd: docker_daemon_cmd, + docker_wait_ready: "#{libexec_dir}/#{docker_name}-wait-ready" + ) + cookbook 'docker' + notifies :run, 'execute[systemctl daemon-reload]', :immediately + notifies :restart, new_resource, :immediately + action :create + end + + # this overrides the main systemd socket + template "/etc/systemd/system/#{docker_name}.socket" do + source 'systemd/docker.socket-override.erb' + owner 'root' + group 'root' + mode '0644' + variables( + config: new_resource, + docker_name: docker_name, + docker_socket: connect_socket.sub(%r{unix://|fd://}, '') + ) + cookbook 'docker' + notifies :run, 'execute[systemctl daemon-reload]', :immediately + notifies :restart, new_resource, :immediately + action :create + end + + # avoid 'Unit file changed on disk' warning + execute 'systemctl daemon-reload' do + command '/bin/systemctl daemon-reload' + action :nothing + end + + # service management resource + service docker_name do + provider Chef::Provider::Service::Systemd + supports status: true + action [:enable, :start] + only_if { ::File.exist?("/lib/systemd/system/#{docker_name}.service") } + end + end + + action :stop do + # service management resource + service docker_name do + provider Chef::Provider::Service::Systemd + supports status: true + action [:disable, :stop] + only_if { ::File.exist?("/lib/systemd/system/#{docker_name}.service") } + end + end + + action :restart do + action_stop + action_start + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_manager_sysvinit_debian.rb b/cookbooks/docker/libraries/docker_service_manager_sysvinit_debian.rb new file mode 100644 index 0000000..47a05fe --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_manager_sysvinit_debian.rb @@ -0,0 +1,87 @@ +module DockerCookbook + class DockerServiceManagerSysvinitDebian < DockerServiceBase + resource_name :docker_service_manager_sysvinit_debian + + provides :docker_service_manager, platform: 'debian' do |node| + node['platform_version'].to_f < 8.0 + end + + provides :docker_service_manager, platform: 'ubuntu' do |node| + node['platform_version'].to_f < 12.04 + end + + provides :docker_service_manager_sysvinit, platform: 'debian' do |node| + node['platform_version'].to_f < 8.0 + end + + provides :docker_service_manager_sysvinit, platform: 'ubuntu' do |node| + node['platform_version'].to_f < 12.04 + end + + action :start do + create_docker_wait_ready + create_init + create_service + end + + action :stop do + create_init + s = create_service + s.action :stop + end + + action :restart do + action_stop + action_start + end + + action_class.class_eval do + def create_init + execute 'groupadd docker' do + not_if 'getent group docker' + action :run + end + + link "/usr/bin/#{docker_name}" do + to '/usr/bin/docker' + link_type :hard + action :create + not_if { docker_name == 'docker' } + end + + template "/etc/init.d/#{docker_name}" do + source 'sysvinit/docker-debian.erb' + owner 'root' + group 'root' + mode '0755' + variables( + docker_name: docker_name, + docker_daemon_arg: docker_daemon_arg, + docker_wait_ready: "#{libexec_dir}/#{docker_name}-wait-ready" + ) + cookbook 'docker' + action :create + end + + template "/etc/default/#{docker_name}" do + source 'default/docker.erb' + variables( + config: new_resource, + docker_daemon_opts: docker_daemon_opts.join(' ') + ) + cookbook 'docker' + notifies :restart, new_resource, :immediately + action :create + end + end + + def create_service + service docker_name do + provider Chef::Provider::Service::Init::Debian + supports restart: true, status: true + action [:enable, :start] + end + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb b/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb new file mode 100644 index 0000000..6962f5f --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb @@ -0,0 +1,82 @@ +module DockerCookbook + class DockerServiceManagerSysvinitRhel < DockerServiceBase + resource_name :docker_service_manager_sysvinit_rhel + + provides :docker_service_manager, platform: 'amazon' + provides :docker_service_manager, platform: 'suse' + provides :docker_service_manager, platform: %w(redhat centos scientific oracle) do |node| # ~FC005 + node['platform_version'].to_f <= 7.0 + end + + provides :docker_service_manager_sysvinit, platform: 'amazon' + provides :docker_service_manager_sysvinit, platform: 'suse' + provides :docker_service_manager_sysvinit, platform: %w(redhat centos scientific oracle) do |node| # ~FC005 + node['platform_version'].to_f <= 7.0 + end + + action :start do + create_docker_wait_ready + create_init + create_service + end + + action :stop do + create_init + s = create_service + s.action :stop + end + + action :restart do + action_stop + action_start + end + + action_class.class_eval do + def create_init + execute 'groupadd docker' do + not_if 'getent group docker' + action :run + end + + link "/usr/bin/#{docker_name}" do + to '/usr/bin/docker' + link_type :hard + action :create + not_if { docker_name == 'docker' } + end + + template "/etc/init.d/#{docker_name}" do + source 'sysvinit/docker-rhel.erb' + owner 'root' + group 'root' + mode '0755' + variables( + docker_name: docker_name, + docker_daemon_arg: docker_daemon_arg, + docker_wait_ready: "#{libexec_dir}/#{docker_name}-wait-ready" + ) + cookbook 'docker' + action :create + end + + template "/etc/sysconfig/#{docker_name}" do + source 'sysconfig/docker.erb' + variables( + config: new_resource, + docker_daemon_opts: docker_daemon_opts.join(' ') + ) + cookbook 'docker' + notifies :restart, new_resource, :immediately + action :create + end + end + + def create_service + service docker_name do + supports restart: true, status: true + action [:enable, :start] + end + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_service_manager_upstart.rb b/cookbooks/docker/libraries/docker_service_manager_upstart.rb new file mode 100644 index 0000000..cb1e431 --- /dev/null +++ b/cookbooks/docker/libraries/docker_service_manager_upstart.rb @@ -0,0 +1,57 @@ +module DockerCookbook + class DockerServiceManagerUpstart < DockerServiceBase + resource_name :docker_service_manager_upstart + + provides :docker_service_manager, platform: 'ubuntu' + provides :docker_service_manager, platform: 'linuxmint' + + action :start do + create_docker_wait_ready + + template "/etc/init/#{docker_name}.conf" do + source 'upstart/docker.conf.erb' + owner 'root' + group 'root' + mode '0644' + variables( + docker_name: docker_name, + docker_daemon_arg: docker_daemon_arg, + docker_wait_ready: "#{libexec_dir}/#{docker_name}-wait-ready" + ) + cookbook 'docker' + action :create + end + + template "/etc/default/#{docker_name}" do + source 'default/docker.erb' + variables( + config: new_resource, + docker_daemon: docker_daemon, + docker_daemon_opts: docker_daemon_opts.join(' ') + ) + cookbook 'docker' + notifies :restart, new_resource, :immediately + action :create + end + + service docker_name do + provider Chef::Provider::Service::Upstart + supports status: true + action :start + end + end + + action :stop do + service docker_name do + provider Chef::Provider::Service::Upstart + supports status: true + action :stop + end + end + + action :restart do + action_stop + action_start + end + end +end diff --git a/cookbooks/docker/libraries/docker_tag.rb b/cookbooks/docker/libraries/docker_tag.rb new file mode 100644 index 0000000..e9fc471 --- /dev/null +++ b/cookbooks/docker/libraries/docker_tag.rb @@ -0,0 +1,27 @@ +module DockerCookbook + class DockerTag < DockerBase + resource_name :docker_tag + + property :target_repo, String, name_property: true + property :target_tag, String + property :to_repo, String + property :to_tag, String + property :force, Boolean, default: false + + ######### + # Actions + ######### + + action :tag do + return if force == false && Docker::Image.exist?("#{to_repo}:#{to_tag}") + begin + converge_by "update #{target_repo}:#{target_tag} to #{to_repo}:#{to_tag}" do + i = Docker::Image.get("#{target_repo}:#{target_tag}") + i.tag('repo' => to_repo, 'tag' => to_tag, 'force' => force) + end + rescue Docker::Error => e + raise e.message + end + end + end +end diff --git a/cookbooks/docker/libraries/docker_volume.rb b/cookbooks/docker/libraries/docker_volume.rb new file mode 100644 index 0000000..bb620d8 --- /dev/null +++ b/cookbooks/docker/libraries/docker_volume.rb @@ -0,0 +1,33 @@ +module DockerCookbook + class DockerVolume < DockerBase + require 'docker' + + resource_name :docker_volume + + property :driver, String, desired_state: false + property :host, [String, nil], default: lazy { default_host }, desired_state: false + property :opts, [String, Array, nil], desired_state: false + property :volume, Docker::Volume, desired_state: false + property :volume_name, String, name_property: true + + load_current_value do + begin + with_retries { volume Docker::Volume.get(volume_name, connection) } + rescue Docker::Error::NotFoundError + current_value_does_not_exist! + end + end + + action :create do + converge_by "creating volume #{volume_name}" do + Docker::Volume.create(volume_name, connection) + end if volume.nil? + end + + action :remove do + converge_by "removing volume #{volume_name}" do + volume.remove + end unless volume.nil? + end + end +end diff --git a/cookbooks/docker/libraries/helpers_auth.rb b/cookbooks/docker/libraries/helpers_auth.rb new file mode 100644 index 0000000..40b3654 --- /dev/null +++ b/cookbooks/docker/libraries/helpers_auth.rb @@ -0,0 +1,10 @@ +module DockerCookbook + module DockerHelpers + module Authentication + # https://github.com/docker/docker/blob/4fcb9ac40ce33c4d6e08d5669af6be5e076e2574/registry/auth.go#L231 + def parse_registry_host(val) + val.sub(%r{https?://}, '').split('/').first + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_base.rb b/cookbooks/docker/libraries/helpers_base.rb new file mode 100644 index 0000000..43b8f30 --- /dev/null +++ b/cookbooks/docker/libraries/helpers_base.rb @@ -0,0 +1,110 @@ +module DockerCookbook + module DockerHelpers + module Base + require 'shellwords' + + # Misc + def to_snake_case(name) + # ExposedPorts -> _exposed_ports + name = name.gsub(/[A-Z]/) { |x| "_#{x.downcase}" } + # _exposed_ports -> exposed_ports + name = name[1..-1] if name.start_with?('_') + name + end + + ########## + # coersion + ########## + + def coerce_labels(v) + case v + when Hash, nil + v + else + Array(v).each_with_object({}) do |label, h| + parts = label.split(':') + h[parts[0]] = parts[1] + end + end + end + + def coerce_shell_command(v) + return nil if v.nil? + return DockerBase::ShellCommandString.new( + ::Shellwords.join(v) + ) if v.is_a?(Array) + DockerBase::ShellCommandString.new(v) + end + + ################ + # Helper methods + ################ + + def api_version + @api_version ||= Docker.version(connection)['ApiVersion'] + end + + def connection + @connection ||= begin + opts = {} + opts[:read_timeout] = read_timeout if read_timeout + opts[:write_timeout] = write_timeout if write_timeout + + if host =~ /^tcp:/ + opts[:scheme] = 'https' if tls || !tls_verify.nil? + opts[:ssl_ca_file] = tls_ca_cert if tls_ca_cert + opts[:client_cert] = tls_client_cert if tls_client_cert + opts[:client_key] = tls_client_key if tls_client_key + end + Docker::Connection.new(host || Docker.url, opts) + end + end + + def with_retries(&_block) + tries = api_retries + begin + yield + # Only catch errors that can be fixed with retries. + rescue Docker::Error::ServerError, # 404 + Docker::Error::UnexpectedResponseError, # 400 + Docker::Error::TimeoutError, + Docker::Error::IOError + tries -= 1 + retry if tries > 0 + raise + end + end + + def call_action(_action) + new_resource.run_action + end + + def default_host + return nil unless ENV['DOCKER_HOST'] + ENV['DOCKER_HOST'] + end + + def default_tls + return nil unless ENV['DOCKER_TLS'] + ENV['DOCKER_TLS'] + end + + def default_tls_verify + return nil unless ENV['DOCKER_TLS_VERIFY'] + ENV['DOCKER_TLS_VERIFY'] + end + + def default_tls_cert_path(v) + return nil unless ENV['DOCKER_CERT_PATH'] + case v + when 'ca' + "#{ENV['DOCKER_CERT_PATH']}/ca.pem" + when 'cert' + "#{ENV['DOCKER_CERT_PATH']}/cert.pem" + when 'key' + "#{ENV['DOCKER_CERT_PATH']}/key.pem" + end + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_container.rb b/cookbooks/docker/libraries/helpers_container.rb new file mode 100644 index 0000000..fab1a64 --- /dev/null +++ b/cookbooks/docker/libraries/helpers_container.rb @@ -0,0 +1,247 @@ +module DockerCookbook + module DockerHelpers + module Container + def coerce_links(v) + case v + when DockerBase::UnorderedArray, nil + v + else + return nil if v.empty? + # Parse docker input of /source:/container_name/dest into source:dest + DockerBase::UnorderedArray.new(Array(v)).map! do |link| + if link =~ %r{^/(?.+):/#{name}/(?.+)} + link = "#{Regexp.last_match[:source]}:#{Regexp.last_match[:dest]}" + end + link + end + end + end + + def coerce_log_opts(v) + case v + when Hash, nil + v + else + Array(v).each_with_object({}) do |log_opt, memo| + key, value = log_opt.split('=', 2) + memo[key] = value + end + end + end + + def coerce_ulimits(v) + return v if v.nil? + Array(v).map do |u| + u = "#{u['Name']}=#{u['Soft']}:#{u['Hard']}" if u.is_a?(Hash) + u + end + end + + def coerce_volumes(v) + case v + when DockerBase::PartialHash, nil + v + when Hash + DockerBase::PartialHash[v] + else + b = [] + v = Array(v).to_a # in case v.is_A?(Chef::Node::ImmutableArray) + v.delete_if do |x| + parts = x.split(':') + b << x if parts.length > 1 + end + b = nil if b.empty? + volumes_binds b + return DockerBase::PartialHash.new if v.empty? + v.each_with_object(DockerBase::PartialHash.new) { |volume, h| h[volume] = {} } + end + end + + def default_network_mode + case api_version + when '1.19' + 'bridge' + when proc { |n| n.to_f < 1.19 } + '' + else + 'default' + end + end + + def state + # Always return the latest state, see #510 + return Docker::Container.get(container_name, {}, connection).info['State'] + rescue + return {} + end + + def wait_running_state(v) + tries = 20 + tries.times do + return if state['Running'] == v + sleep 1 + end + return if state['Running'] == v + + # Container failed to reach correct state: Throw an error + desired_state_str = v ? 'running' : 'not running' + raise Docker::Error::TimeoutError, "Container #{container_name} failed to change to #{desired_state_str} state after #{tries} seconds" + end + + def port(v = nil) + return @port if v.nil? + exposed_ports coerce_exposed_ports(v) + port_bindings coerce_port_bindings(v) + @port = v + @port + end + + def parse_port(v) + parts = v.split(':') + case parts.length + when 3 + host_ip = parts[0] + host_port = parts[1] + container_port = parts[2] + when 2 + host_ip = '0.0.0.0' + host_port = parts[0] + container_port = parts[1] + when 1 + host_ip = '' + host_port = '' + container_port = parts[0] + end + port_range, protocol = container_port.split('/') + if port_range.include?('-') + port_range = container_port.split('-') + port_range.map!(&:to_i) + Chef::Log.fatal("FATAL: Invalid port range! #{container_port}") if port_range[0] > port_range[1] + port_range = (port_range[0]..port_range[1]).to_a + end + # qualify the port-binding protocol even when it is implicitly tcp #427. + protocol = 'tcp' if protocol.nil? + Array(port_range).map do |port| + { + 'host_ip' => host_ip, + 'host_port' => host_port, + 'container_port' => "#{port}/#{protocol}" + } + end + end + + def coerce_exposed_ports(v) + case v + when Hash, nil + v + else + x = Array(v).map { |a| parse_port(a) } + x.flatten! + x.each_with_object({}) do |y, h| + h[y['container_port']] = {} + end + end + end + + def coerce_port_bindings(v) + case v + when Hash, nil + v + else + x = Array(v).map { |a| parse_port(a) } + x.flatten! + x.each_with_object({}) do |y, h| + h[y['container_port']] = [] unless h[y['container_port']] + h[y['container_port']] << { + 'HostIp' => y['host_ip'], + 'HostPort' => y['host_port'] + } + end + end + end + + # log_driver and log_opts really handle this + def log_config(value = Chef::NOT_PASSED) + if value != Chef::NOT_PASSED + @log_config = value + log_driver value['Type'] + log_opts value['Config'] + end + return @log_config if defined?(@log_config) + def_logcfg = {} + def_logcfg['Type'] = log_driver if property_is_set?(:log_driver) + def_logcfg['Config'] = log_opts if property_is_set?(:log_opts) + def_logcfg = nil if def_logcfg.empty? + def_logcfg + end + + # TODO: test image property in serverspec and kitchen, not only in rspec + # for full specs of image parsing, see spec/helpers_container_spec.rb + # + # If you say: `repo 'blah'` + # Image will be: `blah:latest` + # + # If you say: `repo 'blah'; tag '3.1'` + # Image will be: `blah:3.1` + # + # If you say: `image 'blah'` + # Repo will be: `blah` + # Tag will be: `latest` + # + # If you say: `image 'blah:3.1'` + # Repo will be: `blah` + # Tag will be: `3.1` + # + # If you say: `image 'repo/blah'` + # Repo will be: `repo/blah` + # Tag will be: `latest` + # + # If you say: `image 'repo/blah:3.1'` + # Repo will be: `repo/blah` + # Tag will be: `3.1` + # + # If you say: `image 'repo:1337/blah'` + # Repo will be: `repo:1337/blah` + # Tag will be: `latest' + # + # If you say: `image 'repo:1337/blah:3.1'` + # Repo will be: `repo:1337/blah` + # Tag will be: `3.1` + # + def image(image = nil) + if image + if image.include?('/') + # pathological case, a ':' may be present which starts the 'port' + # part of the image name and not a tag. example: 'host:1337/blah' + # fortunately, tags are only found in the 'basename' part of image + # so we can split on '/' and rebuild once the tag has been parsed. + dirname, _, basename = image.rpartition('/') + r, t = basename.split(':', 2) + r = [dirname, r].join('/') + else + # normal case, the ':' starts the tag part + r, t = image.split(':', 2) + end + repo r + tag t if t + end + "#{repo}:#{tag}" + end + + def to_shellwords(command) + return nil if command.nil? + Shellwords.shellwords(command) + end + + def ulimits_to_hash + return nil if ulimits.nil? + ulimits.map do |u| + name = u.split('=')[0] + soft = u.split('=')[1].split(':')[0] + hard = u.split('=')[1].split(':')[1] + { 'Name' => name, 'Soft' => soft.to_i, 'Hard' => hard.to_i } + end + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_image.rb b/cookbooks/docker/libraries/helpers_image.rb new file mode 100644 index 0000000..0ecb0b6 --- /dev/null +++ b/cookbooks/docker/libraries/helpers_image.rb @@ -0,0 +1,104 @@ +module DockerCookbook + module DockerHelpers + module Image + ################ + # Helper methods + ################ + + def build_from_directory + i = Docker::Image.build_from_dir( + source, + { + 'nocache' => nocache, + 'rm' => rm + }, + connection + ) + i.tag('repo' => repo, 'tag' => tag, 'force' => force) + end + + def build_from_dockerfile + i = Docker::Image.build( + IO.read(source), + { + 'nocache' => nocache, + 'rm' => rm + }, + connection + ) + i.tag('repo' => repo, 'tag' => tag, 'force' => force) + end + + def build_from_tar + i = Docker::Image.build_from_tar( + ::File.open(source, 'r'), + { + 'nocache' => nocache, + 'rm' => rm + }, + connection + ) + i.tag('repo' => repo, 'tag' => tag, 'force' => force) + end + + def build_image + if ::File.directory?(source) + build_from_directory + elsif ::File.extname(source) == '.tar' + build_from_tar + else + build_from_dockerfile + end + end + + def image_identifier + "#{repo}:#{tag}" + end + + def import_image + with_retries do + i = Docker::Image.import(source, {}, connection) + i.tag('repo' => repo, 'tag' => tag, 'force' => force) + end + end + + def pull_image + with_retries do + registry_host = parse_registry_host(repo) + creds = node.run_state['docker_auth'] && node.run_state['docker_auth'][registry_host] || (node.run_state['docker_auth'] ||= {})['index.docker.io'] + + original_image = Docker::Image.get(image_identifier, {}, connection) if Docker::Image.exist?(image_identifier, {}, connection) + new_image = Docker::Image.create({ 'fromImage' => image_identifier }, creds, connection) + + !(original_image && original_image.id.start_with?(new_image.id)) + end + end + + def push_image + with_retries do + i = Docker::Image.get(image_identifier, {}, connection) + i.push + end + end + + def remove_image + with_retries do + i = Docker::Image.get(image_identifier, {}, connection) + i.remove(force: force, noprune: noprune) + end + end + + def save_image + with_retries do + Docker::Image.save(repo, destination, connection) + end + end + + def load_image + with_retries do + Docker::Image.load(source, {}, connection) + end + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_installation_binary.rb b/cookbooks/docker/libraries/helpers_installation_binary.rb new file mode 100644 index 0000000..625c8dc --- /dev/null +++ b/cookbooks/docker/libraries/helpers_installation_binary.rb @@ -0,0 +1,66 @@ +module DockerCookbook + module DockerHelpers + module InstallationBinary + def docker_bin + '/usr/bin/docker' + end + + def docker_kernel + node['kernel']['name'] + end + + def docker_arch + node['kernel']['machine'] + end + + def default_source + "https://get.docker.com/builds/#{docker_kernel}/#{docker_arch}/docker-#{version}" + end + + def default_checksum + case docker_kernel + when 'Darwin' + case version + when '1.6.0' then '9e960e925561b4ec2b81f52b6151cd129739c1f4fba91ce94bdc0333d7d98c38' + when '1.6.2' then 'f29b8b2185c291bd276f7cdac45a674f904e964426d5b969fda7b8ef6b8ab557' + when '1.7.0' then '1c8ee59249fdde401afebc9a079cb75d7674f03d2491789fb45c88020a8c5783' + when '1.7.1' then 'b8209b4382d0b4292c756dd055c12e5efacec2055d5900ac91efc8e81d317cf9' + when '1.8.1' then '0f5db35127cf14b57614ad7513296be600ddaa79182d8d118d095cb90c721e3a' + when '1.8.2' then 'cef593612752e5a50bd075931956075a534b293b7002892072397c3093fe11a6' + when '1.8.3' then 'b5a63a0e6fb393de8c3543c83433224796c7545901963ff3e3e9a41b1430c9cd' + when '1.9.0' then '91a8701e41a479def5371a333657c58c36478602e1f5eb1835457a3880232a2e' + when '1.9.1' then '8750ccc2098ec94ef7db110e0016ab02cfa47a1a76f0deb3faa50335b5ec0df9' + when '1.10.0' then 'f8dc0c7ef2a7efbe0e062017822066e55a40c752b9e92a636359f59ef562d79f' + when '1.10.1' then 'de4057057acd259ec38b5244a40d806993e2ca219e9869ace133fad0e09cedf2' + when '1.10.2' then '29249598587ad8f8597235bbeb11a11888fffb977b8089ea80b5ac5267ba9f2e' + end + when 'Linux' + case version + when '1.6.0' then '526fbd15dc6bcf2f24f99959d998d080136e290bbb017624a5a3821b63916ae8' + when '1.6.2' then 'e131b2d78d9f9e51b0e5ca8df632ac0a1d48bcba92036d0c839e371d6cf960ec' + when '1.7.1' then '4d535a62882f2123fb9545a5d140a6a2ccc7bfc7a3c0ec5361d33e498e4876d5' + when '1.8.1' then '843f90f5001e87d639df82441342e6d4c53886c65f72a5cc4765a7ba3ad4fc57' + when '1.8.2' then '97a3f5924b0b831a310efa8bf0a4c91956cd6387c4a8667d27e2b2dd3da67e4d' + when '1.8.3' then 'f024bc65c45a3778cf07213d26016075e8172de8f6e4b5702bedde06c241650f' + when '1.9.0' then '5d46455aac507e231fd2a558459779f1994f7151d6cb027efabfa36f568cf017' + when '1.9.1' then '52286a92999f003e1129422e78be3e1049f963be1888afc3c9a99d5a9af04666' + when '1.10.0' then 'a66b20423b7d849aa8ef448b98b41d18c45a30bf3fe952cc2ba4760600b18087' + when '1.10.1' then 'de4057057acd259ec38b5244a40d806993e2ca219e9869ace133fad0e09cedf2' + when '1.10.2' then '3fcac4f30e1c1a346c52ba33104175ae4ccbd9b9dbb947f56a0a32c9e401b768' + end + end + end + + def default_version + if node['platform'] == 'amazon' || + node['platform'] == 'ubuntu' && node['platform_version'].to_f < 15.04 || + node['platform_family'] == 'rhel' && node['platform_version'].to_i < 7 || + node['platform_family'] == 'debian' && node['platform_version'].to_i <= 7 + '1.6.2' + else + '1.10.2' + end + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_installation_package.rb b/cookbooks/docker/libraries/helpers_installation_package.rb new file mode 100644 index 0000000..5c9cd5d --- /dev/null +++ b/cookbooks/docker/libraries/helpers_installation_package.rb @@ -0,0 +1,88 @@ +module DockerCookbook + module DockerHelpers + module InstallationPackage + def el6? + return true if node['platform_family'] == 'rhel' && node['platform_version'].to_i == 6 + false + end + + def el7? + return true if node['platform_family'] == 'rhel' && node['platform_version'].to_i == 7 + false + end + + def fedora? + return true if node['platform'] == 'fedora' + false + end + + def wheezy? + return true if node['platform'] == 'debian' && node['platform_version'].to_i == 7 + false + end + + def jesse? + return true if node['platform'] == 'debian' && node['platform_version'].to_i == 8 + false + end + + def precise? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '12.04' + false + end + + def trusty? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '14.04' + return true if node['platform'] == 'linuxmint' && node['platform_version'] =~ /^17\.[0-9]$/ + false + end + + def vivid? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '15.04' + false + end + + def wily? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '15.10' + false + end + + def xenial? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '16.04' + false + end + + def amazon? + return true if node['platform'] == 'amazon' + false + end + + # https://github.com/chef/chef/issues/4103 + def version_string(v) + return "#{v}-1.el6" if el6? + return "#{v}-1.el7.centos" if el7? + return "#{v}-1.el6" if amazon? + return "#{v}-1.fc#{node['platform_version'].to_i}" if fedora? + return "#{v}-0~wheezy" if wheezy? + return "#{v}-0~jessie" if jesse? + return "#{v}-0~precise" if precise? + return "#{v}-0~trusty" if trusty? + return "#{v}-0~vivid" if vivid? + return "#{v}-0~wily" if wily? + return "#{v}-0~xenial" if xenial? + v + end + + def default_docker_version + return '1.7.1' if el6? + return '1.7.1' if amazon? + return '1.9.1' if vivid? + '1.11.2' + end + + def docker_bin + '/usr/bin/docker' + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_installation_tarball.rb b/cookbooks/docker/libraries/helpers_installation_tarball.rb new file mode 100644 index 0000000..dd3c27c --- /dev/null +++ b/cookbooks/docker/libraries/helpers_installation_tarball.rb @@ -0,0 +1,50 @@ +module DockerCookbook + module DockerHelpers + module InstallationTarball + def docker_bin_prefix + '/usr/bin' + end + + def docker_bin + "#{docker_bin_prefix}/docker" + end + + def docker_tarball + "#{Chef::Config[:file_cache_path]}/docker-#{version}.tgz" + end + + def docker_kernel + node['kernel']['name'] + end + + def docker_arch + node['kernel']['machine'] + end + + def default_source + "https://get.docker.com/builds/#{docker_kernel}/#{docker_arch}/docker-#{version}.tgz" + end + + def default_checksum + case docker_kernel + when 'Darwin' + case version + when '1.11.0' then '25e4f5f37e2e17beb20e5a468674750350824059bdeeca09d6a941bca8fc4f73' + when '1.11.1' then '6d35487fbcc7e3f722f3d5f3e5c070a41d87c88e3770f52ae28460a689c40efd' + when '1.11.2' then 'f44da1025c355c51ae6e150fcc0672b87a738b9c8ad98e5fa6091502211da19a' + end + when 'Linux' + case version + when '1.11.0' then '87331b3b75d32d3de5d507db9a19a24dd30ff9b2eb6a5a9bdfaba954da15e16b' + when '1.11.1' then '893e3c6e89c0cd2c5f1e51ea41bc2dd97f5e791fcfa3cee28445df277836339d' + when '1.11.2' then '8c2e0c35e3cda11706f54b2d46c2521a6e9026a7b13c7d4b8ae1f3a706fc55e1' + end + end + end + + def default_version + '1.11.2' + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_network.rb b/cookbooks/docker/libraries/helpers_network.rb new file mode 100644 index 0000000..b42ee24 --- /dev/null +++ b/cookbooks/docker/libraries/helpers_network.rb @@ -0,0 +1,118 @@ +module DockerCookbook + module DockerHelpers + module Network + require 'ipaddr' + + ################### + # property coersion + ################### + + def coerce_auxiliary_addresses(v) + ray = [] + Array(v).each do |e| + case e + when String, Array, nil + ray += Array(e) + when Hash + e.each { |key, val| ray << "#{key}=#{val}" } + end + end + ray.length == 1 ? ray[0] : ray + end + + def coerce_gateway(v) + case v + when String + v.split('/')[0] + when Array + ray = Array(v).map { |a| a.split('/')[0] } + ray.length == 1 ? ray[0] : ray + end + end + + def coerce_subnet(v) + Array(v).length == 1 ? Array(v)[0] : v + end + + def coerce_ip_range(v) + Array(v).length == 1 ? Array(v)[0] : v + end + + ###### + # IPAM + ###### + + def consolidate_ipam(subnets, ranges, gateways, auxaddrs) + subnets = Array(subnets) + ranges = Array(ranges) + gateways = Array(gateways) + auxaddrs = Array(auxaddrs) + subnets = [] if subnets.empty? + ranges = [] if ranges.empty? + gateways = [] if gateways.empty? + auxaddrs = [] if auxaddrs.empty? + if subnets.size < ranges.size || subnets.size < gateways.size + raise 'every ip-range or gateway myust have a corresponding subnet' + end + + data = {} + + # Check overlapping subnets + subnets.each do |s| + data.each do |k, _| + if subnet_matches(s, k) || subnet_matches(k, s) + raise 'multiple overlapping subnet configuration is not supported' + end + end + data[s] = { 'Subnet' => s, 'AuxiliaryAddresses' => {} } + end + + ranges.each do |r| + match = false + subnets.each do |s| + ok = subnet_matches(s, r) + next unless ok + if data[s].fetch('IPRange', '') != '' + raise 'cannot configure multiple ranges on the same subnet' + end + data[s]['IPRange'] = r + match = true + end + raise "no matching subnet for range #{r}" unless match + end + + gateways.each do |g| + match = false + subnets.each do |s| + ok = subnet_matches(s, g) + next unless ok + unless data[s].fetch('Gateway', '').empty? + raise "cannot configure multiple gateways (#{g}, #{data[s]['Gateway']}) for the same subnet (#{s})" + end + data[s]['Gateway'] = g + match = true + end + raise "no matching subnet for gateway #{s}" unless match + end + + auxaddrs.each do |aa| + key, a = aa.split('=') + match = false + subnets.each do |s| + # require 'pry' ; binding.pry + ok = subnet_matches(s, a) + next unless ok + data[s]['AuxiliaryAddresses'][key] = a + match = true + end + raise "no matching subnet for aux-address #{a}" unless match + end + data.values + end + + def subnet_matches(subnet, data) + IPAddr.new(subnet).include?(IPAddr.new(data)) + end + end + end +end diff --git a/cookbooks/docker/libraries/helpers_service.rb b/cookbooks/docker/libraries/helpers_service.rb new file mode 100644 index 0000000..0b874ae --- /dev/null +++ b/cookbooks/docker/libraries/helpers_service.rb @@ -0,0 +1,220 @@ +# Constants +IPV6_ADDR ||= /( +([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}| +([0-9a-fA-F]{1,4}:){1,7}:| +([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}| +([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}| +([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}| +([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}| +([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}| +[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})| +:((:[0-9a-fA-F]{1,4}){1,7}|:)| +fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}| +::(ffff(:0{1,4}){0,1}:){0,1} +((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3} +(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])| +([0-9a-fA-F]{1,4}:){1,4}: +((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3} +(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]) +)/ + +IPV4_ADDR ||= /((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])/ + +IPV6_CIDR ||= /s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*/ + +IPV4_CIDR ||= %r{(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))} + +module DockerCookbook + module DockerHelpers + module Service + def docker_bin + '/usr/bin/docker' + end + + def dockerd_bin + '/usr/bin/dockerd' + end + + def docker_name + return 'docker' if name == 'default' + "docker-#{name}" + end + + def docker_version + o = shell_out("#{docker_bin} --version") + o.stdout.split[2].chomp(',') + end + + def connect_host + return nil unless host + sorted = coerce_host(host).sort do |a, b| + c_a = 1 if a =~ /^unix:/ + c_a = 2 if a =~ /^fd:/ + c_a = 3 if a =~ %r{^tcp://127.0.0.1:} + c_a = 4 if a =~ %r{^tcp://(192\.168|10\.|172\.1[6789]\.|172\.2[0-9]\.|172\.3[01]\.).*:} + c_a = 5 if a =~ %r{^tcp://0.0.0.0:} + c_a = 6 unless c_a + c_b = 1 if b =~ /^unix:/ + c_b = 2 if b =~ /^fd:/ + c_b = 3 if b =~ %r{^tcp://127.0.0.1:} + c_b = 4 if b =~ %r{^tcp://(192\.168|10\.|172\.1[6789]\.|172\.2[0-9]\.|172\.3[01]\.).*:} + c_b = 5 if b =~ %r{^tcp://0.0.0.0:} + c_b = 6 unless c_b + c_a <=> c_b + end + if sorted.first =~ %r{^tcp://0.0.0.0:} + r = sorted.first.match(%r{(?.*)://(?[^:]+):?(?\d+)?}) + return "tcp://127.0.0.1:#{r['port']}" + end + sorted.first + end + + def connect_socket + return "/var/run/#{docker_name}.sock" unless host + sorted = coerce_host(host).sort do |a, b| + c_a = 1 if a =~ /^unix:/ + c_a = 2 if a =~ /^fd:/ + c_a = 3 unless c_a + c_b = 1 if b =~ /^unix:/ + c_b = 2 if b =~ /^fd:/ + c_b = 3 unless c_b + c_a <=> c_b + end + sorted.first + end + + def coerce_host(v) + v = v.split if v.is_a?(String) + Array(v).each_with_object([]) do |s, r| + if s.match(/^unix:/) || s.match(/^tcp:/) || s.match(/^fd:/) + r << s + else + Chef::Log.info("WARNING: docker_service host property #{s} not valid") + end + end + end + + def coerce_daemon_labels(v) + Array(v).each_with_object([]) do |label, a| + if label =~ /:/ + parts = label.split(':') + a << "#{parts[0]}=\"#{parts[1]}\"" + elsif label =~ /=/ + parts = label.split('=') + a << "#{parts[0]}=#{parts[1]}" + else + Chef::Log.info("WARNING: docker_service label #{label} not valid") + end + end + end + + def coerce_insecure_registry(v) + case v + when Array, nil + v + else + Array(v) + end + end + + def docker_major_version + ray = docker_version.split('.') + ray.pop + ray.push.join('.') + end + + def docker_daemon + if Gem::Version.new(docker_major_version) < Gem::Version.new('1.12') + docker_bin + else + dockerd_bin + end + end + + def docker_daemon_arg + if Gem::Version.new(docker_major_version) < Gem::Version.new('1.8') + '-d' + elsif Gem::Version.new(docker_major_version) < Gem::Version.new('1.12') + 'daemon' + else + '' + end + end + + def docker_daemon_cmd + [docker_daemon, docker_daemon_arg, docker_daemon_opts].join(' ') + end + + def docker_cmd + [docker_bin, docker_opts].join(' ') + end + + def docker_opts + opts = [] + opts << "--host=#{connect_host}" if connect_host + if connect_host =~ /^tcp:/ + opts << "--tls=#{tls}" unless tls.nil? + opts << "--tlsverify=#{tls_verify}" unless tls_verify.nil? + opts << "--tlscacert=#{tls_ca_cert}" if tls_ca_cert + opts << "--tlscert=#{tls_client_cert}" if tls_client_cert + opts << "--tlskey=#{tls_client_key}" if tls_client_key + end + opts + end + + def docker_daemon_opts + opts = [] + opts << "--api-cors-header=#{api_cors_header}" if api_cors_header + opts << "--bridge=#{bridge}" if bridge + opts << "--bip=#{bip}" if bip + opts << '--debug' if debug + opts << "--cluster-advertise=#{cluster_advertise}" if cluster_advertise + opts << "--cluster-store=#{cluster_store}" if cluster_store + cluster_store_opts.each { |store_opt| opts << "--cluster-store-opt=#{store_opt}" } if cluster_store_opts + default_ulimit.each { |u| opts << "--default-ulimit=#{u}" } if default_ulimit + dns.each { |dns| opts << "--dns=#{dns}" } if dns + dns_search.each { |dns| opts << "--dns-search=#{dns}" } if dns_search + opts << "--exec-driver=#{exec_driver}" if exec_driver + exec_opts.each { |exec_opt| opts << "--exec-opt=#{exec_opt}" } if exec_opts + opts << "--fixed-cidr=#{fixed_cidr}" if fixed_cidr + opts << "--fixed-cidr-v6=#{fixed_cidr_v6}" if fixed_cidr_v6 + opts << "--group=#{group}" if group + opts << "--graph=#{graph}" if graph + host.each { |h| opts << "-H #{h}" } if host + opts << "--icc=#{icc}" unless icc.nil? + insecure_registry.each { |i| opts << "--insecure-registry=#{i}" } if insecure_registry + opts << "--ip=#{ip}" if ip + opts << "--ip-forward=#{ip_forward}" unless ip_forward.nil? + opts << "--ip-masq=#{ip_masq}" unless ip_masq.nil? + opts << "--iptables=#{iptables}" unless iptables.nil? + opts << "--ipv6=#{ipv6}" unless ipv6.nil? + opts << "--log-level=#{log_level}" if log_level + labels.each { |l| opts << "--label=#{l}" } if labels + opts << "--log-driver=#{log_driver}" if log_driver + log_opts.each { |log_opt| opts << "--log-opt #{log_opt}" } if log_opts + opts << "--mtu=#{mtu}" if mtu + opts << "--pidfile=#{pidfile}" if pidfile + opts << "--registry-mirror=#{registry_mirror}" if registry_mirror + storage_driver.each { |s| opts << "--storage-driver=#{s}" } if storage_driver + opts << "--selinux-enabled=#{selinux_enabled}" unless selinux_enabled.nil? + storage_opts.each { |storage_opt| opts << "--storage-opt=#{storage_opt}" } if storage_opts + opts << "--tls=#{tls}" unless tls.nil? + opts << "--tlsverify=#{tls_verify}" unless tls_verify.nil? + opts << "--tlscacert=#{tls_ca_cert}" if tls_ca_cert + opts << "--tlscert=#{tls_server_cert}" if tls_server_cert + opts << "--tlskey=#{tls_server_key}" if tls_server_key + opts << "--userland-proxy=#{userland_proxy}" unless userland_proxy.nil? + opts << "--disable-legacy-registry=#{disable_legacy_registry}" unless disable_legacy_registry.nil? + opts << "--userns-remap=#{userns_remap}" if userns_remap + opts << misc_opts if misc_opts + opts + end + + def docker_running? + o = shell_out("#{docker_cmd} ps | head -n 1 | grep ^CONTAINER") + return true if o.stdout =~ /CONTAINER/ + false + end + end + end +end diff --git a/cookbooks/docker/libraries/matchers.rb b/cookbooks/docker/libraries/matchers.rb new file mode 100644 index 0000000..87cb23d --- /dev/null +++ b/cookbooks/docker/libraries/matchers.rb @@ -0,0 +1,339 @@ +if defined?(ChefSpec) + ##################### + # docker_installation + ##################### + ChefSpec.define_matcher :docker_installation + + def create_docker_installation(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation, :create, resource_name) + end + + def delete_docker_installation(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation, :delete, resource_name) + end + + def create_docker_installation_binary(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_binary, :create, resource_name) + end + + def delete_docker_installation_binary(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_binary, :delete, resource_name) + end + + def create_docker_installation_script(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_script, :create, resource_name) + end + + def delete_docker_installation_script(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_script, :delete, resource_name) + end + + def create_docker_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_package, :create, resource_name) + end + + def delete_docker_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_package, :delete, resource_name) + end + + def create_docker_installation_tarball(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_tarball, :create, resource_name) + end + + def delete_docker_installation_tarball(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_installation_tarball, :delete, resource_name) + end + + ################ + # docker_service + ################ + ChefSpec.define_matcher :docker_service + + def create_docker_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service, :create, resource_name) + end + + def delete_docker_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service, :delete, resource_name) + end + + def start_docker_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service, :start, resource_name) + end + + def stop_docker_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service, :stop, resource_name) + end + + def restart_docker_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service, :restart, resource_name) + end + + ######################## + # docker_service_manager + ######################## + ChefSpec.define_matcher :docker_service_manager + + def create_docker_service_manager(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager, :create, resource_name) + end + + def delete_docker_service_manager(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager, :delete, resource_name) + end + + def start_docker_service_manager(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager, :start, resource_name) + end + + def stop_docker_service_manager(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager, :stop, resource_name) + end + + def restart_docker_service_manager(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager, :restart, resource_name) + end + + def create_docker_service_manager_execute(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_execute, :create, resource_name) + end + + def delete_docker_service_manager_execute(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_execute, :delete, resource_name) + end + + def start_docker_service_manager_execute(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_execute, :start, resource_name) + end + + def stop_docker_service_manager_execute(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_execute, :stop, resource_name) + end + + def restart_docker_service_manager_execute(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_execute, :restart, resource_name) + end + + def create_docker_service_manager_sysvinit(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_sysvinit, :create, resource_name) + end + + def delete_docker_service_manager_sysvinit(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_sysvinit, :delete, resource_name) + end + + def start_docker_service_manager_sysvinit(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_sysvinit, :start, resource_name) + end + + def stop_docker_service_manager_sysvinit(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_sysvinit, :stop, resource_name) + end + + def restart_docker_service_manager_sysvinit(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_sysvinit, :restart, resource_name) + end + + def create_docker_service_manager_upstart(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_upstart, :create, resource_name) + end + + def delete_docker_service_manager_upstart(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_upstart, :delete, resource_name) + end + + def start_docker_service_manager_upstart(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_upstart, :start, resource_name) + end + + def stop_docker_service_manager_upstart(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_upstart, :stop, resource_name) + end + + def restart_docker_service_manager_upstart(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_upstart, :restart, resource_name) + end + + def create_docker_service_manager_systemd(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_systemd, :create, resource_name) + end + + def delete_docker_service_manager_systemd(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_systemd, :delete, resource_name) + end + + def start_docker_service_manager_systemd(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_systemd, :start, resource_name) + end + + def stop_docker_service_manager_systemd(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_systemd, :stop, resource_name) + end + + def restart_docker_service_manager_systemd(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_service_manager_systemd, :restart, resource_name) + end + + ############## + # docker_image + ############## + ChefSpec.define_matcher :docker_image + + def build_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :build, resource_name) + end + + def build_if_missing_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :build_if_missing, resource_name) + end + + def pull_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :pull, resource_name) + end + + def pull_if_missing_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :pull_if_missing, resource_name) + end + + def import_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :import, resource_name) + end + + def push_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :push, resource_name) + end + + def remove_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :remove, resource_name) + end + + def save_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :save, resource_name) + end + + def load_docker_image(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_image, :load, resource_name) + end + + ################## + # docker_container + ################## + ChefSpec.define_matcher :docker_container + + def create_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :create, resource_name) + end + + def start_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :start, resource_name) + end + + def stop_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :stop, resource_name) + end + + def kill_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :kill, resource_name) + end + + def run_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :run, resource_name) + end + + def run_if_missing_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :run_if_missing, resource_name) + end + + def pause_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :pause, resource_name) + end + + def unpause_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :unpause, resource_name) + end + + def restart_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :restart, resource_name) + end + + def redeploy_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :redeploy, resource_name) + end + + def delete_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :delete, resource_name) + end + + def remove_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :remove, resource_name) + end + + def commit_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :commit, resource_name) + end + + def export_docker_container(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_container, :export, resource_name) + end + + ############## + # docker_tag + ############## + ChefSpec.define_matcher :docker_tag + + def tag_docker_tag(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_tag, :tag, resource_name) + end + + ################# + # docker_registry + ################# + ChefSpec.define_matcher :docker_registry + + def login_docker_registry(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_registry, :login, resource_name) + end + + ################ + # docker_network + ################ + ChefSpec.define_matcher :docker_network + + def create_docker_network(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_network, :create, resource_name) + end + + def delete_docker_network(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_network, :delete, resource_name) + end + + def connect_docker_network(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_network, :connect, resource_name) + end + + def disconnect_docker_network(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_network, :disconnect, resource_name) + end + + ############### + # docker_volume + ############### + ChefSpec.define_matcher :docker_volume + + def create_docker_volume(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_volume, :create, resource_name) + end + + def remove_docker_volume(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_volume, :remove, resource_name) + end + + ############### + # docker_exec + ############### + ChefSpec.define_matcher :docker_exec + + def run_docker_exec(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:docker_exec, :run, resource_name) + end +end diff --git a/cookbooks/docker/metadata.json b/cookbooks/docker/metadata.json new file mode 100644 index 0000000..b4582d8 --- /dev/null +++ b/cookbooks/docker/metadata.json @@ -0,0 +1 @@ +{"name":"docker","version":"2.9.8","description":"Provides docker_service, docker_image, and docker_container resources","long_description":"","maintainer":"Cookbook Engineering Team","maintainer_email":"cookbooks@chef.io","license":"Apache 2.0","platforms":{"amazon":">= 0.0.0","centos":">= 0.0.0","scientific":">= 0.0.0","oracle":">= 0.0.0","debian":">= 0.0.0","fedora":">= 0.0.0","redhat":">= 0.0.0","ubuntu":">= 0.0.0"},"dependencies":{"compat_resource":">= 12.14.7"},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{}} \ No newline at end of file diff --git a/cookbooks/docker/templates/default/default/docker-wait-ready.erb b/cookbooks/docker/templates/default/default/docker-wait-ready.erb new file mode 100644 index 0000000..3531221 --- /dev/null +++ b/cookbooks/docker/templates/default/default/docker-wait-ready.erb @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +i=0 +while [ $i -lt <%= @service_timeout * 2 %> ]; do + <%= @docker_cmd %> ps | head -n 1 | grep ^CONTAINER > /dev/null 2>&1 + [ $? -eq 0 ] && break + ((i++)) + sleep 0.5 +done +[ $i -eq <%= @service_timeout * 2 %> ] && exit 1 +exit 0 diff --git a/cookbooks/docker/templates/default/default/docker.erb b/cookbooks/docker/templates/default/default/docker.erb new file mode 100644 index 0000000..f683bb1 --- /dev/null +++ b/cookbooks/docker/templates/default/default/docker.erb @@ -0,0 +1,24 @@ +# Docker Upstart and SysVinit configuration file + +# Customize location of Docker binary (especially for development testing). +DOCKER="<%= @docker_daemon %>" + +# Use DOCKER_OPTS to modify the daemon startup options. +DOCKER_OPTS="<%= @docker_daemon_opts %>" + +# If you need Docker to use an HTTP proxy, it can also be specified here. +<% if @config.http_proxy %> +export http_proxy="<%= @config.http_proxy %>" +<% end %> +<% if @config.https_proxy %> +export https_proxy="<%= @config.https_proxy %>" +<% end %> + +<% if @config.no_proxy %> +export no_proxy="<%= @config.no_proxy %>" +<% end %> + +# This is also a handy place to tweak where Docker's temporary files go. +<% if @config.tmpdir %> +export TMPDIR="<%= @config.tmpdir %>" +<% end %> diff --git a/cookbooks/docker/templates/default/sysconfig/docker.erb b/cookbooks/docker/templates/default/sysconfig/docker.erb new file mode 100755 index 0000000..b132240 --- /dev/null +++ b/cookbooks/docker/templates/default/sysconfig/docker.erb @@ -0,0 +1,19 @@ +# /etc/sysconfig/docker +# +# Other arguments to pass to the docker daemon process +# These will be parsed by the sysv initscript and appended +# to the arguments list passed to docker + +other_args="<%= @docker_daemon_opts %>" + +# If you need Docker to use an HTTP proxy, it can also be specified here. +<% if @config.http_proxy %> +export http_proxy="<%= @config.http_proxy %>" +<% end %> +<% if @config.https_proxy %> +export https_proxy="<%= @config.https_proxy %>" +<% end %> + +<% if @config.no_proxy %> +export no_proxy="<%= @config.no_proxy %>" +<% end %> diff --git a/cookbooks/docker/templates/default/systemd/docker.service-override.erb b/cookbooks/docker/templates/default/systemd/docker.service-override.erb new file mode 100644 index 0000000..ce94624 --- /dev/null +++ b/cookbooks/docker/templates/default/systemd/docker.service-override.erb @@ -0,0 +1,35 @@ +[Unit] +Description=Docker Application Container Engine +Documentation=http://docs.docker.com +After=network.target + +[Service] +Type=notify +<% if @config.http_proxy %> +Environment="HTTP_PROXY=<%= @config.http_proxy %>" +<% end %> +<% if @config.https_proxy %> +Environment="HTTPS_PROXY=<%= @config.https_proxy %>" +<% end %> +<% if @config.no_proxy %> +Environment="NO_PROXY=<%= @config.no_proxy %>" +<% end %> +<% if @config.tmpdir %> +Environment="TMPDIR=<%= @config.tmpdir %>" +<% end %> +<% if @config.ipv4_forward %> +ExecStartPre=/sbin/sysctl -w net.ipv4.ip_forward=1 +<% end %> +<% if @config.ipv6_forward %> +ExecStartPre=/sbin/sysctl -w net.ipv6.conf.all.forwarding=1 +<% end %> +ExecStart=<%= @docker_daemon_cmd %> +ExecStartPost=<%= @docker_wait_ready %> +Restart=always +MountFlags=private +LimitNOFILE=1048576 +LimitNPROC=1048576 +LimitCORE=infinity + +[Install] +WantedBy=multi-user.target diff --git a/cookbooks/docker/templates/default/systemd/docker.service.erb b/cookbooks/docker/templates/default/systemd/docker.service.erb new file mode 100644 index 0000000..e07c8b4 --- /dev/null +++ b/cookbooks/docker/templates/default/systemd/docker.service.erb @@ -0,0 +1,18 @@ +[Unit] +Description=Docker Application Container Engine +Documentation=https://docs.docker.com +After=network.target <%= @docker_name %>.socket +Requires=<%= @docker_name %>.socket + +[Service] +Type=notify +ExecStart=/usr/bin/docker daemon -H fd:// +MountFlags=slave +LimitNOFILE=1048576 +LimitNPROC=1048576 +LimitCORE=infinity +TasksMax=1048576 +TimeoutStartSec=0 + +[Install] +WantedBy=multi-user.target diff --git a/cookbooks/docker/templates/default/systemd/docker.socket-override.erb b/cookbooks/docker/templates/default/systemd/docker.socket-override.erb new file mode 100644 index 0000000..7e6b705 --- /dev/null +++ b/cookbooks/docker/templates/default/systemd/docker.socket-override.erb @@ -0,0 +1,12 @@ +[Unit] +Description=Docker Socket for the API +PartOf=<%= @docker_name %>.service + +[Socket] +ListenStream=<%= @docker_socket %> +SocketMode=0660 +SocketUser=root +SocketGroup=<%= @config.group %> + +[Install] +WantedBy=sockets.target diff --git a/cookbooks/docker/templates/default/systemd/docker.socket.erb b/cookbooks/docker/templates/default/systemd/docker.socket.erb new file mode 100644 index 0000000..22b452d --- /dev/null +++ b/cookbooks/docker/templates/default/systemd/docker.socket.erb @@ -0,0 +1,12 @@ +[Unit] +Description=Docker Socket for the API +PartOf=<%= @docker_name %>.service + +[Socket] +ListenStream=<%= @docker_socket %> +SocketMode=0660 +SocketUser=root +SocketGroup=docker + +[Install] +WantedBy=sockets.target diff --git a/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb b/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb new file mode 100644 index 0000000..a77e3fd --- /dev/null +++ b/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb @@ -0,0 +1 @@ +d /var/run/docker 0755 root <%= @config.group || 'root' %> - diff --git a/cookbooks/docker/templates/default/sysvinit/docker-debian.erb b/cookbooks/docker/templates/default/sysvinit/docker-debian.erb new file mode 100644 index 0000000..88f8715 --- /dev/null +++ b/cookbooks/docker/templates/default/sysvinit/docker-debian.erb @@ -0,0 +1,150 @@ +#!/bin/sh +set -e + +### BEGIN INIT INFO +# Provides: <%= @docker_name %> +# Required-Start: $syslog $remote_fs +# Required-Stop: $syslog $remote_fs +# Should-Start: cgroupfs-mount cgroup-lite +# Should-Stop: cgroupfs-mount cgroup-lite +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: Create lightweight, portable, self-sufficient containers. +# Description: +# Docker is an open-source project to easily create lightweight, portable, +# self-sufficient containers from any application. The same container that a +# developer builds and tests on a laptop can run at scale, in production, on +# VMs, bare metal, OpenStack clusters, public clouds and more. +### END INIT INFO + +export PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin + +BASE=<%= @docker_name %> + +# modify these in /etc/default/$BASE (/etc/default/docker) +DOCKER=/usr/bin/$BASE +# This is the pid file managed by docker itself +DOCKER_PIDFILE=/var/run/$BASE.pid +# This is the pid file created/managed by start-stop-daemon +DOCKER_SSD_PIDFILE=/var/run/$BASE-ssd.pid +DOCKER_LOGFILE=/var/log/$BASE.log +DOCKER_OPTS= +DOCKER_DESC="Docker" + +# Get lsb functions +. /lib/lsb/init-functions + +if [ -f /etc/default/$BASE ]; then + . /etc/default/$BASE +fi + +# Check docker is present +if [ ! -x $DOCKER ]; then + log_failure_msg "$DOCKER not present or not executable" + exit 1 +fi + +check_init() { + # see also init_is_upstart in /lib/lsb/init-functions (which isn't available in Ubuntu 12.04, or we'd use it directly) + if [ -x /sbin/initctl ] && /sbin/initctl version 2>/dev/null | grep -q upstart; then + log_failure_msg "$DOCKER_DESC is managed via upstart, try using service $BASE $1" + exit 1 + fi +} + +fail_unless_root() { + if [ "$(id -u)" != '0' ]; then + log_failure_msg "$DOCKER_DESC must be run as root" + exit 1 + fi +} + +cgroupfs_mount() { + # see also https://github.com/tianon/cgroupfs-mount/blob/master/cgroupfs-mount + if grep -v '^#' /etc/fstab | grep -q cgroup \ + || [ ! -e /proc/cgroups ] \ + || [ ! -d /sys/fs/cgroup ]; then + return + fi + if ! mountpoint -q /sys/fs/cgroup; then + mount -t tmpfs -o uid=0,gid=0,mode=0755 cgroup /sys/fs/cgroup + fi + ( + cd /sys/fs/cgroup + for sys in $(awk '!/^#/ { if ($4 == 1) print $1 }' /proc/cgroups); do + mkdir -p $sys + if ! mountpoint -q $sys; then + if ! mount -n -t cgroup -o $sys cgroup $sys; then + rmdir $sys || true + fi + fi + done + ) +} + +case "$1" in + start) + check_init + + fail_unless_root + + cgroupfs_mount + + touch "$DOCKER_LOGFILE" + chgrp docker "$DOCKER_LOGFILE" + + ulimit -n 1048576 + if [ "$BASH" ]; then + ulimit -u 1048576 + else + ulimit -p 1048576 + fi + + log_begin_msg "Starting $DOCKER_DESC: $BASE" + start-stop-daemon --start --background \ + --no-close \ + --exec "$DOCKER" \ + --pidfile "$DOCKER_SSD_PIDFILE" \ + --make-pidfile \ + -- \ + daemon -p "$DOCKER_PIDFILE" \ + $DOCKER_OPTS \ + >> "$DOCKER_LOGFILE" 2>&1 + <%= @docker_wait_ready %> + log_end_msg $? + ;; + + stop) + check_init + fail_unless_root + log_begin_msg "Stopping $DOCKER_DESC: $BASE" + start-stop-daemon --stop --pidfile "$DOCKER_SSD_PIDFILE" --retry 10 + log_end_msg $? + ;; + + restart) + check_init + fail_unless_root + docker_pid=`cat "$DOCKER_SSD_PIDFILE" 2>/dev/null` + [ -n "$docker_pid" ] \ + && ps -p $docker_pid > /dev/null 2>&1 \ + && $0 stop + $0 start + ;; + + force-reload) + check_init + fail_unless_root + $0 restart + ;; + + status) + check_init + status_of_proc -p "$DOCKER_SSD_PIDFILE" "$DOCKER" "$DOCKER_DESC" + ;; + + *) + echo "Usage: service docker {start|stop|restart|status}" + exit 1 + ;; +esac diff --git a/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb b/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb new file mode 100644 index 0000000..6134447 --- /dev/null +++ b/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb @@ -0,0 +1,132 @@ +#!/bin/sh +# +# /etc/rc.d/init.d/docker +# +# Daemon for docker.com +# +# chkconfig: 2345 95 95 +# description: Daemon for docker.com + +### BEGIN INIT INFO +# Provides: docker +# Required-Start: $network cgconfig +# Required-Stop: +# Should-Start: +# Should-Stop: +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: start and stop docker +# Description: Daemon for docker.com +### END INIT INFO + +# Source function library. +. /etc/rc.d/init.d/functions + +prog="<%= @docker_name %>" +unshare=/usr/bin/unshare +exec="/usr/bin/$prog" +pidfile="/var/run/$prog.pid" +lockfile="/var/lock/subsys/$prog" +logfile="/var/log/$prog" + +[ -e /etc/sysconfig/$prog ] && . /etc/sysconfig/$prog + +prestart() { + service cgconfig status > /dev/null + + if [[ $? != 0 ]]; then + service cgconfig start + fi + +} + +start() { + [ -x $exec ] || exit 5 + + check_for_cleanup + + if ! [ -f $pidfile ]; then + prestart + printf "Starting $prog:\t" + echo "\n$(date)\n" >> $logfile + "$unshare" -m -- $exec <%= @docker_daemon_arg %> $other_args &>> $logfile & + <%= @docker_wait_ready %> + [ $? -eq 0 ] && success || failure + echo + else + failure + echo + printf "$pidfile still exists...\n" + exit 7 + fi +} + +stop() { + echo -n $"Stopping $prog: " + killproc -p $pidfile -d 300 $prog + retval=$? + echo + [ $retval -eq 0 ] && rm -f $lockfile + return $retval +} + +restart() { + stop + start +} + +reload() { + restart +} + +force_reload() { + restart +} + +rh_status() { + status -p $pidfile $prog +} + +rh_status_q() { + rh_status >/dev/null 2>&1 +} + + +check_for_cleanup() { + if [ -f ${pidfile} ]; then + /bin/ps -fp $(cat ${pidfile}) > /dev/null || rm ${pidfile} + fi +} + +case "$1" in + start) + rh_status_q && exit 0 + $1 + ;; + stop) + rh_status_q || exit 0 + $1 + ;; + restart) + $1 + ;; + reload) + rh_status_q || exit 7 + $1 + ;; + force-reload) + force_reload + ;; + status) + rh_status + ;; + condrestart|try-restart) + rh_status_q || exit 0 + restart + ;; + *) + echo $"Usage: $0 {start|stop|status|restart|condrestart|try-restart|reload|force-reload}" + exit 2 +esac + +exit $? diff --git a/cookbooks/docker/templates/default/upstart/docker.conf.erb b/cookbooks/docker/templates/default/upstart/docker.conf.erb new file mode 100644 index 0000000..45dc5ee --- /dev/null +++ b/cookbooks/docker/templates/default/upstart/docker.conf.erb @@ -0,0 +1,59 @@ +description "Docker daemon" + +start on (filesystem and net-device-up IFACE!=lo) +stop on runlevel [!2345] +limit nofile 524288 1048576 +limit nproc 524288 1048576 + +respawn + +kill timeout 20 + +pre-start script + # see also https://github.com/tianon/cgroupfs-mount/blob/master/cgroupfs-mount + if grep -v '^#' /etc/fstab | grep -q cgroup \ + || [ ! -e /proc/cgroups ] \ + || [ ! -d /sys/fs/cgroup ]; then + exit 0 + fi + if ! mountpoint -q /sys/fs/cgroup; then + mount -t tmpfs -o uid=0,gid=0,mode=0755 cgroup /sys/fs/cgroup + fi + ( + cd /sys/fs/cgroup + for sys in $(awk '!/^#/ { if ($4 == 1) print $1 }' /proc/cgroups); do + mkdir -p $sys + if ! mountpoint -q $sys; then + if ! mount -n -t cgroup -o $sys cgroup $sys; then + rmdir $sys || true + fi + fi + done + ) +end script + +script + # modify these in /etc/default/$UPSTART_JOB (/etc/default/docker) + DOCKER=/usr/bin/$UPSTART_JOB + DOCKER_OPTS= + if [ -f /etc/default/$UPSTART_JOB ]; then + . /etc/default/$UPSTART_JOB + fi + exec "$DOCKER" <%= @docker_daemon_arg %> $DOCKER_OPTS +end script + +# Don't emit "started" event until the docker socket is ready. +# See https://github.com/docker/docker/issues/6647 +post-start script + DOCKER_OPTS= + if [ -f /etc/default/$UPSTART_JOB ]; then + . /etc/default/$UPSTART_JOB + fi + <%= @docker_wait_ready %> + if [ $? -eq 0 ]; then + echo "<%= @docker_socket %> is up" + else + echo "<%= @docker_socket %> failed to come start" + exit 1 + fi +end script diff --git a/cookbooks/line/CHANGELOG.md b/cookbooks/line/CHANGELOG.md new file mode 100644 index 0000000..973c923 --- /dev/null +++ b/cookbooks/line/CHANGELOG.md @@ -0,0 +1,22 @@ +line Cookbook CHANGELOG +======================== + +v0.6.3 (2015-10-27) +-------------------- +- Fixing Ruby and Chef deprecation warnings +- Cleaning up tests a bit +- Adding support for source_url and issues_url +- delete_from_list resource + +v0.6.2 (2015-07-15) +-------------------- +- Catch lines missed by strict patterns +- Add rspec tests for the replace_or_add provider. The existing chefspec tests don't step into the provider code and so don't check the provider functionality. +- Change the Gemfile to reflect the need for berkshelf 3, chefspec v4.2, rspec 3 for the tests. +- Update provider_replace_or_add to handle cases where the pattern does not match the replacement line. +- Fix notification problem where updated_by_last_action was set when nothing changed. + +v0.6.1 (2015-02-24) +-------------------- +- Adding CHANGELOG +- Adding ChefSpec matchers diff --git a/cookbooks/line/README.md b/cookbooks/line/README.md new file mode 100644 index 0000000..94c73b6 --- /dev/null +++ b/cookbooks/line/README.md @@ -0,0 +1,84 @@ +# line cookbook + +# Motivation +Quite often, the need arises to do line editing instead of managing an +entire file with a template resource. This cookbook supplies various +resources that will help you do this. + +# Usage +Add "depends 'line'" to your cookbook's metadata.rb to gain access to +the resoures. + + append_if_no_line "make sure a line is in dangerfile" do + path "/tmp/dangerfile" + line "HI THERE I AM STRING" + end + + replace_or_add "spread the love" do + path "/some/file" + pattern "Why hello there.*" + line "Why hello there, you beautiful person, you." + end + + delete_lines "remove hash-comments from /some/file" do + path "/some/file" + pattern "^#.*" + end + + add_to_list "add entry to a list" + path "/some/file" + pattern "People to call: " + delim [","] + entry "Bobby" + end + + delete_from_list "delete entry from a list" + path "/some/file" + pattern "People to call: " + delim [","] + entry "Bobby" + end + +# Notes +So far, the only resource implemented are + + append_if_no_line + replace_or_add + delete_lines + add_to_list + delete_from_list + + add_to_list + delim must be an array of 1, 2 or 3 multi-character elements. + If one delimiter is given, it is assumed that either the delimiter or the given search pattern will proceed each entry and + each entry will be followed by either the delimeter or a new line character: + People to call: Joe, Bobby + delim [","] + entry 'Karen' + People to call: Joe, Bobby, Karen + + If two delimiters are given, the first is used as the list element delimiter and the second as entry delimiters: + my @net1918 = ("10.0.0.0/8", "172.16.0.0/12"); + delim [", ", "\""] + entry "192.168.0.0/16" + my @net1918 = ("10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"); + + if three delimiters are given, the first is used as the list element delimiter, the second as the leading entry delimiter and the third as the trailing delimiter: + multi = ([310], [818]) + delim [", ", "[", "]"] + entry "425" + multi = ([310], [818], [425]) + + delete_from_list + Works exactly the same way as add_to_list, see above. + + +More to follow. + +# Recipes +tester - A recipe to exercise the resources + +# Author +Author:: Sean OMeara () +Contributor:: Antek S. Baranski () + diff --git a/cookbooks/line/files/default/serial.conf b/cookbooks/line/files/default/serial.conf new file mode 100644 index 0000000..f5f6d5c --- /dev/null +++ b/cookbooks/line/files/default/serial.conf @@ -0,0 +1,79 @@ +# +# This is a sample serial.conf file. You should uncomment out and modify +# the relevant lines as necessary. +# + +# These are the standard COM1 through COM4 devices +# +#/dev/ttyS0 uart 16450 port 0x3F8 irq 4 +#/dev/ttyS1 uart 16450 port 0x2F8 irq 3 +#/dev/ttyS2 uart 16450 port 0x3E8 irq 4 +#/dev/ttyS3 uart 16450 port 0x2E8 irq 3 + +# These are the first set of AST Fourport ports +# +#/dev/ttyS4 uart 16450 port 0x1A0 irq 9 fourport +#/dev/ttyS5 uart 16450 port 0x1A8 irq 9 fourport +#/dev/ttyS6 uart 16450 port 0x1B0 irq 9 fourport +#/dev/ttyS7 uart 16450 port 0x1B8 irq 9 fourport + +# This enables the new multiport masking feature, which is highly recommened +# for AST FourPort boards. +# +#/dev/ttyS4 set_multiport port1 0x1BF mask1 0xf match1 0xf + +# These are the second set of AST Fourport ports +# +#/dev/ttyS8 uart 16450 port 0x2A0 irq 5 fourport +#/dev/ttyS9 uart 16450 port 0x2A8 irq 5 fourport +#/dev/ttyS10 uart 16450 port 0x2B0 irq 5 fourport +#/dev/ttyS11 uart 16450 port 0x2B8 irq 5 fourport + +# This enables the new multiport masking feature, which is highly recommened +# for AST FourPort boards. +# +#/dev/ttyS8 set_multiport port1 0x2BF mask1 0xf match1 0xf + +# These are the 3rd and 4th ports on the Accent Async board. +# +#/dev/ttyS12 uart 16450 port 0x330 irq 4 +#/dev/ttyS13 uart 16450 port 0x338 irq 4 + +# These are two spare devices you can use to customize for +# some board which is not supported above.... +# +#/dev/ttyS14 uart XXXXX port XXXX irq X +#/dev/ttyS15 uart XXXXX port XXXX irq X + +# These are the ports used for either the Usenet Serial II +# board, or the Boca Board 4, 8, or 16 port boards. +# +# Uncomment only the first 4 lines for the Usenet Serial II board, +# and uncomment the first 4, 8, or all 16 lines for the +# Boca Board BB-1004, BB-1008, and BB-2016 respectively. +# +#/dev/ttyS16 uart 16550A port 0x100 irq 12 +#/dev/ttyS17 uart 16550A port 0x108 irq 12 +#/dev/ttyS18 uart 16550A port 0x110 irq 12 +#/dev/ttyS19 uart 16550A port 0x118 irq 12 +#/dev/ttyS20 uart 16550A port 0x120 irq 12 +#/dev/ttyS21 uart 16550A port 0x128 irq 12 +#/dev/ttyS22 uart 16550A port 0x130 irq 12 +#/dev/ttyS23 uart 16550A port 0x138 irq 12 +#/dev/ttyS24 uart 16550A port 0x140 irq 12 +#/dev/ttyS25 uart 16550A port 0x148 irq 12 +#/dev/ttyS26 uart 16550A port 0x150 irq 12 +#/dev/ttyS27 uart 16550A port 0x158 irq 12 +#/dev/ttyS28 uart 16550A port 0x160 irq 12 +#/dev/ttyS29 uart 16550A port 0x168 irq 12 +#/dev/ttyS30 uart 16550A port 0x170 irq 12 +#/dev/ttyS31 uart 16550A port 0x178 irq 12 + +# This enables the new multiport masking feature, which is highly recommened +# for Bocaboard ports. Uncomment only the first line if you have a +# BB-1004 or BB-1008. Uncomment both lines if you have a BB-2016. +# These numbers assume the Bocaboard is located at address 0x100. If you +# change this, remember to change the port1 and port2 addresses. +# +#/dev/ttyS16 set_multiport port1 0x107 mask1 0xff match1 0 +#/dev/ttyS16 set_multiport port2 0x147 mask2 0xff match2 0 diff --git a/cookbooks/line/files/default/tests/minitest/default_test.rb b/cookbooks/line/files/default/tests/minitest/default_test.rb new file mode 100644 index 0000000..5b983f3 --- /dev/null +++ b/cookbooks/line/files/default/tests/minitest/default_test.rb @@ -0,0 +1,9 @@ +require File.expand_path('../support/helpers', __FILE__) + +describe 'line::default' do + include Helpers::Line + + # Example spec tests can be found at http://git.io/Fahwsw + it 'runs no tests by default' do + end +end diff --git a/cookbooks/line/files/default/tests/minitest/support/helpers.rb b/cookbooks/line/files/default/tests/minitest/support/helpers.rb new file mode 100644 index 0000000..3d0e1ee --- /dev/null +++ b/cookbooks/line/files/default/tests/minitest/support/helpers.rb @@ -0,0 +1,7 @@ +module Helpers + module Line + include MiniTest::Chef::Assertions + include MiniTest::Chef::Context + include MiniTest::Chef::Resources + end +end diff --git a/cookbooks/line/libraries/default.rb b/cookbooks/line/libraries/default.rb new file mode 100644 index 0000000..332ed68 --- /dev/null +++ b/cookbooks/line/libraries/default.rb @@ -0,0 +1,29 @@ +# +# Cookbook Name:: line +# Library:: default +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# + +def escape_string(string) + pattern = /(\+|\'|\"|\.|\*|\/|\-|\\|\(|\)|\{|\}|\^|\$|\[|\])/ + string.gsub(pattern) { |match| '\\' + match } +end + +def escape_regex(string) + pattern = /(\+|\'|\"|\.|\*|\/|\-|\\|\(|\)|\{|\}|\^|\$|\[|\])/ + string.gsub(pattern) { |match| '\\' + match } +end diff --git a/cookbooks/line/libraries/matchers.rb b/cookbooks/line/libraries/matchers.rb new file mode 100644 index 0000000..aff2b09 --- /dev/null +++ b/cookbooks/line/libraries/matchers.rb @@ -0,0 +1,21 @@ +if defined?(ChefSpec) + ChefSpec.define_matcher :add_to_list + def edit_add_to_list(resource) + ChefSpec::Matchers::ResourceMatcher.new(:add_to_list, :edit, resource) + end + + ChefSpec.define_matcher :append_if_no_line + def edit_append_if_no_line(resource) + ChefSpec::Matchers::ResourceMatcher.new(:append_if_no_line, :edit, resource) + end + + ChefSpec.define_matcher :delete_lines + def edit_delete_lines(resource) + ChefSpec::Matchers::ResourceMatcher.new(:delete_lines, :edit, resource) + end + + ChefSpec.define_matcher :replace_or_add + def edit_replace_or_add(resource) + ChefSpec::Matchers::ResourceMatcher.new(:replace_or_add, :edit, resource) + end +end diff --git a/cookbooks/line/libraries/provider_add_to_list.rb b/cookbooks/line/libraries/provider_add_to_list.rb new file mode 100644 index 0000000..045da33 --- /dev/null +++ b/cookbooks/line/libraries/provider_add_to_list.rb @@ -0,0 +1,87 @@ +# +# Cookbook Name:: line +# Library:: provider_add_to_list +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# + +require 'fileutils' +require 'tempfile' + +class Chef + class Provider + class AddToList < Chef::Provider + + provides :add_to_list if respond_to?(:provides) + + def load_current_resource + end + + def action_edit + regex = /#{new_resource.pattern}/ + + if ::File.exist?(new_resource.path) + begin + f = ::File.open(new_resource.path, 'r+') + + file_owner = f.lstat.uid + file_group = f.lstat.gid + file_mode = f.lstat.mode + + temp_file = Tempfile.new('foo') + + modified = false + + f.each_line do |line| + if line =~ regex + found = true + if new_resource.delim.count == 1 + unless line =~ /(#{new_resource.delim[0]}|#{new_resource.pattern})\s*#{new_resource.entry}\s*(#{new_resource.delim[0]}|\n)/ + line = line.chomp + "#{new_resource.delim[0]}#{new_resource.entry}" + modified = true + end + else + unless line =~ /#{new_resource.delim[0]}\s*#{new_resource.entry}\s*#{new_resource.delim[1]}/ + line = line.chomp + "#{new_resource.delim[0]}#{new_resource.entry}#{new_resource.delim[1]}" + modified = true + end + end + end + temp_file.puts line + end + + f.close + + if modified + temp_file.rewind + FileUtils.copy_file(temp_file.path, new_resource.path) + FileUtils.chown(file_owner, file_group, new_resource.path) + FileUtils.chmod(file_mode, new_resource.path) + new_resource.updated_by_last_action(true) + end + + ensure + temp_file.close + temp_file.unlink + end + end # if ::File.exists? + end # def action_edit + + def nothing + end + end + end +end diff --git a/cookbooks/line/libraries/provider_append_if_no_line.rb b/cookbooks/line/libraries/provider_append_if_no_line.rb new file mode 100644 index 0000000..371f64c --- /dev/null +++ b/cookbooks/line/libraries/provider_append_if_no_line.rb @@ -0,0 +1,60 @@ +# +# Cookbook Name:: line +# Library:: provider_append_if_no_such_line +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# + +class Chef + class Provider + class AppendIfNoLine < Chef::Provider + provides :append_if_no_line if respond_to?(:provides) + def load_current_resource + end + + def action_edit + string = escape_string new_resource.line + regex = /^#{string}$/ + + if ::File.exist?(new_resource.path) + begin + f = ::File.open(new_resource.path, 'r+') + + found = false + f.each_line { |line| found = true if line =~ regex } + + unless found + f.puts new_resource.line + new_resource.updated_by_last_action(true) + end + ensure + f.close + end + else + begin + f = ::File.open(new_resource.path, 'w') + f.puts new_resource.line + ensure + f.close + end + end + + def nothing + end + end + end + end +end diff --git a/cookbooks/line/libraries/provider_delete_from_list.rb b/cookbooks/line/libraries/provider_delete_from_list.rb new file mode 100644 index 0000000..39b9dc4 --- /dev/null +++ b/cookbooks/line/libraries/provider_delete_from_list.rb @@ -0,0 +1,115 @@ +# +# Cookbook Name:: line +# Library:: provider_delete_from_list +# +# Author:: Antek S. Baranski +# +# +# 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. +# + +require 'fileutils' +require 'tempfile' + +class Chef + class Provider + class DeleteFromList < Chef::Provider + + provides :delete_from_list if respond_to?(:provides) + + def load_current_resource + end + + def action_edit + regex = /#{new_resource.pattern}/ + + if ::File.exist?(new_resource.path) + begin + f = ::File.open(new_resource.path, 'r+') + + file_owner = f.lstat.uid + file_group = f.lstat.gid + file_mode = f.lstat.mode + + temp_file = Tempfile.new('foo') + + modified = false + + regexdelim = [] + new_resource.delim.each do |delim| + regexdelim << escape_regex(delim) + end + + f.each_line do |line| + if line =~ regex + case new_resource.delim.count + when 1 + case line + when /#{regexdelim[0]}\s*#{new_resource.entry}/ + line = line.sub(/#{regexdelim[0]}\s*#{new_resource.entry}/, '') + line = line.chomp + modified = true + when /#{new_resource.entry}\s*#{regexdelim[0]}/ + line = line.sub(/#{new_resource.entry}\s*#{regexdelim[0]}/, '') + line = line.chomp + modified = true + end + when 2 + case line + when /#{regexdelim[1]}#{new_resource.entry}#{regexdelim[1]}/ + line = line.sub(/#{regexdelim[0]}\s*#{regexdelim[1]}#{new_resource.entry}#{regexdelim[1]}/, '') + line = line.chomp + modified = true + when /#{regexdelim[1]}#{new_resource.entry}#{regexdelim[1]}/ + line = line.sub(/#{regexdelim[1]}#{new_resource.entry}#{regexdelim[1]}\s*#{regexdelim[0]}/, '') + line = line.chomp + modified = true + end + when 3 + case line + when /#{regexdelim[1]}#{new_resource.entry}#{regexdelim[2]}/ + line = line.sub(/#{regexdelim[0]}\s*#{regexdelim[1]}#{new_resource.entry}#{regexdelim[2]}/, '') + line = line.chomp + modified = true + when /#{regexdelim[1]}#{new_resource.entry}#{regexdelim[2]}/ + line = line.sub(/#{regexdelim[1]}#{new_resource.entry}#{regexdelim[2]}\s*#{regexdelim[0]}/, '') + line = line.chomp + modified = true + end + end + end + temp_file.puts line + end + + f.close + + if modified + temp_file.rewind + FileUtils.copy_file(temp_file.path, new_resource.path) + FileUtils.chown(file_owner, file_group, new_resource.path) + FileUtils.chmod(file_mode, new_resource.path) + new_resource.updated_by_last_action(true) + end + + ensure + temp_file.close + temp_file.unlink + end + end # if ::File.exists? + end # def action_edit + + def nothing + end + end + end +end diff --git a/cookbooks/line/libraries/provider_delete_lines.rb b/cookbooks/line/libraries/provider_delete_lines.rb new file mode 100644 index 0000000..ed3e825 --- /dev/null +++ b/cookbooks/line/libraries/provider_delete_lines.rb @@ -0,0 +1,76 @@ +# +# Cookbook Name:: line +# Library:: provider_delete_lines +# +# Author:: Sean OMeara +# Author:: Jeff Blaine +# Copyright 2012-2013, 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. +# + +require 'fileutils' +require 'tempfile' + +class Chef + class Provider + class DeleteLines < Chef::Provider + provides :delete_lines if respond_to?(:provides) + def load_current_resource + end + + def action_edit + regex = /#{new_resource.pattern}/ + + if ::File.exist?(new_resource.path) + begin + f = ::File.open(new_resource.path, 'r+') + + file_owner = f.lstat.uid + file_group = f.lstat.gid + file_mode = f.lstat.mode + + temp_file = Tempfile.new('foo') + + modified = false + + f.each_line do |line| + if line =~ regex + modified = true + else + temp_file.puts line + end + end + + f.close + + if modified + temp_file.rewind + FileUtils.copy_file(temp_file.path, new_resource.path) + FileUtils.chown(file_owner, file_group, new_resource.path) + FileUtils.chmod(file_mode, new_resource.path) + new_resource.updated_by_last_action(true) + end + + ensure + temp_file.close + temp_file.unlink + end + end # ::File.exists + end # def action_edit + + def action_nothing + end + end + end +end diff --git a/cookbooks/line/libraries/provider_replace_or_add.rb b/cookbooks/line/libraries/provider_replace_or_add.rb new file mode 100644 index 0000000..0c3640d --- /dev/null +++ b/cookbooks/line/libraries/provider_replace_or_add.rb @@ -0,0 +1,96 @@ +# +# Cookbook Name:: line +# Library:: provider_replace_or_add +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# + +require 'fileutils' +require 'tempfile' + +class Chef + class Provider + class ReplaceOrAdd < Chef::Provider + provides :replace_or_add if respond_to?(:provides) + def load_current_resource + end + + def action_edit + regex = /#{new_resource.pattern}/ + + if ::File.exist?(new_resource.path) + begin + f = ::File.open(new_resource.path, 'r+') + + file_owner = f.lstat.uid + file_group = f.lstat.gid + file_mode = f.lstat.mode + + temp_file = Tempfile.new('foo') + + modified = false + found = false + + f.each_line do |line| + if line =~ regex || line.chomp == new_resource.line + found = true + unless line.chomp == new_resource.line + line = new_resource.line + modified = true + end + end + temp_file.puts line + end + + unless found # "add"! + temp_file.puts new_resource.line + modified = true + end + + f.close + + if modified + temp_file.rewind + FileUtils.copy_file(temp_file.path, new_resource.path) + FileUtils.chown(file_owner, file_group, new_resource.path) + FileUtils.chmod(file_mode, new_resource.path) + new_resource.updated_by_last_action(true) + end + + ensure + temp_file.close + temp_file.unlink + end + else + + begin + nf = ::File.open(new_resource.path, 'w') + nf.puts new_resource.line + new_resource.updated_by_last_action(true) + rescue ENOENT + Chef::Log.info('ERROR: Containing directory does not exist for #{nf.class}') + ensure + nf.close + end + + end # if ::File.exists? + end # def action_edit + + def nothing + end + end + end +end diff --git a/cookbooks/line/libraries/resource_add_to_list.rb b/cookbooks/line/libraries/resource_add_to_list.rb new file mode 100644 index 0000000..cf742c3 --- /dev/null +++ b/cookbooks/line/libraries/resource_add_to_list.rb @@ -0,0 +1,63 @@ +# +# Cookbook Name:: line +# Library:: resource_add_to_list +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# +class Chef + class Resource + class AddToList < Chef::Resource + def initialize(name, run_context = nil) + super + @resource_name = :add_to_list + @action = :edit + @allowed_actions.push(:edit, :nothing) + end + + def path(arg = nil) + set_or_return( + :path, + arg, + kind_of: String + ) + end + + def pattern(arg = nil) + set_or_return( + :pattern, + arg, + kind_of: String + ) + end + + def delim(arg = nil) + set_or_return( + :delim, + arg, + kind_of: Array + ) + end + + def entry(arg = nil) + set_or_return( + :entry, + arg, + kind_of: String + ) + end + end + end +end diff --git a/cookbooks/line/libraries/resource_append_if_no_line.rb b/cookbooks/line/libraries/resource_append_if_no_line.rb new file mode 100644 index 0000000..7d21d98 --- /dev/null +++ b/cookbooks/line/libraries/resource_append_if_no_line.rb @@ -0,0 +1,48 @@ +# +# Cookbook Name:: line +# Library:: resource_append_if_no_such_line +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# + +class Chef + class Resource + class AppendIfNoLine < Chef::Resource + def initialize(name, run_context = nil) + super + @resource_name = :append_if_no_line + @action = :edit + @allowed_actions.push(:edit, :nothing) + end + + def path(arg = nil) + set_or_return( + :path, + arg, + kind_of: String + ) + end + + def line(arg = nil) + set_or_return( + :line, + arg, + kind_of: String + ) + end + end + end +end diff --git a/cookbooks/line/libraries/resource_delete_from_list.rb b/cookbooks/line/libraries/resource_delete_from_list.rb new file mode 100644 index 0000000..509d0e1 --- /dev/null +++ b/cookbooks/line/libraries/resource_delete_from_list.rb @@ -0,0 +1,63 @@ +# +# Cookbook Name:: line +# Library:: resource_delete_from_list +# +# Author:: Antek S. Baranski +# +# +# 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. +# +class Chef + class Resource + class DeleteFromList < Chef::Resource + def initialize(name, run_context = nil) + super + @resource_name = :delete_from_list + @action = :edit + @allowed_actions.push(:edit, :nothing) + end + + def path(arg = nil) + set_or_return( + :path, + arg, + kind_of: String + ) + end + + def pattern(arg = nil) + set_or_return( + :pattern, + arg, + kind_of: String + ) + end + + def delim(arg = nil) + set_or_return( + :delim, + arg, + kind_of: Array + ) + end + + def entry(arg = nil) + set_or_return( + :entry, + arg, + kind_of: String + ) + end + end + end +end diff --git a/cookbooks/line/libraries/resource_delete_lines.rb b/cookbooks/line/libraries/resource_delete_lines.rb new file mode 100644 index 0000000..9f5ee10 --- /dev/null +++ b/cookbooks/line/libraries/resource_delete_lines.rb @@ -0,0 +1,48 @@ +# Cookbook Name:: line +# Library:: resource_delete_lines +# +# Author:: Sean OMeara +# Author:: Jeff Blaine +# Copyright 2012-2013, 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. +# + +class Chef + class Resource + class DeleteLines < Chef::Resource + def initialize(name, run_context = nil) + super + @resource_name = :delete_lines + @action = :edit + @allowed_actions.push(:edit, :nothing) + end + + def path(arg = nil) + set_or_return( + :path, + arg, + kind_of: String + ) + end + + def pattern(arg = nil) + set_or_return( + :line, + arg, + kind_of: String + ) + end + end + end +end diff --git a/cookbooks/line/libraries/resource_replace_or_add.rb b/cookbooks/line/libraries/resource_replace_or_add.rb new file mode 100644 index 0000000..78cb40b --- /dev/null +++ b/cookbooks/line/libraries/resource_replace_or_add.rb @@ -0,0 +1,55 @@ +# +# Cookbook Name:: line +# Library:: resource_replace_or_add +# +# Author:: Sean OMeara +# Copyright 2012-2013, 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. +# +class Chef + class Resource + class ReplaceOrAdd < Chef::Resource + def initialize(name, run_context = nil) + super + @resource_name = :replace_or_add + @action = :edit + @allowed_actions.push(:edit) + end + + def path(arg = nil) + set_or_return( + :path, + arg, + kind_of: String + ) + end + + def pattern(arg = nil) + set_or_return( + :pattern, + arg, + kind_of: String + ) + end + + def line(arg = nil) + set_or_return( + :line, + arg, + kind_of: String + ) + end + end + end +end diff --git a/cookbooks/line/metadata.json b/cookbooks/line/metadata.json new file mode 100644 index 0000000..ed4833b --- /dev/null +++ b/cookbooks/line/metadata.json @@ -0,0 +1 @@ +{"name":"line","version":"0.6.3","description":"Provides line editing resources for use by recipes","long_description":"# line cookbook\n\n# Motivation\nQuite often, the need arises to do line editing instead of managing an\nentire file with a template resource. This cookbook supplies various \nresources that will help you do this.\n\n# Usage\nAdd \"depends 'line'\" to your cookbook's metadata.rb to gain access to\nthe resoures.\n\n append_if_no_line \"make sure a line is in dangerfile\" do\n path \"/tmp/dangerfile\"\n line \"HI THERE I AM STRING\"\n end\n \n replace_or_add \"spread the love\" do\n path \"/some/file\"\n pattern \"Why hello there.*\"\n line \"Why hello there, you beautiful person, you.\"\n end\n\n delete_lines \"remove hash-comments from /some/file\" do\n path \"/some/file\"\n pattern \"^#.*\"\n end\n\n add_to_list \"add entry to a list\"\n path \"/some/file\"\n pattern \"People to call: \"\n delim [\",\"]\n entry \"Bobby\"\n end\n\n delete_from_list \"delete entry from a list\"\n path \"/some/file\"\n pattern \"People to call: \"\n delim [\",\"]\n entry \"Bobby\"\n end\n\n# Notes\nSo far, the only resource implemented are \n\n append_if_no_line\n replace_or_add\n delete_lines\n add_to_list\n delete_from_list\n\n add_to_list\n delim must be an array of 1, 2 or 3 multi-character elements.\n If one delimiter is given, it is assumed that either the delimiter or the given search pattern will proceed each entry and\n each entry will be followed by either the delimeter or a new line character:\n People to call: Joe, Bobby\n\t delim [\",\"]\n\t entry 'Karen'\n People to call: Joe, Bobby, Karen\n\t \n If two delimiters are given, the first is used as the list element delimiter and the second as entry delimiters:\n my @net1918 = (\"10.0.0.0/8\", \"172.16.0.0/12\");\n\t delim [\", \", \"\\\"\"]\n\t entry \"192.168.0.0/16\"\n my @net1918 = (\"10.0.0.0/8\", \"172.16.0.0/12\", \"192.168.0.0/16\");\n\n if three delimiters are given, the first is used as the list element delimiter, the second as the leading entry delimiter and the third as the trailing delimiter:\n multi = ([310], [818])\n delim [\", \", \"[\", \"]\"]\n entry \"425\"\n multi = ([310], [818], [425])\n\n delete_from_list\n Works exactly the same way as add_to_list, see above.\n\t \n\nMore to follow.\n\n# Recipes\ntester - A recipe to exercise the resources\n\n# Author\nAuthor:: Sean OMeara ()\nContributor:: Antek S. Baranski ()\n\n","maintainer":"Sean OMeara","maintainer_email":"someara@chef.io","license":"Apache2","platforms":{},"dependencies":{},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{}} \ No newline at end of file diff --git a/cookbooks/line/recipes/default.rb b/cookbooks/line/recipes/default.rb new file mode 100644 index 0000000..975a4fb --- /dev/null +++ b/cookbooks/line/recipes/default.rb @@ -0,0 +1,8 @@ +# +# Cookbook Name:: line +# Recipe:: default +# +# Copyright (C) 2013 YOUR_COPYRIGHT +# +# All rights reserved - Do Not Redistribute +# diff --git a/cookbooks/workstations/metadata.rb b/cookbooks/workstations/metadata.rb index 08788dc..37331f0 100644 --- a/cookbooks/workstations/metadata.rb +++ b/cookbooks/workstations/metadata.rb @@ -9,4 +9,5 @@ depends 'sudo' depends 'chef-ingredient' depends 'ssh' -depends 'line' \ No newline at end of file +depends 'line' +depends 'docker' \ No newline at end of file diff --git a/cookbooks/workstations/recipes/centos-chef_user.rb b/cookbooks/workstations/recipes/centos-chef_user.rb index 6bb5840..b9f93b8 100644 --- a/cookbooks/workstations/recipes/centos-chef_user.rb +++ b/cookbooks/workstations/recipes/centos-chef_user.rb @@ -17,7 +17,7 @@ comment 'ChefDK User' home '/home/chef' shell '/bin/bash' - supports :manage_home => true + manage_home true password '$1$seaspong$/UREL79gaEZJRXoYPaKnE.' action :create end diff --git a/cookbooks/workstations/recipes/centos-docker.rb b/cookbooks/workstations/recipes/centos-docker.rb index 09183ed..0c9d22c 100644 --- a/cookbooks/workstations/recipes/centos-docker.rb +++ b/cookbooks/workstations/recipes/centos-docker.rb @@ -5,70 +5,29 @@ # Copyright (c) 2016 The Authors, All Rights Reserved. # -# Test Kitchen on AWS requires that Docker is installed. +# Start the docker service # -# The correct Docker package is not contained in the standard package repository -# it has to be added through through the Extra Package for Enterprise Linux (EPEL) -# process. -# -# @see https://docs.docker.com/installation/centos/ - -remote_file "epel-release-6-8.noarch.rpm" do - source "http://ftp.osuosl.org/pub/fedora-epel/6/i386/epel-release-6-8.noarch.rpm" +docker_service 'default' do + action [:create, :start] end -# -# Load the EPEL -# -# @note This command is not idempotent. This will break the instance if run a second time. -# -execute "rpm -ivh epel-release-6-8.noarch.rpm" - -# -# Remove docker if it happens to be installed in the package repository. -# Because we need to install a different package name on CentOS. -# -# @note This command is not idempotent. A better command may existin within the yum cookbook. -# -execute "yum -y remove docker" - -# Install the correct Docker Package from the EPEL. -package "docker-io" - -# The service name for docker-io is named docker. -service "docker" do - action [ :start, :enable ] -end - - include_recipe "#{cookbook_name}::centos-chef_user" # # Test Kitchen does not automatically ship with the gem that allows it to talk # with Docker. This will add the necessary gem for Test Kitchen to use Docker. # -# @note install the kitchen-docker gem for the chef user. This workaround was -# required to get the right user to have it installed. Without it the root -# user was getting the kitchen-docker gem -# -execute 'sudo su -c "chef exec gem install kitchen-docker" -s /bin/sh chef' +gem_package 'kitchen-docker' do + gem_binary '/opt/chefdk/embedded/bin/gem' + options '--no-user-install' + notifies :restart, 'docker_service[default]' +end # # To allow the chef user to properly manage docker for the purposes of # integration testing with Test Kitchen. # -group 'dockerroot' do +group 'docker' do members 'chef' + append true end - - -# -# To allow the chef user to properly manage docker for the purposes of -# integration testing with Test Kitchen. -# /var/run/docker.sock -# -# file '/var/run/docker.sock' do -# owner 'dockerroot' -# end - -execute 'chown root:dockerroot /var/run/docker.sock' diff --git a/cookbooks/workstations/recipes/centos-ec2_hints.rb b/cookbooks/workstations/recipes/centos-ec2_hints.rb deleted file mode 100644 index b7adea3..0000000 --- a/cookbooks/workstations/recipes/centos-ec2_hints.rb +++ /dev/null @@ -1,23 +0,0 @@ -# -# Cookbook Name:: workstations -# Recipe:: centos-ec2_hints -# -# Copyright (c) 2016 The Authors, All Rights Reserved. - -# -# These images are being created on EC2 and I have found that often -# times Ohai is unable to determine that the system is an EC2 instance. -# -# This hint file is important because without it the learner will not be able -# to retrieve the public hostname and IP address from the node data from Ohai. -# -# -# @note this hint file is only necessary when working on EC2. - -directory "/etc/chef/ohai/hints" do - recursive true -end - -file "/etc/chef/ohai/hints/ec2.json" do - content '{}' -end diff --git a/cookbooks/workstations/recipes/centos-permissions.rb b/cookbooks/workstations/recipes/centos-permissions.rb index 579c51b..b1ed583 100644 --- a/cookbooks/workstations/recipes/centos-permissions.rb +++ b/cookbooks/workstations/recipes/centos-permissions.rb @@ -4,18 +4,6 @@ # # Copyright (c) 2016 The Authors, All Rights Reserved. - -# -# Instances for security disable password login. We want to make it easy for -# learners to connect to these instances with the very unsecure user name and -# password that we have provided. -# -# @note This is quick-and-dirty solution to enable Password Authentication. -# Instead of depending on another cookbook to provide a recipe or custom -# resource to manage this file. -# -execute "sed 's/#PasswordAuthentication yes/PasswordAuthentication yes/' /etc/ssh_config > /etc/ssh_config" - # # Stop and disable iptables. # diff --git a/cookbooks/workstations/recipes/centos-sshd_config.rb b/cookbooks/workstations/recipes/centos-sshd_config.rb index 6e90752..59186c4 100644 --- a/cookbooks/workstations/recipes/centos-sshd_config.rb +++ b/cookbooks/workstations/recipes/centos-sshd_config.rb @@ -18,4 +18,26 @@ append_if_no_line "Update max startups" do path "/etc/ssh/sshd_config" line "MaxStartups 250" -end \ No newline at end of file +end + +service 'sshd' + +template '/etc/ssh/sshd_config' do + source 'rhel-sshd_config.erb' + owner 'root' + group 'root' + mode '0644' + notifies :restart, "service[sshd]" +end + +directory '/etc/cloud' do + recursive true +end + +template '/etc/cloud/cloud.cfg' do + source 'cloud.cfg.erb' + owner 'root' + group 'root' + mode '0644' +end + diff --git a/cookbooks/workstations/recipes/compliance.rb b/cookbooks/workstations/recipes/compliance.rb index bd01408..fba14b6 100644 --- a/cookbooks/workstations/recipes/compliance.rb +++ b/cookbooks/workstations/recipes/compliance.rb @@ -15,8 +15,6 @@ chef_ingredient 'chefdk' do action :install - channel :stable - version '0.17.17' end include_recipe "#{cookbook_name}::centos-chef_user" @@ -28,4 +26,5 @@ include_recipe "#{cookbook_name}::centos-permissions" -include_recipe "#{cookbook_name}::centos-ec2_hints" +include_recipe "#{cookbook_name}::centos-sshd_config" + diff --git a/cookbooks/workstations/recipes/essentials.rb b/cookbooks/workstations/recipes/essentials.rb index 78a92ef..48a9e4c 100644 --- a/cookbooks/workstations/recipes/essentials.rb +++ b/cookbooks/workstations/recipes/essentials.rb @@ -35,4 +35,3 @@ include_recipe "#{cookbook_name}::centos-sshd_config" -include_recipe "#{cookbook_name}::centos-ec2_hints" diff --git a/cookbooks/workstations/recipes/tdd_cookbook_development.rb b/cookbooks/workstations/recipes/tdd_cookbook_development.rb index 42120de..c332665 100644 --- a/cookbooks/workstations/recipes/tdd_cookbook_development.rb +++ b/cookbooks/workstations/recipes/tdd_cookbook_development.rb @@ -28,4 +28,3 @@ include_recipe "#{cookbook_name}::centos-permissions" -include_recipe "#{cookbook_name}::centos-ec2_hints" diff --git a/cookbooks/workstations/recipes/ubuntu.rb b/cookbooks/workstations/recipes/ubuntu.rb index 919a24c..baff928 100644 --- a/cookbooks/workstations/recipes/ubuntu.rb +++ b/cookbooks/workstations/recipes/ubuntu.rb @@ -37,11 +37,6 @@ template "chef-sudoer.erb" end -# To allow the chef user to login to the system through SSH -# This was easier than grabbing another cookbook -execute "sed 's/#PasswordAuthentication yes/PasswordAuthentication yes/' /etc/ssh/sshd_config > /etc/ssh/sshd_config" - - packages_attendees_will_install = %w[ vim nano emacs git ] packages_attendees_will_install.each do |name| @@ -50,16 +45,14 @@ end end +# SSH config to allow for password login +service 'ssh' -# -# These images are being created on EC2 and I have found that often -# times Ohai is unable to determine that the system is an EC2 instance. -# - -directory '/etc/chef/ohai/hints' do - recursive true +template '/etc/ssh/sshd_config' do + source 'debian-sshd_config.erb' + owner 'root' + group 'root' + mode '0644' + notifies :restart, "service[ssh]" end -file '/etc/chef/ohai/hints/ec2.json' do - content '{}' -end diff --git a/cookbooks/workstations/spec/unit/recipes/centos-ec2_hints_spec.rb b/cookbooks/workstations/spec/unit/recipes/centos-ec2_hints_spec.rb deleted file mode 100644 index 772d9d1..0000000 --- a/cookbooks/workstations/spec/unit/recipes/centos-ec2_hints_spec.rb +++ /dev/null @@ -1,20 +0,0 @@ -# -# Cookbook Name:: workstations -# Spec:: default -# -# Copyright (c) 2016 The Authors, All Rights Reserved. - -require 'spec_helper' - -describe 'workstations::centos-ec2_hints' do - context 'When all attributes are default, on an unspecified platform' do - let(:chef_run) do - runner = ChefSpec::ServerRunner.new - runner.converge(described_recipe) - end - - it 'converges successfully' do - expect { chef_run }.to_not raise_error - end - end -end diff --git a/cookbooks/workstations/templates/chef-sudoer.erb b/cookbooks/workstations/templates/chef-sudoer.erb new file mode 100644 index 0000000..273ddc4 --- /dev/null +++ b/cookbooks/workstations/templates/chef-sudoer.erb @@ -0,0 +1,2 @@ +chef ALL=(ALL) NOPASSWD:ALL +Defaults:chef !requiretty diff --git a/cookbooks/workstations/templates/cloud.cfg.erb b/cookbooks/workstations/templates/cloud.cfg.erb new file mode 100644 index 0000000..3ec1989 --- /dev/null +++ b/cookbooks/workstations/templates/cloud.cfg.erb @@ -0,0 +1,66 @@ +users: + - default + +disable_root: 1 +ssh_pwauth: 1 + +mount_default_fields: [~, ~, 'auto', 'defaults,nofail', '0', '2'] +resize_rootfs_tmp: /dev +ssh_deletekeys: 0 +ssh_genkeytypes: ~ +syslog_fix_perms: ~ + +cloud_init_modules: + - rh_subscription + - migrator + - bootcmd + - write-files + - growpart + - resizefs + - set_hostname + - update_hostname + - update_etc_hosts + - rsyslog + - users-groups + - ssh + +cloud_config_modules: + - mounts + - locale + - set-passwords + - yum-add-repo + - package-update-upgrade-install + - timezone + - puppet + - chef + - salt-minion + - mcollective + - disable-ec2-metadata + - runcmd + +cloud_final_modules: + - rightscale_userdata + - scripts-per-once + - scripts-per-boot + - scripts-per-instance + - scripts-user + - ssh-authkey-fingerprints + - keys-to-console + - phone-home + - final-message + +system_info: + default_user: + name: ec2-user + lock_passwd: true + gecos: Cloud User + groups: [wheel, adm, systemd-journal] + sudo: ["ALL=(ALL) NOPASSWD:ALL"] + shell: /bin/bash + distro: rhel + paths: + cloud_dir: /var/lib/cloud + templates_dir: /etc/cloud/templates + ssh_svcname: sshd + +# vim:syntax=yaml diff --git a/cookbooks/workstations/templates/debian-sshd_config.erb b/cookbooks/workstations/templates/debian-sshd_config.erb new file mode 100644 index 0000000..783c567 --- /dev/null +++ b/cookbooks/workstations/templates/debian-sshd_config.erb @@ -0,0 +1,88 @@ +# Package generated configuration file +# See the sshd_config(5) manpage for details + +# What ports, IPs and protocols we listen for +Port 22 +# Use these options to restrict which interfaces/protocols sshd will bind to +#ListenAddress :: +#ListenAddress 0.0.0.0 +Protocol 2 +# HostKeys for protocol version 2 +HostKey /etc/ssh/ssh_host_rsa_key +HostKey /etc/ssh/ssh_host_dsa_key +HostKey /etc/ssh/ssh_host_ecdsa_key +HostKey /etc/ssh/ssh_host_ed25519_key +#Privilege Separation is turned on for security +UsePrivilegeSeparation yes + +# Lifetime and size of ephemeral version 1 server key +KeyRegenerationInterval 3600 +ServerKeyBits 1024 + +# Logging +SyslogFacility AUTH +LogLevel INFO + +# Authentication: +LoginGraceTime 120 +PermitRootLogin without-password +StrictModes yes + +RSAAuthentication yes +PubkeyAuthentication yes +#AuthorizedKeysFile %h/.ssh/authorized_keys + +# Don't read the user's ~/.rhosts and ~/.shosts files +IgnoreRhosts yes +# For this to work you will also need host keys in /etc/ssh_known_hosts +RhostsRSAAuthentication no +# similar for protocol version 2 +HostbasedAuthentication no +# Uncomment if you don't trust ~/.ssh/known_hosts for RhostsRSAAuthentication +#IgnoreUserKnownHosts yes + +# To enable empty passwords, change to yes (NOT RECOMMENDED) +PermitEmptyPasswords no + +# Change to yes to enable challenge-response passwords (beware issues with +# some PAM modules and threads) +ChallengeResponseAuthentication no + +# Change to no to disable tunnelled clear text passwords +PasswordAuthentication yes + +# Kerberos options +#KerberosAuthentication no +#KerberosGetAFSToken no +#KerberosOrLocalPasswd yes +#KerberosTicketCleanup yes + +# GSSAPI options +#GSSAPIAuthentication no +#GSSAPICleanupCredentials yes + +X11Forwarding yes +X11DisplayOffset 10 +PrintMotd no +PrintLastLog yes +TCPKeepAlive yes +#UseLogin no + +#MaxStartups 10:30:60 +#Banner /etc/issue.net + +# Allow client to pass locale environment variables +AcceptEnv LANG LC_* + +Subsystem sftp /usr/lib/openssh/sftp-server + +# Set this to 'yes' to enable PAM authentication, account processing, +# and session processing. If this is enabled, PAM authentication will +# be allowed through the ChallengeResponseAuthentication and +# PasswordAuthentication. Depending on your PAM configuration, +# PAM authentication via ChallengeResponseAuthentication may bypass +# the setting of "PermitRootLogin without-password". +# If you just want the PAM account and session checks to run without +# PAM authentication, then enable this but set PasswordAuthentication +# and ChallengeResponseAuthentication to 'no'. +UsePAM yes diff --git a/cookbooks/workstations/templates/default/chef-sudoer.erb b/cookbooks/workstations/templates/default/chef-sudoer.erb deleted file mode 100644 index 5365353..0000000 --- a/cookbooks/workstations/templates/default/chef-sudoer.erb +++ /dev/null @@ -1 +0,0 @@ -chef ALL=(ALL) NOPASSWD:ALL \ No newline at end of file diff --git a/cookbooks/workstations/templates/rhel-sshd_config.erb b/cookbooks/workstations/templates/rhel-sshd_config.erb new file mode 100644 index 0000000..e7fb127 --- /dev/null +++ b/cookbooks/workstations/templates/rhel-sshd_config.erb @@ -0,0 +1,77 @@ +# This config file was generated by Chef + +# $OpenBSD: sshd_config,v 1.93 2014/01/10 05:59:19 djm Exp $ + +# This is the sshd server system-wide configuration file. See +# sshd_config(5) for more information. + +# This sshd was compiled with PATH=/usr/local/bin:/usr/bin + +# The strategy used for options in the default sshd_config shipped with +# OpenSSH is to specify options with their default value where +# possible, but leave them commented. Uncommented options override the +# default value. + +# If you want to change the port on a SELinux system, you have to tell +# SELinux about this change. +# semanage port -a -t ssh_port_t -p tcp #PORTNUMBER +# +#Port 22 +#AddressFamily any +#ListenAddress 0.0.0.0 +#ListenAddress :: +# The default requires explicit activation of protocol 1 +#Protocol 2 + +# HostKey for protocol version 1 +#HostKey /etc/ssh/ssh_host_key +# HostKeys for protocol version 2 +HostKey /etc/ssh/ssh_host_rsa_key +#HostKey /etc/ssh/ssh_host_dsa_key +HostKey /etc/ssh/ssh_host_ecdsa_key +HostKey /etc/ssh/ssh_host_ed25519_key + +# Logging +SyslogFacility AUTHPRIV + +# Authentication: + +# The default is to check both .ssh/authorized_keys and .ssh/authorized_keys2 +# but this is overridden so installations will only check .ssh/authorized_keys +AuthorizedKeysFile .ssh/authorized_keys + +# To disable tunneled clear text passwords, change to no here! +PasswordAuthentication yes +#PermitEmptyPasswords no + +# Change to no to disable s/key passwords +#ChallengeResponseAuthentication yes +ChallengeResponseAuthentication no + +# GSSAPI options +GSSAPIAuthentication yes +GSSAPICleanupCredentials no + +# Set this to 'yes' to enable PAM authentication, account processing, +# and session processing. If this is enabled, PAM authentication will +# be allowed through the ChallengeResponseAuthentication and +# PasswordAuthentication. Depending on your PAM configuration, +# PAM authentication via ChallengeResponseAuthentication may bypass +# the setting of "PermitRootLogin without-password". +# If you just want the PAM account and session checks to run without +# PAM authentication, then enable this but set PasswordAuthentication +# and ChallengeResponseAuthentication to 'no'. +# WARNING: 'UsePAM no' is not supported in Red Hat Enterprise Linux and may cause several +# problems. +UsePAM yes + +UsePrivilegeSeparation sandbox # Default for new installations. + +# Accept locale-related environment variables +AcceptEnv LANG LC_CTYPE LC_NUMERIC LC_TIME LC_COLLATE LC_MONETARY LC_MESSAGES +AcceptEnv LC_PAPER LC_NAME LC_ADDRESS LC_TELEPHONE LC_MEASUREMENT +AcceptEnv LC_IDENTIFICATION LC_ALL LANGUAGE +AcceptEnv XMODIFIERS + +# override default of no subsystems +Subsystem sftp /usr/libexec/openssh/sftp-server diff --git a/cookbooks/workstations/templates/default/selinux-config.erb b/cookbooks/workstations/templates/selinux-config.erb similarity index 100% rename from cookbooks/workstations/templates/default/selinux-config.erb rename to cookbooks/workstations/templates/selinux-config.erb diff --git a/cookbooks/workstations/test/integration/compliance/inspec/default_spec.rb b/cookbooks/workstations/test/integration/compliance/inspec/default_spec.rb index a0921ac..42b7415 100644 --- a/cookbooks/workstations/test/integration/compliance/inspec/default_spec.rb +++ b/cookbooks/workstations/test/integration/compliance/inspec/default_spec.rb @@ -31,11 +31,6 @@ it { should be_grouped_into 'dockerroot' } end -describe file("/etc/chef/ohai/hints/ec2.json") do - it { should be_file } - its(:content) { should match(/{}/) } -end - describe command('chef-apply --help') do its(:exit_status) { should eq 0 } end diff --git a/cookbooks/workstations/test/integration/essentials/inspec/default_spec.rb b/cookbooks/workstations/test/integration/essentials/inspec/default_spec.rb index 0503b33..7bacd39 100644 --- a/cookbooks/workstations/test/integration/essentials/inspec/default_spec.rb +++ b/cookbooks/workstations/test/integration/essentials/inspec/default_spec.rb @@ -31,11 +31,6 @@ it { should be_grouped_into 'dockerroot' } end -describe file("/etc/chef/ohai/hints/ec2.json") do - it { should be_file } - its(:content) { should match(/{}/) } -end - describe command('chef-apply --help') do its(:exit_status) { should eq(0) } end diff --git a/cookbooks/workstations/test/integration/extending_cookbooks/inspec/default_spec.rb b/cookbooks/workstations/test/integration/extending_cookbooks/inspec/default_spec.rb index 9a2ff2f..6d43c6c 100644 --- a/cookbooks/workstations/test/integration/extending_cookbooks/inspec/default_spec.rb +++ b/cookbooks/workstations/test/integration/extending_cookbooks/inspec/default_spec.rb @@ -31,11 +31,6 @@ it { should be_grouped_into 'dockerroot' } end -describe file("/etc/chef/ohai/hints/ec2.json") do - it { should be_file } - its(:content) { should match(/{}/) } -end - describe command('chef-apply --help') do its(:exit_status) { should eq 0 } end diff --git a/cookbooks/workstations/test/integration/tdd_cookbook_development/inspec/default_spec.rb b/cookbooks/workstations/test/integration/tdd_cookbook_development/inspec/default_spec.rb index a0921ac..42b7415 100644 --- a/cookbooks/workstations/test/integration/tdd_cookbook_development/inspec/default_spec.rb +++ b/cookbooks/workstations/test/integration/tdd_cookbook_development/inspec/default_spec.rb @@ -31,11 +31,6 @@ it { should be_grouped_into 'dockerroot' } end -describe file("/etc/chef/ohai/hints/ec2.json") do - it { should be_file } - its(:content) { should match(/{}/) } -end - describe command('chef-apply --help') do its(:exit_status) { should eq 0 } end diff --git a/show_running_compliance_instances.sh b/show_running_compliance_instances.sh new file mode 100755 index 0000000..779d049 --- /dev/null +++ b/show_running_compliance_instances.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +AMI_ID=ami-614d7476 + +aws ec2 describe-instances --query 'Reservations[*].Instances[*].[InstanceId,ImageId,PublicIpAddress,State.Name,Tags[?Key==`Name`].Value | [0]]' --output text | grep running | grep $AMI_ID