Replace omnibus_updater with chef_client_updater
omnibus_updater is deprecated
This commit is contained in:
69
cookbooks/chef_client_updater/README.md
Normal file
69
cookbooks/chef_client_updater/README.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# chef_client_updater
|
||||
|
||||
[](https://travis-ci.org/chef-cookbooks/chef_client_updater) [](https://supermarket.chef.io/cookbooks/chef_client_updater)
|
||||
|
||||
This cookbook updates the chef-client
|
||||
|
||||
## Requirements
|
||||
|
||||
### Platforms
|
||||
|
||||
- All platforms with a chef-client package on downloads.chef.io
|
||||
|
||||
### Chef
|
||||
|
||||
- Chef 12.1+
|
||||
|
||||
### Cookbooks
|
||||
|
||||
- compat_resource
|
||||
|
||||
### Usage
|
||||
|
||||
This cookbook provides both a custom resource and a default recipe. The default recipe simply uses the custom resource with a set of attributes. You can add chef_client_updater::default to your run list or use the custom resource in a wrapper cookbook.
|
||||
|
||||
### chef_client_updater
|
||||
|
||||
Installs the mixlib-install/mixlib-install gems and upgrades the chef-client.
|
||||
|
||||
#### properties
|
||||
|
||||
- `channel` - The chef channel you fetch the chef client from. `stable` contains all officially released chef-client builds where as `current` contains unreleased builds. Default: `stable`
|
||||
- `prevent_downgrade` - Don't allow this cookbook to downgrade the chef-client version. Default: true
|
||||
- `version` - The version of the chef-client to install. Default :latest
|
||||
- `post_install_action` - After installing the chef-client what should we do. `exec` to exec the new client or `kill` to kill the client and rely on the init system to start up the new version. Default: `exec`
|
||||
- `exec_command` - The chef-client command. default: $PROGRAM_NAME.split(' ').first
|
||||
- `exec_args` - An array of arguments to exec the chef-client with. default: ARGV
|
||||
|
||||
#### examples
|
||||
|
||||
```ruby
|
||||
chef_client_updater 'Install latest'
|
||||
```
|
||||
|
||||
```ruby
|
||||
chef_client_updater 'Install 12.13.36 and kill' do
|
||||
version '12.13.36'
|
||||
post_install_action 'kill'
|
||||
end
|
||||
```
|
||||
|
||||
## License & Authors
|
||||
|
||||
- Author: Tim Smith ([tsmith@chef.io](mailto:tsmith@chef.io))
|
||||
|
||||
```text
|
||||
Copyright:: 2016-2017, 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.
|
||||
```
|
||||
Reference in New Issue
Block a user