diff --git a/Vagrantfile b/Vagrantfile index d005d77..dfa5ddc 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -48,7 +48,7 @@ Vagrant.configure("2") do |config| chef.json = { 'metasploitable' => { # Customizations here - } + } } chef.add_recipe "metasploitable::mysql" @@ -69,4 +69,4 @@ Vagrant.configure("2") do |config| chef.add_recipe "metasploitable::drupal" end end -end \ No newline at end of file +end diff --git a/chef/cookbooks/compat_resource/CHANGELOG.md b/chef/cookbooks/compat_resource/CHANGELOG.md new file mode 100644 index 0000000..592b3b8 --- /dev/null +++ b/chef/cookbooks/compat_resource/CHANGELOG.md @@ -0,0 +1,48 @@ +# compat_resource Cookbook CHANGELOG + +This file is used to list changes made in each version of the compat_resource cookbook. + +## 12.16.2 (2016-11-09) + +- Sync chef-client changes from Chef 12.16.42 + +## 12.16.1 (2016-10-20) + +- add delayed_action helper + +## 12.16.0 (2016-10-19) + +- Sync chef-client changes from Chef 12.16.14 + +## 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/chef/cookbooks/compat_resource/CONTRIBUTING.md b/chef/cookbooks/compat_resource/CONTRIBUTING.md new file mode 100644 index 0000000..ef2f2b8 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/MAINTAINERS.md b/chef/cookbooks/compat_resource/MAINTAINERS.md new file mode 100644 index 0000000..5ae0806 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/README.md b/chef/cookbooks/compat_resource/README.md new file mode 100644 index 0000000..f5c17e5 --- /dev/null +++ b/chef/cookbooks/compat_resource/README.md @@ -0,0 +1,60 @@ +# 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:: Lamont Granquist ([lamont@chef.io](mailto:lamont@chef.io)) +- Author:: John Keiser ([jkeiser@chef.io](mailto:jkeiser@chef.io)) + +```text +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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef.rb new file mode 100644 index 0000000..219b05b --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/constants.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/constants.rb new file mode 100644 index 0000000..4acd742 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/delayed_evaluator.rb new file mode 100644 index 0000000..4fb687e --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/core.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/core.rb new file mode 100644 index 0000000..8e30d30 --- /dev/null +++ b/chef/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 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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/declare_resource.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/declare_resource.rb new file mode 100644 index 0000000..45e69dc --- /dev/null +++ b/chef/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 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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/platform_introspection.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/recipe.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/recipe.rb new file mode 100644 index 0000000..f896ec7 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/universal.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/dsl/universal.rb new file mode 100644 index 0000000..7f529f1 --- /dev/null +++ b/chef/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 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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/lazy_module_include.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/notifying_block.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/params_validate.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/powershell_out.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/mixin/properties.rb new file mode 100644 index 0000000..bdf9f7e --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/property.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/property.rb new file mode 100644 index 0000000..3399596 --- /dev/null +++ b/chef/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}` was incorrectly passed a block. Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block_given? + self.class.properties[#{name.inspect}].call(self, value) + end + def #{name}=(value) + raise "Property `#{name}` of `\#{self}` was incorrectly passed a block. Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" 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}` was incorrectly passed a block! Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" if block + self.class.properties[name].call(self, value) + end + declared_in.define_method("#{name}=") do |value, &block| + raise "Property `#{name}` of `#{self}` was incorrectly passed a block! Possible property-resource collision. To call a resource named `#{name}` either rename the property or else use `declare_resource(:#{name}, ...)`" 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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider.rb new file mode 100644 index 0000000..7ccf87b --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_repository.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/apt_update.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/noop.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/noop.rb new file mode 100644 index 0000000..87c34e6 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/support/yum_repo.erb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/support/yum_repo.erb new file mode 100644 index 0000000..7d9a2d0 --- /dev/null +++ b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/support/yum_repo.erb @@ -0,0 +1,125 @@ +# This file was generated by Chef +# Do NOT modify this file by hand. + +[<%= @config.repositoryid %>] +name=<%= @config.description %> +<% if @config.baseurl %> +baseurl=<%= @config.baseurl %> +<% end %> +<% if @config.cost %> +cost=<%= @config.cost %> +<% end %> +<% if @config.enabled %> +enabled=1 +<% else %> +enabled=0 +<% end %> +<% if @config.enablegroups %> +enablegroups=1 +<% end %> +<% if @config.exclude %> +exclude=<%= @config.exclude %> +<% end %> +<% if @config.failovermethod %> +failovermethod=<%= @config.failovermethod %> +<% end %> +<% if @config.fastestmirror_enabled %> +fastestmirror_enabled=<%= @config.fastestmirror_enabled %> +<% end %> +<% if @config.gpgcheck %> +gpgcheck=1 +<% else %> +gpgcheck=0 +<% end %> +<% if @config.gpgkey %> +gpgkey=<%= case @config.gpgkey + when Array + @config.gpgkey.join("\n ") + else + @config.gpgkey + end %> +<% end -%> +<% if @config.http_caching %> +http_caching=<%= @config.http_caching %> +<% end %> +<% if @config.include_config %> +include=<%= @config.include_config %> +<% end %> +<% if @config.includepkgs %> +includepkgs=<%= @config.includepkgs %> +<% end %> +<% if @config.keepalive %> +keepalive=1 +<% end %> +<% if @config.metadata_expire %> +metadata_expire=<%= @config.metadata_expire %> +<% end %> +<% if @config.mirrorlist %> +mirrorlist=<%= @config.mirrorlist %> +<% end %> +<% if @config.mirror_expire %> +mirror_expire=<%= @config.mirror_expire %> +<% end %> +<% if @config.mirrorlist_expire %> +mirrorlist_expire=<%= @config.mirrorlist_expire %> +<% end %> +<% if @config.priority %> +priority=<%= @config.priority %> +<% end %> +<% if @config.proxy %> +proxy=<%= @config.proxy %> +<% end %> +<% if @config.proxy_username %> +proxy_username=<%= @config.proxy_username %> +<% end %> +<% if @config.proxy_password %> +proxy_password=<%= @config.proxy_password %> +<% end %> +<% if @config.username %> +username=<%= @config.username %> +<% end %> +<% if @config.password %> +password=<%= @config.password %> +<% end %> +<% if @config.repo_gpgcheck %> +repo_gpgcheck=1 +<% end %> +<% if @config.max_retries %> +retries=<%= @config.max_retries %> +<% end %> +<% if @config.report_instanceid %> +report_instanceid=<%= @config.report_instanceid %> +<% end %> +<% if @config.skip_if_unavailable %> +skip_if_unavailable=1 +<% end %> +<% if @config.sslcacert %> +sslcacert=<%= @config.sslcacert %> +<% end %> +<% if @config.sslclientcert %> +sslclientcert=<%= @config.sslclientcert %> +<% end %> +<% if @config.sslclientkey %> +sslclientkey=<%= @config.sslclientkey %> +<% end %> +<% unless @config.sslverify.nil? %> +sslverify=<%= ( @config.sslverify ) ? 'true' : 'false' %> +<% end %> +<% if @config.timeout %> +timeout=<%= @config.timeout %> +<% end %> +<% if @config.options -%> +<% @config.options.each do |key, value| -%> +<%= key %>=<%= + case value + when Array + value.join("\n ") + when TrueClass + '1' + when FalseClass + '0' + else + value + end %> +<% end -%> +<% end -%> diff --git a/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/systemd_unit.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/provider/yum_repository.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource.rb new file mode 100644 index 0000000..e5c9a14 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/action_class.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_repository.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/apt_update.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/systemd_unit.rb b/chef/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/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/yum_repository.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource/yum_repository.rb new file mode 100644 index 0000000..e733daa --- /dev/null +++ b/chef/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_property: 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/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource_builder.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/copied_from_chef/chef/resource_builder.rb new file mode 100644 index 0000000..688e856 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/mixin/properties.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/mixin/properties.rb new file mode 100644 index 0000000..a3920d1 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches.rb new file mode 100644 index 0000000..9ac83e8 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef.rb new file mode 100644 index 0000000..9669f6a --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/node.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/node.rb new file mode 100644 index 0000000..93379b0 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/property.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/property.rb new file mode 100644 index 0000000..2308d32 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/provider.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/provider.rb new file mode 100644 index 0000000..591cedb --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe.rb new file mode 100644 index 0000000..7c4c8be --- /dev/null +++ b/chef/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.42').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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe_hook.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/recipe_hook.rb new file mode 100644 index 0000000..24aa20f --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb new file mode 100644 index 0000000..d61b60b --- /dev/null +++ b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource.rb @@ -0,0 +1,156 @@ +# 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 + + 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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource/lwrp_base.rb new file mode 100644 index 0000000..5f098fd --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection.rb new file mode 100644 index 0000000..4f07489 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_list.rb new file mode 100644 index 0000000..dfbd442 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/resource_collection/resource_set.rb new file mode 100644 index 0000000..bcead10 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/run_context.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/run_context.rb new file mode 100644 index 0000000..03c9d60 --- /dev/null +++ b/chef/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.42').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/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/runner.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/monkeypatches/chef/runner.rb new file mode 100644 index 0000000..9add7a8 --- /dev/null +++ b/chef/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.42').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/chef/cookbooks/compat_resource/files/lib/chef_compat/property.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/property.rb new file mode 100644 index 0000000..be21113 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/recipe.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/recipe.rb new file mode 100644 index 0000000..86e39d9 --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/resource.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/resource.rb new file mode 100644 index 0000000..bcf0fdb --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/files/lib/chef_compat/resource/lwrp_base.rb b/chef/cookbooks/compat_resource/files/lib/chef_compat/resource/lwrp_base.rb new file mode 100644 index 0000000..2ebb98f --- /dev/null +++ b/chef/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' + + resources_dir = File.expand_path("chef_compat/copied_from_chef/chef/resource", File.dirname(__FILE__)) + providers_dir = File.expand_path("chef_compat/copied_from_chef/chef/provider", File.dirname(__FILE__)) + Dir["#{resources_dir}/*.rb"].each {|file| require file } + Dir["#{providers_dir}/*.rb"].each {|file| require file } +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/chef/cookbooks/compat_resource/libraries/autoload.rb b/chef/cookbooks/compat_resource/libraries/autoload.rb new file mode 100644 index 0000000..db52cfc --- /dev/null +++ b/chef/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/chef/cookbooks/compat_resource/metadata.json b/chef/cookbooks/compat_resource/metadata.json new file mode 100644 index 0000000..af64b50 --- /dev/null +++ b/chef/cookbooks/compat_resource/metadata.json @@ -0,0 +1 @@ +{"name":"compat_resource","version":"12.16.3","description":"Backports functionality introduced in the latest chef-client releases to any chef-client from 12.1 onwards","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:: Lamont Granquist ([lamont@chef.io](mailto:lamont@chef.io))\n- Author:: John Keiser ([jkeiser@chef.io](mailto:jkeiser@chef.io))\n\n```text\nCopyright:: 2015-2016 Chef Software, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","maintainer":"Lamont Granquist","maintainer_email":"lamont@chef.io","license":"Apache 2.0","platforms":{},"dependencies":{},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{},"source_url":"https://github.com/chef-cookbooks/compat_resource","issues_url":"https://github.com/chef-cookbooks/compat_resource/issues","chef_version":">= 12.1","ohai_version":{}} \ No newline at end of file diff --git a/chef/cookbooks/docker/.foodcritic b/chef/cookbooks/docker/.foodcritic new file mode 100644 index 0000000..913f038 --- /dev/null +++ b/chef/cookbooks/docker/.foodcritic @@ -0,0 +1 @@ +~FC005 diff --git a/chef/cookbooks/docker/CHANGELOG.md b/chef/cookbooks/docker/CHANGELOG.md new file mode 100644 index 0000000..7235bec --- /dev/null +++ b/chef/cookbooks/docker/CHANGELOG.md @@ -0,0 +1,1676 @@ +# Docker Cookbook Changelog + +This file is used to list changes made in each version of the docker cookbook. + +## 12.15.2 (2017-02-15) +- Reverting 12.15.1 changes + +## 12.15.1 (2017-02-15) +- 799 - Adding service restarts to systemd template resources + +## 12.15.0 (2017-02-15) +- Removing dependency on compat_resource. +- Now requires Chef 12.5 or higher. + +## 12.14.3 (2017-02-14) +- Defaulting package installation version to docker 1.13.1 + +## 12.14.3 (2017-02-06) +- Reverting gem vendor due to c extensions in json dep. +- Using docker-api-1.33.2 in _autoload + +## 12.14.2 (2017-01-31) +- Vendoring docker-api-1.33.2 + +## 12.14.1 (2017-01-31) +- defaulting to package installation on amazonlinux + +## 2.14.0 (2017-01-31) +- various updates for Docker 1.13.0 +- defaulting to 1.13.0 for docker_installation +- package name fixes for new debian/ubuntu schemes +- defaulting restart_policy to nil in docker_resource + +## 2.13.11 (2017-01-25) +- #798 - Temporary "fix" for delayed service restart: using :immediate + notification in docker_service resource + +## 2.13.10 (2017-01-13) +- #800 - fixing ubuntu startup script +- #802 - using chef_version methong only in 12.6.0 and higher + +## 2.13.9 (2016-12-29) +- 793 - Removing service restarts due to chef-client behavior changes. + +## 2.13.8 (2016-12-28) +- #794 - network mode bridge +- removing emacs package in upstart provider +- Adding dokken / travis test matrix + +## 2.13.7 (2016-12-24) +- adding additional logging drivers +- adding action :reload + +## 2.13.6 (2016-12-22) +- adding ip_address support for docker_containers +- adding volume_driver support + +## 2.13.5 (2016-12-21) +- Temporary work around for broke upstart provider in chef-client +- Fixing package name for ubuntu version later than 1.12.3 + +## 2.13.4 (2016-12-20) +- Fixing comparison operator docker daemon args for versions < 1.12 + +## 2.13.3 (2016-12-20) +- 792 - Reverting 791 fix + +## 2.13.2 (2016-12-20) +- 791 - Fix logic bug in docker_service daemon args calculation + +## 2.13.1 (2016-12-19) +- #786 - Adding options hash to docker_volume connection +- #787 - Adding wait loop to docker_service_manager_execute :stop + +## 2.13.0 (2016-11-25) +- Adding sysctl property to docker_container resource + +## 2.12.0 (2016-11-25) +- Updating compat_resource dep to 12.16.2 +- Updating docker-api gem dep 1.32.1 + +## 2.11.1 (2016-11-24) +- Fix for #701 - Revert commit that caused restart loops in systemd provider + +## 2.11.0 (2016-11-23) +- make systemd MountFlags configurable +- make running wait time configurable + +## 2.10.0 (2016-11-23) +- Implement network connect/disconnect +- Fixed dns options mutual exclusion +- Misc test harness cleanup + +## 2.9.10 (2016-11-14) +-renaming systemd_conf to systemd_args due to a conflict with systemd cookbook + +## 2.9.9 (2016-11-14) +-Fixing resource idempotence in labels property +-Fix regression introduced by #741, breaking Debian installation +-Added ro_rootfs => ReadonlyRootfs special cases mapping +-Enable systemd options as a docker_service attribute + +## 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/chef/cookbooks/docker/CONTRIBUTING.md b/chef/cookbooks/docker/CONTRIBUTING.md new file mode 100644 index 0000000..ef2f2b8 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/MAINTAINERS.md b/chef/cookbooks/docker/MAINTAINERS.md new file mode 100644 index 0000000..a7645b9 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/README.md b/chef/cookbooks/docker/README.md new file mode 100644 index 0000000..e6ac39b --- /dev/null +++ b/chef/cookbooks/docker/README.md @@ -0,0 +1,1417 @@ +# 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 | 1.12.3 | 1.13.0 | +|--------------|:-----:|:------|:-----:|:------:|:------:|:------:|:-------| +| amazon linux | | | | | | | ✔ | +| debian-7 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| debian-8 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| centos-7 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| fedora | | | ✔ | ✔ | ✔ | ✔ | ✔ | +| ubuntu-12.04 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| ubuntu-14.04 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| ubuntu-16.04 | | | | | ✔ | ✔ | ✔ | + + +## 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 + 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" + systemd_opts ["TasksMax=infinity","MountFlags=private"] + 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/) + +- `install_method` - Select binary, script, package, tarball, none, or auto. Defaults to `auto`. +- `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 +- `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) +- `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/awslogs/splunk/etwlogs/gcplogs/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)) +- `mount_flags` - Set the systemd mount propagation flag. Defaults to slave. + +#### Miscellaneous Options + +- `misc_opts` - Pass the docker daemon any other options bypassing + flag validation, supplied as `--flag=value` + +#### Systemd-specific Options + +- `systemd_opts` - An array of strings that will be included as + individual lines in the systemd service unit for Docker. *Note*: + This option is only relevant for systems where systemd is the + default service manager or where systemd is specified explicitly as + the service manager. + +### 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 be as short as `busybox`, `alpine`, or `centos`. These names refer + to official images on the public registry. Names can be as long as + `my.computers.biz:5043/what/ever` to refer to custom images on an + private registry. Often you'll see something like `chef/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 will exit succesfully. It will happen on every chef-client run. + +```ruby +docker_container 'busybox_ls' do + repo 'busybox' + command 'ls -la /' + action :run +end +``` + +- The :run action contains both :create and :start the container in one action. Redeploys the container on resource change. It is the default action. + +```ruby +docker_container 'alpine_ls' do + repo 'alpine' + tag '3.1' + command 'ls -la /' + action :run +end +``` + +- Set environment variables in a container + +```ruby +docker_container 'env' do + repo 'debian' + env ['PATH=/usr/bin', 'FOO=bar'] + command 'env' + action :run +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). +- `ip_address` - Container IPv4 address (e.g. 172.30.100.104) +- `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. +- `running_wait_time` - Amount of seconds `docker_container` wait to determine if a process is running.` +- `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`. +- `sysctls` - A hash of sysctls to set on the container. Defaults to `{}`. +- `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 `[:]` +- `volume_driver` - Driver that this container users to mount volumes. +- `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. +- `:reload` - Sends SIGHUP to pid 1 in 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']` +- `container` - Container-id/name to be connected/disconnected to/from + the network. Used only by `:connect` and `:disconnect` actions + + +### 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 +``` + +Connect to multiple networks + +```ruby +docker_network 'network_h1' do + action :create +end + +docker_network 'network_h2' do + action :create +end + +docker_container 'echo-base-networks_h' do + repo 'alpine' + tag '3.1' + command 'nc -ll -p 1337 -e /bin/cat' + port '1337' + network_mode 'network_h1' + action :run +end + +docker_network 'network_h2' do + container 'echo-base-networks_h' + action :connect +end +``` + +### Actions + +- `:create` - create a network +- `:delete` - delete a network +- `:connect` - connect a container to a network +- `:disconnect` - disconnect a container from 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 volume +- `:remove` - remove a volume + +## 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/chef/cookbooks/docker/files/default/vendor/cache/docker-api-1.33.2.gem b/chef/cookbooks/docker/files/default/vendor/cache/docker-api-1.33.2.gem new file mode 100644 index 0000000..3ea1b66 Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/cache/docker-api-1.33.2.gem differ diff --git a/chef/cookbooks/docker/files/default/vendor/cache/excon-0.54.0.gem b/chef/cookbooks/docker/files/default/vendor/cache/excon-0.54.0.gem new file mode 100644 index 0000000..dd686c6 Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/cache/excon-0.54.0.gem differ diff --git a/chef/cookbooks/docker/files/default/vendor/cache/json-2.0.3.gem b/chef/cookbooks/docker/files/default/vendor/cache/json-2.0.3.gem new file mode 100644 index 0000000..56ab32d Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/cache/json-2.0.3.gem differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/excon-0.54.0/Gemfile.lock b/chef/cookbooks/docker/files/default/vendor/gems/excon-0.54.0/Gemfile.lock new file mode 100644 index 0000000..80a6583 --- /dev/null +++ b/chef/cookbooks/docker/files/default/vendor/gems/excon-0.54.0/Gemfile.lock @@ -0,0 +1,301 @@ +PATH + remote: . + specs: + excon (0.54.0) + +GEM + remote: http://rubygems.org/ + specs: + activesupport (3.2.6) + i18n (~> 0.6) + multi_json (~> 1.0) + backports (3.6.4) + chronic (0.6.7) + delorean (2.0.0) + chronic + diff-lcs (1.2.5) + eventmachine (1.0.4) + eventmachine (1.0.4-java) + ffi2-generators (0.1.1) + formatador (0.2.3) + i18n (0.6.0) + jruby-openssl (0.9.17-java) + json (1.8.2) + json (1.8.2-java) + kgio (2.9.2) + minitest (4.7.5) + multi_json (1.3.6) + open4 (1.3.0) + puma (3.6.0) + puma (3.6.0-java) + rack (1.6.0) + rack-protection (1.2.0) + rack + rack-test (0.6.3) + rack (>= 1.0) + raindrops (0.13.0) + rake (0.9.2.2) + rdoc (3.12) + json (~> 1.4) + rspec (3.5.0) + rspec-core (~> 3.5.0) + rspec-expectations (~> 3.5.0) + rspec-mocks (~> 3.5.0) + rspec-core (3.5.0) + rspec-support (~> 3.5.0) + rspec-expectations (3.5.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.5.0) + rspec-mocks (3.5.0) + diff-lcs (>= 1.2.0, < 2.0) + rspec-support (~> 3.5.0) + rspec-support (3.5.0) + rubysl (2.0.14) + rubysl-abbrev (~> 2.0) + rubysl-base64 (~> 2.0) + rubysl-benchmark (~> 2.0) + rubysl-bigdecimal (~> 2.0) + rubysl-cgi (~> 2.0) + rubysl-cgi-session (~> 2.0) + rubysl-cmath (~> 2.0) + rubysl-complex (~> 2.0) + rubysl-continuation (~> 2.0) + rubysl-coverage (~> 2.0) + rubysl-csv (~> 2.0) + rubysl-curses (~> 2.0) + rubysl-date (~> 2.0) + rubysl-delegate (~> 2.0) + rubysl-digest (~> 2.0) + rubysl-drb (~> 2.0) + rubysl-e2mmap (~> 2.0) + rubysl-english (~> 2.0) + rubysl-enumerator (~> 2.0) + rubysl-erb (~> 2.0) + rubysl-etc (~> 2.0) + rubysl-expect (~> 2.0) + rubysl-fcntl (~> 2.0) + rubysl-fiber (~> 2.0) + rubysl-fileutils (~> 2.0) + rubysl-find (~> 2.0) + rubysl-forwardable (~> 2.0) + rubysl-getoptlong (~> 2.0) + rubysl-gserver (~> 2.0) + rubysl-io-console (~> 2.0) + rubysl-io-nonblock (~> 2.0) + rubysl-io-wait (~> 2.0) + rubysl-ipaddr (~> 2.0) + rubysl-irb (~> 2.0) + rubysl-logger (~> 2.0) + rubysl-mathn (~> 2.0) + rubysl-matrix (~> 2.0) + rubysl-mkmf (~> 2.0) + rubysl-monitor (~> 2.0) + rubysl-mutex_m (~> 2.0) + rubysl-net-ftp (~> 2.0) + rubysl-net-http (~> 2.0) + rubysl-net-imap (~> 2.0) + rubysl-net-pop (~> 2.0) + rubysl-net-protocol (~> 2.0) + rubysl-net-smtp (~> 2.0) + rubysl-net-telnet (~> 2.0) + rubysl-nkf (~> 2.0) + rubysl-observer (~> 2.0) + rubysl-open-uri (~> 2.0) + rubysl-open3 (~> 2.0) + rubysl-openssl (~> 2.0) + rubysl-optparse (~> 2.0) + rubysl-ostruct (~> 2.0) + rubysl-pathname (~> 2.0) + rubysl-prettyprint (~> 2.0) + rubysl-prime (~> 2.0) + rubysl-profile (~> 2.0) + rubysl-profiler (~> 2.0) + rubysl-pstore (~> 2.0) + rubysl-pty (~> 2.0) + rubysl-rational (~> 2.0) + rubysl-readline (~> 2.0) + rubysl-resolv (~> 2.0) + rubysl-rexml (~> 2.0) + rubysl-rinda (~> 2.0) + rubysl-rss (~> 2.0) + rubysl-scanf (~> 2.0) + rubysl-securerandom (~> 2.0) + rubysl-set (~> 2.0) + rubysl-shellwords (~> 2.0) + rubysl-singleton (~> 2.0) + rubysl-socket (~> 2.0) + rubysl-stringio (~> 2.0) + rubysl-strscan (~> 2.0) + rubysl-sync (~> 2.0) + rubysl-syslog (~> 2.0) + rubysl-tempfile (~> 2.0) + rubysl-test-unit (~> 2.0) + rubysl-thread (~> 2.0) + rubysl-thwait (~> 2.0) + rubysl-time (~> 2.0) + rubysl-timeout (~> 2.0) + rubysl-tmpdir (~> 2.0) + rubysl-tsort (~> 2.0) + rubysl-un (~> 2.0) + rubysl-uri (~> 2.0) + rubysl-weakref (~> 2.0) + rubysl-webrick (~> 2.0) + rubysl-xmlrpc (~> 2.0) + rubysl-yaml (~> 2.0) + rubysl-zlib (~> 2.0) + rubysl-abbrev (2.0.4) + rubysl-base64 (2.0.0) + rubysl-benchmark (2.0.1) + rubysl-bigdecimal (2.0.2) + rubysl-cgi (2.0.1) + rubysl-cgi-session (2.0.1) + rubysl-cmath (2.0.0) + rubysl-complex (2.0.0) + rubysl-continuation (2.0.0) + rubysl-coverage (2.0.3) + rubysl-csv (2.0.2) + rubysl-english (~> 2.0) + rubysl-curses (2.0.0) + rubysl-date (2.0.6) + rubysl-delegate (2.0.1) + rubysl-digest (2.0.3) + rubysl-drb (2.0.1) + rubysl-e2mmap (2.0.0) + rubysl-english (2.0.0) + rubysl-enumerator (2.0.0) + rubysl-erb (2.0.1) + rubysl-etc (2.0.3) + ffi2-generators (~> 0.1) + rubysl-expect (2.0.0) + rubysl-fcntl (2.0.4) + ffi2-generators (~> 0.1) + rubysl-fiber (2.0.0) + rubysl-fileutils (2.0.3) + rubysl-find (2.0.1) + rubysl-forwardable (2.0.1) + rubysl-getoptlong (2.0.0) + rubysl-gserver (2.0.0) + rubysl-socket (~> 2.0) + rubysl-thread (~> 2.0) + rubysl-io-console (2.0.0) + rubysl-io-nonblock (2.0.0) + rubysl-io-wait (2.0.0) + rubysl-ipaddr (2.0.0) + rubysl-irb (2.0.4) + rubysl-e2mmap (~> 2.0) + rubysl-mathn (~> 2.0) + rubysl-readline (~> 2.0) + rubysl-thread (~> 2.0) + rubysl-logger (2.0.0) + rubysl-mathn (2.0.0) + rubysl-matrix (2.1.0) + rubysl-e2mmap (~> 2.0) + rubysl-mkmf (2.0.1) + rubysl-fileutils (~> 2.0) + rubysl-shellwords (~> 2.0) + rubysl-monitor (2.0.0) + rubysl-mutex_m (2.0.0) + rubysl-net-ftp (2.0.1) + rubysl-net-http (2.0.4) + rubysl-cgi (~> 2.0) + rubysl-erb (~> 2.0) + rubysl-singleton (~> 2.0) + rubysl-net-imap (2.0.1) + rubysl-net-pop (2.0.1) + rubysl-net-protocol (2.0.1) + rubysl-net-smtp (2.0.1) + rubysl-net-telnet (2.0.0) + rubysl-nkf (2.0.1) + rubysl-observer (2.0.0) + rubysl-open-uri (2.0.0) + rubysl-open3 (2.0.0) + rubysl-openssl (2.0.4) + rubysl-optparse (2.0.1) + rubysl-shellwords (~> 2.0) + rubysl-ostruct (2.0.4) + rubysl-pathname (2.0.0) + rubysl-prettyprint (2.0.2) + rubysl-prime (2.0.0) + rubysl-profile (2.0.0) + rubysl-profiler (2.0.1) + rubysl-pstore (2.0.0) + rubysl-pty (2.0.2) + rubysl-rational (2.0.1) + rubysl-readline (2.0.2) + rubysl-resolv (2.0.0) + rubysl-rexml (2.0.2) + rubysl-rinda (2.0.0) + rubysl-rss (2.0.0) + rubysl-scanf (2.0.0) + rubysl-securerandom (2.0.0) + rubysl-set (2.0.1) + rubysl-shellwords (2.0.0) + rubysl-singleton (2.0.0) + rubysl-socket (2.0.1) + rubysl-stringio (2.0.0) + rubysl-strscan (2.0.0) + rubysl-sync (2.0.0) + rubysl-syslog (2.0.1) + ffi2-generators (~> 0.1) + rubysl-tempfile (2.0.1) + rubysl-test-unit (2.0.1) + minitest (~> 4.7) + rubysl-thread (2.0.2) + rubysl-thwait (2.0.0) + rubysl-time (2.0.3) + rubysl-timeout (2.0.0) + rubysl-tmpdir (2.0.0) + rubysl-tsort (2.0.1) + rubysl-un (2.0.0) + rubysl-fileutils (~> 2.0) + rubysl-optparse (~> 2.0) + rubysl-uri (2.0.0) + rubysl-weakref (2.0.0) + rubysl-webrick (2.0.0) + rubysl-xmlrpc (2.0.0) + rubysl-yaml (2.0.3) + rubysl-zlib (2.0.1) + shindo (0.3.4) + formatador (>= 0.1.1) + sinatra (1.3.2) + rack (~> 1.3, >= 1.3.6) + rack-protection (~> 1.2) + tilt (~> 1.3, >= 1.3.3) + sinatra-contrib (1.3.2) + backports (>= 2.0) + eventmachine + rack-protection + rack-test + sinatra (~> 1.3.0) + tilt (~> 1.3) + tilt (1.3.3) + unicorn (4.8.3) + kgio (~> 2.6) + rack + raindrops (~> 0.7) + +PLATFORMS + java + ruby + +DEPENDENCIES + activesupport + delorean + eventmachine (>= 1.0.4) + excon! + jruby-openssl (~> 0.9) + json (>= 1.8.2) + open4 + puma + rack (~> 1.6) + rake + rdoc + rspec (>= 3.5.0) + rubysl (~> 2.0) + shindo + sinatra + sinatra-contrib + unicorn + +BUNDLED WITH + 1.13.1 diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/Makefile b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/Makefile new file mode 100644 index 0000000..db374b9 --- /dev/null +++ b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/Makefile @@ -0,0 +1,196 @@ + +SHELL = /bin/sh + +# V=0 quiet, V=1 verbose. other values don't work. +V = 0 +Q1 = $(V:1=) +Q = $(Q1:0=@) +ECHO1 = $(V:1=@:) +ECHO = $(ECHO1:0=@echo) +NULLCMD = : + +#### Start of system configuration section. #### + +srcdir = . +topdir = /opt/chefdk/embedded/include/ruby-2.3.0 +hdrdir = $(topdir) +arch_hdrdir = /opt/chefdk/embedded/include/ruby-2.3.0/x86_64-darwin13 +PATH_SEPARATOR = : +VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby +prefix = $(DESTDIR)/opt/chefdk/embedded +rubysitearchprefix = $(rubylibprefix)/$(sitearch) +rubyarchprefix = $(rubylibprefix)/$(arch) +rubylibprefix = $(libdir)/$(RUBY_BASE_NAME) +exec_prefix = $(prefix) +vendorarchhdrdir = $(vendorhdrdir)/$(sitearch) +sitearchhdrdir = $(sitehdrdir)/$(sitearch) +rubyarchhdrdir = $(rubyhdrdir)/$(arch) +vendorhdrdir = $(rubyhdrdir)/vendor_ruby +sitehdrdir = $(rubyhdrdir)/site_ruby +rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME) +vendorarchdir = $(vendorlibdir)/$(sitearch) +vendorlibdir = $(vendordir)/$(ruby_version) +vendordir = $(rubylibprefix)/vendor_ruby +sitearchdir = $(DESTDIR)./.gem.20170131-68034-1687ce7 +sitelibdir = $(DESTDIR)./.gem.20170131-68034-1687ce7 +sitedir = $(rubylibprefix)/site_ruby +rubyarchdir = $(rubylibdir)/$(arch) +rubylibdir = $(rubylibprefix)/$(ruby_version) +sitearchincludedir = $(includedir)/$(sitearch) +archincludedir = $(includedir)/$(arch) +sitearchlibdir = $(libdir)/$(sitearch) +archlibdir = $(libdir)/$(arch) +ridir = $(datarootdir)/$(RI_BASE_NAME) +mandir = $(datarootdir)/man +localedir = $(datarootdir)/locale +libdir = $(exec_prefix)/lib +psdir = $(docdir) +pdfdir = $(docdir) +dvidir = $(docdir) +htmldir = $(docdir) +infodir = $(datarootdir)/info +docdir = $(datarootdir)/doc/$(PACKAGE) +oldincludedir = $(DESTDIR)/usr/include +includedir = $(SDKROOT)$(prefix)/include +localstatedir = $(prefix)/var +sharedstatedir = $(prefix)/com +sysconfdir = $(prefix)/etc +datadir = $(datarootdir) +datarootdir = $(prefix)/share +libexecdir = $(exec_prefix)/libexec +sbindir = $(exec_prefix)/sbin +bindir = $(exec_prefix)/bin +archdir = $(rubyarchdir) + + +CC = clang +CXX = g++ +LIBRUBY = $(LIBRUBY_SO) +LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a +LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME) +LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static -framework CoreFoundation +empty = +OUTFLAG = -o $(empty) +COUTFLAG = -o $(empty) + +RUBY_EXTCONF_H = +cflags = $(optflags) $(debugflags) $(warnflags) +cxxflags = $(optflags) $(debugflags) $(warnflags) +optflags = -O3 -fno-fast-math +debugflags = -ggdb3 +warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -diag-disable=2259 -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration -Wdivision-by-zero -Wdeprecated-declarations -Wextra-tokens +CCDLFLAGS = -fno-common +CFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments -fno-common $(ARCH_FLAG) +INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) +DEFS = +CPPFLAGS = -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -arch x86_64 -m64 -O3 -g -pipe -Qunused-arguments -I/opt/chefdk/embedded/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT $(DEFS) $(cppflags) +CXXFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments $(ARCH_FLAG) +ldflags = -L. -L/opt/chefdk/embedded/lib -fstack-protector -L/opt/chefdk/embedded/lib +dldflags = -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress -L/opt/chefdk/embedded/lib +ARCH_FLAG = -m64 +DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG) +LDSHARED = $(CC) -dynamic -bundle +LDSHAREDXX = $(CXX) -dynamic -bundle +AR = ar +EXEEXT = + +RUBY_INSTALL_NAME = $(RUBY_BASE_NAME) +RUBY_SO_NAME = ruby.2.3.0 +RUBYW_INSTALL_NAME = +RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version) +RUBYW_BASE_NAME = rubyw +RUBY_BASE_NAME = ruby + +arch = x86_64-darwin13 +sitearch = $(arch) +ruby_version = 2.3.0 +ruby = $(bindir)/$(RUBY_BASE_NAME) +RUBY = $(ruby) +ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h + +RM = rm -f +RM_RF = $(RUBY) -run -e rm -- -rf +RMDIRS = rmdir -p +MAKEDIRS = mkdir -p +INSTALL = /usr/bin/install -c +INSTALL_PROG = $(INSTALL) -m 0755 +INSTALL_DATA = $(INSTALL) -m 644 +COPY = cp +TOUCH = exit > + +#### End of system configuration section. #### + +preload = + +libpath = . $(libdir) /opt/chefdk/embedded/lib +LIBPATH = -L. -L$(libdir) -L/opt/chefdk/embedded/lib +DEFFILE = + +CLEANFILES = mkmf.log +DISTCLEANFILES = +DISTCLEANDIRS = + +extout = +extout_prefix = +target_prefix = +LOCAL_LIBS = +LIBS = $(LIBRUBYARG_SHARED) -lpthread -ldl -lobjc +ORIG_SRCS = +SRCS = $(ORIG_SRCS) +OBJS = +HDRS = +TARGET = +TARGET_NAME = +TARGET_ENTRY = Init_$(TARGET_NAME) +DLLIB = +EXTSTATIC = +STATIC_LIB = + +TIMESTAMP_DIR = . +BINDIR = $(bindir) +RUBYCOMMONDIR = $(sitedir)$(target_prefix) +RUBYLIBDIR = $(sitelibdir)$(target_prefix) +RUBYARCHDIR = $(sitearchdir)$(target_prefix) +HDRDIR = $(rubyhdrdir)/ruby$(target_prefix) +ARCHHDRDIR = $(rubyhdrdir)/$(arch)/ruby$(target_prefix) + +TARGET_SO = $(DLLIB) +CLEANLIBS = $(TARGET).bundle +CLEANOBJS = *.o *.bak + +all: Makefile +static: $(STATIC_LIB) install-rb +.PHONY: all install static install-so install-rb +.PHONY: clean clean-so clean-static clean-rb + +clean-static:: +clean-rb-default:: +clean-rb:: +clean-so:: +clean: clean-so clean-static clean-rb-default clean-rb + -$(Q)$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time + +distclean-rb-default:: +distclean-rb:: +distclean-so:: +distclean-static:: +distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb + -$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log + -$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES) + -$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true + +realclean: distclean +install: install-so install-rb + +install-so: Makefile +install-rb: pre-install-rb install-rb-default +install-rb-default: pre-install-rb-default +pre-install-rb: Makefile +pre-install-rb-default: Makefile +pre-install-rb-default: + @$(NULLCMD) + +site-install: site-install-so site-install-rb +site-install-so: install-so +site-install-rb: install-rb + diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/Makefile b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/Makefile new file mode 100644 index 0000000..0e1776b --- /dev/null +++ b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/Makefile @@ -0,0 +1,262 @@ + +SHELL = /bin/sh + +# V=0 quiet, V=1 verbose. other values don't work. +V = 0 +Q1 = $(V:1=) +Q = $(Q1:0=@) +ECHO1 = $(V:1=@:) +ECHO = $(ECHO1:0=@echo) +NULLCMD = : + +#### Start of system configuration section. #### + +srcdir = . +topdir = /opt/chefdk/embedded/include/ruby-2.3.0 +hdrdir = $(topdir) +arch_hdrdir = /opt/chefdk/embedded/include/ruby-2.3.0/x86_64-darwin13 +PATH_SEPARATOR = : +VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby +prefix = $(DESTDIR)/opt/chefdk/embedded +rubysitearchprefix = $(rubylibprefix)/$(sitearch) +rubyarchprefix = $(rubylibprefix)/$(arch) +rubylibprefix = $(libdir)/$(RUBY_BASE_NAME) +exec_prefix = $(prefix) +vendorarchhdrdir = $(vendorhdrdir)/$(sitearch) +sitearchhdrdir = $(sitehdrdir)/$(sitearch) +rubyarchhdrdir = $(rubyhdrdir)/$(arch) +vendorhdrdir = $(rubyhdrdir)/vendor_ruby +sitehdrdir = $(rubyhdrdir)/site_ruby +rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME) +vendorarchdir = $(vendorlibdir)/$(sitearch) +vendorlibdir = $(vendordir)/$(ruby_version) +vendordir = $(rubylibprefix)/vendor_ruby +sitearchdir = $(DESTDIR)./.gem.20170131-68034-12q3abg +sitelibdir = $(DESTDIR)./.gem.20170131-68034-12q3abg +sitedir = $(rubylibprefix)/site_ruby +rubyarchdir = $(rubylibdir)/$(arch) +rubylibdir = $(rubylibprefix)/$(ruby_version) +sitearchincludedir = $(includedir)/$(sitearch) +archincludedir = $(includedir)/$(arch) +sitearchlibdir = $(libdir)/$(sitearch) +archlibdir = $(libdir)/$(arch) +ridir = $(datarootdir)/$(RI_BASE_NAME) +mandir = $(datarootdir)/man +localedir = $(datarootdir)/locale +libdir = $(exec_prefix)/lib +psdir = $(docdir) +pdfdir = $(docdir) +dvidir = $(docdir) +htmldir = $(docdir) +infodir = $(datarootdir)/info +docdir = $(datarootdir)/doc/$(PACKAGE) +oldincludedir = $(DESTDIR)/usr/include +includedir = $(SDKROOT)$(prefix)/include +localstatedir = $(prefix)/var +sharedstatedir = $(prefix)/com +sysconfdir = $(prefix)/etc +datadir = $(datarootdir) +datarootdir = $(prefix)/share +libexecdir = $(exec_prefix)/libexec +sbindir = $(exec_prefix)/sbin +bindir = $(exec_prefix)/bin +archdir = $(rubyarchdir) + + +CC = clang +CXX = g++ +LIBRUBY = $(LIBRUBY_SO) +LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a +LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME) +LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static -framework CoreFoundation +empty = +OUTFLAG = -o $(empty) +COUTFLAG = -o $(empty) + +RUBY_EXTCONF_H = +cflags = $(optflags) $(debugflags) $(warnflags) +cxxflags = $(optflags) $(debugflags) $(warnflags) +optflags = -O3 -fno-fast-math +debugflags = -ggdb3 +warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -diag-disable=2259 -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration -Wdivision-by-zero -Wdeprecated-declarations -Wextra-tokens +CCDLFLAGS = -fno-common +CFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments -fno-common $(ARCH_FLAG) +INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) +DEFS = +CPPFLAGS = -DJSON_GENERATOR -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -arch x86_64 -m64 -O3 -g -pipe -Qunused-arguments -I/opt/chefdk/embedded/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT $(DEFS) $(cppflags) +CXXFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments $(ARCH_FLAG) +ldflags = -L. -L/opt/chefdk/embedded/lib -fstack-protector -L/opt/chefdk/embedded/lib +dldflags = -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress -L/opt/chefdk/embedded/lib +ARCH_FLAG = -m64 +DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG) +LDSHARED = $(CC) -dynamic -bundle +LDSHAREDXX = $(CXX) -dynamic -bundle +AR = ar +EXEEXT = + +RUBY_INSTALL_NAME = $(RUBY_BASE_NAME) +RUBY_SO_NAME = ruby.2.3.0 +RUBYW_INSTALL_NAME = +RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version) +RUBYW_BASE_NAME = rubyw +RUBY_BASE_NAME = ruby + +arch = x86_64-darwin13 +sitearch = $(arch) +ruby_version = 2.3.0 +ruby = $(bindir)/$(RUBY_BASE_NAME) +RUBY = $(ruby) +ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h + +RM = rm -f +RM_RF = $(RUBY) -run -e rm -- -rf +RMDIRS = rmdir -p +MAKEDIRS = mkdir -p +INSTALL = /usr/bin/install -c +INSTALL_PROG = $(INSTALL) -m 0755 +INSTALL_DATA = $(INSTALL) -m 644 +COPY = cp +TOUCH = exit > + +#### End of system configuration section. #### + +preload = + +libpath = . $(libdir) /opt/chefdk/embedded/lib +LIBPATH = -L. -L$(libdir) -L/opt/chefdk/embedded/lib +DEFFILE = + +CLEANFILES = mkmf.log +DISTCLEANFILES = +DISTCLEANDIRS = + +extout = +extout_prefix = +target_prefix = /json/ext +LOCAL_LIBS = +LIBS = $(LIBRUBYARG_SHARED) -lpthread -ldl -lobjc +ORIG_SRCS = generator.c +SRCS = $(ORIG_SRCS) +OBJS = generator.o +HDRS = $(srcdir)/generator.h +TARGET = generator +TARGET_NAME = generator +TARGET_ENTRY = Init_$(TARGET_NAME) +DLLIB = $(TARGET).bundle +EXTSTATIC = +STATIC_LIB = + +TIMESTAMP_DIR = . +BINDIR = $(bindir) +RUBYCOMMONDIR = $(sitedir)$(target_prefix) +RUBYLIBDIR = $(sitelibdir)$(target_prefix) +RUBYARCHDIR = $(sitearchdir)$(target_prefix) +HDRDIR = $(rubyhdrdir)/ruby$(target_prefix) +ARCHHDRDIR = $(rubyhdrdir)/$(arch)/ruby$(target_prefix) + +TARGET_SO = $(DLLIB) +CLEANLIBS = $(TARGET).bundle +CLEANOBJS = *.o *.bak + +all: $(DLLIB) +static: $(STATIC_LIB) install-rb +.PHONY: all install static install-so install-rb +.PHONY: clean clean-so clean-static clean-rb + +clean-static:: +clean-rb-default:: +clean-rb:: +clean-so:: +clean: clean-so clean-static clean-rb-default clean-rb + -$(Q)$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time + +distclean-rb-default:: +distclean-rb:: +distclean-so:: +distclean-static:: +distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb + -$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log + -$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES) + -$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true + +realclean: distclean +install: install-so install-rb + +install-so: $(DLLIB) $(TIMESTAMP_DIR)/.RUBYARCHDIR.-.json.-.ext.time + $(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR) +clean-static:: + -$(Q)$(RM) $(STATIC_LIB) +install-rb: pre-install-rb install-rb-default +install-rb-default: pre-install-rb-default +pre-install-rb: Makefile +pre-install-rb-default: Makefile +pre-install-rb-default: + @$(NULLCMD) +$(TIMESTAMP_DIR)/.RUBYARCHDIR.-.json.-.ext.time: + $(Q) $(MAKEDIRS) $(@D) $(RUBYARCHDIR) + $(Q) $(TOUCH) $@ + +site-install: site-install-so site-install-rb +site-install-so: install-so +site-install-rb: install-rb + +.SUFFIXES: .c .m .cc .mm .cxx .cpp .o .S + +.cc.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cc.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.mm.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.mm.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.cxx.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cxx.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.cpp.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cpp.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.c.o: + $(ECHO) compiling $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $< + +.c.S: + $(ECHO) translating $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $< + +.m.o: + $(ECHO) compiling $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $< + +.m.S: + $(ECHO) translating $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $< + +$(DLLIB): $(OBJS) Makefile + $(ECHO) linking shared-object json/ext/$(DLLIB) + -$(Q)$(RM) $(@) + $(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS) + $(Q) $(POSTLINK) + + + +### +generator.o: generator.c generator.h $(srcdir)/../fbuffer/fbuffer.h diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.bundle b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.bundle new file mode 100755 index 0000000..58caf84 Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.bundle differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.o b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.o new file mode 100644 index 0000000..8d72eda Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/generator/generator.o differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/Makefile b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/Makefile new file mode 100644 index 0000000..d72e19d --- /dev/null +++ b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/Makefile @@ -0,0 +1,262 @@ + +SHELL = /bin/sh + +# V=0 quiet, V=1 verbose. other values don't work. +V = 0 +Q1 = $(V:1=) +Q = $(Q1:0=@) +ECHO1 = $(V:1=@:) +ECHO = $(ECHO1:0=@echo) +NULLCMD = : + +#### Start of system configuration section. #### + +srcdir = . +topdir = /opt/chefdk/embedded/include/ruby-2.3.0 +hdrdir = $(topdir) +arch_hdrdir = /opt/chefdk/embedded/include/ruby-2.3.0/x86_64-darwin13 +PATH_SEPARATOR = : +VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby +prefix = $(DESTDIR)/opt/chefdk/embedded +rubysitearchprefix = $(rubylibprefix)/$(sitearch) +rubyarchprefix = $(rubylibprefix)/$(arch) +rubylibprefix = $(libdir)/$(RUBY_BASE_NAME) +exec_prefix = $(prefix) +vendorarchhdrdir = $(vendorhdrdir)/$(sitearch) +sitearchhdrdir = $(sitehdrdir)/$(sitearch) +rubyarchhdrdir = $(rubyhdrdir)/$(arch) +vendorhdrdir = $(rubyhdrdir)/vendor_ruby +sitehdrdir = $(rubyhdrdir)/site_ruby +rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME) +vendorarchdir = $(vendorlibdir)/$(sitearch) +vendorlibdir = $(vendordir)/$(ruby_version) +vendordir = $(rubylibprefix)/vendor_ruby +sitearchdir = $(DESTDIR)./.gem.20170131-68034-1leg24r +sitelibdir = $(DESTDIR)./.gem.20170131-68034-1leg24r +sitedir = $(rubylibprefix)/site_ruby +rubyarchdir = $(rubylibdir)/$(arch) +rubylibdir = $(rubylibprefix)/$(ruby_version) +sitearchincludedir = $(includedir)/$(sitearch) +archincludedir = $(includedir)/$(arch) +sitearchlibdir = $(libdir)/$(sitearch) +archlibdir = $(libdir)/$(arch) +ridir = $(datarootdir)/$(RI_BASE_NAME) +mandir = $(datarootdir)/man +localedir = $(datarootdir)/locale +libdir = $(exec_prefix)/lib +psdir = $(docdir) +pdfdir = $(docdir) +dvidir = $(docdir) +htmldir = $(docdir) +infodir = $(datarootdir)/info +docdir = $(datarootdir)/doc/$(PACKAGE) +oldincludedir = $(DESTDIR)/usr/include +includedir = $(SDKROOT)$(prefix)/include +localstatedir = $(prefix)/var +sharedstatedir = $(prefix)/com +sysconfdir = $(prefix)/etc +datadir = $(datarootdir) +datarootdir = $(prefix)/share +libexecdir = $(exec_prefix)/libexec +sbindir = $(exec_prefix)/sbin +bindir = $(exec_prefix)/bin +archdir = $(rubyarchdir) + + +CC = clang +CXX = g++ +LIBRUBY = $(LIBRUBY_SO) +LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a +LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME) +LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static -framework CoreFoundation +empty = +OUTFLAG = -o $(empty) +COUTFLAG = -o $(empty) + +RUBY_EXTCONF_H = +cflags = $(optflags) $(debugflags) $(warnflags) +cxxflags = $(optflags) $(debugflags) $(warnflags) +optflags = -O3 -fno-fast-math +debugflags = -ggdb3 +warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -diag-disable=2259 -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration -Wdivision-by-zero -Wdeprecated-declarations -Wextra-tokens +CCDLFLAGS = -fno-common +CFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments -fno-common $(ARCH_FLAG) +INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) +DEFS = +CPPFLAGS = -DHAVE_RB_ENC_RAISE -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -arch x86_64 -m64 -O3 -g -pipe -Qunused-arguments -I/opt/chefdk/embedded/include -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE -D_DARWIN_UNLIMITED_SELECT -D_REENTRANT $(DEFS) $(cppflags) +CXXFLAGS = $(CCDLFLAGS) -I/opt/chefdk/embedded/include -O2 -I/opt/chefdk/embedded/include/ncurses -O3 -g -pipe -Qunused-arguments $(ARCH_FLAG) +ldflags = -L. -L/opt/chefdk/embedded/lib -fstack-protector -L/opt/chefdk/embedded/lib +dldflags = -Wl,-undefined,dynamic_lookup -Wl,-multiply_defined,suppress -L/opt/chefdk/embedded/lib +ARCH_FLAG = -m64 +DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG) +LDSHARED = $(CC) -dynamic -bundle +LDSHAREDXX = $(CXX) -dynamic -bundle +AR = ar +EXEEXT = + +RUBY_INSTALL_NAME = $(RUBY_BASE_NAME) +RUBY_SO_NAME = ruby.2.3.0 +RUBYW_INSTALL_NAME = +RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version) +RUBYW_BASE_NAME = rubyw +RUBY_BASE_NAME = ruby + +arch = x86_64-darwin13 +sitearch = $(arch) +ruby_version = 2.3.0 +ruby = $(bindir)/$(RUBY_BASE_NAME) +RUBY = $(ruby) +ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h + +RM = rm -f +RM_RF = $(RUBY) -run -e rm -- -rf +RMDIRS = rmdir -p +MAKEDIRS = mkdir -p +INSTALL = /usr/bin/install -c +INSTALL_PROG = $(INSTALL) -m 0755 +INSTALL_DATA = $(INSTALL) -m 644 +COPY = cp +TOUCH = exit > + +#### End of system configuration section. #### + +preload = + +libpath = . $(libdir) /opt/chefdk/embedded/lib +LIBPATH = -L. -L$(libdir) -L/opt/chefdk/embedded/lib +DEFFILE = + +CLEANFILES = mkmf.log +DISTCLEANFILES = +DISTCLEANDIRS = + +extout = +extout_prefix = +target_prefix = /json/ext +LOCAL_LIBS = +LIBS = $(LIBRUBYARG_SHARED) -lpthread -ldl -lobjc +ORIG_SRCS = parser.c +SRCS = $(ORIG_SRCS) +OBJS = parser.o +HDRS = $(srcdir)/parser.h +TARGET = parser +TARGET_NAME = parser +TARGET_ENTRY = Init_$(TARGET_NAME) +DLLIB = $(TARGET).bundle +EXTSTATIC = +STATIC_LIB = + +TIMESTAMP_DIR = . +BINDIR = $(bindir) +RUBYCOMMONDIR = $(sitedir)$(target_prefix) +RUBYLIBDIR = $(sitelibdir)$(target_prefix) +RUBYARCHDIR = $(sitearchdir)$(target_prefix) +HDRDIR = $(rubyhdrdir)/ruby$(target_prefix) +ARCHHDRDIR = $(rubyhdrdir)/$(arch)/ruby$(target_prefix) + +TARGET_SO = $(DLLIB) +CLEANLIBS = $(TARGET).bundle +CLEANOBJS = *.o *.bak + +all: $(DLLIB) +static: $(STATIC_LIB) install-rb +.PHONY: all install static install-so install-rb +.PHONY: clean clean-so clean-static clean-rb + +clean-static:: +clean-rb-default:: +clean-rb:: +clean-so:: +clean: clean-so clean-static clean-rb-default clean-rb + -$(Q)$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time + +distclean-rb-default:: +distclean-rb:: +distclean-so:: +distclean-static:: +distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb + -$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log + -$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES) + -$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true + +realclean: distclean +install: install-so install-rb + +install-so: $(DLLIB) $(TIMESTAMP_DIR)/.RUBYARCHDIR.-.json.-.ext.time + $(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR) +clean-static:: + -$(Q)$(RM) $(STATIC_LIB) +install-rb: pre-install-rb install-rb-default +install-rb-default: pre-install-rb-default +pre-install-rb: Makefile +pre-install-rb-default: Makefile +pre-install-rb-default: + @$(NULLCMD) +$(TIMESTAMP_DIR)/.RUBYARCHDIR.-.json.-.ext.time: + $(Q) $(MAKEDIRS) $(@D) $(RUBYARCHDIR) + $(Q) $(TOUCH) $@ + +site-install: site-install-so site-install-rb +site-install-so: install-so +site-install-rb: install-rb + +.SUFFIXES: .c .m .cc .mm .cxx .cpp .o .S + +.cc.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cc.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.mm.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.mm.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.cxx.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cxx.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.cpp.o: + $(ECHO) compiling $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $< + +.cpp.S: + $(ECHO) translating $(<) + $(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $< + +.c.o: + $(ECHO) compiling $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $< + +.c.S: + $(ECHO) translating $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $< + +.m.o: + $(ECHO) compiling $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $< + +.m.S: + $(ECHO) translating $(<) + $(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $< + +$(DLLIB): $(OBJS) Makefile + $(ECHO) linking shared-object json/ext/$(DLLIB) + -$(Q)$(RM) $(@) + $(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS) + $(Q) $(POSTLINK) + + + +### +parser.o: parser.c parser.h $(srcdir)/../fbuffer/fbuffer.h diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.bundle b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.bundle new file mode 100755 index 0000000..49a099e Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.bundle differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.o b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.o new file mode 100644 index 0000000..3dfeb76 Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/ext/json/ext/parser/parser.o differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/generator.bundle b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/generator.bundle new file mode 100755 index 0000000..58caf84 Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/generator.bundle differ diff --git a/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/parser.bundle b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/parser.bundle new file mode 100755 index 0000000..49a099e Binary files /dev/null and b/chef/cookbooks/docker/files/default/vendor/gems/json-2.0.3/lib/json/ext/parser.bundle differ diff --git a/chef/cookbooks/docker/libraries/_autoload.rb b/chef/cookbooks/docker/libraries/_autoload.rb new file mode 100644 index 0000000..3c007fd --- /dev/null +++ b/chef/cookbooks/docker/libraries/_autoload.rb @@ -0,0 +1,13 @@ +begin + gem 'docker-api', '= 1.33.2' +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.33.2' + docker.run_action(:install) + end +end diff --git a/chef/cookbooks/docker/libraries/docker_base.rb b/chef/cookbooks/docker/libraries/docker_base.rb new file mode 100644 index 0000000..b7cd1a6 --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_base.rb @@ -0,0 +1,90 @@ +module DockerCookbook + class DockerBase < Chef::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, Integer, default: 3, desired_state: false + property :read_timeout, [Integer, nil], default: 60, desired_state: false + property :write_timeout, [Integer, nil], desired_state: false + property :running_wait_time, [Integer, nil], default: 20, 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/chef/cookbooks/docker/libraries/docker_container.rb b/chef/cookbooks/docker/libraries/docker_container.rb new file mode 100644 index 0000000..1a8f0a6 --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_container.rb @@ -0,0 +1,437 @@ +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, [Integer, 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 etwlogs gcplogs none ), default: 'json-file', desired_state: false + property :log_opts, [Hash, nil], coerce: proc { |v| coerce_log_opts(v) }, desired_state: false + property :ip_address, String + property :mac_address, String + property :memory, Integer, default: 0 + property :memory_swap, Integer, default: 0 + property :network_disabled, Boolean, default: false + property :network_mode, [String, NilClass], default: 'bridge' + 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, Integer, default: 0 + property :restart_policy, String + 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 :sysctls, Hash, default: {} + property :timeout, [Integer, 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 :volume_driver, String + 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' || key == 'ReadonlyRootfs' + + # Image => image + # Set exposed_ports = ExposedPorts (etc.) + property_name = to_snake_case(key) + public_send(property_name, value) if respond_to?(property_name) + end + + # load container specific labels (without engine/image ones) + load_container_labels + + # 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'] + ro_rootfs container.info['HostConfig']['ReadonlyRootfs'] + 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 + + # Loads container specific labels excluding those of engine or image. + # This insures idempotency. + def load_container_labels + image_labels = Docker::Image.get(container.info['Image'], {}, connection).info['Config']['Labels'] || {} + engine_labels = Docker.info(connection)['Labels'] || {} + + labels = (container.info['Config']['Labels'] || {}).reject do |key, val| + image_labels.any? { |k, v| k == key && v == val } || + engine_labels.any? { |k, v| k == key && v == val } + end + + public_send(:labels, labels) + 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?) || + !(mac_address.nil? || mac_address.empty?) + ) + raise Chef::Exceptions::ValidationFailed, 'Cannot specify hostname or mac_address 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, + 'Sysctls' => sysctls, + 'Ulimits' => ulimits_to_hash, + 'UsernsMode' => userns_mode, + 'UTSMode' => uts_mode, + 'VolumesFrom' => volumes_from, + 'VolumeDriver' => volume_driver, + }, + } + net_config = { + 'NetworkingConfig' => { + 'EndpointsConfig' => { + network_mode => { + 'IPAMConfig' => { + 'IPv4Address' => ip_address, + }, + }, + }, + }, + } if network_mode + config.merge! net_config + + 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 :reload do + converge_by "reloading #{container_name}" do + with_retries { container.kill(signal: 'SIGHUP') } + 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/chef/cookbooks/docker/libraries/docker_exec.rb b/chef/cookbooks/docker/libraries/docker_exec.rb new file mode 100644 index 0000000..0491d0d --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_image.rb b/chef/cookbooks/docker/libraries/docker_image.rb new file mode 100644 index 0000000..8455194 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_installation_binary.rb b/chef/cookbooks/docker/libraries/docker_installation_binary.rb new file mode 100644 index 0000000..041dab4 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_installation_package.rb b/chef/cookbooks/docker/libraries/docker_installation_package.rb new file mode 100644 index 0000000..6d789cd --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_installation_package.rb @@ -0,0 +1,32 @@ +module DockerCookbook + class DockerInstallationPackage < DockerBase + require_relative 'helpers_installation_package' + + include DockerHelpers::InstallationPackage + + # Resource properties + resource_name :docker_installation_package + + provides :docker_installation, platform: 'amazon' + + property :package_name, String, default: lazy { default_package_name }, 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/chef/cookbooks/docker/libraries/docker_installation_script.rb b/chef/cookbooks/docker/libraries/docker_installation_script.rb new file mode 100644 index 0000000..305031a --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_installation_tarball.rb b/chef/cookbooks/docker/libraries/docker_installation_tarball.rb new file mode 100644 index 0000000..d9b1d31 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_network.rb b/chef/cookbooks/docker/libraries/docker_network.rb new file mode 100644 index 0000000..050db8a --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_network.rb @@ -0,0 +1,127 @@ +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, String, 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 + unless container + raise Chef::Exceptions::ValidationFailed, 'Container id or name is required for action :connect' + end + + if current_resource + container_index = network.info['Containers'].values.index { |c| c['Name'] == container } + if container_index.nil? + converge_by("connect #{container}") do + with_retries do + network.connect(container) + end + end + end + else + Chef::Log.warn("Cannot connect to #{network_name}: network does not exist") + end + end + + action :disconnect do + unless container + raise Chef::Exceptions::ValidationFailed, 'Container id or name is required for action :disconnect' + end + + if current_resource + container_index = network.info['Containers'].values.index { |c| c['Name'] == container } + unless container_index.nil? + converge_by("disconnect #{container}") do + with_retries do + network.disconnect(container) + end + end + end + else + Chef::Log.warn("Cannot disconnect from #{network_name}: network does not exist") + end + end + end +end diff --git a/chef/cookbooks/docker/libraries/docker_registry.rb b/chef/cookbooks/docker/libraries/docker_registry.rb new file mode 100644 index 0000000..58eeff6 --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_registry.rb @@ -0,0 +1,38 @@ +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 + raise Docker::Error::AuthenticationError, "#{username} failed to authenticate with #{serveraddress}" if (tries -= 1) == 0 + retry + end + + true + end + end +end diff --git a/chef/cookbooks/docker/libraries/docker_service.rb b/chef/cookbooks/docker/libraries/docker_service.rb new file mode 100644 index 0000000..10725c2 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_service_base.rb b/chef/cookbooks/docker/libraries/docker_service_base.rb new file mode 100644 index 0000000..fa2393e --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_service_base.rb @@ -0,0 +1,123 @@ +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 :mount_flags, String, default: 'slave' + 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 options specific to systemd configuration such as + # LimitNOFILE or TasksMax that you may wannt to use to customize + # the environment in which Docker runs. + property :systemd_opts, ArrayType + + # 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/chef/cookbooks/docker/libraries/docker_service_manager_execute.rb b/chef/cookbooks/docker/libraries/docker_service_manager_execute.rb new file mode 100644 index 0000000..01dc20e --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_service_manager_execute.rb @@ -0,0 +1,56 @@ +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}` && while [ -e #{pidfile} ]; do sleep 1; done" + timeout 10 + 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/chef/cookbooks/docker/libraries/docker_service_manager_systemd.rb b/chef/cookbooks/docker/libraries/docker_service_manager_systemd.rb new file mode 100644 index 0000000..f26994c --- /dev/null +++ b/chef/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://}, ''), + docker_mount_flags: mount_flags + ) + 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 + + 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, + systemd_args: systemd_args, + docker_wait_ready: "#{libexec_dir}/#{docker_name}-wait-ready", + docker_mount_flags: mount_flags + ) + cookbook 'docker' + notifies :run, 'execute[systemctl daemon-reload]', :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 + 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/chef/cookbooks/docker/libraries/docker_service_manager_sysvinit_debian.rb b/chef/cookbooks/docker/libraries/docker_service_manager_sysvinit_debian.rb new file mode 100644 index 0000000..12e0b0c --- /dev/null +++ b/chef/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 dockerd_bin_link do + to dockerd_bin + link_type :hard + action :create + end + + template "/etc/init.d/#{docker_name}" do + source 'sysvinit/docker-debian.erb' + owner 'root' + group 'root' + mode '0755' + variables( + docker_name: docker_name, + dockerd_bin_link: dockerd_bin_link, + 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, + dockerd_bin_link: dockerd_bin_link, + docker_daemon_opts: docker_daemon_opts.join(' ') + ) + cookbook 'docker' + 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/chef/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb b/chef/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb new file mode 100644 index 0000000..6480d04 --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_service_manager_sysvinit_rhel.rb @@ -0,0 +1,81 @@ +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 dockerd_bin_link do + to dockerd_bin + link_type :hard + action :create + end + + template "/etc/init.d/#{docker_name}" do + source 'sysvinit/docker-rhel.erb' + owner 'root' + group 'root' + mode '0755' + variables( + docker_name: docker_name, + dockerd_bin_link: dockerd_bin_link, + docker_daemon_cmd: docker_daemon_cmd, + 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' + 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/chef/cookbooks/docker/libraries/docker_service_manager_upstart.rb b/chef/cookbooks/docker/libraries/docker_service_manager_upstart.rb new file mode 100644 index 0000000..93997c1 --- /dev/null +++ b/chef/cookbooks/docker/libraries/docker_service_manager_upstart.rb @@ -0,0 +1,63 @@ +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 + + link dockerd_bin_link do + to dockerd_bin + link_type :hard + action :create + end + + template "/etc/init/#{docker_name}.conf" do + source 'upstart/docker.conf.erb' + owner 'root' + group 'root' + mode '0644' + variables( + docker_name: docker_name, + dockerd_bin_link: dockerd_bin_link, + 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, + dockerd_bin_link: dockerd_bin_link, + docker_daemon_opts: docker_daemon_opts.join(' ') + ) + cookbook 'docker' + 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/chef/cookbooks/docker/libraries/docker_tag.rb b/chef/cookbooks/docker/libraries/docker_tag.rb new file mode 100644 index 0000000..e9fc471 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/docker_volume.rb b/chef/cookbooks/docker/libraries/docker_volume.rb new file mode 100644 index 0000000..9bc735f --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_auth.rb b/chef/cookbooks/docker/libraries/helpers_auth.rb new file mode 100644 index 0000000..40b3654 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_base.rb b/chef/cookbooks/docker/libraries/helpers_base.rb new file mode 100644 index 0000000..43b8f30 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_container.rb b/chef/cookbooks/docker/libraries/helpers_container.rb new file mode 100644 index 0000000..66e8dca --- /dev/null +++ b/chef/cookbooks/docker/libraries/helpers_container.rb @@ -0,0 +1,236 @@ +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 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 = running_wait_time + 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/chef/cookbooks/docker/libraries/helpers_image.rb b/chef/cookbooks/docker/libraries/helpers_image.rb new file mode 100644 index 0000000..f08614c --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_installation_binary.rb b/chef/cookbooks/docker/libraries/helpers_installation_binary.rb new file mode 100644 index 0000000..625c8dc --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_installation_package.rb b/chef/cookbooks/docker/libraries/helpers_installation_package.rb new file mode 100644 index 0000000..6d738fa --- /dev/null +++ b/chef/cookbooks/docker/libraries/helpers_installation_package.rb @@ -0,0 +1,105 @@ +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) + ubuntu_prefix = if Gem::Version.new(v) > Gem::Version.new('1.12.3') + 'ubuntu-' + else + '' + end + + debian_prefix = if Gem::Version.new(v) > Gem::Version.new('1.12.3') + 'debian-' + else + '' + end + + return "#{v}-1.el6" if el6? + return "#{v}-1.el7.centos" if el7? + return "#{v}-1.17.amzn1" if amazon? + return "#{v}-1.fc#{node['platform_version'].to_i}" if fedora? + return "#{v}-0~#{debian_prefix}wheezy" if wheezy? + return "#{v}-0~#{debian_prefix}jessie" if jesse? + return "#{v}-0~#{ubuntu_prefix}precise" if precise? + return "#{v}-0~#{ubuntu_prefix}trusty" if trusty? + return "#{v}-0~#{ubuntu_prefix}vivid" if vivid? + return "#{v}-0~#{ubuntu_prefix}wily" if wily? + return "#{v}-0~#{ubuntu_prefix}xenial" if xenial? + v + end + + def default_docker_version + return '1.7.1' if el6? + return '1.9.1' if vivid? + return '1.12.6' if amazon? + '1.13.1' + end + + def default_package_name + return 'docker' if amazon? + 'docker-engine' + end + + def docker_bin + '/usr/bin/docker' + end + end + end +end diff --git a/chef/cookbooks/docker/libraries/helpers_installation_tarball.rb b/chef/cookbooks/docker/libraries/helpers_installation_tarball.rb new file mode 100644 index 0000000..dd3c27c --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_network.rb b/chef/cookbooks/docker/libraries/helpers_network.rb new file mode 100644 index 0000000..b42ee24 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/libraries/helpers_service.rb b/chef/cookbooks/docker/libraries/helpers_service.rb new file mode 100644 index 0000000..320ab63 --- /dev/null +++ b/chef/cookbooks/docker/libraries/helpers_service.rb @@ -0,0 +1,223 @@ +# 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 + return '/usr/bin/docker' if Gem::Version.new(docker_major_version) < Gem::Version.new('1.12') + '/usr/bin/dockerd' + end + + def dockerd_bin_link + "/usr/bin/dockerd-#{name}" + end + + def docker_name + return 'docker' if name == 'default' + "docker-#{name}" + end + + def installed_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 = installed_docker_version.split('.') + ray.pop + ray.push.join('.') + 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 + [dockerd_bin, 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 systemd_args + opts = '' + systemd_opts.each { |systemd_opt| opts << "#{systemd_opt}\n" } if systemd_opts + 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/chef/cookbooks/docker/libraries/matchers.rb b/chef/cookbooks/docker/libraries/matchers.rb new file mode 100644 index 0000000..87cb23d --- /dev/null +++ b/chef/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/chef/cookbooks/docker/metadata.json b/chef/cookbooks/docker/metadata.json new file mode 100644 index 0000000..d40d638 --- /dev/null +++ b/chef/cookbooks/docker/metadata.json @@ -0,0 +1 @@ +{"name":"docker","version":"2.15.2","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":{},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{}} \ No newline at end of file diff --git a/chef/cookbooks/docker/templates/default/default/docker-wait-ready.erb b/chef/cookbooks/docker/templates/default/default/docker-wait-ready.erb new file mode 100644 index 0000000..3531221 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/templates/default/default/docker.erb b/chef/cookbooks/docker/templates/default/default/docker.erb new file mode 100644 index 0000000..d798cec --- /dev/null +++ b/chef/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="<%= @dockerd_bin_link %>" + +# 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/chef/cookbooks/docker/templates/default/sysconfig/docker.erb b/chef/cookbooks/docker/templates/default/sysconfig/docker.erb new file mode 100755 index 0000000..b132240 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/templates/default/systemd/docker.service-override.erb b/chef/cookbooks/docker/templates/default/systemd/docker.service-override.erb new file mode 100644 index 0000000..8c0f83e --- /dev/null +++ b/chef/cookbooks/docker/templates/default/systemd/docker.service-override.erb @@ -0,0 +1,36 @@ +[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=<%= @docker_mount_flags %> +LimitNOFILE=1048576 +LimitNPROC=1048576 +LimitCORE=infinity +<%= @systemd_args %> + +[Install] +WantedBy=multi-user.target diff --git a/chef/cookbooks/docker/templates/default/systemd/docker.service.erb b/chef/cookbooks/docker/templates/default/systemd/docker.service.erb new file mode 100644 index 0000000..5c924d8 --- /dev/null +++ b/chef/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=<%= @docker_mount_flags %> +LimitNOFILE=1048576 +LimitNPROC=1048576 +LimitCORE=infinity +TasksMax=1048576 +TimeoutStartSec=0 + +[Install] +WantedBy=multi-user.target diff --git a/chef/cookbooks/docker/templates/default/systemd/docker.socket-override.erb b/chef/cookbooks/docker/templates/default/systemd/docker.socket-override.erb new file mode 100644 index 0000000..7e6b705 --- /dev/null +++ b/chef/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/chef/cookbooks/docker/templates/default/systemd/docker.socket.erb b/chef/cookbooks/docker/templates/default/systemd/docker.socket.erb new file mode 100644 index 0000000..22b452d --- /dev/null +++ b/chef/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/chef/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb b/chef/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb new file mode 100644 index 0000000..a77e3fd --- /dev/null +++ b/chef/cookbooks/docker/templates/default/systemd/tmpfiles.d.conf.erb @@ -0,0 +1 @@ +d /var/run/docker 0755 root <%= @config.group || 'root' %> - diff --git a/chef/cookbooks/docker/templates/default/sysvinit/docker-debian.erb b/chef/cookbooks/docker/templates/default/sysvinit/docker-debian.erb new file mode 100644 index 0000000..bd1ffbf --- /dev/null +++ b/chef/cookbooks/docker/templates/default/sysvinit/docker-debian.erb @@ -0,0 +1,149 @@ +#!/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=<%= @dockerd_bin_link %> +# 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_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 \ + -- \ + <%= @docker_daemon_arg %> -p "$DOCKER_PID_FILE" \ + $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/chef/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb b/chef/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb new file mode 100644 index 0000000..98e758f --- /dev/null +++ b/chef/cookbooks/docker/templates/default/sysvinit/docker-rhel.erb @@ -0,0 +1,133 @@ +#!/bin/sh +# +# /etc/rc.d/init.d/<%= @docker_name %> +# +# 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="<%= @dockerd_bin_link %>" +instance=<%= @docker_name %> +unshare=/usr/bin/unshare +exec="$prog" +pidfile="/var/run/$instance.pid" +lockfile="/var/lock/subsys/$instance" +logfile="/var/log/$instance" + +[ -e /etc/sysconfig/$instance ] && . /etc/sysconfig/$instance + +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 -- <%= @docker_daemon_cmd %> &>> $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/chef/cookbooks/docker/templates/default/upstart/docker.conf.erb b/chef/cookbooks/docker/templates/default/upstart/docker.conf.erb new file mode 100644 index 0000000..4189fe6 --- /dev/null +++ b/chef/cookbooks/docker/templates/default/upstart/docker.conf.erb @@ -0,0 +1,57 @@ +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=<%= @dockerd_bin_link %> + DOCKER_OPTS= + if [ -f /etc/default/$UPSTART_JOB ]; then + . /etc/default/$UPSTART_JOB + fi + exec "$DOCKER" <%= @docker_daemon_arg %> $DOCKER_OPTS --raw-logs +end script + +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/chef/cookbooks/metasploitable/.delivery/build_cookbook/.kitchen.yml b/chef/cookbooks/metasploitable/.delivery/build_cookbook/.kitchen.yml new file mode 100644 index 0000000..2d3fce6 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/.kitchen.yml @@ -0,0 +1,21 @@ +--- +driver: + name: vagrant + synced_folders: + - [<%= File.join(ENV['PWD'], '..', '..')%>, '/tmp/repo-data'] + +provisioner: + name: chef_zero + encrypted_data_bag_secret_key_path: 'secrets/fakey-mcfakerton' + data_bags_path: './data_bags' + +platforms: + - name: ubuntu-16.04 + - name: centos-7.2 + +suites: + - name: default + run_list: + - recipe[delivery_build::default] + - recipe[test] + attributes: diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/Berksfile b/chef/cookbooks/metasploitable/.delivery/build_cookbook/Berksfile new file mode 100644 index 0000000..fe9c94f --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/Berksfile @@ -0,0 +1,9 @@ +source 'https://supermarket.chef.io' + +metadata + +group :delivery do + cookbook 'delivery_build', git: 'https://github.com/chef-cookbooks/delivery_build' + cookbook 'delivery-base', git: 'https://github.com/chef-cookbooks/delivery-base' + cookbook 'test', path: './test/fixtures/cookbooks/test' +end diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/LICENSE b/chef/cookbooks/metasploitable/.delivery/build_cookbook/LICENSE new file mode 100644 index 0000000..d31c097 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/LICENSE @@ -0,0 +1,3 @@ +Copyright 2017 The Authors + +All rights reserved, do not redistribute. diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/README.md b/chef/cookbooks/metasploitable/.delivery/build_cookbook/README.md new file mode 100644 index 0000000..1ecf0b7 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/README.md @@ -0,0 +1,146 @@ +# build_cookbook + +A build cookbook for running the parent project through Chef Delivery + +This build cookbook should be customized to suit the needs of the parent project. Using this cookbook can be done outside of Chef Delivery, too. If the parent project is a Chef cookbook, we've detected that and "wrapped" [delivery-truck](https://github.com/chef-cookbooks/delivery-truck). That means it is a dependency, and each of its pipeline phase recipes is included in the appropriate phase recipes in this cookbook. If the parent project is not a cookbook, it's left as an exercise to the reader to customize the recipes as needed for each phase in the pipeline. + +## .delivery/config.json + +In the parent directory to this build_cookbook, the `config.json` can be modified as necessary. For example, phases can be skipped, publishing information can be added, and so on. Refer to customer support or the Chef Delivery documentation for assistance on what options are available for this configuration. + +## Test Kitchen - Local Verify Testing + +This cookbook also has a `.kitchen.yml` which can be used to create local build nodes with Test Kitchen to perform the verification phases, `unit`, `syntax`, and `lint`. When running `kitchen converge`, the instances will be set up like Chef Delivery "build nodes" with the [delivery_build cookbook](https://github.com/chef-cookbooks/delivery_build). The reason for this is to make sure that the same exact kind of nodes are used by this build cookbook are run on the local workstation as would run Delivery. It will run `delivery job verify PHASE` for the parent project. + +Modify the `.kitchen.yml` if necessary to change the platforms or other configuration to run the verify phases. After making changes in the parent project, `cd` into this directory (`.delivery/build_cookbook`), and run: + +``` +kitchen test +``` + +## Recipes + +Each of the recipes in this build_cookbook are run in the named phase during the Chef Delivery pipeline. The `unit`, `syntax`, and `lint` recipes are additionally run when using Test Kitchen for local testing as noted in the above section. + +## Making Changes - Cookbook Example + +When making changes in the parent project (that which lives in `../..` from this directory), or in the recipes in this build cookbook, there is a bespoke workflow for Chef Delivery. As an example, we'll discuss a Chef Cookbook as the parent. + +First, create a new branch for the changes. + +``` +git checkout -b testing-build-cookbook +``` + +Next, increment the version in the metadata.rb. This should be in the _parent_, not in this, the build_cookbook. If this is not done, the verify phase will fail. + +``` +% git diff + +-version '0.1.0' ++version '0.1.1' +``` + +The change we'll use for an example is to install the `zsh` package. Write a failing ChefSpec in the cookbook project's `spec/unit/recipes/default_spec.rb`. + +```ruby +require 'spec_helper' + +describe 'godzilla::default' 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 'installs zsh' do + expect(chef_run).to install_package('zsh') + end + end +end +``` + +Commit the local changes as work in progress. The `delivery job` expects to use a clean git repository. + +``` +git add ../.. +git commit -m 'WIP: Testing changes' +``` + +From _this_ directory (`.delivery/build_cookbook`, relative to the parent cookbook project), run + +``` +cd .delivery/build_cookbook +kitchen converge +``` + +This will take some time at first, because the VMs need to be created, Chef installed, the Delivery CLI installed, etc. Later runs will be faster until they are destroyed. It will also fail on the first VM, as expected, because we wrote the test first. Now edit the parent cookbook project's default recipe to install `zsh`. + +``` +cd ../../ +$EDITOR/recipes/default.rb +``` + +It should look like this: + +``` +package 'zsh' +``` + +Create another commit. + +``` +git add . +git commit -m 'WIP: Install zsh in default recipe' +``` + +Now rerun kitchen from the build_cookbook. + +``` +cd .delivery/build_cookbook +kitchen converge +``` + +This will take awhile because it will now pass on the first VM, and then create the second VM. We should have warned you this was a good time for a coffee break. + +``` +Recipe: test::default + +- execute HOME=/home/vagrant delivery job verify unit --server localhost --ent test --org kitchen + * execute[HOME=/home/vagrant delivery job verify lint --server localhost --ent test --org kitchen] action run + - execute HOME=/home/vagrant delivery job verify lint --server localhost --ent test --org kitchen + + - execute HOME=/home/vagrant delivery job verify syntax --server localhost --ent test --org kitchen + +Running handlers: +Running handlers complete +Chef Client finished, 3/32 resources updated in 54.665445968 seconds +Finished converging (1m26.83s). +``` + +Victory is ours! Our verify phase passed on the build nodes. + +We are ready to run this through our Delivery pipeline. Simply run `delivery review` on the local system from the parent project, and it will open a browser window up to the change we just added. + +``` +cd ../.. +delivery review +``` + +## FAQ + +### Why don't I just run rspec and foodcritic/rubocop on my local system? + +An objection to the Test Kitchen approach is that it is much faster to run the unit, lint, and syntax commands for the project on the local system. That is totally true, and also totally valid. Do that for the really fast feedback loop. However, the dance we do with Test Kitchen brings a much higher degree of confidence in the changes we're making, that everything will run on the build nodes in Chef Delivery. We strongly encourage this approach before actually pushing the changes to Delivery. + +### Why do I have to make a commit every time? + +When running `delivery job`, it expects to merge the commit for the changeset against the clean master branch. If we don't save our progress by making a commit, our local changes aren't run through `delivery job` in the Test Kitchen build instances. We can always perform an interactive rebase, and modify the original changeset message in Delivery with `delivery review --edit`. The latter won't modify the git commits, only the changeset in Delivery. + +### What do I do next? + +Make changes in the cookbook project as required for organizational goals and needs. Modify the `build_cookbook` as necessary for the pipeline phases that the cookbook should go through. + +### What if I get stuck? + +Contact Chef Support, or your Chef Customer Success team and they will help you get unstuck. diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/chefignore b/chef/cookbooks/metasploitable/.delivery/build_cookbook/chefignore new file mode 100644 index 0000000..38e7379 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/chefignore @@ -0,0 +1,107 @@ +# Put files/directories that should be ignored in this file when uploading +# to a chef-server or supermarket. +# Lines that start with '# ' are comments. + +# OS generated files # +###################### +.DS_Store +Icon? +nohup.out +ehthumbs.db +Thumbs.db + +# SASS # +######## +.sass-cache + +# EDITORS # +########### +\#* +.#* +*~ +*.sw[a-z] +*.bak +REVISION +TAGS* +tmtags +*_flymake.* +*_flymake +*.tmproj +.project +.settings +mkmf.log + +## COMPILED ## +############## +a.out +*.o +*.pyc +*.so +*.com +*.class +*.dll +*.exe +*/rdoc/ + +# Testing # +########### +.watchr +.rspec +spec/* +spec/fixtures/* +test/* +features/* +examples/* +Guardfile +Procfile +.kitchen* +.rubocop.yml +spec/* +Rakefile +.travis.yml +.foodcritic +.codeclimate.yml + +# SCM # +####### +.git +*/.git +.gitignore +.gitmodules +.gitconfig +.gitattributes +.svn +*/.bzr/* +*/.hg/* +*/.svn/* + +# Berkshelf # +############# +Berksfile +Berksfile.lock +cookbooks/* +tmp + +# Policyfile # +############## +Policyfile.rb +Policyfile.lock.json + +# Cookbooks # +############# +CONTRIBUTING* +CHANGELOG* +TESTING* +MAINTAINERS.toml + +# Strainer # +############ +Colanderfile +Strainerfile +.colander +.strainer + +# Vagrant # +########### +.vagrant +Vagrantfile diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/data_bags/keys/delivery_builder_keys.json b/chef/cookbooks/metasploitable/.delivery/build_cookbook/data_bags/keys/delivery_builder_keys.json new file mode 100644 index 0000000..af375ea --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/data_bags/keys/delivery_builder_keys.json @@ -0,0 +1 @@ +{"id": "delivery_builder_keys"} \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/metadata.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/metadata.rb new file mode 100644 index 0000000..10330e7 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/metadata.rb @@ -0,0 +1,7 @@ +name 'build_cookbook' +maintainer 'The Authors' +maintainer_email 'you@example.com' +license 'all_rights' +version '0.1.0' + +depends 'delivery-truck' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/default.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/default.rb new file mode 100644 index 0000000..b2746b5 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/default.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: default +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::default' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/deploy.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/deploy.rb new file mode 100644 index 0000000..9a61010 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/deploy.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: deploy +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::deploy' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/functional.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/functional.rb new file mode 100644 index 0000000..cae646d --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/functional.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: functional +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::functional' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/lint.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/lint.rb new file mode 100644 index 0000000..40aee0c --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/lint.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: lint +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::lint' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/provision.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/provision.rb new file mode 100644 index 0000000..57d0a78 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/provision.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: provision +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::provision' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/publish.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/publish.rb new file mode 100644 index 0000000..ad890fd --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/publish.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: publish +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::publish' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/quality.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/quality.rb new file mode 100644 index 0000000..f5d4d74 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/quality.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: quality +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::quality' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/security.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/security.rb new file mode 100644 index 0000000..7d47af1 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/security.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: security +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::security' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/smoke.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/smoke.rb new file mode 100644 index 0000000..2203cbd --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/smoke.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: smoke +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::smoke' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/syntax.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/syntax.rb new file mode 100644 index 0000000..7147f96 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/syntax.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: syntax +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::syntax' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/unit.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/unit.rb new file mode 100644 index 0000000..fa6d9ba --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/recipes/unit.rb @@ -0,0 +1,6 @@ +# +# Cookbook:: build_cookbook +# Recipe:: unit +# +# Copyright:: 2017, The Authors, All Rights Reserved. +include_recipe 'delivery-truck::unit' diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/secrets/fakey-mcfakerton b/chef/cookbooks/metasploitable/.delivery/build_cookbook/secrets/fakey-mcfakerton new file mode 100644 index 0000000..e69de29 diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/metadata.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/metadata.rb new file mode 100644 index 0000000..1725039 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/metadata.rb @@ -0,0 +1,2 @@ +name 'test' +version '0.1.0' \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/recipes/default.rb b/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/recipes/default.rb new file mode 100644 index 0000000..c26a70a --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/build_cookbook/test/fixtures/cookbooks/test/recipes/default.rb @@ -0,0 +1,7 @@ +%w(unit lint syntax).each do |phase| + # TODO: This works on Linux/Unix. Not Windows. + execute "HOME=/home/vagrant delivery job verify #{phase} --server localhost --ent test --org kitchen" do + cwd '/tmp/repo-data' + user 'vagrant' + end +end diff --git a/chef/cookbooks/metasploitable/.delivery/config.json b/chef/cookbooks/metasploitable/.delivery/config.json new file mode 100644 index 0000000..6c0e69f --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/config.json @@ -0,0 +1,12 @@ +{ + "version": "2", + "build_cookbook": { + "name": "build_cookbook", + "path": ".delivery/build_cookbook" + }, + "skip_phases": [], + "job_dispatch": { + "version": "v2" + }, + "dependencies": [] +} diff --git a/chef/cookbooks/metasploitable/.delivery/project.toml b/chef/cookbooks/metasploitable/.delivery/project.toml new file mode 100644 index 0000000..c453234 --- /dev/null +++ b/chef/cookbooks/metasploitable/.delivery/project.toml @@ -0,0 +1,36 @@ +# Delivery Prototype for Local Phases Execution +# +# The purpose of this file is to prototype a new way to execute +# phases locally on your workstation. The delivery-cli will read +# this file and execute the command(s) that are configured for +# each phase. You can customize them by just modifying the phase +# key on this file. +# +# By default these phases are configured for Cookbook Workflow only +# +# As this is still a prototype we are not modifying the current +# config.json file and it will continue working as usual. + +[local_phases] +unit = "chef exec rspec spec/" +lint = "chef exec cookstyle" +# Foodcritic includes rules only appropriate for community cookbooks +# uploaded to Supermarket. We turn off any rules tagged "supermarket" +# by default. If you plan to share this cookbook you should remove +# '-t ~supermarket' below to enable supermarket rules. +syntax = "chef exec foodcritic . --exclude spec -f any -t ~supermarket" +provision = "chef exec kitchen create" +deploy = "chef exec kitchen converge" +smoke = "chef exec kitchen verify" +# The functional phase is optional, you can define it by uncommenting +# the line below and running the command: `delivery local functional` +# functional = "" +cleanup = "chef exec kitchen destroy" + +# Remote project.toml file +# +# Specify a remote URI location for the `project.toml` file. +# This is useful for teams that wish to centrally manage the behavior +# of the `delivery local` command across many different projects. +# +# remote_file = "https://url/project.toml" diff --git a/chef/cookbooks/metasploitable/.gitignore b/chef/cookbooks/metasploitable/.gitignore new file mode 100644 index 0000000..febee30 --- /dev/null +++ b/chef/cookbooks/metasploitable/.gitignore @@ -0,0 +1,21 @@ +.vagrant +*~ +*# +.#* +\#*# +.*.sw[a-z] +*.un~ + +# Bundler +Gemfile.lock +bin/* +.bundle/* + +# test kitchen +.kitchen/ +.kitchen.local.yml + +# Chef +Berksfile.lock +.zero-knife.rb +Policyfile.lock.json diff --git a/chef/cookbooks/metasploitable/.kitchen.yml b/chef/cookbooks/metasploitable/.kitchen.yml new file mode 100644 index 0000000..d7bd3a0 --- /dev/null +++ b/chef/cookbooks/metasploitable/.kitchen.yml @@ -0,0 +1,26 @@ +--- +driver: + name: vagrant + +provisioner: + name: chef_zero + # You may wish to disable always updating cookbooks in CI or other testing environments. + # For example: + # always_update_cookbooks: <%= !ENV['CI'] %> + always_update_cookbooks: true + +verifier: + name: inspec + +platforms: + - name: ubuntu-16.04 + - name: centos-7.2 + +suites: + - name: default + run_list: + - recipe[metasploitable::default] + verifier: + inspec_tests: + - test/smoke/default + attributes: diff --git a/chef/cookbooks/metasploitable/Berksfile b/chef/cookbooks/metasploitable/Berksfile new file mode 100644 index 0000000..34fea21 --- /dev/null +++ b/chef/cookbooks/metasploitable/Berksfile @@ -0,0 +1,3 @@ +source 'https://supermarket.chef.io' + +metadata diff --git a/chef/cookbooks/metasploitable/README.md b/chef/cookbooks/metasploitable/README.md new file mode 100644 index 0000000..534fc8e --- /dev/null +++ b/chef/cookbooks/metasploitable/README.md @@ -0,0 +1,4 @@ +# metasploitable + +TODO: Enter the cookbook description here. + diff --git a/chef/cookbooks/metasploitable/chefignore b/chef/cookbooks/metasploitable/chefignore new file mode 100644 index 0000000..38e7379 --- /dev/null +++ b/chef/cookbooks/metasploitable/chefignore @@ -0,0 +1,107 @@ +# Put files/directories that should be ignored in this file when uploading +# to a chef-server or supermarket. +# Lines that start with '# ' are comments. + +# OS generated files # +###################### +.DS_Store +Icon? +nohup.out +ehthumbs.db +Thumbs.db + +# SASS # +######## +.sass-cache + +# EDITORS # +########### +\#* +.#* +*~ +*.sw[a-z] +*.bak +REVISION +TAGS* +tmtags +*_flymake.* +*_flymake +*.tmproj +.project +.settings +mkmf.log + +## COMPILED ## +############## +a.out +*.o +*.pyc +*.so +*.com +*.class +*.dll +*.exe +*/rdoc/ + +# Testing # +########### +.watchr +.rspec +spec/* +spec/fixtures/* +test/* +features/* +examples/* +Guardfile +Procfile +.kitchen* +.rubocop.yml +spec/* +Rakefile +.travis.yml +.foodcritic +.codeclimate.yml + +# SCM # +####### +.git +*/.git +.gitignore +.gitmodules +.gitconfig +.gitattributes +.svn +*/.bzr/* +*/.hg/* +*/.svn/* + +# Berkshelf # +############# +Berksfile +Berksfile.lock +cookbooks/* +tmp + +# Policyfile # +############## +Policyfile.rb +Policyfile.lock.json + +# Cookbooks # +############# +CONTRIBUTING* +CHANGELOG* +TESTING* +MAINTAINERS.toml + +# Strainer # +############ +Colanderfile +Strainerfile +.colander +.strainer + +# Vagrant # +########### +.vagrant +Vagrantfile diff --git a/chef/cookbooks/metasploitable/files/apache/cgi-bin.conf b/chef/cookbooks/metasploitable/files/apache/cgi-bin.conf new file mode 100644 index 0000000..993480e --- /dev/null +++ b/chef/cookbooks/metasploitable/files/apache/cgi-bin.conf @@ -0,0 +1,19 @@ + + + Define ENABLE_CGI_BIN + + + + Define ENABLE_CGI_BIN + + + + ScriptAlias /cgi-bin/ /var/www/cgi-bin/ + + AllowOverride None + Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch + Order allow,deny + Allow from all + + + \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/files/apache/hello_world.sh b/chef/cookbooks/metasploitable/files/apache/hello_world.sh new file mode 100644 index 0000000..b66e0a2 --- /dev/null +++ b/chef/cookbooks/metasploitable/files/apache/hello_world.sh @@ -0,0 +1,3 @@ +#!/bin/bash +printf "Content-type: text/html\n\n" +printf "Hello World!\n" \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/files/apache/php5.conf b/chef/cookbooks/metasploitable/files/apache/php5.conf new file mode 100644 index 0000000..9ca0874 --- /dev/null +++ b/chef/cookbooks/metasploitable/files/apache/php5.conf @@ -0,0 +1,17 @@ + + SetHandler application/x-httpd-php + + + SetHandler application/x-httpd-php-source + Order Deny,Allow + Deny from all + + + Order Deny,Allow + Deny from all + + + + php_admin_flag engine Off + + diff --git a/chef/cookbooks/metasploitable/files/apache/php5.load b/chef/cookbooks/metasploitable/files/apache/php5.load new file mode 100644 index 0000000..653695f --- /dev/null +++ b/chef/cookbooks/metasploitable/files/apache/php5.load @@ -0,0 +1 @@ +LoadModule php5_module /usr/lib/apache2/modules/libphp5.so diff --git a/chef/cookbooks/metasploitable/files/phpmyadmin/config.inc.php b/chef/cookbooks/metasploitable/files/phpmyadmin/config.inc.php new file mode 100644 index 0000000..60fc79d --- /dev/null +++ b/chef/cookbooks/metasploitable/files/phpmyadmin/config.inc.php @@ -0,0 +1,30 @@ + \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/files/proftpd/proftpd b/chef/cookbooks/metasploitable/files/proftpd/proftpd new file mode 100644 index 0000000..b808935 --- /dev/null +++ b/chef/cookbooks/metasploitable/files/proftpd/proftpd @@ -0,0 +1,39 @@ +#!/bin/sh +### BEGIN INIT INFO +# Provides: proftpd +# Required-Start: $local_fs +# Required-Stop: $local_fs +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# X-Interactive: false +# Short-Description: Init script for proftpd +# Description: Start/stop proftpd +### END INIT INFO + +DESC="proftpd" +NAME=proftpd +#DAEMON= + +do_start() +{ + echo "Starting proftpd."; + /opt/proftpd/sbin/proftpd +} + +do_stop() +{ + echo "Stopping proftpd." + killall proftpd +} + + +case "$1" in + start) + do_start + ;; + stop) + do_stop + ;; +esac + +exit 0 \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/metadata.rb b/chef/cookbooks/metasploitable/metadata.rb new file mode 100644 index 0000000..804b8bf --- /dev/null +++ b/chef/cookbooks/metasploitable/metadata.rb @@ -0,0 +1,22 @@ +name 'metasploitable' +maintainer 'Rapid7' +maintainer_email '' +license 'BSD-3-clause' +description 'Installs/Configures metasploitable3' +long_description 'Installs/Configures metasploitable3' +version '0.1.0' + +# The `issues_url` points to the location where issues for this cookbook are +# tracked. A `View Issues` link will be displayed on this cookbook's page when +# uploaded to a Supermarket. +# +# issues_url 'https://github.com//metasploitable3/issues' if respond_to?(:issues_url) + +# The `source_url` points to the development reposiory for this cookbook. A +# `View Source` link will be displayed on this cookbook's page when uploaded to +# a Supermarket. +# +# source_url 'https://github.com//metasploitable3' if respond_to?(:source_url) + +depends 'docker' +depends 'mysql' diff --git a/chef/cookbooks/metasploitable/recipes/apache_continuum.rb b/chef/cookbooks/metasploitable/recipes/apache_continuum.rb new file mode 100644 index 0000000..be0cae9 --- /dev/null +++ b/chef/cookbooks/metasploitable/recipes/apache_continuum.rb @@ -0,0 +1,26 @@ +# +# Cookbook:: metasploitable +# Recipe:: apache_continuum +# +# Copyright:: 2017, Rapid7, All Rights Reserved. + +execute "apt-get update" do + command "apt-get update" +end +package 'openjdk-6-jre' +package 'openjdk-6-jdk' + +bash 'Download and extract Apache Continuum 1.4.2' do + code <<-EOH + mkdir /opt/apache-continuum/ + cd /opt/apache-continuum/ + wget http://archive.apache.org/dist/continuum/binaries/apache-continuum-1.4.2-bin.tar.gz + tar xvf apache-continuum-1.4.2-bin.tar.gz + rm apache-continuum-1.4.2/bin/wrapper-linux-x86-32 + rm -rf apache-continuum-1.4.2/data + tar -xvzf /vagrant/resources/apache_continuum/data.tar.gz -C /opt/apache-continuum/apache-continuum-1.4.2/ + ln -s /opt/apache-continuum/apache-continuum-1.4.2/bin/continuum /etc/init.d/continuum + update-rc.d continuum defaults 80 + service continuum start + EOH +end \ No newline at end of file diff --git a/chef/cookbooks/metasploitable/recipes/default.rb b/chef/cookbooks/metasploitable/recipes/default.rb new file mode 100644 index 0000000..7f84311 --- /dev/null +++ b/chef/cookbooks/metasploitable/recipes/default.rb @@ -0,0 +1,5 @@ +# +# Cookbook:: metasploitable +# Recipe:: default +# +# Copyright:: 2017, The Authors, All Rights Reserved. diff --git a/chef/cookbooks/metasploitable/recipes/phpmyadmin.rb b/chef/cookbooks/metasploitable/recipes/phpmyadmin.rb new file mode 100644 index 0000000..80ec507 --- /dev/null +++ b/chef/cookbooks/metasploitable/recipes/phpmyadmin.rb @@ -0,0 +1,25 @@ +# +# Cookbook:: metasploitable +# Recipe:: phpmyadmin +# +# Copyright:: 2017, Rapid7, All Rights Reserved. + +include_recipe 'metasploitable::mysql' +include_recipe 'metasploitable::apache' +include_recipe 'metasploitable::php_545' + +bash "download and extract phpmyadmin" do + code <<-EOH + wget -c -t 3 -O /tmp/phpMyAdmin-3.5.8-all-languages.tar.gz https://files.phpmyadmin.net/phpMyAdmin/3.5.8/phpMyAdmin-3.5.8-all-languages.tar.gz + tar xvfz /tmp/phpMyAdmin-3.5.8-all-languages.tar.gz -C /var/www/html + mv /var/www/html/phpMyAdmin-3.5.8-all-languages /var/www/html/phpmyadmin + EOH +end + +cookbook_file 'var/www/html/phpmyadmin/config.inc.php' do + source 'phpmyadmin/config.inc.php' +end + +service 'apache2' do + action [:restart] +end diff --git a/chef/cookbooks/metasploitable/recipes/proftpd.rb b/chef/cookbooks/metasploitable/recipes/proftpd.rb new file mode 100644 index 0000000..a7c145e --- /dev/null +++ b/chef/cookbooks/metasploitable/recipes/proftpd.rb @@ -0,0 +1,30 @@ +# +# Cookbook:: metasploitable +# Recipe:: proftpd +# +# Copyright:: 2017, Rapid7, All Rights Reserved. + +# Install steps taken from https://github.com/rapid7/metasploit-framework/pull/5224 + +include_recipe 'metasploitable::apache' + +bash "download, extract, and compile proftpd" do + code <<-EOH + cd /home/vagrant + wget "ftp://ftp.proftpd.org/distrib/source/proftpd-1.3.5.tar.gz" + tar zxfv proftpd-1.3.5.tar.gz + cd proftpd-1.3.5 + ./configure --prefix=/opt/proftpd --with-modules=mod_copy + make + make install + EOH +end + +cookbook_file '/etc/init.d/proftpd' do + source 'proftpd/proftpd' + mode '760' +end + +service 'proftpd' do + action [:enable, :start] +end diff --git a/chef/cookbooks/metasploitable/spec/spec_helper.rb b/chef/cookbooks/metasploitable/spec/spec_helper.rb new file mode 100644 index 0000000..1dd5126 --- /dev/null +++ b/chef/cookbooks/metasploitable/spec/spec_helper.rb @@ -0,0 +1,2 @@ +require 'chefspec' +require 'chefspec/berkshelf' diff --git a/chef/cookbooks/metasploitable/spec/unit/recipes/default_spec.rb b/chef/cookbooks/metasploitable/spec/unit/recipes/default_spec.rb new file mode 100644 index 0000000..8ef0601 --- /dev/null +++ b/chef/cookbooks/metasploitable/spec/unit/recipes/default_spec.rb @@ -0,0 +1,20 @@ +# +# Cookbook:: metasploitable +# Spec:: default +# +# Copyright:: 2017, The Authors, All Rights Reserved. + +require 'spec_helper' + +describe 'metasploitable::default' 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/chef/cookbooks/metasploitable/spec/unit/recipes/mysql_spec.rb b/chef/cookbooks/metasploitable/spec/unit/recipes/mysql_spec.rb new file mode 100644 index 0000000..fe77069 --- /dev/null +++ b/chef/cookbooks/metasploitable/spec/unit/recipes/mysql_spec.rb @@ -0,0 +1,20 @@ +# +# Cookbook:: metasploitable +# Spec:: default +# +# Copyright:: 2017, The Authors, All Rights Reserved. + +require 'spec_helper' + +describe 'metasploitable::mysql' 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/chef/cookbooks/metasploitable/test/smoke/default/default_test.rb b/chef/cookbooks/metasploitable/test/smoke/default/default_test.rb new file mode 100644 index 0000000..d489da5 --- /dev/null +++ b/chef/cookbooks/metasploitable/test/smoke/default/default_test.rb @@ -0,0 +1,18 @@ +# # encoding: utf-8 + +# Inspec test for recipe metasploitable::default + +# The Inspec reference, with examples and extensive documentation, can be +# found at http://inspec.io/docs/reference/resources/ + +unless os.windows? + describe user('root') do + it { should exist } + skip 'This is an example test, replace with your own test.' + end +end + +describe port(80) do + it { should_not be_listening } + skip 'This is an example test, replace with your own test.' +end diff --git a/chef/cookbooks/metasploitable/test/smoke/default/mysql.rb b/chef/cookbooks/metasploitable/test/smoke/default/mysql.rb new file mode 100644 index 0000000..1010bdc --- /dev/null +++ b/chef/cookbooks/metasploitable/test/smoke/default/mysql.rb @@ -0,0 +1,18 @@ +# # encoding: utf-8 + +# Inspec test for recipe metasploitable::mysql + +# The Inspec reference, with examples and extensive documentation, can be +# found at http://inspec.io/docs/reference/resources/ + +unless os.windows? + describe user('root') do + it { should exist } + skip 'This is an example test, replace with your own test.' + end +end + +describe port(80) do + it { should_not be_listening } + skip 'This is an example test, replace with your own test.' +end diff --git a/chef/cookbooks/mysql/.foodcritic b/chef/cookbooks/mysql/.foodcritic new file mode 100644 index 0000000..913f038 --- /dev/null +++ b/chef/cookbooks/mysql/.foodcritic @@ -0,0 +1 @@ +~FC005 diff --git a/chef/cookbooks/mysql/CHANGELOG.md b/chef/cookbooks/mysql/CHANGELOG.md new file mode 100644 index 0000000..bf6334e --- /dev/null +++ b/chef/cookbooks/mysql/CHANGELOG.md @@ -0,0 +1,665 @@ +# mysql Cookbook CHANGELOG + +This file is used to list changes made in each version of the mysql cookbook. + +## 8.2.0 (2016-12-03) + +- Include client development packages on RHEL/SUSE platforms + +## 8.1.1 (2016-10-31) +- Fixing CVE-2016-6662 - Reverting execure bit on mysql config + +## 8.1.0 (2016-10-29) + +- Drop hardcoded, specific package version logic that broke many users + +## 8.0.4 (2016-09-26) +- Bump debian version +- Updated packages for 12.04 and 14.04 too +- Add chef_version metadata +- Update platforms in the kitchen file +- Add selinux to the Berksfile for testing +- Make sure yum repos are setup in local Test Kitchen + +## 8.0.3 (2016-09-14) +- [GH-390] Fix #390 incorrect escaping of initial_root_password +- Updated package versions for Ubuntu 16.04 +- Testing updates + +# v8.0.2 (2016-08-25) +- Various bug fixed and updates to package version strings + +# v8.0.1 (2016-07-20) +- Fixed a regression in the mysql_client resource where the action was changed from create to install in the 8.0 release +- Added oracle, opensuse, and opensuseleap as supported platforms in the metadata + +# v8.0.0 (2016-07-11) + +- Converting from LWRP to custom resources +- Removing yum-mysql and other dependencies. +- ^ BREAKING CHANGE: RHELish users are now responsible + for including a recipe from the "yum-mysql" or equivalent + cookbook before utilizing the mysql_* resources. +- More thoughtful ChefSpec +- Renaming "replication" test suite to "smoke" +- Moving to Inspec + +## v7.2.0 (2016-06-30) + +- Support openeSUSE leap +- Support Fedora 24 + +## v7.1.2 (2016-06-30) + +- Avoid deprecation warnings on the upcoming Chef 12.12 release + +## v7.1.1 (2016-06-03) + +- Fix apparmor blocking writes to non-default tmp_dirs +- Updated apparmor config to allow read & write to sock.lock file +- Use cookstyle instead of Rubocop directly + +## v7.1.0 (2016-05-11) + +- Added support for Ubuntu 16.04 + +## v7.0.0 (2016-04-19) + +- Removed support for legacy distros: Ubuntu 10.04/13.04/14.10/15.04, Fedora 20/21, OmniOS r151006, opensuse 11.3/12.0 +- Added support for Fedora 23, suse 13.X, and Ubuntu 16.04 +- Updated the systemd support to create unit files in /etc/systemd and not /usr/lib/systemd +- Adding umask to bash resource that sets root password PR #386 @gziskind +- Cleaned up the Test Kitchen config to test the right platform version + mysql pairings +- Added Travis CI Test Kitchen testing on Fedora 22/23 and removed Fedora 21 +- Updated the platforms used in the specs + +## v6.1.3 (2016-03-14) + +- Added support for Ubuntu 15.10 +- Added support for Amazon Linux 2016-03 +- Updated Kitchen testing configs + +## v6.1.2 (2015-10-05) + +- Added support for Amazon Linux 2015.09 + +## v6.1.1 (2015-09-24) + +- Completing ChefSpec matchers + +## v6.1.0 (2015-07-17) + +- Adding tunables for tmp_dir, error_log, and pid_file +- Adding mysqld_options hash interface for main my.cnf template + +## v6.0.31 (2015-07-13) + +- Reverting create_stop_system_service checks + +## v6.0.30 (2015-07-13) + +- Ubuntu 15.04 support +- Check for scripts and unit files during create_stop_system_service + +## v6.0.29 (2015-07-12) + +- Patch to allow blank root password +- Adding package information for Suse 12.0 + +## v6.0.28 (2015-07-10) + +- Fixes for 12.4.x + +## v6.0.27 (2015-07-09) + +- Allowing integer value for port number + +## v6.0.26 (2015-07-07) + +- Reverting breaking changes introduced in 6.0.25 + +## v6.0.25 (2015-07-06) + +- Fixes for 12.4.1 + +## v6.0.24 (2015-06-27) + +- 341 - Changing default GRANT for root from '%' to 'localhost' and '127.0.0.1' + +## v6.0.23 (2015-06-21) + +- 354 Better handling of long MySQL startup times + +## v6.0.22 (2015-05-07) + +- Debian 8 (Jessie) support + +## v6.0.21 (2015-04-08) + +- Fix to Upstart prestart script when using custom socket +- Adding --explicit_defaults_for_timestamp mysql_install_db_cmd for +- 5.6 and above + +## v6.0.20 (2015-03-27) + +- 318 - Fixing Upstart pre-start script to handle custom socket paths + +## v6.0.19 (2015-03-25) + +- Adding support for Amazon Linux 2015.03 + +## v6.0.18 (2015-03-24) + +- Adding support for 5.6 and 5.7 packages from dotdeb repos on Debian 7 + +## v6.0.17 (2015-03-13) + +- Updated for MySQL 5.7.6. +- Handing removal of mysql_install_db and mysqld_safe + +## v6.0.16 (2015-03-10) + +- Moved --defaults-file as first option to mysql_install_db_script + +## v6.0.15 (2015-02-26) + +- Updating docker detection fix to pass specs + +## v6.0.14 (2015-02-26) + +- Fixed debian system service :disable action. Now survives reboot +- Fixing centos-7 instance :enable action. Now survives +- Not applying Apparmor policy if running in a Docker container + +## v6.0.13 (2015-02-15) + +- Adding support for special characters in initial_root_password +- Fixing failure status bug in sysvinit script + +## v6.0.12 (2015-02-30) + +- No changes. Released a 6.0.11 that was identical to 6.0.10. +- Git before coffee. + +## v6.0.11 (2015-02-30) + +- Adding support for configurable socket files + +## v6.0.10 (2015-01-19) + +- Fix #282 - Fixing up data_dir template variable + +## v6.0.9 (2015-01-19) + +- Fix #282 - undefined method `parsed_data_dir' bug + +## v6.0.8 (2015-01-19) + +- Refactoring helper methods out of resource classes + +## v6.0.7 (2015-01-14) + +- Fixing timing issue with Upstart provider :restart and :reload +- actions where service returns before being available + +## v6.0.6 (2014-12-26) + +- Fixing subtle bug where MysqlCookbook::Helper methods were polluting Chef::Resource + +## v6.0.5 (2014-12-25) + +- Using 'include_recipe' instead of 'recipe_eval' in LWRP +- Fixing type checking on package_name attribute in mysql_client resource. + +## v6.0.4 (2014-12-21) + +- Suggest available versions if current is not available for current platform. + +## v6.0.3 (2014-12-17) + +- Adding bind_address parameter to mysql_service resource + +## v6.0.2 (2014-12-17) + +- Fixing sysvinit provider to survive reboots + +## v6.0.1 (2014-12-16) + +- Fixing Upstart template to survive reboots + +## v6.0.0 (2014-12-15) + +- Major version update +- Cookbook now provides LWRPs instead of recipes +- Platform providers re-factored into init system providers +- Separated :create and :start actions for use in recipes that build containers +- mysql_service now supports multiple instances on the same machine +- mysql_service no longer attempts to manage user records +- Removal of debian-sys-maint +- Unified Sysvinit script that works on all platforms +- mysql_config resource introduced +- mysql_client fixed up +- Refactored acceptance tests +- Temporarily dropped FreeBSD support + +## v5.6.1 (2014-10-29) + +- Use Gem::Version instead of Chef::Version + +## v5.6.0 (2014-10-29) + +- Changing default charset to utf8 +- Quoting passwords in debian.cnf.erb +- Amazon 2014.09 support +- Ubuntu 14.10 support +- Only hide passwords from STDOUT via "sensitive true" in chef-client higher than 11.14 +- Updating test harness + +## v5.5.4 (2014-10-07) + +- Adding sensitive flag to execute resources to protect passwords from logs + +## v5.5.3 (2014-09-24) + +- Reverting back to Upstart on Ubuntu 14.04 + +## v5.5.2 (2014-09-8) + +- Reverting commit that broke Debian pass_string + +## v5.5.1 (2014-09-2) + +- Switching Ubuntu service provider to use SysVinit instead of Upstart + +## v5.5.0 (2014-08-27) + +- Adding package version and action parameters to mysql_service resource +- Fixing Debian pass_string + +## v5.4.4 (2014-08-27) + +- Changing module namespace to MysqlCookbook + +## v5.4.3 (2014-08-25) + +- More refactoring. Moving helper function bits into resource parsed_parameters + +## v5.4.2 (2014-08-25) + +- Moving provider local variables into definitions for RHEL provider + +## v5.4.1 (2014-08-25) + +- Refactoring resources into the LWRP style with parsed parameters +- Moving provider local variables into definitions + +## v5.4.0 (2014-08-25) + +- 212 - support for centos-7 (mysql55 and mysql56) +- Adding (untested) Debian-6 support +- Adding Suse support to metadata.rb +- Adding ability to change MySQL root password +- Added libmysqlclient-devel package to SuSE client provider +- Appeasing AppArmor +- Reducing duplication in client provider + +## v5.3.6 (2014-06-18) + +- Fixing pid path location. Updating tests to include real RHEL + +## v5.3.4 (2014-06-16) + +- Fixing specs for Amazon Linux server package names + +## v5.3.2 (2014-06-16) + +- Fixing Amazon Linux support + +## v5.3.0 (2014-06-11) + +- 189 - Fix server_repl_password description +- 191 - Adding support for server55 and server56 on el-6 +- 193 - Fix syntax in mysql_service example +- 199 - Adding Suse support + +## v5.2.12 (2014-05-19) + +PR #192 - recipes/server.rb should honor parameter node['mysql']['version'] + +## v5.2.10 (2014-05-15) + +- COOK-4394 - restore freebsd support + +## v5.2.8 (2014-05-15) + +- [COOK-4653] - Missing mySQL 5.6 support for Ubuntu 14.04 + +## v5.2.6 (2014-05-07) + +- [COOK-4625] - Fix password resource parameter consumption on Debian and Ubuntu +- Fix up typos and version numbers in PLATFORMS.md +- Fix up specs from COOK-4613 changes + +## v5.2.4 (2014-05-02) + +- [COOK-4613] - Fix permissions on mysql data_dir to allow global access to mysql.sock + +## v5.2.2 (2014-04-24) + +- [COOK-4564] - Using positive tests for datadir move + +## v5.2.0 (2014-04-22) + +- [COOK-4551] - power grants.sql from resource parameters + +## v5.1.12 (2014-04-21) + +- [COOK-4554] - Support for Debian Sid + +## v5.1.10 (2014-04-21) + +- [COOK-4565] Support for Ubuntu 14.04 +- [COOK-4565] Adding Specs and TK platform +- Removing non-LTS 13.10 specs and TK platform + +## v5.1.8 (2014-04-12) + +Adding Ubuntu 13.04 to Platforminfo + +## v5.1.6 (2014-04-11) + +- [COOK-4548] - Add template[/etc/mysql/debian.cnf] to Ubuntu provider + +## v5.1.4 (2014-04-11) + +- [COOK-4547] - Shellescape server_root_password + +## v5.1.2 (2014-04-09) + +- [COOK-4519] - Fix error in run_dir for Ubuntu +- [COOK-4531] - Fix pid and run_dir for Debian + +## v5.1.0 (2014-04-08) + +[COOK-4523] - Allow for both :restart and :reload + +## v5.0.6 (2014-04-07) + +- [COOK-4519] - Updating specs to reflect pid file change on Ubuntu + +## v5.0.4 (2014-04-07) + +- [COOK-4519] - Fix path to pid file on Ubuntu + +## v5.0.2 (2014-04-01) + +- Moving server_deprecated into recipes directory + +## v5.0.0 (2014-03-31) + +- Rewriting as a library cookbook +- Exposing mysql_service and mysql_client resources +- User now needs to supply configuration +- Moving attribute driven recipe to server-deprecated + +## v4.1.2 (2014-02-28) + +- [COOK-4349] - Fix invalid platform check +- [COOK-4184] - Better handling of Ubuntu upstart service +- [COOK-2100] - Changing innodb_log_file_size tunable results in inability to start MySQL + +## v4.1.1 (2014-02-25) + +- **[COOK-2966] - Address foodcritic failures' +- **[COOK-4182] - Template parse failure in /etc/init/mysql.conf (data_dir)' +- **[COOK-4198] - Added missing tunable' +- **[COOK-4206] - create root@127.0.0.1, as well as root@localhost' + +## v4.0.20 (2014-01-18) + +- [COOK-3931] - MySQL Server Recipe Regression for Non-LTS Ubuntu Versions +- [COOK-3945] - MySQL cookbook fails on Ubuntu 13.04/13.10 +- [COOK-3966] - mysql::server recipe can't find a template with debian 7.x +- [COOK-3985] - Missing /etc/mysql/debian.cnf template on mysql::_server_debian.rb recipe (mysql 4.0.4) +- [COOK-3974] - debian.cnf not updated +- [COOK-4001] - Pull request: Fixes for broken mysql::server on Debian +- [COOK-4071] - Mysql cookbook doesn't work on debian 7.2 + +## v4.0.14 + +Fixing style cops + +## v4.0.12 + +### Bug + +- **[COOK-4068](https://tickets.chef.io/browse/COOK-4068)** - rework MySQL Windows recipe + +### Improvement + +- **[COOK-3801](https://tickets.chef.io/browse/COOK-3801)** - Add innodb_adaptive_flushing_method and innodb_adaptive_checkpoint + +## v4.0.10 + +fixing metadata version error. locking to 3.0 + +## v4.0.8 + +Locking yum dependency to '< 3' + +## v4.0.6 + +# Bug + +- [COOK-3943] Notifying service restart on grants update + +## v4.0.4 + +[COOK-3952] - Adding 'recursive true' to directory resources + +## v4.0.2 + +### BUGS + +- Adding support for Amazon Linux in attributes/server_rhel.rb +- Fixing bug where unprivileged users cannot connect over a local socket. Adding integration test. +- Fixing bug in mysql_grants_cmd generation + +## v4.0.0 + +- [COOK-3928] Heavily refactoring for readability. Moving platform implementation into separate recipes +- Moving integration tests from minitest to serverspec, removing "improper" tests +- Moving many attributes into the ['mysql']['server']['whatever'] namespace +- [COOK-3481] - Merged Lucas Welsh's Windows bits and moved into own recipe +- [COOK-3697] - Adding security hardening attributes +- [COOK-3780] - Fixing data_dir on Debian and Ubuntu +- [COOK-3807] - Don't use execute[assign-root-password] on Debian and Ubuntu +- [COOK-3881] - Fixing /etc being owned by mysql user + +## v3.0.12 + +### Bug + +- **[COOK-3752](https://tickets.chef.io/browse/COOK-3752)** - mysql service fails to start in mysql::server recipe + +## v3.0.10 + +- Fix a failed release attempt for v3.0.8 + +## v3.0.8 + +### Bug + +- **[COOK-3749](https://tickets.chef.io/browse/COOK-3749)** - Fix a regression with Chef 11-specific features + +## v3.0.6 + +### Bug + +- **[COOK-3674](https://tickets.chef.io/browse/COOK-3674)** - Fix an issue where the MySQL server fails to set the root password correctly when `data_dir` is a non-default value +- **[COOK-3647](https://tickets.chef.io/browse/COOK-3647)** - Fix README typo (databas => database) +- **[COOK-3477](https://tickets.chef.io/browse/COOK-3477)** - Fix log-queries-not-using-indexes not working +- **[COOK-3436](https://tickets.chef.io/browse/COOK-3436)** - Pull percona repo in compilation phase +- **[COOK-3208](https://tickets.chef.io/browse/COOK-3208)** - Fix README typo (LitenPort => ListenPort) +- **[COOK-3149](https://tickets.chef.io/browse/COOK-3149)** - Create my.cnf before installing +- **[COOK-2681](https://tickets.chef.io/browse/COOK-2681)** - Fix log_slow_queries for 5.5+ +- **[COOK-2606](https://tickets.chef.io/browse/COOK-2606)** - Use proper bind address on cloud providers + +### Improvement + +- **[COOK-3498](https://tickets.chef.io/browse/COOK-3498)** - Add support for replicate_* variables in my.cnf + +## v3.0.4 + +### Bug + +- **[COOK-3310](https://tickets.chef.io/browse/COOK-3310)** - Fix missing `GRANT` option +- **[COOK-3233](https://tickets.chef.io/browse/COOK-3233)** - Fix escaping special characters +- **[COOK-3156](https://tickets.chef.io/browse/COOK-3156)** - Fix GRANTS file when `remote_root_acl` is specified +- **[COOK-3134](https://tickets.chef.io/browse/COOK-3134)** - Fix Chef 11 support +- **[COOK-2318](https://tickets.chef.io/browse/COOK-2318)** - Remove redundant `if` block around `node.mysql.tunable.log_bin` + +## v3.0.2 + +### Bug + +- [COOK-2158]: apt-get update is run twice at compile time +- [COOK-2832]: mysql grants.sql file has errors depending on attrs +- [COOK-2995]: server.rb is missing a platform_family comparison value + +### Sub-task + +- [COOK-2102]: `innodb_flush_log_at_trx_commit` value is incorrectly set based on CPU count + +## v3.0.0 + +**Note** This is a backwards incompatible version with previous versions of the cookbook. Tickets that introduce incompatibility are COOK-2615 and COOK-2617. + +- [COOK-2478] - Duplicate 'read_only' server attribute in base and tunable +- [COOK-2471] - Add tunable to set slave_compressed_protocol for reduced network traffic +- [COOK-1059] - Update attributes in mysql cookbook to support missing options for my.cnf usable by Percona +- [COOK-2590] - Typo in server recipe to do with conf_dir and confd_dir +- [COOK-2602] - Add `lower_case_table_names` tunable +- [COOK-2430] - Add a tunable to create a network ACL when allowing `remote_root_access` +- [COOK-2619] - mysql: isamchk deprecated +- [COOK-2515] - Better support for SUSE distribution for mysql cookbook +- [COOK-2557] - mysql::percona_repo attributes missing and key server typo +- [COOK-2614] - Duplicate `innodb_file_per_table` +- [COOK-2145] - MySQL cookbook should remove anonymous and password less accounts +- [COOK-2553] - Enable include directory in my.cnf template for any platform +- [COOK-2615] - Rename `key_buffer` to `key_buffer_size` +- [COOK-2626] - Percona repo URL is being constructed incorrectly +- [COOK-2616] - Unneeded attribute thread_cache +- [COOK-2618] - myisam-recover not using attribute value +- [COOK-2617] - open-files is a duplicate of open-files-limit + +## v2.1.2 + +- [COOK-2172] - Mysql cookbook duplicates `binlog_format` configuration + +## v2.1.0 + +- [COOK-1669] - Using platform("ubuntu") in default attributes always returns true +- [COOK-1694] - Added additional my.cnf fields and reorganized cookbook to avoid race conditions with mysql startup and sql script execution +- [COOK-1851] - Support server-id and binlog_format settings +- [COOK-1929] - Update msyql server attributes file because setting attributes without specifying a precedence is deprecated +- [COOK-1999] - Add read_only tunable useful for replication slave servers + +## v2.0.2 + +- [COOK-1967] - mysql: trailing comma in server.rb platform family + +## v2.0.0 + +**Important note for this release** + +Under Chef Solo, you must set the node attributes for the root, debian and repl passwords or the run will completely fail. See COOK-1737 for background on this. + +- [COOK-1390] - MySQL service cannot start after reboot +- [COOK-1610] - Set root password outside preseed (blocker for drop-in mysql replacements) +- [COOK-1624] - Mysql cookbook fails to even compile on windows +- [COOK-1669] - Using platform("ubuntu") in default attributes always returns true +- [COOK-1686] - Add mysql service start +- [COOK-1687] - duplicate `innodb_buffer_pool_size` attribute +- [COOK-1704] - mysql cookbook fails spec tests when minitest-handler cookbook enabled +- [COOK-1737] - Fail a chef-solo run when `server_root_password`, `server_debian_password`, and/or `server_repl_password` is not set +- [COOK-1769] - link to database recipe in mysql README goes to old chef/cookbooks repo instead of chef-cookbook organization +- [COOK-1963] - use `platform_family` + +## v1.3.0 + +**Important note for this release** + +This version no longer installs Ruby bindings in the client recipe by default. Use the ruby recipe if you'd like the RubyGem. If you'd like packages from your distribution, use them in your application's specific cookbook/recipe, or modify the client packages attribute. This resolves the following tickets: + +- COOK-932 +- COOK-1009 +- COOK-1384 + +Additionally, this cookbook now has tests (COOK-1439) for use under test-kitchen. + +The following issues are also addressed in this release. + +- [COOK-1443] - MySQL (>= 5.1.24) does not support `innodb_flush_method` = fdatasync +- [COOK-1175] - Add Mac OS X support +- [COOK-1289] - handle additional tunable attributes +- [COOK-1305] - add auto-increment-increment and auto-increment-offset attributes +- [COOK-1397] - make the port an attribute +- [COOK-1439] - Add MySQL cookbook tests for test-kitchen support +- [COOK-1236] - Move package names into attributes to allow percona to free-ride +- [COOK-934] - remove deprecated mysql/libraries/database.rb, use the database cookbook instead. +- [COOK-1475] - fix restart on config change + +## v1.2.6 + +- [COOK-1113] - Use an attribute to determine if upstart is used +- [COOK-1121] - Add support for Windows +- [COOK-1140] - Fix conf.d on Debian +- [COOK-1151] - Fix server_ec2 handling /var/lib/mysql bind mount +- [COOK-1321] - Document setting password attributes for solo + +## v1.2.4 + +- [COOK-992] - fix FATAL nameerror +- [COOK-827] - `mysql:server_ec2` recipe can't mount `data_dir` +- [COOK-945] - FreeBSD support + +## v1.2.2 + +- [COOK-826] mysql::server recipe doesn't quote password string +- [COOK-834] Add 'scientific' and 'amazon' platforms to mysql cookbook + +## v1.2.1 + +- [COOK-644] Mysql client cookbook 'package missing' error message is confusing +- [COOK-645] RHEL6/CentOS6 - mysql cookbook contains 'skip-federated' directive which is unsupported on MySQL 5.1 + +## v1.2.0 + +- [COOK-684] remove mysql_database LWRP + +## v1.0.8 + +- [COOK-633] ensure "cloud" attribute is available + +## v1.0.7 + +- [COOK-614] expose all mysql tunable settings in config +- [COOK-617] bind to private IP if available + +## v1.0.6 + +- [COOK-605] install mysql-client package on ubuntu/debian + +## v1.0.5 + +- [COOK-465] allow optional remote root connections to mysql +- [COOK-455] improve platform version handling +- externalize conf_dir attribute for easier cross platform support +- change datadir attribute to data_dir for consistency + +## v1.0.4 + +- fix regressions on debian platform +- [COOK-578] wrap root password in quotes +- [COOK-562] expose all tunables in my.cnf diff --git a/chef/cookbooks/mysql/CONTRIBUTING.md b/chef/cookbooks/mysql/CONTRIBUTING.md new file mode 100644 index 0000000..ef2f2b8 --- /dev/null +++ b/chef/cookbooks/mysql/CONTRIBUTING.md @@ -0,0 +1,2 @@ +Please refer to +https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD diff --git a/chef/cookbooks/mysql/MAINTAINERS.md b/chef/cookbooks/mysql/MAINTAINERS.md new file mode 100644 index 0000000..b3548a4 --- /dev/null +++ b/chef/cookbooks/mysql/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 +* [Tim Smith](https://github.com/tas50) + +# 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) diff --git a/chef/cookbooks/mysql/README.md b/chef/cookbooks/mysql/README.md new file mode 100644 index 0000000..54aca85 --- /dev/null +++ b/chef/cookbooks/mysql/README.md @@ -0,0 +1,444 @@ +# MySQL Cookbook + +[![Build Status](https://travis-ci.org/chef-cookbooks/mysql.svg?branch=master)](https://travis-ci.org/chef-cookbooks/mysql) [![Cookbook Version](https://img.shields.io/cookbook/v/mysql.svg)](https://supermarket.chef.io/cookbooks/mysql) + +The Mysql Cookbook is a library cookbook that provides resource primitives (LWRPs) for use in recipes. It is designed to be a reference example for creating highly reusable cross-platform cookbooks. + +## Scope + +This cookbook is concerned with the "MySQL Community Server", particularly those shipped with F/OSS Unix and Linux distributions. It does not address forks or value-added repackaged MySQL distributions like Drizzle, MariaDB, or Percona. + +## Requirements + +- Chef 12.5 or higher +- Network accessible package repositories +- 'recipe[selinux::disabled]' on RHEL platforms + +## Platform Support + +The following platforms have been tested with Test Kitchen: + +``` +|----------------+-----+-----+-----+-----+-----| +| | 5.0 | 5.1 | 5.5 | 5.6 | 5.7 | +|----------------+-----+-----+-----+-----+-----| +| debian-7 | | | X | | | +|----------------+-----+-----+-----+-----+-----| +| debian-8 | | | X | | | +|----------------+-----+-----+-----+-----+-----| +| ubuntu-12.04 | | | X | | | +|----------------+-----+-----+-----+-----+-----| +| ubuntu-14.04 | | | X | X | | +|----------------+-----+-----+-----+-----+-----| +| ubuntu-16.04 | | | | | X | +|----------------+-----+-----+-----+-----+-----| +| centos-5 | X | X | X | X | X | +|----------------+-----+-----+-----+-----+-----| +| centos-6 | | X | X | X | X | +|----------------+-----+-----+-----+-----+-----| +| centos-7 | | | X | X | X | +|----------------+-----+-----+-----+-----+-----| +| fedora | | | | X | X | +|----------------+-----+-----+-----+-----+-----| +| openSUSE 13.2 | | | | X | | +|----------------+-----+-----+-----+-----+-----| +| openSUSE 42.1 | | | | X | | +|----------------+-----+-----+-----+-----+-----| +``` + +## Cookbook Dependencies + +There are no hard coupled dependencies. +However, there is a loose dependency on `yum-mysql-community` for RHEL/Centos platforms. +As of the 8.0 version of this cookbook, configuration of the package repos is now the +responsibility of the user. + +## Usage + +Place a dependency on the mysql cookbook in your cookbook's metadata.rb + +```ruby +depends 'mysql', '~> 8.0' +``` + +Then, in a recipe: + +```ruby +mysql_service 'foo' do + port '3306' + version '5.5' + initial_root_password 'change me' + action [:create, :start] +end +``` + +The service name on the OS is `mysql-foo`. You can manually start and stop it with `service mysql-foo start` and `service mysql-foo stop`. + +The configuration file is at `/etc/mysql-foo/my.cnf`. It contains the minimum options to get the service running. It looks like this. + +``` +# Chef generated my.cnf for instance mysql-foo + +[client] +default-character-set = utf8 +port = 3306 +socket = /var/run/mysql-foo/mysqld.sock + +[mysql] +default-character-set = utf8 + +[mysqld] +user = mysql +pid-file = /var/run/mysql-foo/mysqld.pid +socket = /var/run/mysql-foo/mysqld.sock +port = 3306 +datadir = /var/lib/mysql-foo +tmpdir = /tmp +log-error = /var/log/mysql-foo/error.log +!includedir /etc/mysql-foo/conf.d + +[mysqld_safe] +socket = /var/run/mysql-foo/mysqld.sock +``` + +You can put extra configuration into the conf.d directory by using the `mysql_config` resource, like this: + +```ruby +mysql_service 'foo' do + port '3306' + version '5.5' + initial_root_password 'change me' + action [:create, :start] +end + +mysql_config 'foo' do + source 'my_extra_settings.erb' + notifies :restart, 'mysql_service[foo]' + action :create +end +``` + +You are responsible for providing `my_extra_settings.erb` in your own cookbook's templates folder. + +## Connecting with the mysql CLI command + +Logging into the machine and typing `mysql` with no extra arguments will fail. You need to explicitly connect over the socket with `mysql -S /var/run/mysql-foo/mysqld.sock`, or over the network with `mysql -h 127.0.0.1` + +## Upgrading from older version of the mysql cookbook + +- It is strongly recommended that you rebuild the machine from scratch. This is easy if you have your `data_dir` on a dedicated mount point. If you _must_ upgrade in-place, follow the instructions below. +- The 6.x series supports multiple service instances on a single machine. It dynamically names the support directories and service names. `/etc/mysql becomes /etc/mysql-instance_name`. Other support directories in `/var` `/run` etc work the same way. Make sure to specify the `data_dir` property on the `mysql_service` resource to point to the old `/var/lib/mysql` directory. + +## Resources Overview + +### mysql_service + +The `mysql_service` resource manages the basic plumbing needed to get a MySQL server instance running with minimal configuration. + +The `:create` action handles package installation, support directories, socket files, and other operating system level concerns. The internal configuration file contains just enough to get the service up and running, then loads extra configuration from a conf.d directory. Further configurations are managed with the `mysql_config` resource. + +- If the `data_dir` is empty, a database will be initialized, and a +- root user will be set up with `initial_root_password`. If this +- directory already contains database files, no action will be taken. + +The `:start` action starts the service on the machine using the appropriate provider for the platform. The `:start` action should be omitted when used in recipes designed to build containers. + +#### Example + +```ruby +mysql_service 'default' do + version '5.7' + bind_address '0.0.0.0' + port '3306' + data_dir '/data' + initial_root_password 'Ch4ng3me' + action [:create, :start] +end +``` + +Please note that when using `notifies` or `subscribes`, the resource to reference is `mysql_service[name]`, not `service[mysql]`. + +#### Parameters + +- `charset` - specifies the default character set. Defaults to `utf8`. +- `data_dir` - determines where the actual data files are kept on the machine. This is useful when mounting external storage. When omitted, it will default to the platform's native location. +- `error_log` - Tunable location of the error_log +- `initial_root_password` - allows the user to specify the initial root password for mysql when initializing new databases. This can be set explicitly in a recipe, driven from a node attribute, or from data_bags. When omitted, it defaults to `ilikerandompasswords`. Please be sure to change it. +- `instance` - A string to identify the MySQL service. By convention, to allow for multiple instances of the `mysql_service`, directories and files on disk are named `mysql-`. Defaults to the resource name. +- `package_action` - Defaults to `:install`. +- `package_name` - Defaults to a value looked up in an internal map. +- `package_version` - Specific version of the package to install,passed onto the underlying package manager. Defaults to `nil`. +- `bind_address` - determines the listen IP address for the mysqld service. When omitted, it will be determined by MySQL. If the address is "regular" IPv4/IPv6address (e.g 127.0.0.1 or ::1), the server accepts TCP/IP connections only for that particular address. If the address is "0.0.0.0" (IPv4) or "::" (IPv6), the server accepts TCP/IP connections on all IPv4 or IPv6 interfaces. +- `mysqld_options` - A key value hash of options to be rendered into the main my.cnf. WARNING - It is highly recommended that you use the `mysql_config` resource instead of sending extra config into a `mysql_service` resource. This will allow you to set up notifications and subscriptions between the service and its configuration. That being said, this can be useful for adding extra options needed for database initialization at first run. +- `port` - determines the listen port for the mysqld service. When omitted, it will default to '3306'. +- `run_group` - The name of the system group the `mysql_service` should run as. Defaults to 'mysql'. +- `run_user` - The name of the system user the `mysql_service` should run as. Defaults to 'mysql'. +- `pid_file` - Tunable location of the pid file. +- `socket` - determines where to write the socket file for the `mysql_service` instance. Useful when configuring clients on the same machine to talk over socket and skip the networking stack. Defaults to a calculated value based on platform and instance name. +- `tmp_dir` - Tunable location of the tmp_dir +- `version` - allows the user to select from the versions available for the platform, where applicable. When omitted, it will install the default MySQL version for the target platform. Available version numbers are `5.0`, `5.1`, `5.5`, `5.6`, and `5.7`, depending on platform. + +#### Actions + +- `:create` - Configures everything but the underlying operating system service. +- `:delete` - Removes everything but the package and data_dir. +- `:start` - Starts the underlying operating system service +- `:stop`- Stops the underlying operating system service +- `:restart` - Restarts the underlying operating system service +- `:reload` - Reloads the underlying operating system service + +#### Providers + +Chef selects the appropriate provider based on platform and version, but you can specify one if your platform support it. + +```ruby +mysql_service[instance-1] do + port '1234' + data_dir '/mnt/lottadisk' + provider Chef::Provider::MysqlServiceSysvinit + action [:create, :start] +end +``` + +- `Chef::Provider::MysqlServiceBase` - Configures everything needed to run a MySQL service except the platform service facility. This provider should never be used directly. The `:start`, `:stop`, `:restart`, and `:reload` actions are stubs meant to be overridden by the providers below. +- `Chef::Provider::MysqlServiceSmf` - Starts a `mysql_service` using the Service Management Facility, used by Solaris and Illumos. Manages the FMRI and method script. +- `Chef::Provider::MysqlServiceSystemd` - Starts a `mysql_service` using SystemD. Manages the unit file and activation state +- `Chef::Provider::MysqlServiceSysvinit` - Starts a `mysql_service` using SysVinit. Manages the init script and status. +- `Chef::Provider::MysqlServiceUpstart` - Starts a `mysql_service` using Upstart. Manages job definitions and status. + +### mysql_config + +The `mysql_config` resource is a wrapper around the core Chef `template` resource. Instead of a `path` parameter, it uses the `instance` parameter to calculate the path on the filesystem where file is rendered. + +#### Example + +```ruby +mysql_config[default] do + source 'site.cnf.erb' + action :create +end +``` + +#### Parameters + +- `config_name` - The base name of the configuration file to be rendered into the conf.d directory on disk. Defaults to the resource name. +- `cookbook` - The name of the cookbook to look for the template source. Defaults to nil +- `group` - System group for file ownership. Defaults to 'mysql'. +- `instance` - Name of the `mysql_service` instance the config is meant for. Defaults to 'default'. +- `owner` - System user for file ownership. Defaults to 'mysql'. +- `source` - Template in cookbook to be rendered. +- `variables` - Variables to be passed to the underlying `template` resource. +- `version` - Version of the `mysql_service` instance the config is meant for. Used to calculate path. Only necessary when using packages with unique configuration paths, such as RHEL Software Collections or OmniOS. Defaults to 'nil' + +#### Actions + +- `:create` - Renders the template to disk at a path calculated using the instance parameter. +- `:delete` - Deletes the file from the conf.d directory calculated using the instance parameter. + +#### More Examples + +```ruby +mysql_service 'instance-1' do + action [:create, :start] +end + +mysql_service 'instance-2' do + action [:create, :start] +end + +mysql_config 'logging' do + instance 'instance-1' + source 'logging.cnf.erb' + action :create + notifies :restart, 'mysql_service[instance-1]' +end + +mysql_config 'security settings for instance-2' do + config_name 'security' + instance 'instance-2' + source 'security_stuff.cnf.erb' + variables(:foo => 'bar') + action :create + notifies :restart, 'mysql_service[instance-2]' +end +``` + +### mysql_client + +The `mysql_client` resource manages the MySQL client binaries and development libraries. + +It is an example of a "singleton" resource. Declaring two `mysql_client` resources on a machine usually won't yield two separate copies of the client binaries, except for platforms that support multiple versions (RHEL SCL, OmniOS). + +#### Example + +```ruby +mysql_client 'default' do + action :create +end +``` + +#### Properties + +- `package_name` - An array of packages to be installed. Defaults to a value looked up in an internal map. +- `package_version` - Specific versions of the package to install, passed onto the underlying package manager. Defaults to `nil`. +- `version` - Major MySQL version number of client packages. Only valid on for platforms that support multiple versions, such as RHEL via Software Collections and OmniOS. + +#### Actions + +- `:create` - Installs the client software +- `:delete` - Removes the client software + +## Advanced Usage Examples + +There are a number of configuration scenarios supported by the use of resource primitives in recipes. For example, you might want to run multiple MySQL services, as different users, and mount block devices that contain pre-existing databases. + +### Multiple Instances as Different Users + +```ruby +# instance-1 +user 'alice' do + action :create +end + +directory '/mnt/data/mysql/instance-1' do + owner 'alice' + action :create +end + +mount '/mnt/data/mysql/instance-1' do + device '/dev/sdb1' + fstype 'ext4' + action [:mount, :enable] +end + +mysql_service 'instance-1' do + port '3307' + run_user 'alice' + data_dir '/mnt/data/mysql/instance-1' + action [:create, :start] +end + +mysql_config 'site config for instance-1' do + instance 'instance-1' + source 'instance-1.cnf.erb' + notifies :restart, 'mysql_service[instance-1]' +end + +# instance-2 +user 'bob' do + action :create +end + +directory '/mnt/data/mysql/instance-2' do + owner 'bob' + action :create +end + +mount '/mnt/data/mysql/instance-2' do + device '/dev/sdc1' + fstype 'ext3' + action [:mount, :enable] +end + +mysql_service 'instance-2' do + port '3308' + run_user 'bob' + data_dir '/mnt/data/mysql/instance-2' + action [:create, :start] +end + +mysql_config 'site config for instance-2' do + instance 'instance-2' + source 'instance-2.cnf.erb' + notifies :restart, 'mysql_service[instance-2]' +end +``` + +### Replication Testing + +Use multiple `mysql_service` instances to test a replication setup. This particular example serves as a smoke test in Test Kitchen because it exercises different resources and requires service restarts. + + + +## Frequently Asked Questions + +### How do I run this behind my firewall? + +On Linux, the `mysql_service` resource uses the platform's underlying package manager to install software. For this to work behind firewalls, you'll need to either: + +- Configure the system yum/apt utilities to use a proxy server that +- can reach the Internet +- Host a package repository on a network that the machine can talk to + +On the RHEL platform_family, applying the `yum::default` recipe will allow you to drive the `yum_globalconfig` resource with attributes to change the global yum proxy settings. + +If hosting repository mirrors, applying one of the following recipes and adjust the settings with node attributes. + +- `recipe[yum-centos::default]` from the Supermarket + + + + + +- `recipe[yum-mysql-community::default]` from the Supermarket + + + + + +### The mysql command line doesn't work + +If you log into the machine and type `mysql`, you may see an error like this one: + +`Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock'` + +This is because MySQL is hardcoded to read the defined default my.cnf file, typically at /etc/my.cnf, and this LWRP deletes it to prevent overlap among multiple MySQL configurations. + +To connect to the socket from the command line, check the socket in the relevant my.cnf file and use something like this: + +`mysql -S /var/run/mysql-foo/mysqld.sock -Pwhatever` + +Or to connect over the network, use something like this: connect over the network.. + +`mysql -h 127.0.0.1 -Pwhatever` + +These network or socket ssettings can also be put in you $HOME/.my.cnf, if preferred. + +### What about MariaDB, Percona, Drizzle, WebScaleSQL, etc. + +MySQL forks are purposefully out of scope for this cookbook. This is mostly to reduce the testing matrix to a manageable size. Cookbooks for these technologies can easily be created by copying and adapting this cookbook. However, there will be differences. + +Package repository locations, package version names, software major version numbers, supported platform matrices, and the availability of software such as XtraDB and Galera are the main reasons that creating multiple cookbooks to make sense. + +## Warnings + +## Hacking / Testing / TODO + +Please refer to the HACKING.md + +## License & Authors + +- Author:: Joshua Timberman ([joshua@chef.io](mailto:joshua@chef.io)) +- Author:: AJ Christensen ([aj@chef.io](mailto:aj@chef.io)) +- Author:: Seth Chisamore ([schisamo@chef.io](mailto:schisamo@chef.io)) +- Author:: Brian Bianco ([brian.bianco@gmail.com](mailto:brian.bianco@gmail.com)) +- Author:: Jesse Howarth ([him@jessehowarth.com](mailto:him@jessehowarth.com)) +- Author:: Andrew Crump ([andrew@kotirisoftware.com](mailto:andrew@kotirisoftware.com)) +- Author:: Christoph Hartmann ([chris@lollyrock.com](mailto:chris@lollyrock.com)) +- Author:: Sean OMeara ([sean@sean.io](mailto:sean@sean.io)) + +```text +Copyright:: 2009-2014 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/chef/cookbooks/mysql/libraries/helpers.rb b/chef/cookbooks/mysql/libraries/helpers.rb new file mode 100644 index 0000000..b2f022b --- /dev/null +++ b/chef/cookbooks/mysql/libraries/helpers.rb @@ -0,0 +1,336 @@ +module MysqlCookbook + module HelpersBase + require 'shellwords' + + def el5? + return true if node['platform_family'] == 'rhel' && node['platform_version'].to_i == 5 + false + end + + 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 fc23? + return true if node['platform'] == 'fedora' && node['platform_version'].to_i == 23 + false + end + + def fc24? + return true if node['platform'] == 'fedora' && node['platform_version'].to_i == 24 + false + end + + def squeeze? + return true if node['platform'] == 'debian' && node['platform_version'].to_i == 6 + false + end + + def wheezy? + return true if node['platform'] == 'debian' && node['platform_version'].to_i == 7 + false + end + + def jessie? + 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 xenial? + return true if node['platform'] == 'ubuntu' && node['platform_version'] == '16.04' + false + end + + def amazon? + return true if node['platform'] == 'amazon' + end + + def opensuse? + return true if node['platform'] == 'opensuse' + end + + def opensuseleap? + return true if node['platform'] == 'opensuseleap' + end + + def defaults_file + "#{etc_dir}/my.cnf" + end + + def default_data_dir + return "/opt/local/lib/#{mysql_name}" if node['os'] == 'solaris2' + return "/var/lib/#{mysql_name}" if node['os'] == 'linux' + return "/var/db/#{mysql_name}" if node['os'] == 'freebsd' + end + + def default_error_log + "#{log_dir}/error.log" + end + + def default_pid_file + "#{run_dir}/mysqld.pid" + end + + def default_major_version + # rhelish + return '5.0' if el5? + return '5.1' if el6? + return '5.6' if el7? + return '5.5' if amazon? + + # debian + return '5.1' if squeeze? + return '5.5' if wheezy? + return '5.5' if jessie? + + # ubuntu + return '5.5' if precise? + return '5.5' if trusty? + return '5.7' if xenial? + + # misc + return '5.6' if node['platform'] == 'freebsd' + return '5.6' if node['platform'] == 'fedora' + return '5.6' if node['platform_family'] == 'suse' + end + + def major_from_full(v) + v.split('.').shift(2).join('.') + end + + def mysql_name + "mysql-#{instance}" + end + + def default_socket_file + "#{run_dir}/mysqld.sock" + end + + def default_client_package_name + return ['mysql', 'mysql-devel'] if major_version == '5.0' && el5? + return ['mysql51-mysql', 'mysql51-mysql-libs'] if major_version == '5.1' && el5? + return ['mysql', 'mysql-devel'] if major_version == '5.1' && el6? + return ['mysql55-mysql', 'mysql55-mysql-devel'] if major_version == '5.5' && el5? + return ['mysql-client-5.5', 'libmysqlclient-dev'] if major_version == '5.5' && node['platform_family'] == 'debian' + return ['mysql-client-5.6', 'libmysqlclient-dev'] if major_version == '5.6' && node['platform_family'] == 'debian' + return ['mysql-client-5.7', 'libmysqlclient-dev'] if major_version == '5.7' && node['platform_family'] == 'debian' + return 'mysql-community-server-client' if major_version == '5.6' && node['platform_family'] == 'suse' + ['mysql-community-client', 'mysql-community-devel'] + end + + def default_server_package_name + return 'mysql-server' if major_version == '5.0' && el5? + return 'mysql51-mysql-server' if major_version == '5.1' && el5? + return 'mysql-server' if major_version == '5.1' && el6? + return 'mysql55-mysql-server' if major_version == '5.5' && el5? + return 'mysql-server-5.5' if major_version == '5.5' && node['platform_family'] == 'debian' + return 'mysql-server-5.6' if major_version == '5.6' && node['platform_family'] == 'debian' + return 'mysql-server-5.7' if major_version == '5.7' && node['platform_family'] == 'debian' + return 'mysql-community-server' if major_version == '5.6' && node['platform_family'] == 'suse' + 'mysql-community-server' + end + + def socket_dir + File.dirname(socket) + end + + def run_dir + return "#{prefix_dir}/var/run/#{mysql_name}" if node['platform_family'] == 'rhel' + return "/run/#{mysql_name}" if node['platform_family'] == 'debian' + "/var/run/#{mysql_name}" + end + + def prefix_dir + return "/opt/mysql#{pkg_ver_string}" if node['platform_family'] == 'omnios' + return '/opt/local' if node['platform_family'] == 'smartos' + return "/opt/rh/#{scl_name}/root" if scl_package? + end + + def scl_name + return unless node['platform_family'] == 'rhel' + return 'mysql51' if version == '5.1' && node['platform_version'].to_i == 5 + return 'mysql55' if version == '5.5' && node['platform_version'].to_i == 5 + end + + def scl_package? + return unless node['platform_family'] == 'rhel' + return true if version == '5.1' && node['platform_version'].to_i == 5 + return true if version == '5.5' && node['platform_version'].to_i == 5 + false + end + + def etc_dir + return "/opt/mysql#{pkg_ver_string}/etc/#{mysql_name}" if node['platform_family'] == 'omnios' + return "#{prefix_dir}/etc/#{mysql_name}" if node['platform_family'] == 'smartos' + "#{prefix_dir}/etc/#{mysql_name}" + end + + def base_dir + prefix_dir || '/usr' + end + + def system_service_name + return 'mysql51-mysqld' if node['platform_family'] == 'rhel' && scl_name == 'mysql51' + return 'mysql55-mysqld' if node['platform_family'] == 'rhel' && scl_name == 'mysql55' + return 'mysqld' if node['platform_family'] == 'rhel' + return 'mysqld' if node['platform_family'] == 'fedora' + return 'mysql' if node['platform_family'] == 'debian' + return 'mysql' if node['platform_family'] == 'suse' + return 'mysql' if node['platform_family'] == 'omnios' + return 'mysql' if node['platform_family'] == 'smartos' + end + + def v56plus + return false if version.split('.')[0].to_i < 5 + return false if version.split('.')[1].to_i < 6 + true + end + + def v57plus + return false if version.split('.')[0].to_i < 5 + return false if version.split('.')[1].to_i < 7 + true + end + + def default_include_dir + "#{etc_dir}/conf.d" + end + + def log_dir + return "/var/adm/log/#{mysql_name}" if node['platform_family'] == 'omnios' + "#{prefix_dir}/var/log/#{mysql_name}" + end + + def lc_messages_dir + end + + def init_records_script + # Note: shell-escaping passwords in a SQL file may cause corruption - eg + # mysql will read \& as &, but \% as \%. Just escape bare-minimum \ and ' + sql_escaped_password = root_password.gsub('\\') { '\\\\' }.gsub("'") { '\\\'' } + + <<-EOS + set -e + rm -rf /tmp/#{mysql_name} + mkdir /tmp/#{mysql_name} + + cat > /tmp/#{mysql_name}/my.sql <<-'EOSQL' +UPDATE mysql.user SET #{password_column_name}=PASSWORD('#{sql_escaped_password}')#{password_expired} WHERE user = 'root'; +DELETE FROM mysql.user WHERE USER LIKE ''; +DELETE FROM mysql.user WHERE user = 'root' and host NOT IN ('127.0.0.1', 'localhost'); +FLUSH PRIVILEGES; +DELETE FROM mysql.db WHERE db LIKE 'test%'; +DROP DATABASE IF EXISTS test ; +EOSQL + + #{db_init} + #{record_init} + + while [ ! -f #{pid_file} ] ; do sleep 1 ; done + kill `cat #{pid_file}` + while [ -f #{pid_file} ] ; do sleep 1 ; done + rm -rf /tmp/#{mysql_name} + EOS + end + + def password_column_name + return 'authentication_string' if v57plus + 'password' + end + + def root_password + if initial_root_password == '' + Chef::Log.info('Root password is empty') + return '' + end + initial_root_password + end + + def password_expired + return ", password_expired='N'" if v57plus + '' + end + + def db_init + return mysqld_initialize_cmd if v57plus + mysql_install_db_cmd + end + + def mysql_install_db_bin + return "#{base_dir}/scripts/mysql_install_db" if node['platform_family'] == 'omnios' + return "#{prefix_dir}/bin/mysql_install_db" if node['platform_family'] == 'smartos' + 'mysql_install_db' + end + + def mysql_install_db_cmd + cmd = mysql_install_db_bin + cmd << " --defaults-file=#{etc_dir}/my.cnf" + cmd << " --datadir=#{data_dir}" + cmd << ' --explicit_defaults_for_timestamp' if v56plus + return "scl enable #{scl_name} \"#{cmd}\"" if scl_package? + cmd + end + + def mysqladmin_bin + return "#{prefix_dir}/bin/mysqladmin" if node['platform_family'] == 'smartos' + return 'mysqladmin' if scl_package? + "#{prefix_dir}/usr/bin/mysqladmin" + end + + def mysqld_bin + return "#{prefix_dir}/libexec/mysqld" if node['platform_family'] == 'smartos' + return "#{base_dir}/bin/mysqld" if node['platform_family'] == 'omnios' + return '/usr/sbin/mysqld' if node['platform_family'] == 'fedora' && v56plus + return '/usr/libexec/mysqld' if node['platform_family'] == 'fedora' + return 'mysqld' if scl_package? + "#{prefix_dir}/usr/sbin/mysqld" + end + + def mysqld_initialize_cmd + cmd = mysqld_bin + cmd << " --defaults-file=#{etc_dir}/my.cnf" + cmd << ' --initialize' + cmd << ' --explicit_defaults_for_timestamp' if v56plus + return "scl enable #{scl_name} \"#{cmd}\"" if scl_package? + cmd + end + + def mysqld_safe_bin + return "#{prefix_dir}/bin/mysqld_safe" if node['platform_family'] == 'smartos' + return "#{base_dir}/bin/mysqld_safe" if node['platform_family'] == 'omnios' + return 'mysqld_safe' if scl_package? + "#{prefix_dir}/usr/bin/mysqld_safe" + end + + def record_init + cmd = v56plus ? mysqld_bin : mysqld_safe_bin + cmd << " --defaults-file=#{etc_dir}/my.cnf" + cmd << " --init-file=/tmp/#{mysql_name}/my.sql" + cmd << ' --explicit_defaults_for_timestamp' if v56plus + cmd << ' &' + return "scl enable #{scl_name} \"#{cmd}\"" if scl_package? + cmd + end + + def sensitive_supported? + Gem::Version.new(Chef::VERSION) >= Gem::Version.new('11.14.0') + end + end +end diff --git a/chef/cookbooks/mysql/libraries/matchers.rb b/chef/cookbooks/mysql/libraries/matchers.rb new file mode 100644 index 0000000..adf5e73 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/matchers.rb @@ -0,0 +1,71 @@ +if defined?(ChefSpec) + ChefSpec.define_matcher :mysql_config + ChefSpec.define_matcher :mysql_service + ChefSpec.define_matcher :mysql_client + + # mysql_client_client_installation_package + def install_mysql_client_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_client_installation_package, :create, resource_name) + end + + def remove_mysql_client_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_client_installation_package, :remove, resource_name) + end + + # mysql_server_server_installation_package + def install_mysql_server_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_server_installation_package, :install, resource_name) + end + + def remove_mysql_server_installation_package(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_server_installation_package, :remove, resource_name) + end + + ##### + # old + ##### + + # client + def create_mysql_client(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_client, :create, resource_name) + end + + def delete_mysql_client(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_client, :delete, resource_name) + end + + # mysql_config + def create_mysql_config(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_config, :create, resource_name) + end + + def delete_mysql_config(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_config, :delete, resource_name) + end + + # service + def create_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :create, resource_name) + end + + def delete_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :delete, resource_name) + end + + def start_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :start, resource_name) + end + + def stop_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :stop, resource_name) + end + + def restart_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :restart, resource_name) + end + + def reload_mysql_service(resource_name) + ChefSpec::Matchers::ResourceMatcher.new(:mysql_service, :reload, resource_name) + end + +end diff --git a/chef/cookbooks/mysql/libraries/mysql_base.rb b/chef/cookbooks/mysql/libraries/mysql_base.rb new file mode 100644 index 0000000..b04a129 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_base.rb @@ -0,0 +1,30 @@ +module MysqlCookbook + class MysqlBase < Chef::Resource + require_relative 'helpers' + + # All resources are composites + def whyrun_supported? + true + end + + ################ + # Type Constants + ################ + + Boolean = property_type( + is: [true, false], + default: false + ) unless defined?(Boolean) + + ################### + # Common Properties + ################### + property :run_group, String, default: 'mysql', desired_state: false + property :run_user, String, default: 'mysql', desired_state: false + property :version, String, default: lazy { default_major_version }, desired_state: false + property :include_dir, String, default: lazy { default_include_dir }, desired_state: false + property :major_version, String, default: lazy { major_from_full(version) }, desired_state: false + + declare_action_class + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_client_installation_package.rb b/chef/cookbooks/mysql/libraries/mysql_client_installation_package.rb new file mode 100644 index 0000000..1e1d946 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_client_installation_package.rb @@ -0,0 +1,31 @@ +module MysqlCookbook + class MysqlClientInstallationPackage < MysqlBase + # helper methods + require_relative 'helpers' + include MysqlCookbook::HelpersBase + + # Resource properties + resource_name :mysql_client_installation_package + provides :mysql_client_installation, os: 'linux' + provides :mysql_client, os: 'linux' + + property :package_name, [String, Array], default: lazy { default_client_package_name }, desired_state: false + property :package_options, [String, nil], desired_state: false + property :package_version, [String, nil], default: nil, desired_state: false + + # Actions + action :create do + package package_name do + version package_version if package_version + options package_options if package_options + action :install + end + end + + action :delete do + package package_name do + action :remove + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_config.rb b/chef/cookbooks/mysql/libraries/mysql_config.rb new file mode 100644 index 0000000..707119a --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_config.rb @@ -0,0 +1,56 @@ +module MysqlCookbook + class MysqlConfig < MysqlBase + resource_name :mysql_config + + property :config_name, String, name_property: true, desired_state: false + property :cookbook, String, desired_state: false + property :group, String, default: 'mysql', desired_state: false + property :instance, String, default: 'default', desired_state: false + property :owner, String, default: 'mysql', desired_state: false + property :source, String, desired_state: false + property :variables, [Hash], desired_state: false + property :version, String, default: lazy { default_major_version }, desired_state: false + + require_relative 'helpers' + include MysqlCookbook::HelpersBase + + provides :mysql_config + + action :create do + # hax because group property + g = Chef::Resource::Group.new(new_resource.group, run_context) + g.system true if name == 'mysql' + resource_collection.insert g + + user owner do + gid owner + system true if name == 'mysql' + action :create + end + + directory include_dir do + owner new_resource.owner + group new_resource.group + mode '0750' + recursive true + action :create + end + + template "#{include_dir}/#{config_name}.cnf" do + owner new_resource.owner + group new_resource.group + mode '0640' + variables(new_resource.variables) + source new_resource.source + cookbook cookbook + action :create + end + end + + action :delete do + file "#{include_dir}/#{config_name}.cnf" do + action :delete + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_server_installation_package.rb b/chef/cookbooks/mysql/libraries/mysql_server_installation_package.rb new file mode 100644 index 0000000..385e202 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_server_installation_package.rb @@ -0,0 +1,42 @@ +module MysqlCookbook + class MysqlServerInstallationPackage < MysqlBase + # Resource properties + resource_name :mysql_server_installation_package + provides :mysql_server_installation, os: 'linux' + + property :package_name, String, default: lazy { default_server_package_name }, desired_state: false + property :package_options, [String, nil], desired_state: false + property :package_version, [String, nil], default: nil, desired_state: false + + # helper methods + require_relative 'helpers' + include MysqlCookbook::HelpersBase + + # Actions + action :install do + package package_name do + version package_version if package_version + options package_options if package_options + notifies :install, 'package[perl-Sys-Hostname-Long]', :immediately if platform_family?('suse') + notifies :run, 'execute[Initial DB setup script]', :immediately if platform_family?('suse') + action :install + end + + package 'perl-Sys-Hostname-Long' do + action :nothing + end + + execute 'Initial DB setup script' do + environment 'INSTANCE' => new_resource.name + command '/usr/lib/mysql/mysql-systemd-helper install' + action :nothing + end + end + + action :delete do + package package_name do + action :remove + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_service.rb b/chef/cookbooks/mysql/libraries/mysql_service.rb new file mode 100644 index 0000000..e7a0cbf --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_service.rb @@ -0,0 +1,105 @@ +module MysqlCookbook + require_relative 'mysql_service_base' + class MysqlService < MysqlServiceBase + resource_name :mysql_service + + # installation type and service_manager + property :install_method, %w(package auto), default: 'auto', desired_state: false + property :service_manager, %w(sysvinit upstart systemd auto), default: 'auto', desired_state: false + + # mysql_server_installation + property :version, String, default: lazy { default_major_version }, desired_state: false + property :major_version, String, default: lazy { major_from_full(version) }, desired_state: false + property :package_name, String, default: lazy { default_package_name }, desired_state: false + property :package_options, [String, nil], desired_state: false + property :package_version, [String, nil], default: nil, desired_state: false + + ################ + # Helper Methods + ################ + + 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 = mysql_server_installation(name, &block) + when 'package' + install = mysql_server_installation_package(name, &block) + when 'none' + Chef::Log.info('Skipping Mysql installation. Assuming it was handled previously.') + return + end + copy_properties_to(install) + install + end + + def svc_manager(&block) + case service_manager + when 'auto' + svc = mysql_service_manager(name, &block) + when 'sysvinit' + svc = mysql_service_manager_sysvinit(name, &block) + when 'upstart' + svc = mysql_service_manager_upstart(name, &block) + when 'systemd' + svc = mysql_service_manager_systemd(name, &block) + end + copy_properties_to(svc) + svc + end + end + + ######### + # Actions + ######### + + action :create do + installation do + action :install + end + + svc_manager do + action :create + end + end + + action :start do + svc_manager do + action :start + end + end + + action :delete do + svc_manager do + action :delete + end + + installation do + action :delete + end + end + + action :restart do + svc_manager do + action :restart + end + end + + action :stop do + svc_manager do + action :stop + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_service_base.rb b/chef/cookbooks/mysql/libraries/mysql_service_base.rb new file mode 100644 index 0000000..7ec861d --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_service_base.rb @@ -0,0 +1,205 @@ +module MysqlCookbook + class MysqlServiceBase < MysqlBase + property :bind_address, String, desired_state: false + property :charset, String, default: 'utf8', desired_state: false + property :data_dir, String, default: lazy { default_data_dir }, desired_state: false + property :error_log, String, default: lazy { default_error_log }, desired_state: false + property :initial_root_password, String, default: 'ilikerandompasswords', desired_state: false + property :instance, String, name_property: true, desired_state: false + property :mysqld_options, Hash, default: {}, desired_state: false + property :pid_file, String, default: lazy { default_pid_file }, desired_state: false + property :port, [String, Integer], default: '3306', desired_state: false + property :socket, String, default: lazy { default_socket_file }, desired_state: false + property :tmp_dir, String, desired_state: false + + alias socket_file socket + + require_relative 'helpers' + include MysqlCookbook::HelpersBase + + # FIXME: comment about what this does + declare_action_class.class_eval do + def create_system_user + group 'mysql' do + action :create + end + + user 'mysql' do + gid 'mysql' + action :create + end + end + + def create_config + # require 'pry' ; binding.pry + + # Yak shaving secion. Account for random errata. + # + # Turns out that mysqld is hard coded to try and read + # /etc/mysql/my.cnf, and its presence causes problems when + # setting up multiple services. + file "#{prefix_dir}/etc/mysql/my.cnf" do + action :delete + end + + file "#{prefix_dir}/etc/my.cnf" do + action :delete + end + + # mysql_install_db is broken on 5.6.13 + link "#{prefix_dir}/usr/share/my-default.cnf" do + to "#{etc_dir}/my.cnf" + not_if { ::File.exist? "#{prefix_dir}/usr/share/my-default.cnf" } # FIXME: Chef bug? + action :create + end + + # Support directories + directory etc_dir do + owner run_user + group run_group + mode '0750' + recursive true + action :create + end + + directory include_dir do + owner run_user + group run_group + mode '0750' + recursive true + action :create + end + + directory run_dir do + owner run_user + group run_group + mode '0755' + recursive true + action :create + end + + directory log_dir do + owner run_user + group run_group + mode '0750' + recursive true + action :create + end + + directory data_dir do + owner run_user + group run_group + mode '0750' + recursive true + action :create + end + + # Main configuration file + template "#{etc_dir}/my.cnf" do + source 'my.cnf.erb' + cookbook 'mysql' + owner run_user + group run_group + mode '0600' + variables(config: new_resource) + action :create + end + end + + def initialize_database + # initialize database and create initial records + bash "#{name} initial records" do + code init_records_script + umask '022' + returns [0, 1, 2] # facepalm + not_if "/usr/bin/test -f #{data_dir}/mysql/user.frm" + action :run + end + end + + def delete_support_directories + # Stop the service before removing support directories + delete_stop_service + + directory etc_dir do + recursive true + action :delete + end + + directory run_dir do + recursive true + action :delete + end + + directory log_dir do + recursive true + action :delete + end + end + + # + # Platform specific bits + # + def configure_apparmor + # Do not add these resource if inside a container + # Only valid on Ubuntu + + unless ::File.exist?('/.dockerenv') || ::File.exist?('/.dockerinit') + if node['platform'] == 'ubuntu' + # Apparmor + package 'apparmor' do + action :install + end + + directory '/etc/apparmor.d/local/mysql' do + owner 'root' + group 'root' + mode '0755' + recursive true + action :create + end + + template '/etc/apparmor.d/local/usr.sbin.mysqld' do + cookbook 'mysql' + source 'apparmor/usr.sbin.mysqld-local.erb' + owner 'root' + group 'root' + mode '0644' + action :create + notifies :restart, "service[#{instance} apparmor]", :immediately + end + + template '/etc/apparmor.d/usr.sbin.mysqld' do + cookbook 'mysql' + source 'apparmor/usr.sbin.mysqld.erb' + owner 'root' + group 'root' + mode '0644' + action :create + notifies :restart, "service[#{instance} apparmor]", :immediately + end + + template "/etc/apparmor.d/local/mysql/#{instance}" do + cookbook 'mysql' + source 'apparmor/usr.sbin.mysqld-instance.erb' + owner 'root' + group 'root' + mode '0644' + variables( + config: new_resource, + mysql_name: mysql_name + ) + action :create + notifies :restart, "service[#{instance} apparmor]", :immediately + end + + service "#{instance} apparmor" do + service_name 'apparmor' + action :nothing + end + end + end + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_service_manager_systemd.rb b/chef/cookbooks/mysql/libraries/mysql_service_manager_systemd.rb new file mode 100644 index 0000000..ba0f235 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_service_manager_systemd.rb @@ -0,0 +1,160 @@ +module MysqlCookbook + class MysqlServiceManagerSystemd < MysqlServiceBase + resource_name :mysql_service_manager_systemd + + provides :mysql_service_manager, platform: 'fedora' + + provides :mysql_service_manager, platform: %w(redhat centos scientific) do |node| # ~FC005 + node['platform_version'].to_f >= 7.0 + end + + provides :mysql_service_manager, platform: 'debian' do |node| + node['platform_version'].to_f >= 8.0 + end + + provides :mysql_service_manager, platform: 'ubuntu' do |node| + node['platform_version'].to_f >= 15.04 + end + + provides :mysql_service_manager, platform: 'opensuse' do |node| + node['platform_version'].to_f >= 13.0 + end + + provides :mysql_service_manager, platform: 'opensuseleap' do |node| + node['platform_version'].to_f >= 42.0 + end + + action :create do + # from base + create_system_user + stop_system_service + create_config + configure_apparmor + initialize_database + end + + action :start do + # Needed for Debian / Ubuntu + directory '/usr/libexec' do + owner 'root' + group 'root' + mode '0755' + action :create + end + + # this script is called by the main systemd unit file, and + # spins around until the service is actually up and running. + template "/usr/libexec/#{mysql_name}-wait-ready" do + path "/usr/libexec/#{mysql_name}-wait-ready" + source 'systemd/mysqld-wait-ready.erb' + owner 'root' + group 'root' + mode '0755' + variables(socket_file: socket_file) + cookbook 'mysql' + action :create + end + + # this is the main systemd unit file + template "/etc/systemd/system/#{mysql_name}.service" do + path "/etc/systemd/system/#{mysql_name}.service" + source 'systemd/mysqld.service.erb' + owner 'root' + group 'root' + mode '0644' + variables( + config: new_resource, + etc_dir: etc_dir, + base_dir: base_dir, + mysqld_bin: mysqld_bin + ) + cookbook 'mysql' + notifies :run, "execute[#{instance} systemctl daemon-reload]", :immediately + action :create + end + + # avoid 'Unit file changed on disk' warning + execute "#{instance} systemctl daemon-reload" do + command '/bin/systemctl daemon-reload' + action :nothing + end + + # tmpfiles.d config so the service survives reboot + template "/usr/lib/tmpfiles.d/#{mysql_name}.conf" do + path "/usr/lib/tmpfiles.d/#{mysql_name}.conf" + source 'tmpfiles.d.conf.erb' + owner 'root' + group 'root' + mode '0644' + variables( + run_dir: run_dir, + run_user: run_user, + run_group: run_group + ) + cookbook 'mysql' + action :create + end + + # service management resource + service mysql_name.to_s do + service_name mysql_name + provider Chef::Provider::Service::Systemd + supports restart: true, status: true + action [:enable, :start] + end + end + + action :stop do + # service management resource + service mysql_name.to_s do + service_name mysql_name + provider Chef::Provider::Service::Systemd + supports status: true + action [:disable, :stop] + only_if { ::File.exist?("/usr/lib/systemd/system/#{mysql_name}.service") } + end + end + + action :restart do + # service management resource + service mysql_name.to_s do + service_name mysql_name + provider Chef::Provider::Service::Systemd + supports restart: true + action :restart + end + end + + action :reload do + # service management resource + service mysql_name.to_s do + service_name mysql_name + provider Chef::Provider::Service::Systemd + action :reload + end + end + + declare_action_class.class_eval do + def stop_system_service + # service management resource + service 'mysql' do + service_name system_service_name + provider Chef::Provider::Service::Systemd + supports status: true + action [:stop, :disable] + end + end + + def delete_stop_service + # service management resource + service mysql_name.to_s do + service_name mysql_name + provider Chef::Provider::Service::Systemd + supports status: true + action [:disable, :stop] + only_if { ::File.exist?("/usr/lib/systemd/system/#{mysql_name}.service") } + end + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_service_manager_sysvinit.rb b/chef/cookbooks/mysql/libraries/mysql_service_manager_sysvinit.rb new file mode 100644 index 0000000..58deae3 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_service_manager_sysvinit.rb @@ -0,0 +1,96 @@ +module MysqlCookbook + class MysqlServiceManagerSysvinit < MysqlServiceBase + resource_name :mysql_service_manager_sysvinit + + provides :mysql_service_manager, platform: %w(redhat centos scientific oracle) do |node| # ~FC005 + node['platform_version'].to_f <= 7.0 + end + + provides :mysql_service_manager, platform: 'suse' + provides :mysql_service_manager, platform: 'debian' + + action :create do + # from base + create_system_user + stop_system_service + create_config + initialize_database + configure_apparmor + end + + action :start do + template "/etc/init.d/#{mysql_name}" do + source 'sysvinit/mysqld.erb' + owner 'root' + group 'root' + mode '0755' + variables( + config: new_resource, + defaults_file: defaults_file, + error_log: error_log, + mysql_name: mysql_name, + mysqladmin_bin: mysqladmin_bin, + mysqld_safe_bin: mysqld_safe_bin, + pid_file: pid_file, + scl_name: scl_name + ) + cookbook 'mysql' + action :create + end + + service mysql_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + supports restart: true, status: true + action [:enable, :start] + end + end + + action :stop do + service mysql_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + supports restart: true, status: true + action [:stop] + end + end + + action :restart do + service mysql_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + supports restart: true + action :restart + end + end + + action :reload do + service mysql_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + action :reload + end + end + + declare_action_class.class_eval do + def stop_system_service + service system_service_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + supports status: true + action [:stop, :disable] + end + end + + def delete_stop_service + service mysql_name do + provider Chef::Provider::Service::Init::Redhat if node['platform_family'] == 'redhat' + provider Chef::Provider::Service::Init::Insserv if node['platform_family'] == 'debian' + supports status: true + action [:disable, :stop] + only_if { ::File.exist?("#{etc_dir}/init.d/#{mysql_name}") } + end + end + end + end +end diff --git a/chef/cookbooks/mysql/libraries/mysql_service_manager_upstart.rb b/chef/cookbooks/mysql/libraries/mysql_service_manager_upstart.rb new file mode 100644 index 0000000..4b496c4 --- /dev/null +++ b/chef/cookbooks/mysql/libraries/mysql_service_manager_upstart.rb @@ -0,0 +1,107 @@ +module MysqlCookbook + class MysqlServiceManagerUpstart < MysqlServiceBase + resource_name :mysql_service_manager_upstart + provides :mysql_service_manager, platform: 'ubuntu' + + action :create do + # from base + create_system_user + stop_system_service + create_config + configure_apparmor + initialize_database + end + + action :start do + template "/usr/sbin/#{mysql_name}-wait-ready" do + source 'upstart/mysqld-wait-ready.erb' + owner 'root' + group 'root' + mode '0755' + variables(socket_file: socket_file) + cookbook 'mysql' + action :create + end + + template "/etc/init/#{mysql_name}.conf" do + source 'upstart/mysqld.erb' + owner 'root' + group 'root' + mode '0644' + variables( + defaults_file: defaults_file, + mysql_name: mysql_name, + run_group: run_group, + run_user: run_user, + socket_dir: socket_dir + ) + cookbook 'mysql' + action :create + end + + service mysql_name do + provider Chef::Provider::Service::Upstart + supports status: true + action [:start] + end + end + + action :stop do + service mysql_name do + provider Chef::Provider::Service::Upstart + supports restart: true, status: true + action [:stop] + end + end + + action :restart do + # With Upstart, restarting the service doesn't behave "as expected". + # We want the post-start stanzas, which wait until the + # service is available before returning + # + # http://upstart.ubuntu.com/cookbook/#restart + service mysql_name do + provider Chef::Provider::Service::Upstart + action :stop + end + + service mysql_name do + provider Chef::Provider::Service::Upstart + action :start + end + end + + action :reload do + # With Upstart, reload just sends a HUP signal to the process. + # As far as I can tell, this doesn't work the way it's + # supposed to, so we need to actually restart the service. + service mysql_name do + provider Chef::Provider::Service::Upstart + action :stop + end + + service mysql_name do + provider Chef::Provider::Service::Upstart + action :start + end + end + + declare_action_class.class_eval do + def stop_system_service + service system_service_name do + provider Chef::Provider::Service::Upstart + supports status: true + action [:stop, :disable] + end + end + + def delete_stop_service + service mysql_name do + provider Chef::Provider::Service::Upstart + action [:disable, :stop] + only_if { ::File.exist?("#{etc_dir}/init/#{mysql_name}") } + end + end + end + end +end diff --git a/chef/cookbooks/mysql/metadata.json b/chef/cookbooks/mysql/metadata.json new file mode 100644 index 0000000..6a8b7e4 --- /dev/null +++ b/chef/cookbooks/mysql/metadata.json @@ -0,0 +1 @@ +{"name":"mysql","version":"8.2.0","description":"Provides mysql_service, mysql_config, and mysql_client resources","long_description":"","maintainer":"Chef Software, Inc.","maintainer_email":"cookbooks@chef.io","license":"Apache 2.0","platforms":{"amazon":">= 0.0.0","redhat":">= 0.0.0","centos":">= 0.0.0","scientific":">= 0.0.0","oracle":">= 0.0.0","fedora":">= 0.0.0","debian":">= 0.0.0","ubuntu":">= 0.0.0","suse":">= 0.0.0","opensuse":">= 0.0.0","opensuseleap":">= 0.0.0"},"dependencies":{},"recommendations":{},"suggestions":{},"conflicting":{},"providing":{},"replacing":{},"attributes":{},"groupings":{},"recipes":{}} \ No newline at end of file diff --git a/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-instance.erb b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-instance.erb new file mode 100644 index 0000000..130beb7 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-instance.erb @@ -0,0 +1,14 @@ +/etc/<%= @mysql_name %>/*.pem r, +/etc/<%= @mysql_name %>/conf.d/ r, +/etc/<%= @mysql_name %>/conf.d/* r, +/etc/<%= @mysql_name %>/my.cnf r, +<%= @config.log_dir %>/ r, +<%= @config.log_dir %>/* rw, +<%= @config.data_dir %>/ r, +<%= @config.data_dir %>/** rwk, +<%= @config.run_dir %>/** rw, +<%= @config.pid_file %> rw, +<%= @config.socket_file %> rw, +/tmp/<%= @mysql_name %>/ r, +/tmp/<%= @mysql_name %>/my.sql r, +<%= @config.tmp_dir %>/* rw, diff --git a/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-local.erb b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-local.erb new file mode 100644 index 0000000..b261920 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld-local.erb @@ -0,0 +1 @@ +#include diff --git a/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld.erb b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld.erb new file mode 100644 index 0000000..19ddbf5 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/apparmor/usr.sbin.mysqld.erb @@ -0,0 +1,47 @@ +# vim:syntax=apparmor +# Last Modified: Tue Jun 19 17:37:30 2007 +#include + +/usr/sbin/mysqld { + #include + #include + #include + #include + #include + + capability dac_override, + capability sys_resource, + capability setgid, + capability setuid, + + network tcp, + + /etc/hosts.allow r, + /etc/hosts.deny r, + + /etc/mysql/*.pem r, + /etc/mysql/conf.d/ r, + /etc/mysql/conf.d/* r, + /etc/mysql/*.cnf r, + /usr/lib/mysql/plugin/ r, + /usr/lib/mysql/plugin/*.so* mr, + /usr/sbin/mysqld mr, + /usr/share/mysql/** r, + /var/log/mysql.log rw, + /var/log/mysql.err rw, + /var/lib/mysql/ r, + /var/lib/mysql/** rwk, + /var/log/mysql/ r, + /var/log/mysql/* rw, + /var/run/mysqld/mysqld.pid rw, + /var/run/mysqld/mysqld.sock w, + /var/run/mysqld/mysqld.sock.lock rw, + /run/mysqld/mysqld.pid rw, + /run/mysqld/mysqld.sock w, + /run/mysqld/mysqld.sock.lock rw, + + /sys/devices/system/cpu/ r, + + # Site-specific additions and overrides. See local/README for details. + #include +} diff --git a/chef/cookbooks/mysql/templates/default/my.cnf.erb b/chef/cookbooks/mysql/templates/default/my.cnf.erb new file mode 100644 index 0000000..ff10156 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/my.cnf.erb @@ -0,0 +1,57 @@ +# Chef generated my.cnf for instance mysql-<%= @config.name %> + +[client] +<% if @config.charset %> +default-character-set = <%= @config.charset %> +<% end %> +<% if @config.port %> +port = <%= @config.port %> +<% end %> +<% if @config.socket_file %> +socket = <%= @config.socket_file %> +<% end %> + +[mysql] +<% if @config.charset %> +default-character-set = <%= @config.charset %> +<% end %> + +[mysqld] +<% if @config.run_user %> +user = <%= @config.run_user %> +<% end %> +<% if @config.pid_file %> +pid-file = <%= @config.pid_file %> +<% end %> +<% if @config.socket_file %> +socket = <%= @config.socket_file %> +<% end %> +<% if @config.bind_address %> +bind-address = <%= @config.bind_address %> +<% end %> +<% if @config.port %> +port = <%= @config.port %> +<% end %> +<% if @config.data_dir %> +datadir = <%= @config.data_dir %> +<% end %> +<% if @config.tmp_dir %> +tmpdir = <%= @config.tmp_dir %> +<% end %> +<% @config.mysqld_options.each do |option,value| %> +<%= option %> = <%= value %> +<% end %> +<% if @config.lc_messages_dir %> +lc-messages-dir = <%= @config.lc_messages_dir %> +<% end %> +<% if @config.error_log %> +log-error = <%= @config.error_log %> +<% end %> +<% if @config.include_dir %> +!includedir <%= @config.include_dir %> +<% end %> + +[mysqld_safe] +<% if @config.socket_file %> +socket = <%= @config.socket_file %> +<% end %> diff --git a/chef/cookbooks/mysql/templates/default/smf/svc.method.mysqld.erb b/chef/cookbooks/mysql/templates/default/smf/svc.method.mysqld.erb new file mode 100644 index 0000000..5cc178a --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/smf/svc.method.mysqld.erb @@ -0,0 +1,28 @@ +#!/sbin/sh +# +# Generated by Chef +# + +. /lib/svc/share/smf_include.sh + +ulimit -n 10240 + +case "$1" in +start) + <%= @mysqld_bin %> \ + --defaults-file=<%= @defaults_file %> \ + --basedir=<%= @base_dir %> \ + --datadir=<%= @data_dir %> \ + --pid-file=<%= @pid_file %> \ + --log-error=<%= @error_log %> & + ;; +stop) + [ -f <%= @pid_file %> ] && kill `/usr/bin/head -1 <%= @pid_file %>` + ;; +*) + echo "Usage: $0 {start|stop}" >&2 + exit 1 + ;; +esac + +exit $SMF_EXIT_OK diff --git a/chef/cookbooks/mysql/templates/default/systemd/mysqld-wait-ready.erb b/chef/cookbooks/mysql/templates/default/systemd/mysqld-wait-ready.erb new file mode 100644 index 0000000..a566bf3 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/systemd/mysqld-wait-ready.erb @@ -0,0 +1,30 @@ +#!/bin/sh + +daemon_pid="$1" + +# Wait for the server to come up or for the mysqld process to disappear +ret=0 +while /bin/true; do + RESPONSE=`/usr/bin/mysqladmin --no-defaults --socket="<%= @socket_file %>" --user=UNKNOWN_MYSQL_USER ping 2>&1` + mret=$? + if [ $mret -eq 0 ]; then + break + fi + # exit codes 1, 11 (EXIT_CANNOT_CONNECT_TO_SERVICE) are expected, + # anything else suggests a configuration error + if [ $mret -ne 1 -a $mret -ne 11 ]; then + ret=1 + break + fi + # "Access denied" also means the server is alive + echo "$RESPONSE" | grep -q "Access denied for user" && break + + # Check process still exists + if ! /bin/kill -0 $daemon_pid 2>/dev/null; then + ret=1 + break + fi + sleep 1 +done + +exit $ret diff --git a/chef/cookbooks/mysql/templates/default/systemd/mysqld.service.erb b/chef/cookbooks/mysql/templates/default/systemd/mysqld.service.erb new file mode 100644 index 0000000..f1fb6c1 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/systemd/mysqld.service.erb @@ -0,0 +1,16 @@ +[Unit] +Description=mysql_service[mysql-<%= @config.instance %>] +After=syslog.target +After=network.target + +[Service] +Type=simple +User=<%= @config.run_user %> +Group=<%= @config.run_group %> +ExecStart=<%= @mysqld_bin %> --defaults-file=<%= @etc_dir %>/my.cnf --basedir=<%= @base_dir %> +ExecStartPost=/usr/libexec/mysql-<%= @config.instance %>-wait-ready $MAINPID +TimeoutSec=300 +PrivateTmp=true + +[Install] +WantedBy=multi-user.target diff --git a/chef/cookbooks/mysql/templates/default/sysvinit/mysqld.erb b/chef/cookbooks/mysql/templates/default/sysvinit/mysqld.erb new file mode 100644 index 0000000..45b952d --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/sysvinit/mysqld.erb @@ -0,0 +1,279 @@ +#!/bin/bash +# +### BEGIN INIT INFO +# Provides: <%= @mysql_name %> +# Required-Start: $remote_fs $syslog +# Required-Stop: $remote_fs $syslog +# Should-Start: $network $time +# Should-Stop: $network $time +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: Start and stop the mysql database server daemon +# Description: Controls the main MySQL database server daemon "mysqld" +# and its wrapper script "mysqld_safe". +### END INIT INFO + +# set -e +# set -u + +### Exit code reference +# http://fedoraproject.org/wiki/Packaging:SysVInitScript +# http://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html + +# Source functions +<% if node['platform_family'] == 'rhel' %> +# Source RHEL function library. +. /etc/rc.d/init.d/functions +<% end %> + +#### +# Variables +#### + +STARTTIMEOUT=900 +STOPTIMEOUT=900 +PID_DELAY=60 + +#### +# Helper functions +### + +# Boolean function to see if MYSQL_PID exists and is a number +pid_exists() { + PID_EXISTS=1 + if [ -f <%= @pid_file %> ]; then + MYSQLD_PID=`cat <%= @pid_file %> 2>/dev/null` + if [ -n "$MYSQLD_PID" ] && [ -d "/proc/$MYSQLD_PID" ] ; then + PID_EXISTS=0 + fi + fi + return $PID_EXISTS +} + +# Use mysqladmin to ping the service as an invalid user over a socket +running() { + RUNNING=1 + RESPONSE=`<%= @mysqladmin_bin %> --defaults-file=<%= @defaults_file %> --user=UNKNOWN_MYSQL_USER ping 2>&1` + local mret=$? + if pid_exists \ + && [ $mret -eq 0 ] \ + || [ `echo $RESPONSE | grep -q "Access denied for user"` ]; then + RUNNING=0 + fi + return $RUNNING +} + +writable_error_log() { + WRITABLE_ERROR_LOG=1 + touch "<%= @error_log %>" 2>/dev/null + touchret=$? + if [ $touchret -eq 0 ]; then + chown <%= @config.run_user %>:<%= @config.run_group %> <%= @error_log %> + return 0 + else + return $WRITABLE_ERROR_LOG + fi +} + +print_start_success() { + <% if node['platform_family'] == 'rhel' %> + action $"Starting <%= @mysql_name %>: " /bin/true + <% else %> + echo "Staring MySQL instance <%= @mysql_name %>" + <% end %> + return 0; +} + +print_start_failure() { + <% if node['platform_family'] == 'rhel' %> + action $"Starting <%= @mysql_name %>: " /bin/false + <% else %> + echo "Could not start MySQL instance <%= @mysql_name %>" + <% end %> + return 0; +} + +print_reload_success() { + <% if node['platform_family'] == 'rhel' %> + action $"Reloading <%= @mysql_name %>" /bin/true + <% else %> + echo "Reload success for <%= @mysql_name %>" + <% end %> + return 0; +} + +print_reload_failure() { + <% if node['platform_family'] == 'rhel' %> + action $"Reloading <%= @mysql_name %>" /bin/false + <% else %> + echo "Reload failed for <%= @mysql_name %>" + <% end %> + return 0; +} + +print_stop_success() { + <% if node['platform_family'] == 'rhel' %> + action $"Stopping <%= @mysql_name %>: " /bin/true + <% else %> + echo "Stopping MySQL instance <%= @mysql_name %>" + <% end %> + return 0; +} + +print_stop_failure() { + <% if node['platform_family'] == 'rhel' %> + action $"Stopping <%= @mysql_name %>: " /bin/false + <% else %> + echo "Could not stop MySQL instance <%= @mysql_name %>" + <% end %> + return 0; +} + +start_command() { + # Attempt to start <%= @mysql_name %> + echo "Starting MySQL instance <%= @mysql_name %>" + + local scl_name="<%= @scl_name %>" + + if [ -z $scl_name ]; then + <%= @mysqld_safe_bin %> \ + --defaults-file=<%= @defaults_file %> \ + >/dev/null 2>&1 & + local pid=$! + else + scl enable $scl_name "<%= @mysqld_safe_bin %> \ + --defaults-file=<%= @defaults_file %> \ + >/dev/null 2>&1 &" + local pid=$! + fi + + return $pid +} + +#### +# Init script actions +### + +# Start <%= @mysql_name %> +start() { + # exit 0 if already running. + if running; then + print_start_success + return 0; + fi + + # exit 4 if we can't write to error_log + if ! writable_error_log; then + print_start_failure + return 4 + fi + + # run program + start_command; + start_pid=$? + + # Timeout loop + local TIMEOUT=$STARTTIMEOUT + while [ $TIMEOUT -gt 0 ]; do + if running; then + break + fi + + let CURRENT_DELAY=${STARTTIMEOUT}-${TIMEOUT} + if [ $CURRENT_DELAY -gt $PID_DELAY ] \ + && ! pid_exists; then + break + fi + + sleep 1 + let TIMEOUT=${TIMEOUT}-1 + done + + if running; then + # successbaby.gif + print_start_success + return 0 + elif ! pid_exists; then + # Handle startup failure + print_start_failure + return 3 + elif [ $TIMEOUT -eq 0 ]; then + # Handle timeout + print_start_failure + # clean up + kill $start_pid 2>/dev/null + return 1 + fi +} + +# Reload <%= @mysql_name %> +reload() { + <%= @mysqladmin_bin %> reload + local ret=$? + if [ $ret -eq 0 ]; then + print_reload_success; + else + print_reload_failure; + fi + return $ret +} + +# Status of <%= @mysql_name %> +status() { + if running; then + echo "<%= @mysql_name %> is running" + return 0 + else + echo "<%= @mysql_name %> is not running" + return 1 + fi +} + +# Stop <%= @mysql_name %> +stop() { + if running; then + echo "Stopping MySQL instance <%= @mysql_name %>" + if [ -f <%= @pid_file %> ]; then + /bin/kill `cat <%= @pid_file %> 2>/dev/null` + kstat=$? + fi + + # Timeout loop + local TIMEOUT=$STARTTIMEOUT + while [ $TIMEOUT -gt 0 ]; do + if [ -e <%= @pid_file %> ]; then + sleep 1 + fi + let TIMEOUT=${TIMEOUT}-1 + done + + return $kstat + else + echo "MySQL instance <%= @mysql_name %> Stopped." + return 0 + fi +} + +# main() +case "$1" in + start) + start + ;; + stop) + stop + ;; + status) + status + ;; + restart) + stop ; start + ;; + reload) + reload + ;; + *) + echo $"Usage: $0 {start|stop|status|restart|reload}" + exit 2 +esac + +exit $? diff --git a/chef/cookbooks/mysql/templates/default/tmpfiles.d.conf.erb b/chef/cookbooks/mysql/templates/default/tmpfiles.d.conf.erb new file mode 100644 index 0000000..59d0426 --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/tmpfiles.d.conf.erb @@ -0,0 +1 @@ +d <%= @run_dir %> 0755 <%= @run_user %> <%= @run_group %> - diff --git a/chef/cookbooks/mysql/templates/default/upstart/mysqld-wait-ready.erb b/chef/cookbooks/mysql/templates/default/upstart/mysqld-wait-ready.erb new file mode 100644 index 0000000..f99308f --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/upstart/mysqld-wait-ready.erb @@ -0,0 +1,22 @@ +#!/bin/sh + +# Wait for the server to come up +ret=0 +while /bin/true; do + RESPONSE=`/usr/bin/mysqladmin --no-defaults --socket="<%= @socket_file %>" --user=UNKNOWN_MYSQL_USER ping 2>&1` + mret=$? + if [ $mret -eq 0 ]; then + break + fi + # exit codes 1, 11 (EXIT_CANNOT_CONNECT_TO_SERVICE) are expected, + # anything else suggests a configuration error + if [ $mret -ne 1 -a $mret -ne 11 ]; then + ret=1 + break + fi + # "Access denied" also means the server is alive + echo "$RESPONSE" | grep -q "Access denied for user" && break + sleep 1 +done + +exit $ret diff --git a/chef/cookbooks/mysql/templates/default/upstart/mysqld.erb b/chef/cookbooks/mysql/templates/default/upstart/mysqld.erb new file mode 100644 index 0000000..4ac214c --- /dev/null +++ b/chef/cookbooks/mysql/templates/default/upstart/mysqld.erb @@ -0,0 +1,26 @@ +# <%= @mysql_name %> Service + +description "MySQL service <%= @mysql_name %>" +author "chef-client" + +start on runlevel [2345] +stop on starting rc RUNLEVEL=[016] + +respawn +respawn limit 2 5 + +env HOME=/etc/<%= @mysql_name %> +umask 007 + +kill timeout 300 + +pre-start script +[ -d /run/<%= @mysql_name %> ] || install -m 755 -o <%= @run_user %> -g <%= @run_group %> -d /run/<%= @mysql_name %> +[ -d <%= @socket_dir %> ] || install -m 755 -o <%= @run_user %> -g <%= @run_group %> -d <%= @socket_dir %> +end script + +exec /usr/sbin/mysqld --defaults-file=<%= @defaults_file %> + +post-start script +/usr/sbin/<%= @mysql_name %>-wait-ready +end script diff --git a/resources/apache_continuum/data.tar.gz b/resources/apache_continuum/data.tar.gz new file mode 100644 index 0000000..970dc69 Binary files /dev/null and b/resources/apache_continuum/data.tar.gz differ