chef 16.4.41 → 16.5.64
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/Rakefile +2 -2
- data/bin/knife +1 -1
- data/chef.gemspec +2 -1
- data/lib/chef/application.rb +18 -16
- data/lib/chef/application/apply.rb +12 -7
- data/lib/chef/application/base.rb +26 -23
- data/lib/chef/application/client.rb +10 -4
- data/lib/chef/application/exit_code.rb +13 -4
- data/lib/chef/application/knife.rb +22 -11
- data/lib/chef/application/solo.rb +2 -1
- data/lib/chef/application/windows_service.rb +14 -14
- data/lib/chef/application/windows_service_manager.rb +6 -6
- data/lib/chef/chef_fs/knife.rb +2 -2
- data/lib/chef/chef_fs/parallelizer.rb +0 -1
- data/lib/chef/client.rb +10 -11
- data/lib/chef/cookbook/cookbook_version_loader.rb +1 -1
- data/lib/chef/cookbook/synchronizer.rb +2 -2
- data/lib/chef/cookbook_site_streaming_uploader.rb +13 -11
- data/lib/chef/cookbook_uploader.rb +1 -1
- data/lib/chef/data_collector.rb +6 -5
- data/lib/chef/data_collector/config_validation.rb +22 -13
- data/lib/chef/data_collector/run_end_message.rb +2 -2
- data/lib/chef/data_collector/run_start_message.rb +1 -1
- data/lib/chef/deprecated.rb +1 -1
- data/lib/chef/deprecation/warnings.rb +2 -2
- data/lib/chef/digester.rb +2 -2
- data/lib/chef/dsl/chef_vault.rb +1 -1
- data/lib/chef/dsl/data_query.rb +2 -2
- data/lib/chef/dsl/platform_introspection.rb +1 -1
- data/lib/chef/encrypted_data_bag_item.rb +3 -4
- data/lib/chef/encrypted_data_bag_item/decryptor.rb +3 -3
- data/lib/chef/encrypted_data_bag_item/encryptor.rb +3 -3
- data/lib/chef/environment.rb +2 -2
- data/lib/chef/event_loggers/windows_eventlog.rb +2 -2
- data/lib/chef/exceptions.rb +4 -4
- data/lib/chef/file_access_control/windows.rb +5 -1
- data/lib/chef/formatters/doc.rb +7 -6
- data/lib/chef/formatters/error_inspectors/api_error_formatting.rb +6 -5
- data/lib/chef/formatters/error_inspectors/node_load_error_inspector.rb +3 -3
- data/lib/chef/formatters/error_inspectors/registration_error_inspector.rb +9 -9
- data/lib/chef/formatters/error_inspectors/resource_failure_inspector.rb +2 -2
- data/lib/chef/formatters/error_inspectors/run_list_expansion_error_inspector.rb +3 -3
- data/lib/chef/formatters/minimal.rb +5 -4
- data/lib/chef/http.rb +6 -4
- data/lib/chef/http/auth_credentials.rb +5 -1
- data/lib/chef/http/authenticator.rb +1 -1
- data/lib/chef/http/basic_client.rb +4 -2
- data/lib/chef/http/decompressor.rb +1 -1
- data/lib/chef/http/http_request.rb +7 -5
- data/lib/chef/http/socketless_chef_zero_client.rb +5 -2
- data/lib/chef/http/ssl_policies.rb +1 -1
- data/lib/chef/json_compat.rb +1 -1
- data/lib/chef/knife.rb +4 -4
- data/lib/chef/knife/bootstrap.rb +16 -14
- data/lib/chef/knife/bootstrap/chef_vault_handler.rb +1 -1
- data/lib/chef/knife/bootstrap/templates/chef-full.erb +3 -3
- data/lib/chef/knife/bootstrap/templates/windows-chef-client-msi.erb +7 -7
- data/lib/chef/knife/client_create.rb +3 -3
- data/lib/chef/knife/config_get.rb +8 -97
- data/lib/chef/knife/config_get_profile.rb +9 -9
- data/lib/chef/knife/config_list.rb +139 -0
- data/lib/chef/knife/config_list_profiles.rb +8 -98
- data/lib/chef/knife/config_show.rb +127 -0
- data/lib/chef/knife/config_use.rb +61 -0
- data/lib/chef/knife/config_use_profile.rb +9 -24
- data/lib/chef/knife/configure.rb +2 -2
- data/lib/chef/knife/core/bootstrap_context.rb +2 -2
- data/lib/chef/knife/core/object_loader.rb +1 -1
- data/lib/chef/knife/core/windows_bootstrap_context.rb +11 -11
- data/lib/chef/knife/exec.rb +2 -2
- data/lib/chef/knife/node_show.rb +2 -2
- data/lib/chef/knife/serve.rb +3 -3
- data/lib/chef/knife/ssh.rb +16 -1
- data/lib/chef/knife/ssl_check.rb +3 -3
- data/lib/chef/knife/status.rb +2 -2
- data/lib/chef/knife/user_create.rb +2 -2
- data/lib/chef/knife/yaml_convert.rb +1 -1
- data/lib/chef/local_mode.rb +2 -2
- data/lib/chef/log/syslog.rb +2 -2
- data/lib/chef/log/winevt.rb +2 -2
- data/lib/chef/mixin/deep_merge.rb +0 -12
- data/lib/chef/mixin/openssl_helper.rb +1 -4
- data/lib/chef/mixin/template.rb +2 -2
- data/lib/chef/mixin/uris.rb +2 -2
- data/lib/chef/mixin/versioned_api.rb +1 -2
- data/lib/chef/monkey_patches/net_http.rb +4 -4
- data/lib/chef/node_map.rb +2 -2
- data/lib/chef/policy_builder/policyfile.rb +2 -2
- data/lib/chef/provider.rb +0 -4
- data/lib/chef/provider/file.rb +2 -2
- data/lib/chef/provider/ifconfig.rb +1 -1
- data/lib/chef/provider/launchd.rb +2 -2
- data/lib/chef/provider/mount/linux.rb +63 -0
- data/lib/chef/provider/package/rubygems.rb +21 -18
- data/lib/chef/provider/package/snap.rb +0 -1
- data/lib/chef/provider/package/windows.rb +2 -2
- data/lib/chef/provider/package/windows/registry_uninstall_entry.rb +3 -1
- data/lib/chef/provider/package/zypper.rb +1 -1
- data/lib/chef/provider/remote_file/content.rb +3 -0
- data/lib/chef/provider/remote_file/ftp.rb +6 -4
- data/lib/chef/provider/remote_file/sftp.rb +6 -4
- data/lib/chef/provider/route.rb +2 -6
- data/lib/chef/provider/service/macosx.rb +2 -2
- data/lib/chef/provider/template_finder.rb +2 -10
- data/lib/chef/provider/user/dscl.rb +3 -3
- data/lib/chef/provider/user/mac.rb +1 -1
- data/lib/chef/provider/windows_task.rb +1 -2
- data/lib/chef/provider/zypper_repository.rb +2 -2
- data/lib/chef/provider_resolver.rb +1 -1
- data/lib/chef/providers.rb +1 -0
- data/lib/chef/recipe.rb +2 -2
- data/lib/chef/resource.rb +1 -1
- data/lib/chef/resource/apt_repository.rb +1 -1
- data/lib/chef/resource/bff_package.rb +22 -0
- data/lib/chef/resource/breakpoint.rb +57 -2
- data/lib/chef/resource/build_essential.rb +1 -1
- data/lib/chef/resource/cab_package.rb +29 -0
- data/lib/chef/resource/chef_client_cron.rb +32 -25
- data/lib/chef/resource/chef_client_launchd.rb +194 -0
- data/lib/chef/resource/chef_client_scheduled_task.rb +21 -18
- data/lib/chef/resource/chef_client_systemd_timer.rb +24 -17
- data/lib/chef/resource/chef_client_trusted_certificate.rb +101 -0
- data/lib/chef/resource/chef_gem.rb +10 -10
- data/lib/chef/resource/chef_handler.rb +148 -4
- data/lib/chef/resource/chef_sleep.rb +2 -2
- data/lib/chef/resource/chef_vault_secret.rb +1 -1
- data/lib/chef/resource/cookbook_file.rb +2 -2
- data/lib/chef/resource/cron/cron_d.rb +0 -1
- data/lib/chef/resource/dnf_package.rb +2 -2
- data/lib/chef/resource/dsc_resource.rb +0 -1
- data/lib/chef/resource/dsc_script.rb +2 -2
- data/lib/chef/resource/execute.rb +6 -6
- data/lib/chef/resource/file.rb +4 -4
- data/lib/chef/resource/gem_package.rb +5 -5
- data/lib/chef/resource/homebrew_package.rb +3 -3
- data/lib/chef/resource/homebrew_update.rb +5 -5
- data/lib/chef/resource/hostname.rb +2 -2
- data/lib/chef/resource/launchd.rb +2 -1
- data/lib/chef/resource/locale.rb +2 -2
- data/lib/chef/resource/macos_userdefaults.rb +3 -3
- data/lib/chef/resource/notify_group.rb +0 -1
- data/lib/chef/resource/ohai.rb +46 -3
- data/lib/chef/resource/ohai_hint.rb +33 -0
- data/lib/chef/resource/openssl_dhparam.rb +27 -5
- data/lib/chef/resource/openssl_ec_private_key.rb +6 -3
- data/lib/chef/resource/openssl_ec_public_key.rb +2 -2
- data/lib/chef/resource/openssl_rsa_private_key.rb +6 -3
- data/lib/chef/resource/openssl_x509_certificate.rb +14 -14
- data/lib/chef/resource/openssl_x509_crl.rb +19 -10
- data/lib/chef/resource/openssl_x509_request.rb +14 -16
- data/lib/chef/resource/osx_profile.rb +77 -13
- data/lib/chef/resource/plist.rb +1 -1
- data/lib/chef/resource/powershell_package_source.rb +5 -5
- data/lib/chef/resource/reboot.rb +2 -2
- data/lib/chef/resource/remote_file.rb +3 -3
- data/lib/chef/resource/rhsm_register.rb +22 -10
- data/lib/chef/resource/ruby_block.rb +2 -2
- data/lib/chef/resource/scm/subversion.rb +2 -2
- data/lib/chef/resource/service.rb +3 -3
- data/lib/chef/resource/ssh_known_hosts_entry.rb +2 -2
- data/lib/chef/resource/support/cron.d.erb +1 -1
- data/lib/chef/resource/support/cron_access.erb +1 -1
- data/lib/chef/resource/support/sudoer.erb +1 -1
- data/lib/chef/resource/support/ulimit.erb +1 -1
- data/lib/chef/resource/sysctl.rb +1 -5
- data/lib/chef/resource/systemd_unit.rb +2 -2
- data/lib/chef/resource/template.rb +2 -2
- data/lib/chef/resource/windows_ad_join.rb +10 -3
- data/lib/chef/resource/windows_certificate.rb +6 -4
- data/lib/chef/resource/windows_firewall_profile.rb +22 -20
- data/lib/chef/resource/windows_package.rb +28 -5
- data/lib/chef/resource/windows_printer.rb +5 -3
- data/lib/chef/resource/windows_printer_port.rb +6 -4
- data/lib/chef/resource/windows_user_privilege.rb +53 -54
- data/lib/chef/resource/windows_workgroup.rb +3 -3
- data/lib/chef/resource/yum_package.rb +2 -2
- data/lib/chef/resources.rb +3 -1
- data/lib/chef/run_context.rb +2 -2
- data/lib/chef/run_context/cookbook_compiler.rb +1 -1
- data/lib/chef/run_lock.rb +2 -2
- data/lib/chef/search/query.rb +4 -5
- data/lib/chef/shell.rb +31 -26
- data/lib/chef/shell/ext.rb +11 -11
- data/lib/chef/shell/shell_session.rb +2 -2
- data/lib/chef/train_transport.rb +5 -104
- data/lib/chef/util/diff.rb +3 -3
- data/lib/chef/util/powershell/cmdlet.rb +3 -1
- data/lib/chef/util/powershell/ps_credential.rb +18 -14
- data/lib/chef/util/threaded_job_queue.rb +0 -2
- data/lib/chef/version.rb +1 -1
- data/lib/chef/win32/crypto.rb +1 -1
- data/lib/chef/win32/registry.rb +1 -2
- data/spec/data/shef-config.rb +1 -1
- data/spec/functional/event_loggers/windows_eventlog_spec.rb +6 -5
- data/spec/functional/resource/aix_service_spec.rb +2 -2
- data/spec/functional/resource/aixinit_service_spec.rb +1 -1
- data/spec/functional/resource/insserv_spec.rb +1 -1
- data/spec/functional/resource/user/dscl_spec.rb +1 -1
- data/spec/functional/resource/user/mac_user_spec.rb +1 -1
- data/spec/functional/resource/windows_task_spec.rb +13 -13
- data/spec/functional/version_spec.rb +3 -3
- data/spec/integration/client/client_spec.rb +4 -4
- data/spec/integration/client/exit_code_spec.rb +3 -2
- data/spec/integration/client/ipv6_spec.rb +1 -1
- data/spec/integration/knife/{config_list_profiles_spec.rb → config_list_spec.rb} +30 -29
- data/spec/integration/knife/{config_get_spec.rb → config_show_spec.rb} +3 -3
- data/spec/integration/knife/{config_use_profile_spec.rb → config_use_spec.rb} +53 -10
- data/spec/integration/knife/cookbook_api_ipv6_spec.rb +1 -1
- data/spec/integration/ohai/ohai_spec.rb +61 -0
- data/spec/integration/recipes/remote_directory.rb +1 -1
- data/spec/integration/solo/solo_spec.rb +5 -5
- data/spec/spec_helper.rb +6 -3
- data/spec/stress/win32/file_spec.rb +1 -1
- data/spec/support/chef_helpers.rb +2 -2
- data/spec/support/matchers/leak.rb +2 -2
- data/spec/support/platform_helpers.rb +16 -34
- data/spec/support/shared/functional/securable_resource.rb +108 -27
- data/spec/support/shared/functional/win32_service.rb +1 -1
- data/spec/support/shared/unit/application_dot_d.rb +5 -3
- data/spec/tiny_server.rb +0 -1
- data/spec/unit/application/client_spec.rb +2 -2
- data/spec/unit/application/exit_code_spec.rb +10 -0
- data/spec/unit/application_spec.rb +4 -6
- data/spec/unit/chef_fs/parallelizer_spec.rb +5 -1
- data/spec/unit/chef_fs/path_util_spec.rb +1 -1
- data/spec/unit/cookbook/synchronizer_spec.rb +2 -2
- data/spec/unit/cookbook_spec.rb +2 -2
- data/spec/unit/data_collector/config_validation_spec.rb +208 -0
- data/spec/unit/data_collector_spec.rb +0 -113
- data/spec/unit/dsl/declare_resource_spec.rb +1 -1
- data/spec/unit/file_access_control_spec.rb +1 -1
- data/spec/unit/knife/bootstrap_spec.rb +6 -6
- data/spec/unit/knife/core/ui_spec.rb +1 -0
- data/spec/unit/knife/ssh_spec.rb +2 -2
- data/spec/unit/lwrp_spec.rb +3 -3
- data/spec/unit/mixin/deep_merge_spec.rb +15 -0
- data/spec/unit/mixin/openssl_helper_spec.rb +1 -1
- data/spec/unit/mixin/powershell_exec_spec.rb +1 -1
- data/spec/unit/mixin/securable_spec.rb +2 -2
- data/spec/unit/node/immutable_collections_spec.rb +2 -2
- data/spec/unit/provider/mount/linux_spec.rb +97 -0
- data/spec/unit/provider/package/chocolatey_spec.rb +1 -1
- data/spec/unit/provider/package/powershell_spec.rb +1 -1
- data/spec/unit/provider/package/rubygems_spec.rb +4 -1
- data/spec/unit/provider/route_spec.rb +0 -2
- data/spec/unit/recipe_spec.rb +1 -1
- data/spec/unit/resource/chef_client_cron_spec.rb +35 -14
- data/spec/unit/resource/chef_client_launchd_spec.rb +127 -0
- data/spec/unit/resource/chef_client_systemd_timer_spec.rb +36 -1
- data/spec/unit/resource/chef_client_trusted_certificate_spec.rb +54 -0
- data/spec/unit/resource/launchd_spec.rb +8 -0
- data/spec/unit/resource/osx_profile_spec.rb +67 -1
- data/spec/unit/resource/rhsm_register_spec.rb +56 -18
- data/spec/unit/resource/windows_uac_spec.rb +1 -1
- data/spec/unit/resource/windows_user_privilege_spec.rb +55 -0
- data/spec/unit/run_lock_spec.rb +5 -1
- data/spec/unit/runner_spec.rb +1 -2
- data/spec/unit/shell/shell_ext_spec.rb +46 -3
- data/spec/unit/shell/shell_session_spec.rb +35 -64
- data/spec/unit/shell_spec.rb +16 -19
- data/spec/unit/train_transport_spec.rb +14 -13
- data/spec/unit/util/selinux_spec.rb +2 -0
- data/tasks/rspec.rb +0 -2
- metadata +41 -17
- data/lib/chef/dist.rb +0 -68
- data/spec/integration/knife/config_get_profile_spec.rb +0 -114
@@ -0,0 +1,194 @@
|
|
1
|
+
#
|
2
|
+
# Copyright:: Copyright (c) Chef Software Inc.
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
require_relative "../resource"
|
18
|
+
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
|
19
|
+
class Chef
|
20
|
+
class Resource
|
21
|
+
class ChefClientLaunchd < Chef::Resource
|
22
|
+
unified_mode true
|
23
|
+
|
24
|
+
provides :chef_client_launchd
|
25
|
+
|
26
|
+
description "Use the **chef_client_launchd** resource to configure the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule."
|
27
|
+
introduced "16.5"
|
28
|
+
examples <<~DOC
|
29
|
+
**Set the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule**:
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
chef_client_launchd 'Setup the #{ChefUtils::Dist::Infra::PRODUCT} to run every 30 minutes' do
|
33
|
+
interval 30
|
34
|
+
action :enable
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
**Disable the #{ChefUtils::Dist::Infra::PRODUCT} running on a schedule**:
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
chef_client_launchd 'Prevent the #{ChefUtils::Dist::Infra::PRODUCT} from running on a schedule' do
|
42
|
+
action :disable
|
43
|
+
end
|
44
|
+
```
|
45
|
+
DOC
|
46
|
+
|
47
|
+
property :user, String,
|
48
|
+
description: "The name of the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
|
49
|
+
default: "root"
|
50
|
+
|
51
|
+
property :working_directory, String,
|
52
|
+
description: "The working directory to run the #{ChefUtils::Dist::Infra::PRODUCT} from.",
|
53
|
+
default: "/var/root"
|
54
|
+
|
55
|
+
property :interval, [Integer, String],
|
56
|
+
description: "Time in minutes between #{ChefUtils::Dist::Infra::PRODUCT} executions.",
|
57
|
+
coerce: proc { |x| Integer(x) },
|
58
|
+
callbacks: { "should be a positive number" => proc { |v| v > 0 } },
|
59
|
+
default: 30
|
60
|
+
|
61
|
+
property :splay, [Integer, String],
|
62
|
+
default: 300,
|
63
|
+
coerce: proc { |x| Integer(x) },
|
64
|
+
callbacks: { "should be a positive number" => proc { |v| v > 0 } },
|
65
|
+
description: "A random number of seconds between 0 and X to add to interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time."
|
66
|
+
|
67
|
+
property :accept_chef_license, [true, false],
|
68
|
+
description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
|
69
|
+
default: false
|
70
|
+
|
71
|
+
property :config_directory, String,
|
72
|
+
description: "The path of the config directory.",
|
73
|
+
default: ChefConfig::Config.etc_chef_dir
|
74
|
+
|
75
|
+
property :log_directory, String,
|
76
|
+
description: "The path of the directory to create the log file in.",
|
77
|
+
default: "/Library/Logs/Chef"
|
78
|
+
|
79
|
+
property :log_file_name, String,
|
80
|
+
description: "The name of the log file to use.",
|
81
|
+
default: "client.log"
|
82
|
+
|
83
|
+
property :chef_binary_path, String,
|
84
|
+
description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary.",
|
85
|
+
default: "/opt/#{ChefUtils::Dist::Infra::DIR_SUFFIX}/bin/#{ChefUtils::Dist::Infra::CLIENT}"
|
86
|
+
|
87
|
+
property :daemon_options, Array,
|
88
|
+
description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
|
89
|
+
default: lazy { [] }
|
90
|
+
|
91
|
+
property :environment, Hash,
|
92
|
+
description: "A Hash containing additional arbitrary environment variables under which the launchd daemon will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
|
93
|
+
default: lazy { {} }
|
94
|
+
|
95
|
+
property :nice, [Integer, String],
|
96
|
+
description: "The process priority to run the #{ChefUtils::Dist::Infra::CLIENT} process at. A value of -20 is the highest priority and 19 is the lowest priority.",
|
97
|
+
coerce: proc { |x| Integer(x) },
|
98
|
+
callbacks: { "should be an Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
|
99
|
+
|
100
|
+
property :low_priority_io, [true, false],
|
101
|
+
description: "Run the #{ChefUtils::Dist::Infra::CLIENT} process with low priority disk IO",
|
102
|
+
default: true
|
103
|
+
|
104
|
+
action :enable do
|
105
|
+
unless ::Dir.exist?(new_resource.log_directory)
|
106
|
+
directory new_resource.log_directory do
|
107
|
+
owner new_resource.user
|
108
|
+
mode "0750"
|
109
|
+
recursive true
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
launchd "com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}" do
|
114
|
+
username new_resource.user
|
115
|
+
working_directory new_resource.working_directory
|
116
|
+
start_interval new_resource.interval * 60
|
117
|
+
program_arguments ["/bin/bash", "-c", client_command]
|
118
|
+
environment_variables new_resource.environment unless new_resource.environment.empty?
|
119
|
+
nice new_resource.nice
|
120
|
+
low_priority_io true
|
121
|
+
notifies :sleep, "chef_sleep[Sleep before client restart]", :immediately
|
122
|
+
action :create # create only creates the file. No service restart triggering
|
123
|
+
end
|
124
|
+
|
125
|
+
# Launchd doesn't have the concept of a reload aka restart. Instead to update a daemon config you have
|
126
|
+
# to unload it and then reload the new plist. That's usually fine, but not if chef-client is trying
|
127
|
+
# to restart itself. If the chef-client process uses launchd or macosx_service resources to restart itself
|
128
|
+
# we'll end up with a stopped service that will never get started back up. Instead we use this daemon
|
129
|
+
# that triggers when the chef-client plist file is updated, and handles the restart outside the run.
|
130
|
+
launchd "com.#{ChefUtils::Dist::Infra::SHORT}.restarter" do
|
131
|
+
username "root"
|
132
|
+
watch_paths ["/Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist"]
|
133
|
+
standard_out_path ::File.join(new_resource.log_directory, new_resource.log_file_name)
|
134
|
+
standard_error_path ::File.join(new_resource.log_directory, new_resource.log_file_name)
|
135
|
+
program_arguments ["/bin/bash",
|
136
|
+
"-c",
|
137
|
+
"echo; echo #{ChefUtils::Dist::Infra::PRODUCT} launchd daemon config has been updated. Manually unloading and reloading the daemon; echo Now unloading the daemon; launchctl unload /Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist; sleep 2; echo Now loading the daemon; launchctl load /Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist"]
|
138
|
+
action :enable # enable creates the plist & triggers service restarts on change
|
139
|
+
end
|
140
|
+
|
141
|
+
# We want to make sure that after we update the chef-client launchd config that we don't move on to another recipe
|
142
|
+
# before the restarter daemon can do its thing. This sleep avoids killing the client while it's doing something like
|
143
|
+
# installing a package, which could be problematic. It also makes it a bit more clear in the log that the killed process
|
144
|
+
# was intentional.
|
145
|
+
chef_sleep "Sleep before client restart" do
|
146
|
+
seconds 10
|
147
|
+
action :nothing
|
148
|
+
end
|
149
|
+
end
|
150
|
+
|
151
|
+
action :disable do
|
152
|
+
service ChefUtils::Dist::Infra::PRODUCT do
|
153
|
+
service_name "com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}"
|
154
|
+
action :disable
|
155
|
+
end
|
156
|
+
|
157
|
+
service "com.#{ChefUtils::Dist::Infra::SHORT}.restarter" do
|
158
|
+
action :disable
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
action_class do
|
163
|
+
#
|
164
|
+
# Generate a uniformly distributed unique number to sleep from 0 to the splay time
|
165
|
+
#
|
166
|
+
# @param [Integer] splay The number of seconds to splay
|
167
|
+
#
|
168
|
+
# @return [Integer]
|
169
|
+
#
|
170
|
+
def splay_sleep_time(splay)
|
171
|
+
seed = node["shard_seed"] || Digest::MD5.hexdigest(node.name).to_s.hex
|
172
|
+
random = Random.new(seed.to_i)
|
173
|
+
random.rand(splay)
|
174
|
+
end
|
175
|
+
|
176
|
+
#
|
177
|
+
# random sleep time + chef-client + daemon option properties + license acceptance
|
178
|
+
#
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
def client_command
|
182
|
+
cmd = ""
|
183
|
+
cmd << "/bin/sleep #{splay_sleep_time(new_resource.splay)};"
|
184
|
+
cmd << " #{new_resource.chef_binary_path}"
|
185
|
+
cmd << " #{new_resource.daemon_options.join(" ")}" unless new_resource.daemon_options.empty?
|
186
|
+
cmd << " -c #{::File.join(new_resource.config_directory, "client.rb")}"
|
187
|
+
cmd << " -L #{::File.join(new_resource.log_directory, new_resource.log_file_name)}"
|
188
|
+
cmd << " --chef-license accept" if new_resource.accept_chef_license
|
189
|
+
cmd
|
190
|
+
end
|
191
|
+
end
|
192
|
+
end
|
193
|
+
end
|
194
|
+
end
|
@@ -15,7 +15,7 @@
|
|
15
15
|
#
|
16
16
|
|
17
17
|
require_relative "../resource"
|
18
|
-
|
18
|
+
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
|
19
19
|
|
20
20
|
class Chef
|
21
21
|
class Resource
|
@@ -24,24 +24,24 @@ class Chef
|
|
24
24
|
|
25
25
|
provides :chef_client_scheduled_task
|
26
26
|
|
27
|
-
description "Use the **chef_client_scheduled_task** resource to setup the #{
|
27
|
+
description "Use the **chef_client_scheduled_task** resource to setup the #{ChefUtils::Dist::Infra::PRODUCT} to run as a Windows scheduled task. This resource will also create the specified log directory if it doesn't already exist."
|
28
28
|
introduced "16.0"
|
29
29
|
examples <<~DOC
|
30
|
-
**Setup #{
|
30
|
+
**Setup #{ChefUtils::Dist::Infra::PRODUCT} to run using the default 30 minute cadence**:
|
31
31
|
|
32
32
|
```ruby
|
33
|
-
chef_client_scheduled_task "Run #{
|
33
|
+
chef_client_scheduled_task "Run #{ChefUtils::Dist::Infra::PRODUCT} as a scheduled task"
|
34
34
|
```
|
35
35
|
|
36
|
-
**Run #{
|
36
|
+
**Run #{ChefUtils::Dist::Infra::PRODUCT} on system start**:
|
37
37
|
|
38
38
|
```ruby
|
39
|
-
chef_client_scheduled_task '#{
|
39
|
+
chef_client_scheduled_task '#{ChefUtils::Dist::Infra::PRODUCT} on start' do
|
40
40
|
frequency 'onstart'
|
41
41
|
end
|
42
42
|
```
|
43
43
|
|
44
|
-
**Run #{
|
44
|
+
**Run #{ChefUtils::Dist::Infra::PRODUCT} with extra options passed to the client**:
|
45
45
|
|
46
46
|
```ruby
|
47
47
|
chef_client_scheduled_task "Run an override recipe" do
|
@@ -49,7 +49,7 @@ class Chef
|
|
49
49
|
end
|
50
50
|
```
|
51
51
|
|
52
|
-
**Run #{
|
52
|
+
**Run #{ChefUtils::Dist::Infra::PRODUCT} daily at 01:00 am, specifying a named run-list**:
|
53
53
|
|
54
54
|
```ruby
|
55
55
|
chef_client_scheduled_task "Run chef-client named run-list daily" do
|
@@ -64,14 +64,15 @@ class Chef
|
|
64
64
|
|
65
65
|
property :task_name, String,
|
66
66
|
description: "The name of the scheduled task to create.",
|
67
|
-
default:
|
67
|
+
default: ChefUtils::Dist::Infra::CLIENT
|
68
68
|
|
69
69
|
property :user, String,
|
70
|
-
description: "The name of the user that #{
|
70
|
+
description: "The name of the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
|
71
71
|
default: "System", sensitive: true
|
72
72
|
|
73
|
-
property :password, String,
|
74
|
-
description: "The password for the user that #{
|
73
|
+
property :password, String,
|
74
|
+
description: "The password for the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
|
75
|
+
sensitive: true
|
75
76
|
|
76
77
|
property :frequency, String,
|
77
78
|
description: "Frequency with which to run the task.",
|
@@ -100,16 +101,16 @@ class Chef
|
|
100
101
|
property :splay, [Integer, String],
|
101
102
|
coerce: proc { |x| Integer(x) },
|
102
103
|
callbacks: { "should be a positive number" => proc { |v| v > 0 } },
|
103
|
-
description: "A random number of seconds between 0 and X to add to interval so that all #{
|
104
|
+
description: "A random number of seconds between 0 and X to add to interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time.",
|
104
105
|
default: 300
|
105
106
|
|
106
107
|
property :run_on_battery, [true, false],
|
107
|
-
description: "Run the #{
|
108
|
+
description: "Run the #{ChefUtils::Dist::Infra::PRODUCT} task when the system is on batteries.",
|
108
109
|
default: true
|
109
110
|
|
110
111
|
property :config_directory, String,
|
111
112
|
description: "The path of the config directory.",
|
112
|
-
default:
|
113
|
+
default: ChefConfig::Config.etc_chef_dir
|
113
114
|
|
114
115
|
property :log_directory, String,
|
115
116
|
description: "The path of the directory to create the log file in.",
|
@@ -121,11 +122,11 @@ class Chef
|
|
121
122
|
default: "client.log"
|
122
123
|
|
123
124
|
property :chef_binary_path, String,
|
124
|
-
description: "The path to the #{
|
125
|
-
default: "C:/#{
|
125
|
+
description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary.",
|
126
|
+
default: "C:/#{ChefUtils::Dist::Org::LEGACY_CONF_DIR}/#{ChefUtils::Dist::Infra::DIR_SUFFIX}/bin/#{ChefUtils::Dist::Infra::CLIENT}"
|
126
127
|
|
127
128
|
property :daemon_options, Array,
|
128
|
-
description: "An array of options to pass to the #{
|
129
|
+
description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
|
129
130
|
default: lazy { [] }
|
130
131
|
|
131
132
|
action :add do
|
@@ -175,9 +176,11 @@ class Chef
|
|
175
176
|
"#{cmd_path} /c \"#{client_cmd}\""
|
176
177
|
end
|
177
178
|
|
179
|
+
#
|
178
180
|
# Build command line to pass to cmd.exe
|
179
181
|
#
|
180
182
|
# @return [String]
|
183
|
+
#
|
181
184
|
def client_cmd
|
182
185
|
cmd = new_resource.chef_binary_path.dup
|
183
186
|
cmd << " -L #{::File.join(new_resource.log_directory, new_resource.log_file_name)}"
|
@@ -15,7 +15,7 @@
|
|
15
15
|
#
|
16
16
|
|
17
17
|
require_relative "../resource"
|
18
|
-
|
18
|
+
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
|
19
19
|
|
20
20
|
class Chef
|
21
21
|
class Resource
|
@@ -24,24 +24,24 @@ class Chef
|
|
24
24
|
|
25
25
|
provides :chef_client_systemd_timer
|
26
26
|
|
27
|
-
description "Use the **chef_client_systemd_timer** resource to setup the #{
|
27
|
+
description "Use the **chef_client_systemd_timer** resource to setup the #{ChefUtils::Dist::Infra::PRODUCT} to run as a systemd timer."
|
28
28
|
introduced "16.0"
|
29
29
|
examples <<~DOC
|
30
|
-
**Setup #{
|
30
|
+
**Setup #{ChefUtils::Dist::Infra::PRODUCT} to run using the default 30 minute cadence**:
|
31
31
|
|
32
32
|
```ruby
|
33
|
-
chef_client_systemd_timer "Run #{
|
33
|
+
chef_client_systemd_timer "Run #{ChefUtils::Dist::Infra::PRODUCT} as a systemd timer"
|
34
34
|
```
|
35
35
|
|
36
|
-
**Run #{
|
36
|
+
**Run #{ChefUtils::Dist::Infra::PRODUCT} every 1 hour**:
|
37
37
|
|
38
38
|
```ruby
|
39
|
-
chef_client_systemd_timer "Run #{
|
39
|
+
chef_client_systemd_timer "Run #{ChefUtils::Dist::Infra::PRODUCT} every 1 hour" do
|
40
40
|
interval "1hr"
|
41
41
|
end
|
42
42
|
```
|
43
43
|
|
44
|
-
**Run #{
|
44
|
+
**Run #{ChefUtils::Dist::Infra::PRODUCT} with extra options passed to the client**:
|
45
45
|
|
46
46
|
```ruby
|
47
47
|
chef_client_systemd_timer "Run an override recipe" do
|
@@ -52,14 +52,14 @@ class Chef
|
|
52
52
|
|
53
53
|
property :job_name, String,
|
54
54
|
description: "The name of the system timer to create.",
|
55
|
-
default:
|
55
|
+
default: ChefUtils::Dist::Infra::CLIENT
|
56
56
|
|
57
57
|
property :description, String,
|
58
58
|
description: "The description to add to the systemd timer. This will be displayed when running `systemctl status` for the timer.",
|
59
|
-
default: "#{
|
59
|
+
default: "#{ChefUtils::Dist::Infra::PRODUCT} periodic execution"
|
60
60
|
|
61
61
|
property :user, String,
|
62
|
-
description: "The name of the user that #{
|
62
|
+
description: "The name of the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
|
63
63
|
default: "root"
|
64
64
|
|
65
65
|
property :delay_after_boot, String,
|
@@ -71,7 +71,7 @@ class Chef
|
|
71
71
|
default: "30min"
|
72
72
|
|
73
73
|
property :splay, String,
|
74
|
-
description: "A interval between 0 and X to add to the interval so that all #{
|
74
|
+
description: "A interval between 0 and X to add to the interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time. This is expressed as a systemd time span such as `300seconds`, `1hr`, or `1m`. See <https://www.freedesktop.org/software/systemd/man/systemd.time.html> for a complete list of allowed time span values.",
|
75
75
|
default: "5min"
|
76
76
|
|
77
77
|
property :accept_chef_license, [true, false],
|
@@ -79,25 +79,31 @@ class Chef
|
|
79
79
|
default: false
|
80
80
|
|
81
81
|
property :run_on_battery, [true, false],
|
82
|
-
description: "Run the timer for #{
|
82
|
+
description: "Run the timer for #{ChefUtils::Dist::Infra::PRODUCT} if the system is on battery.",
|
83
83
|
default: true
|
84
84
|
|
85
85
|
property :config_directory, String,
|
86
86
|
description: "The path of the config directory.",
|
87
|
-
default:
|
87
|
+
default: ChefConfig::Config.etc_chef_dir
|
88
88
|
|
89
89
|
property :chef_binary_path, String,
|
90
|
-
description: "The path to the #{
|
91
|
-
default: "/opt/#{
|
90
|
+
description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary.",
|
91
|
+
default: "/opt/#{ChefUtils::Dist::Infra::DIR_SUFFIX}/bin/#{ChefUtils::Dist::Infra::CLIENT}"
|
92
92
|
|
93
93
|
property :daemon_options, Array,
|
94
|
-
description: "An array of options to pass to the #{
|
94
|
+
description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
|
95
95
|
default: lazy { [] }
|
96
96
|
|
97
97
|
property :environment, Hash,
|
98
98
|
description: "A Hash containing additional arbitrary environment variables under which the systemd timer will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
|
99
99
|
default: lazy { {} }
|
100
100
|
|
101
|
+
property :cpu_quota, [Integer, String],
|
102
|
+
description: "The systemd CPUQuota to run the #{ChefUtils::Dist::Infra::CLIENT} process with. This is a percentage value of the total CPU time available on the system. If the system has more than 1 core this may be a value greater than 100.",
|
103
|
+
introduced: "16.5",
|
104
|
+
coerce: proc { |x| Integer(x) },
|
105
|
+
callbacks: { "should be a positive Integer" => proc { |v| v > 0 } }
|
106
|
+
|
101
107
|
action :add do
|
102
108
|
systemd_unit "#{new_resource.job_name}.service" do
|
103
109
|
content service_content
|
@@ -127,7 +133,7 @@ class Chef
|
|
127
133
|
# @return [String]
|
128
134
|
#
|
129
135
|
def chef_client_cmd
|
130
|
-
cmd =
|
136
|
+
cmd = new_resource.chef_binary_path.dup
|
131
137
|
cmd << " #{new_resource.daemon_options.join(" ")}" unless new_resource.daemon_options.empty?
|
132
138
|
cmd << " --chef-license accept" if new_resource.accept_chef_license
|
133
139
|
cmd << " -c #{::File.join(new_resource.config_directory, "client.rb")}"
|
@@ -171,6 +177,7 @@ class Chef
|
|
171
177
|
}
|
172
178
|
|
173
179
|
unit["Service"]["ConditionACPower"] = "true" unless new_resource.run_on_battery
|
180
|
+
unit["Service"]["CPUQuota"] = new_resource.cpu_quota if new_resource.cpu_quota
|
174
181
|
unit["Service"]["Environment"] = new_resource.environment.collect { |k, v| "\"#{k}=#{v}\"" } unless new_resource.environment.empty?
|
175
182
|
unit
|
176
183
|
end
|
@@ -0,0 +1,101 @@
|
|
1
|
+
#
|
2
|
+
# Copyright:: Copyright (c) Chef Software Inc.
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
require_relative "../resource"
|
18
|
+
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
|
19
|
+
|
20
|
+
class Chef
|
21
|
+
class Resource
|
22
|
+
class ChefClientTrustedCertificate < Chef::Resource
|
23
|
+
unified_mode true
|
24
|
+
|
25
|
+
provides :chef_client_trusted_certificate
|
26
|
+
|
27
|
+
description "Use the **chef_client_trusted_certificate** resource to add certificates to #{ChefUtils::Dist::Infra::PRODUCT}'s trusted certificate directory. This allows the #{ChefUtils::Dist::Infra::PRODUCT} to communicate with internal encrypted resources without errors."
|
28
|
+
introduced "16.5"
|
29
|
+
examples <<~DOC
|
30
|
+
**Trust a self signed certificate**:
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
chef_client_trusted_certificate 'self-signed.badssl.com' do
|
34
|
+
certificate <<~CERT
|
35
|
+
-----BEGIN CERTIFICATE-----
|
36
|
+
MIIDeTCCAmGgAwIBAgIJAPziuikCTox4MA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNV
|
37
|
+
BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp
|
38
|
+
c2NvMQ8wDQYDVQQKDAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTAeFw0x
|
39
|
+
OTEwMDkyMzQxNTJaFw0yMTEwMDgyMzQxNTJaMGIxCzAJBgNVBAYTAlVTMRMwEQYD
|
40
|
+
VQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ8wDQYDVQQK
|
41
|
+
DAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTCCASIwDQYJKoZIhvcNAQEB
|
42
|
+
BQADggEPADCCAQoCggEBAMIE7PiM7gTCs9hQ1XBYzJMY61yoaEmwIrX5lZ6xKyx2
|
43
|
+
PmzAS2BMTOqytMAPgLaw+XLJhgL5XEFdEyt/ccRLvOmULlA3pmccYYz2QULFRtMW
|
44
|
+
hyefdOsKnRFSJiFzbIRMeVXk0WvoBj1IFVKtsyjbqv9u/2CVSndrOfEk0TG23U3A
|
45
|
+
xPxTuW1CrbV8/q71FdIzSOciccfCFHpsKOo3St/qbLVytH5aohbcabFXRNsKEqve
|
46
|
+
ww9HdFxBIuGa+RuT5q0iBikusbpJHAwnnqP7i/dAcgCskgjZjFeEU4EFy+b+a1SY
|
47
|
+
QCeFxxC7c3DvaRhBB0VVfPlkPz0sw6l865MaTIbRyoUCAwEAAaMyMDAwCQYDVR0T
|
48
|
+
BAIwADAjBgNVHREEHDAaggwqLmJhZHNzbC5jb22CCmJhZHNzbC5jb20wDQYJKoZI
|
49
|
+
hvcNAQELBQADggEBAGlwCdbPxflZfYOaukZGCaxYK6gpincX4Lla4Ui2WdeQxE95
|
50
|
+
w7fChXvP3YkE3UYUE7mupZ0eg4ZILr/A0e7JQDsgIu/SRTUE0domCKgPZ8v99k3A
|
51
|
+
vka4LpLK51jHJJK7EFgo3ca2nldd97GM0MU41xHFk8qaK1tWJkfrrfcGwDJ4GQPI
|
52
|
+
iLlm6i0yHq1Qg1RypAXJy5dTlRXlCLd8ufWhhiwW0W75Va5AEnJuqpQrKwl3KQVe
|
53
|
+
wGj67WWRgLfSr+4QG1mNvCZb2CkjZWmxkGPuoP40/y7Yu5OFqxP5tAjj4YixCYTW
|
54
|
+
EVA0pmzIzgBg+JIe3PdRy27T0asgQW/F4TY61Yk=
|
55
|
+
-----END CERTIFICATE-----
|
56
|
+
CERT
|
57
|
+
end
|
58
|
+
```
|
59
|
+
DOC
|
60
|
+
|
61
|
+
property :cert_name, String, name_property: true,
|
62
|
+
description: "The name to use for the certificate file on disk. If not provided the name of the resource block will be used instead."
|
63
|
+
|
64
|
+
property :certificate, String, required: [:add],
|
65
|
+
description: "The text of the certificate file including the BEGIN/END comment lines."
|
66
|
+
|
67
|
+
action :add do
|
68
|
+
unless ::Dir.exist?(Chef::Config[:trusted_certs_dir])
|
69
|
+
directory Chef::Config[:trusted_certs_dir] do
|
70
|
+
mode "0640"
|
71
|
+
recursive true
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
file cert_path do
|
76
|
+
content new_resource.certificate
|
77
|
+
mode "0640"
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
action :remove do
|
82
|
+
file cert_path do
|
83
|
+
action :delete
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
action_class do
|
88
|
+
#
|
89
|
+
# The path to the string on disk
|
90
|
+
#
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
def cert_path
|
94
|
+
path = ::File.join(Chef::Config[:trusted_certs_dir], new_resource.cert_name)
|
95
|
+
path << ".pem" unless path.end_with?(".pem")
|
96
|
+
path
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|