chef 13.11.3 → 13.12.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +4 -3
- data/README.md +35 -40
- data/Rakefile +18 -22
- data/chef-universal-mingw32.gemspec +1 -1
- data/chef.gemspec +3 -3
- data/lib/chef/client.rb +1 -1
- data/lib/chef/mixin/params_validate.rb +3 -1
- data/lib/chef/provider/script.rb +2 -2
- data/lib/chef/version.rb +1 -1
- data/spec/functional/http/simple_spec.rb +12 -6
- data/spec/functional/resource/remote_file_spec.rb +19 -15
- data/spec/support/platform_helpers.rb +2 -1
- data/tasks/announce.rb +1 -1
- data/tasks/dependencies.rb +5 -39
- data/tasks/maintainers.rb +10 -10
- data/tasks/rspec.rb +2 -2
- data/tasks/templates/prerelease.md.erb +11 -2
- data/tasks/templates/release.md.erb +9 -1
- metadata +6 -248
- data/CONTRIBUTING.md +0 -151
- data/VERSION +0 -1
- data/acceptance/.gitignore +0 -3
- data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +0 -33
- data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +0 -283
- data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml +0 -59
- data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb +0 -68
- data/acceptance/.shared/kitchen_acceptance/metadata.rb +0 -1
- data/acceptance/Gemfile +0 -19
- data/acceptance/Gemfile.lock +0 -266
- data/acceptance/README.md +0 -137
- data/acceptance/basics/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/basics/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/basics/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/basics/.kitchen.yml +0 -4
- data/acceptance/basics/test/integration/chef-current-install/serverspec/chef_client_spec.rb +0 -19
- data/acceptance/basics/test/integration/chef-current-install/serverspec/spec_helper.rb +0 -6
- data/acceptance/basics/test/integration/helpers/serverspec/Gemfile +0 -8
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -2
- data/acceptance/data-collector/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/.gitignore +0 -16
- data/acceptance/data-collector/.acceptance/data-collector-test/Berksfile +0 -3
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/api.rb +0 -101
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/apigemfile +0 -3
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-both-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-client-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-no-endpoint.rb +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/client-rb-solo-mode.rb +0 -4
- data/acceptance/data-collector/.acceptance/data-collector-test/files/default/config.ru +0 -2
- data/acceptance/data-collector/.acceptance/data-collector-test/metadata.rb +0 -7
- data/acceptance/data-collector/.acceptance/data-collector-test/recipes/default.rb +0 -44
- data/acceptance/data-collector/.kitchen.yml +0 -9
- data/acceptance/data-collector/Berksfile +0 -3
- data/acceptance/data-collector/test/integration/default/serverspec/default_spec.rb +0 -208
- data/acceptance/data-collector/test/integration/helpers/serverspec/Gemfile +0 -8
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/metadata.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/omnitruck/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -61
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/cookbook_kitchen.rb +0 -43
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/libraries/top_cookbooks.rb +0 -41
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/metadata.rb +0 -3
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/top-cookbooks/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/top-cookbooks/.gitignore +0 -1
- data/acceptance/top-cookbooks/.kitchen.chocolatey.yml +0 -6
- data/acceptance/top-cookbooks/.kitchen.iis.yml +0 -4
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-rhel.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-ubuntu.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.learn-the-basics-windows.yml +0 -7
- data/acceptance/top-cookbooks/.kitchen.powershell.yml +0 -4
- data/acceptance/top-cookbooks/.kitchen.sql_server.yml +0 -5
- data/acceptance/top-cookbooks/.kitchen.winbox.yml +0 -8
- data/acceptance/top-cookbooks/.kitchen.windows.yml +0 -38
- data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb +0 -2
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/trivial/.kitchen.yml +0 -7
- data/acceptance/trivial/test/integration/chef-current-install/inspec/chef_client_spec.rb +0 -5
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/.gitignore +0 -2
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/metadata.rb +0 -2
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/destroy.rb +0 -1
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/provision.rb +0 -1
- data/acceptance/windows-service/.acceptance/acceptance-cookbook/recipes/verify.rb +0 -1
- data/acceptance/windows-service/.kitchen.yml +0 -7
- data/acceptance/windows-service/test/integration/chef-windows-service/inspec/chef_windows_service_spec.rb +0 -58
- data/distro/common/html/_sources/ctl_chef_client.txt +0 -36
- data/distro/common/html/_sources/ctl_chef_server.txt +0 -341
- data/distro/common/html/_sources/ctl_chef_shell.txt +0 -15
- data/distro/common/html/_sources/ctl_chef_solo.txt +0 -25
- data/distro/common/html/_sources/index.txt +0 -135
- data/distro/common/html/_sources/knife.txt +0 -74
- data/distro/common/html/_sources/knife_bootstrap.txt +0 -56
- data/distro/common/html/_sources/knife_client.txt +0 -151
- data/distro/common/html/_sources/knife_common_options.txt +0 -6
- data/distro/common/html/_sources/knife_configure.txt +0 -29
- data/distro/common/html/_sources/knife_cookbook.txt +0 -236
- data/distro/common/html/_sources/knife_cookbook_site.txt +0 -157
- data/distro/common/html/_sources/knife_data_bag.txt +0 -160
- data/distro/common/html/_sources/knife_delete.txt +0 -26
- data/distro/common/html/_sources/knife_deps.txt +0 -61
- data/distro/common/html/_sources/knife_diff.txt +0 -34
- data/distro/common/html/_sources/knife_download.txt +0 -44
- data/distro/common/html/_sources/knife_edit.txt +0 -26
- data/distro/common/html/_sources/knife_environment.txt +0 -158
- data/distro/common/html/_sources/knife_exec.txt +0 -47
- data/distro/common/html/_sources/knife_index_rebuild.txt +0 -21
- data/distro/common/html/_sources/knife_list.txt +0 -33
- data/distro/common/html/_sources/knife_node.txt +0 -250
- data/distro/common/html/_sources/knife_raw.txt +0 -35
- data/distro/common/html/_sources/knife_recipe_list.txt +0 -23
- data/distro/common/html/_sources/knife_role.txt +0 -157
- data/distro/common/html/_sources/knife_search.txt +0 -53
- data/distro/common/html/_sources/knife_serve.txt +0 -19
- data/distro/common/html/_sources/knife_show.txt +0 -27
- data/distro/common/html/_sources/knife_ssh.txt +0 -43
- data/distro/common/html/_sources/knife_ssl_check.txt +0 -41
- data/distro/common/html/_sources/knife_ssl_fetch.txt +0 -41
- data/distro/common/html/_sources/knife_status.txt +0 -37
- data/distro/common/html/_sources/knife_tag.txt +0 -69
- data/distro/common/html/_sources/knife_upload.txt +0 -49
- data/distro/common/html/_sources/knife_user.txt +0 -127
- data/distro/common/html/_sources/knife_using.txt +0 -43
- data/distro/common/html/_sources/knife_xargs.txt +0 -30
- data/distro/common/html/_static/ajax-loader.gif +0 -0
- data/distro/common/html/_static/basic.css +0 -537
- data/distro/common/html/_static/chef.ico +0 -0
- data/distro/common/html/_static/chef_html_logo.png +0 -0
- data/distro/common/html/_static/comment-bright.png +0 -0
- data/distro/common/html/_static/comment-close.png +0 -0
- data/distro/common/html/_static/comment.png +0 -0
- data/distro/common/html/_static/contents.png +0 -0
- data/distro/common/html/_static/doctools.js +0 -238
- data/distro/common/html/_static/down-pressed.png +0 -0
- data/distro/common/html/_static/down.png +0 -0
- data/distro/common/html/_static/file.png +0 -0
- data/distro/common/html/_static/guide.css +0 -505
- data/distro/common/html/_static/jquery.js +0 -2
- data/distro/common/html/_static/minus.png +0 -0
- data/distro/common/html/_static/navigation.png +0 -0
- data/distro/common/html/_static/plus.png +0 -0
- data/distro/common/html/_static/pygments.css +0 -62
- data/distro/common/html/_static/searchtools.js +0 -622
- data/distro/common/html/_static/underscore.js +0 -31
- data/distro/common/html/_static/up-pressed.png +0 -0
- data/distro/common/html/_static/up.png +0 -0
- data/distro/common/html/_static/websupport.js +0 -808
- data/distro/common/html/ctl_chef_client.html +0 -270
- data/distro/common/html/ctl_chef_server.html +0 -728
- data/distro/common/html/ctl_chef_shell.html +0 -163
- data/distro/common/html/ctl_chef_solo.html +0 -194
- data/distro/common/html/index.html +0 -202
- data/distro/common/html/knife.html +0 -170
- data/distro/common/html/knife_bootstrap.html +0 -285
- data/distro/common/html/knife_client.html +0 -285
- data/distro/common/html/knife_common_options.html +0 -96
- data/distro/common/html/knife_configure.html +0 -105
- data/distro/common/html/knife_cookbook.html +0 -487
- data/distro/common/html/knife_cookbook_site.html +0 -375
- data/distro/common/html/knife_data_bag.html +0 -374
- data/distro/common/html/knife_delete.html +0 -93
- data/distro/common/html/knife_deps.html +0 -143
- data/distro/common/html/knife_diff.html +0 -123
- data/distro/common/html/knife_download.html +0 -145
- data/distro/common/html/knife_edit.html +0 -89
- data/distro/common/html/knife_environment.html +0 -322
- data/distro/common/html/knife_exec.html +0 -220
- data/distro/common/html/knife_index_rebuild.html +0 -83
- data/distro/common/html/knife_list.html +0 -114
- data/distro/common/html/knife_node.html +0 -458
- data/distro/common/html/knife_raw.html +0 -110
- data/distro/common/html/knife_recipe_list.html +0 -91
- data/distro/common/html/knife_role.html +0 -295
- data/distro/common/html/knife_search.html +0 -203
- data/distro/common/html/knife_serve.html +0 -79
- data/distro/common/html/knife_show.html +0 -104
- data/distro/common/html/knife_ssh.html +0 -177
- data/distro/common/html/knife_ssl_check.html +0 -151
- data/distro/common/html/knife_ssl_fetch.html +0 -151
- data/distro/common/html/knife_status.html +0 -144
- data/distro/common/html/knife_tag.html +0 -138
- data/distro/common/html/knife_upload.html +0 -153
- data/distro/common/html/knife_user.html +0 -242
- data/distro/common/html/knife_using.html +0 -210
- data/distro/common/html/knife_xargs.html +0 -122
- data/distro/common/html/objects.inv +0 -0
- data/distro/common/html/search.html +0 -82
- data/distro/common/html/searchindex.js +0 -1
- data/distro/common/man/man1/README.md +0 -58
- data/distro/common/man/man1/chef-shell.1 +0 -194
- data/distro/common/man/man1/knife-bootstrap.1 +0 -215
- data/distro/common/man/man1/knife-client.1 +0 -443
- data/distro/common/man/man1/knife-configure.1 +0 -161
- data/distro/common/man/man1/knife-cookbook-site.1 +0 -552
- data/distro/common/man/man1/knife-cookbook.1 +0 -770
- data/distro/common/man/man1/knife-data-bag.1 +0 -617
- data/distro/common/man/man1/knife-delete.1 +0 -127
- data/distro/common/man/man1/knife-deps.1 +0 -246
- data/distro/common/man/man1/knife-diff.1 +0 -226
- data/distro/common/man/man1/knife-download.1 +0 -258
- data/distro/common/man/man1/knife-edit.1 +0 -121
- data/distro/common/man/man1/knife-environment.1 +0 -496
- data/distro/common/man/man1/knife-exec.1 +0 -362
- data/distro/common/man/man1/knife-index-rebuild.1 +0 -63
- data/distro/common/man/man1/knife-list.1 +0 -174
- data/distro/common/man/man1/knife-node.1 +0 -716
- data/distro/common/man/man1/knife-raw.1 +0 -172
- data/distro/common/man/man1/knife-recipe-list.1 +0 -85
- data/distro/common/man/man1/knife-role.1 +0 -426
- data/distro/common/man/man1/knife-search.1 +0 -359
- data/distro/common/man/man1/knife-serve.1 +0 -109
- data/distro/common/man/man1/knife-show.1 +0 -160
- data/distro/common/man/man1/knife-ssh.1 +0 -284
- data/distro/common/man/man1/knife-ssl-check.1 +0 -207
- data/distro/common/man/man1/knife-ssl-fetch.1 +0 -207
- data/distro/common/man/man1/knife-status.1 +0 -234
- data/distro/common/man/man1/knife-tag.1 +0 -189
- data/distro/common/man/man1/knife-upload.1 +0 -280
- data/distro/common/man/man1/knife-user.1 +0 -356
- data/distro/common/man/man1/knife-xargs.1 +0 -189
- data/distro/common/man/man1/knife.1 +0 -332
- data/distro/common/man/man8/chef-apply.8 +0 -86
- data/distro/common/man/man8/chef-client.8 +0 -398
- data/distro/common/man/man8/chef-solo.8 +0 -260
- data/distro/common/markdown/README +0 -3
- data/distro/common/markdown/man1/chef-shell.mkd +0 -195
- data/distro/common/markdown/man1/knife-bootstrap.mkd +0 -141
- data/distro/common/markdown/man1/knife-client.mkd +0 -103
- data/distro/common/markdown/man1/knife-configure.mkd +0 -71
- data/distro/common/markdown/man1/knife-cookbook-site.mkd +0 -123
- data/distro/common/markdown/man1/knife-cookbook.mkd +0 -263
- data/distro/common/markdown/man1/knife-data-bag.mkd +0 -121
- data/distro/common/markdown/man1/knife-environment.mkd +0 -151
- data/distro/common/markdown/man1/knife-exec.mkd +0 -42
- data/distro/common/markdown/man1/knife-index.mkd +0 -30
- data/distro/common/markdown/man1/knife-node.mkd +0 -130
- data/distro/common/markdown/man1/knife-role.mkd +0 -85
- data/distro/common/markdown/man1/knife-search.mkd +0 -180
- data/distro/common/markdown/man1/knife-ssh.mkd +0 -69
- data/distro/common/markdown/man1/knife-status.mkd +0 -36
- data/distro/common/markdown/man1/knife-tag.mkd +0 -39
- data/distro/common/markdown/man1/knife.mkd +0 -213
- data/distro/common/markdown/man8/chef-client.mkd +0 -75
- data/distro/common/markdown/man8/chef-expander.mkd +0 -81
- data/distro/common/markdown/man8/chef-expanderctl.mkd +0 -57
- data/distro/common/markdown/man8/chef-server-webui.mkd +0 -121
- data/distro/common/markdown/man8/chef-server.mkd +0 -120
- data/distro/common/markdown/man8/chef-solo.mkd +0 -107
- data/distro/common/markdown/man8/chef-solr.mkd +0 -89
- data/distro/powershell/chef/chef.psm1 +0 -459
- data/tasks/cbgb.rb +0 -84
|
@@ -1,270 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
6
|
-
<head>
|
|
7
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
8
|
-
|
|
9
|
-
<title>chef-client — chef-client Man Pages</title>
|
|
10
|
-
|
|
11
|
-
<link rel="stylesheet" href="_static/guide.css" type="text/css" />
|
|
12
|
-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
13
|
-
|
|
14
|
-
<script type="text/javascript">
|
|
15
|
-
var DOCUMENTATION_OPTIONS = {
|
|
16
|
-
URL_ROOT: './',
|
|
17
|
-
VERSION: '',
|
|
18
|
-
COLLAPSE_INDEX: false,
|
|
19
|
-
FILE_SUFFIX: '.html',
|
|
20
|
-
HAS_SOURCE: true
|
|
21
|
-
};
|
|
22
|
-
</script>
|
|
23
|
-
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
24
|
-
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
25
|
-
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
</head>
|
|
29
|
-
<body>
|
|
30
|
-
<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
|
|
31
|
-
<a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
|
|
32
|
-
</div>
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
<div class="document">
|
|
38
|
-
<div class="documentwrapper">
|
|
39
|
-
|
|
40
|
-
<div class="body">
|
|
41
|
-
|
|
42
|
-
<div class="section" id="chef-client">
|
|
43
|
-
<h1>chef-client<a class="headerlink" href="#chef-client" title="Permalink to this headline">¶</a></h1>
|
|
44
|
-
<p>A chef-client is an agent that runs locally on every node that is under management by Chef. When a chef-client is run, it will perform all of the steps that are required to bring the node into the expected state, including:</p>
|
|
45
|
-
<ul class="simple">
|
|
46
|
-
<li>Registering and authenticating the node with the Chef server</li>
|
|
47
|
-
<li>Building the node object</li>
|
|
48
|
-
<li>Synchronizing cookbooks</li>
|
|
49
|
-
<li>Compiling the resource collection by loading each of the required cookbooks, including recipes, attributes, and all other dependencies</li>
|
|
50
|
-
<li>Taking the appropriate and required actions to configure the node</li>
|
|
51
|
-
<li>Looking for exceptions and notifications, handling each as required</li>
|
|
52
|
-
</ul>
|
|
53
|
-
<p>The chef-client executable is run as a command-line tool.</p>
|
|
54
|
-
<div class="admonition note">
|
|
55
|
-
<p class="first admonition-title">Note</p>
|
|
56
|
-
<p>A client.rb file is used to specify the configuration details for the chef-client.</p>
|
|
57
|
-
<ul class="last simple">
|
|
58
|
-
<li>This file is loaded every time this executable is run</li>
|
|
59
|
-
<li>On UNIX- and Linux-based machines, the default location for this file is <tt class="docutils literal"><span class="pre">/etc/chef/client.rb</span></tt>; on Microsoft Windows machines, the default location for this file is <tt class="docutils literal"><span class="pre">C:\chef\client.rb</span></tt>; use the <tt class="docutils literal"><span class="pre">--config</span></tt> option from the command line to change this location</li>
|
|
60
|
-
<li>This file is not created by default</li>
|
|
61
|
-
<li>When a client.rb file is present in this directory, the settings contained within that file will override the default configuration settings</li>
|
|
62
|
-
</ul>
|
|
63
|
-
</div>
|
|
64
|
-
<div class="section" id="options">
|
|
65
|
-
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
|
66
|
-
<p>This command has the following syntax:</p>
|
|
67
|
-
<div class="highlight-python"><div class="highlight"><pre>chef-client OPTION VALUE OPTION VALUE ...
|
|
68
|
-
</pre></div>
|
|
69
|
-
</div>
|
|
70
|
-
<p>This command has the following options:</p>
|
|
71
|
-
<dl class="docutils">
|
|
72
|
-
<dt><tt class="docutils literal"><span class="pre">-A</span></tt>, <tt class="docutils literal"><span class="pre">--fatal-windows-admin-check</span></tt></dt>
|
|
73
|
-
<dd>Use to cause a chef-client run to fail when the chef-client does not have administrator privileges in Microsoft Windows.</dd>
|
|
74
|
-
<dt><tt class="docutils literal"><span class="pre">--chef-zero-port</span> <span class="pre">PORT</span></tt></dt>
|
|
75
|
-
<dd>The port on which chef-zero will listen. If a port is not specified—individually, as range of ports, or from the <tt class="docutils literal"><span class="pre">chef_zero.port</span></tt> setting in the client.rb file—the chef-client will scan for ports between 8889-9999 and will pick the first port that is available.</dd>
|
|
76
|
-
<dt><tt class="docutils literal"><span class="pre">-F</span> <span class="pre">FORMAT</span></tt>, <tt class="docutils literal"><span class="pre">--format</span> <span class="pre">FORMAT</span></tt></dt>
|
|
77
|
-
<dd><p class="first">The output format: <tt class="docutils literal"><span class="pre">doc</span></tt> (default) or <tt class="docutils literal"><span class="pre">min</span></tt>.</p>
|
|
78
|
-
<p>Use <tt class="docutils literal"><span class="pre">doc</span></tt> to print the progress of the chef-client run using full strings that display a summary of updates as they occur.</p>
|
|
79
|
-
<p>Use <tt class="docutils literal"><span class="pre">min</span></tt> to print the progress of the chef-client run using single characters. A summary of updates is printed at the end of the chef-client run. A dot (<tt class="docutils literal"><span class="pre">.</span></tt>) is printed for events that do not have meaningful status information, such as loading a file or synchronizing a cookbook. For resources, a dot (<tt class="docutils literal"><span class="pre">.</span></tt>) is printed when the resource is up to date, an <tt class="docutils literal"><span class="pre">S</span></tt> is printed when the resource is skipped by <tt class="docutils literal"><span class="pre">not_if</span></tt> or <tt class="docutils literal"><span class="pre">only_if</span></tt>, and a <tt class="docutils literal"><span class="pre">U</span></tt> is printed when the resource is updated.</p>
|
|
80
|
-
<p class="last">Other formatting options are available when those formatters are configured in the client.rb file using the <tt class="docutils literal"><span class="pre">add_formatter</span></tt> option.</p>
|
|
81
|
-
</dd>
|
|
82
|
-
<dt><tt class="docutils literal"><span class="pre">--force-formatter</span></tt></dt>
|
|
83
|
-
<dd>Use to show formatter output instead of logger output.</dd>
|
|
84
|
-
<dt><tt class="docutils literal"><span class="pre">--force-logger</span></tt></dt>
|
|
85
|
-
<dd>Use to show logger output instead of formatter output.</dd>
|
|
86
|
-
<dt><tt class="docutils literal"><span class="pre">-g</span> <span class="pre">GROUP</span></tt>, <tt class="docutils literal"><span class="pre">--group</span> <span class="pre">GROUP</span></tt></dt>
|
|
87
|
-
<dd>The name of the group that owns a process. This is required when starting any executable as a daemon.</dd>
|
|
88
|
-
<dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
|
|
89
|
-
<dd>Shows help for the command.</dd>
|
|
90
|
-
<dt><tt class="docutils literal"><span class="pre">-i</span> <span class="pre">SECONDS</span></tt>, <tt class="docutils literal"><span class="pre">--interval</span> <span class="pre">SECONDS</span></tt></dt>
|
|
91
|
-
<dd>The frequency (in seconds) at which the chef-client runs. When the chef-client is run at intervals, <tt class="docutils literal"><span class="pre">--splay</span></tt> and <tt class="docutils literal"><span class="pre">--interval</span></tt> values are applied before the chef-client run. Default value: <tt class="docutils literal"><span class="pre">1800</span></tt>.</dd>
|
|
92
|
-
<dt><tt class="docutils literal"><span class="pre">-j</span> <span class="pre">PATH</span></tt>, <tt class="docutils literal"><span class="pre">--json-attributes</span> <span class="pre">PATH</span></tt></dt>
|
|
93
|
-
<dd><p class="first">The path to a file that contains JSON data.</p>
|
|
94
|
-
<p>Use this option to define a <tt class="docutils literal"><span class="pre">run_list</span></tt> object. For example, a JSON file similar to:</p>
|
|
95
|
-
<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">"run_list"</span><span class="o">:</span> <span class="p">[</span>
|
|
96
|
-
<span class="s2">"recipe[base]"</span><span class="p">,</span>
|
|
97
|
-
<span class="s2">"recipe[foo]"</span><span class="p">,</span>
|
|
98
|
-
<span class="s2">"recipe[bar]"</span><span class="p">,</span>
|
|
99
|
-
<span class="s2">"role[webserver]"</span>
|
|
100
|
-
<span class="p">],</span>
|
|
101
|
-
</pre></div>
|
|
102
|
-
</div>
|
|
103
|
-
<p>may be used by running <tt class="docutils literal"><span class="pre">chef-client</span> <span class="pre">-j</span> <span class="pre">path/to/file.json</span></tt>.</p>
|
|
104
|
-
<p>In certain situations this option may be used to update <tt class="docutils literal"><span class="pre">normal</span></tt> attributes.</p>
|
|
105
|
-
<div class="last admonition warning">
|
|
106
|
-
<p class="first admonition-title">Warning</p>
|
|
107
|
-
<p>Any other attribute type that is contained in this JSON file will be treated as a <tt class="docutils literal"><span class="pre">normal</span></tt> attribute. For example, attempting to update <tt class="docutils literal"><span class="pre">override</span></tt> attributes using the <tt class="docutils literal"><span class="pre">-j</span></tt> option:</p>
|
|
108
|
-
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
|
|
109
|
-
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"dev-99"</span><span class="p">,</span>
|
|
110
|
-
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Install some stuff"</span><span class="p">,</span>
|
|
111
|
-
<span class="s2">"override_attributes"</span><span class="o">:</span> <span class="p">{</span>
|
|
112
|
-
<span class="s2">"apptastic"</span><span class="o">:</span> <span class="p">{</span>
|
|
113
|
-
<span class="s2">"enable_apptastic"</span><span class="o">:</span> <span class="s2">"false"</span><span class="p">,</span>
|
|
114
|
-
<span class="s2">"apptastic_tier_name"</span><span class="o">:</span> <span class="s2">"dev-99.bomb.com"</span>
|
|
115
|
-
<span class="p">}</span>
|
|
116
|
-
<span class="p">}</span>
|
|
117
|
-
<span class="p">}</span>
|
|
118
|
-
</pre></div>
|
|
119
|
-
</div>
|
|
120
|
-
<p>will result in a node object similar to:</p>
|
|
121
|
-
<div class="last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
|
|
122
|
-
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"maybe-dev-99"</span><span class="p">,</span>
|
|
123
|
-
<span class="s2">"normal"</span><span class="o">:</span> <span class="p">{</span>
|
|
124
|
-
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"dev-99"</span><span class="p">,</span>
|
|
125
|
-
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Install some stuff"</span><span class="p">,</span>
|
|
126
|
-
<span class="s2">"override_attributes"</span><span class="o">:</span> <span class="p">{</span>
|
|
127
|
-
<span class="s2">"apptastic"</span><span class="o">:</span> <span class="p">{</span>
|
|
128
|
-
<span class="s2">"enable_apptastic"</span><span class="o">:</span> <span class="s2">"false"</span><span class="p">,</span>
|
|
129
|
-
<span class="s2">"apptastic_tier_name"</span><span class="o">:</span> <span class="s2">"dev-99.bomb.com"</span>
|
|
130
|
-
<span class="p">}</span>
|
|
131
|
-
<span class="p">}</span>
|
|
132
|
-
<span class="p">}</span>
|
|
133
|
-
<span class="p">}</span>
|
|
134
|
-
</pre></div>
|
|
135
|
-
</div>
|
|
136
|
-
</div>
|
|
137
|
-
</dd>
|
|
138
|
-
<dt><tt class="docutils literal"><span class="pre">-k</span> <span class="pre">KEY_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--client_key</span> <span class="pre">KEY_FILE</span></tt></dt>
|
|
139
|
-
<dd>The location of the file which contains the client key. Default value: <tt class="docutils literal"><span class="pre">/etc/chef/client.pem</span></tt>.</dd>
|
|
140
|
-
<dt><tt class="docutils literal"><span class="pre">-K</span> <span class="pre">KEY_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--validation_key</span> <span class="pre">KEY_FILE</span></tt></dt>
|
|
141
|
-
<dd>The location of the file which contains the key used when a chef-client is registered with a Chef server. A validation key is signed using the <tt class="docutils literal"><span class="pre">validation_client_name</span></tt> for authentication. Default value: <tt class="docutils literal"><span class="pre">/etc/chef/validation.pem</span></tt>.</dd>
|
|
142
|
-
<dt><tt class="docutils literal"><span class="pre">-l</span> <span class="pre">LEVEL</span></tt>, <tt class="docutils literal"><span class="pre">--log_level</span> <span class="pre">LEVEL</span></tt></dt>
|
|
143
|
-
<dd>The level of logging that will be stored in a log file.</dd>
|
|
144
|
-
<dt><tt class="docutils literal"><span class="pre">-L</span> <span class="pre">LOGLOCATION</span></tt>, <tt class="docutils literal"><span class="pre">--logfile</span> <span class="pre">c</span></tt></dt>
|
|
145
|
-
<dd>The location in which log file output files will be saved. If this location is set to something other than <tt class="docutils literal"><span class="pre">STDOUT</span></tt>, standard output logging will still be performed (otherwise there would be no output other than to a file). This is recommended when starting any executable as a daemon. Default value: <tt class="docutils literal"><span class="pre">STDOUT</span></tt>.</dd>
|
|
146
|
-
<dt><tt class="docutils literal"><span class="pre">--[no-]color</span></tt></dt>
|
|
147
|
-
<dd>Use to view colored output. Default setting: <tt class="docutils literal"><span class="pre">--color</span></tt>.</dd>
|
|
148
|
-
<dt><tt class="docutils literal"><span class="pre">-N</span> <span class="pre">NODE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--node-name</span> <span class="pre">NODE_NAME</span></tt></dt>
|
|
149
|
-
<dd>The name of the node.</dd>
|
|
150
|
-
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">RUN_LIST_ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--override-runlist</span> <span class="pre">RUN_LIST_ITEM</span></tt></dt>
|
|
151
|
-
<dd>Replace the current run list with the specified items. This option will not clear the list of cookbooks (and related files) that is cached on the node.</dd>
|
|
152
|
-
<dt><tt class="docutils literal"><span class="pre">--once</span></tt></dt>
|
|
153
|
-
<dd>Use to run the chef-client only once and to cancel <tt class="docutils literal"><span class="pre">interval</span></tt> and <tt class="docutils literal"><span class="pre">splay</span></tt> options.</dd>
|
|
154
|
-
<dt><tt class="docutils literal"><span class="pre">-P</span> <span class="pre">PID_FILE</span></tt>, <tt class="docutils literal"><span class="pre">--pid</span> <span class="pre">PID_FILE</span></tt></dt>
|
|
155
|
-
<dd>The location in which a process identification number (pid) is saved. An executable, when started as a daemon, will write the pid to the specified file. Default value: <tt class="docutils literal"><span class="pre">/tmp/name-of-executable.pid</span></tt>.</dd>
|
|
156
|
-
<dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">RUN_LIST_ITEM</span></tt>, <tt class="docutils literal"><span class="pre">--runlist</span> <span class="pre">RUN_LIST_ITEM</span></tt></dt>
|
|
157
|
-
<dd>Use to permanently replace the current run-list with the specified run-list items.</dd>
|
|
158
|
-
<dt><tt class="docutils literal"><span class="pre">-R</span></tt>, <tt class="docutils literal"><span class="pre">--enable-reporting</span></tt></dt>
|
|
159
|
-
<dd>Use to enable Chef reporting, which performs data collection during a chef-client run.</dd>
|
|
160
|
-
<dt><tt class="docutils literal"><span class="pre">RECIPE_FILE</span></tt></dt>
|
|
161
|
-
<dd>The path to a recipe. For example, if a recipe file is in the current directory, use <tt class="docutils literal"><span class="pre">recipe_file.rb</span></tt>. This is typically used with the <tt class="docutils literal"><span class="pre">--local-mode</span></tt> option.</dd>
|
|
162
|
-
<dt><tt class="docutils literal"><span class="pre">--run-lock-timeout</span> <span class="pre">SECONDS</span></tt></dt>
|
|
163
|
-
<dd>The amount of time (in seconds) to wait for a chef-client run to finish. Default value: not set (indefinite). Set to <tt class="docutils literal"><span class="pre">0</span></tt> to cause a second chef-client to exit immediately.</dd>
|
|
164
|
-
<dt><tt class="docutils literal"><span class="pre">-s</span> <span class="pre">SECONDS</span></tt>, <tt class="docutils literal"><span class="pre">--splay</span> <span class="pre">SECONDS</span></tt></dt>
|
|
165
|
-
<dd>A number (in seconds) to add to the <tt class="docutils literal"><span class="pre">interval</span></tt> that is used to determine the frequency of chef-client runs. This number can help prevent server load when there are many clients running at the same time. When the chef-client is run at intervals, <tt class="docutils literal"><span class="pre">--splay</span></tt> and <tt class="docutils literal"><span class="pre">--interval</span></tt> values are applied before the chef-client run.</dd>
|
|
166
|
-
<dt><tt class="docutils literal"><span class="pre">-S</span> <span class="pre">CHEF_SERVER_URL</span></tt>, <tt class="docutils literal"><span class="pre">--server</span> <span class="pre">CHEF_SERVER_URL</span></tt></dt>
|
|
167
|
-
<dd>The URL for the Chef server.</dd>
|
|
168
|
-
<dt><tt class="docutils literal"><span class="pre">-u</span> <span class="pre">USER</span></tt>, <tt class="docutils literal"><span class="pre">--user</span> <span class="pre">USER</span></tt></dt>
|
|
169
|
-
<dd>The user that owns a process. This is required when starting any executable as a daemon.</dd>
|
|
170
|
-
<dt><tt class="docutils literal"><span class="pre">-v</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt></dt>
|
|
171
|
-
<dd>The version of the chef-client.</dd>
|
|
172
|
-
<dt><tt class="docutils literal"><span class="pre">-W</span></tt>, <tt class="docutils literal"><span class="pre">--why-run</span></tt></dt>
|
|
173
|
-
<dd>Use to run the executable in why-run mode, which is a type of chef-client run that does everything except modify the system. Use why-run mode to understand why the chef-client makes the decisions that it makes and to learn more about the current and proposed state of the system.</dd>
|
|
174
|
-
<dt><tt class="docutils literal"><span class="pre">-z</span></tt>, <tt class="docutils literal"><span class="pre">--local-mode</span></tt></dt>
|
|
175
|
-
<dd>Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo.</dd>
|
|
176
|
-
</dl>
|
|
177
|
-
</div>
|
|
178
|
-
<div class="section" id="run-with-elevated-privileges">
|
|
179
|
-
<h2>Run with Elevated Privileges<a class="headerlink" href="#run-with-elevated-privileges" title="Permalink to this headline">¶</a></h2>
|
|
180
|
-
<p>The chef-client may need to be run with elevated privileges in order to get a recipe to converge correctly. On UNIX and UNIX-like operating systems this can be done by running the command as root. On Microsoft Windows this can be done by running the command prompt as an administrator.</p>
|
|
181
|
-
<div class="section" id="linux">
|
|
182
|
-
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
|
|
183
|
-
<p>On Linux, the following error sometimes occurs when the permissions used to run the chef-client are incorrect:</p>
|
|
184
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-client
|
|
185
|
-
<span class="o">[</span>Tue, 29 Nov 2011 19:46:17 -0800<span class="o">]</span> INFO: *** Chef 10.X.X ***
|
|
186
|
-
<span class="o">[</span>Tue, 29 Nov 2011 19:46:18 -0800<span class="o">]</span> WARN: Failed to <span class="nb">read </span>the private key /etc/chef/client.pem: <span class="c">#<Errno::EACCES: Permission denied - /etc/chef/client.pem></span>
|
|
187
|
-
</pre></div>
|
|
188
|
-
</div>
|
|
189
|
-
<p>This can be resolved by running the command as root. There are a few ways this can be done:</p>
|
|
190
|
-
<ul>
|
|
191
|
-
<li><p class="first">Log in as root and then run the chef-client</p>
|
|
192
|
-
</li>
|
|
193
|
-
<li><p class="first">Use <tt class="docutils literal"><span class="pre">su</span></tt> to become the root user, and then run the chef-client. For example:</p>
|
|
194
|
-
<blockquote>
|
|
195
|
-
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>su
|
|
196
|
-
</pre></div>
|
|
197
|
-
</div>
|
|
198
|
-
<p>and then:</p>
|
|
199
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-client
|
|
200
|
-
</pre></div>
|
|
201
|
-
</div>
|
|
202
|
-
</div></blockquote>
|
|
203
|
-
</li>
|
|
204
|
-
<li><p class="first">Use the sudo utility</p>
|
|
205
|
-
<blockquote>
|
|
206
|
-
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo chef-client
|
|
207
|
-
</pre></div>
|
|
208
|
-
</div>
|
|
209
|
-
</div></blockquote>
|
|
210
|
-
</li>
|
|
211
|
-
<li><p class="first">Give a user access to read <tt class="docutils literal"><span class="pre">/etc/chef</span></tt> and also the files accessed by the chef-client. This requires super user privileges and, as such, is not a recommended approach</p>
|
|
212
|
-
</li>
|
|
213
|
-
</ul>
|
|
214
|
-
</div>
|
|
215
|
-
<div class="section" id="windows">
|
|
216
|
-
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
|
|
217
|
-
<p>On Microsoft Windows, running without elevated privileges (when they are necessary) is an issue that fails silently. It will appear that the chef-client completed its run successfully, but the changes will not have been made. When this occurs, do one of the following to run the chef-client as the administrator:</p>
|
|
218
|
-
<ul>
|
|
219
|
-
<li><p class="first">Log in to the administrator account. (This is not the same as an account in the administrator’s security group.)</p>
|
|
220
|
-
</li>
|
|
221
|
-
<li><p class="first">Run the chef-client process from the administrator account while being logged into another account. Run the following command:</p>
|
|
222
|
-
<blockquote>
|
|
223
|
-
<div><div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>runas /user:Administrator <span class="s2">"cmd /C chef-client"</span>
|
|
224
|
-
</pre></div>
|
|
225
|
-
</div>
|
|
226
|
-
<p>This will prompt for the administrator account password.</p>
|
|
227
|
-
</div></blockquote>
|
|
228
|
-
</li>
|
|
229
|
-
<li><p class="first">Open a command prompt by right-clicking on the command prompt application, and then selecting <strong>Run as administrator</strong>. After the command window opens, the chef-client can be run as the administrator</p>
|
|
230
|
-
</li>
|
|
231
|
-
</ul>
|
|
232
|
-
</div>
|
|
233
|
-
</div>
|
|
234
|
-
<div class="section" id="examples">
|
|
235
|
-
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
|
236
|
-
<p><strong>Start a Chef run when the chef-client is running as a daemon</strong></p>
|
|
237
|
-
<p>A chef-client that is running as a daemon can be woken up and started by sending the process a <tt class="docutils literal"><span class="pre">SIGUSR1</span></tt>. For example, to trigger a chef-client run on a machine running Linux:</p>
|
|
238
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo killall -USR1 chef-client
|
|
239
|
-
</pre></div>
|
|
240
|
-
</div>
|
|
241
|
-
<p><strong>Start a Chef run manually</strong></p>
|
|
242
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>ps auxw|grep chef-client
|
|
243
|
-
</pre></div>
|
|
244
|
-
</div>
|
|
245
|
-
<p>to return something like:</p>
|
|
246
|
-
<div class="highlight-bash"><div class="highlight"><pre>root 66066 0.9 0.0 2488880 264 s001 S+ 10:26AM 0:03.05
|
|
247
|
-
/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby /usr/bin/chef-client -i 3600 -s 20
|
|
248
|
-
</pre></div>
|
|
249
|
-
</div>
|
|
250
|
-
<p>and then enter:</p>
|
|
251
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>sudo <span class="nb">kill</span> -USR1 66066
|
|
252
|
-
</pre></div>
|
|
253
|
-
</div>
|
|
254
|
-
</div>
|
|
255
|
-
</div>
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
</div>
|
|
259
|
-
|
|
260
|
-
</div>
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
<div class="clearer"></div>
|
|
264
|
-
</div>
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
</body>
|
|
270
|
-
</html>
|
|
@@ -1,728 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
6
|
-
<head>
|
|
7
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
8
|
-
|
|
9
|
-
<title>chef-server-ctl (executable) — chef-client Man Pages</title>
|
|
10
|
-
|
|
11
|
-
<link rel="stylesheet" href="_static/guide.css" type="text/css" />
|
|
12
|
-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
13
|
-
|
|
14
|
-
<script type="text/javascript">
|
|
15
|
-
var DOCUMENTATION_OPTIONS = {
|
|
16
|
-
URL_ROOT: './',
|
|
17
|
-
VERSION: '',
|
|
18
|
-
COLLAPSE_INDEX: false,
|
|
19
|
-
FILE_SUFFIX: '.html',
|
|
20
|
-
HAS_SOURCE: true
|
|
21
|
-
};
|
|
22
|
-
</script>
|
|
23
|
-
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
24
|
-
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
25
|
-
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
</head>
|
|
29
|
-
<body>
|
|
30
|
-
<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px">
|
|
31
|
-
<a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a>
|
|
32
|
-
</div>
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
<div class="document">
|
|
38
|
-
<div class="documentwrapper">
|
|
39
|
-
|
|
40
|
-
<div class="body">
|
|
41
|
-
|
|
42
|
-
<div class="section" id="chef-server-ctl-executable">
|
|
43
|
-
<h1>chef-server-ctl (executable)<a class="headerlink" href="#chef-server-ctl-executable" title="Permalink to this headline">¶</a></h1>
|
|
44
|
-
<p>The Chef server includes a command-line utility named chef-server-ctl. This command-line tool is used to start and stop individual services, reconfigure the Chef server, run chef-pedant, and then tail Chef server log files.</p>
|
|
45
|
-
<div class="section" id="backup-recover">
|
|
46
|
-
<h2>backup-recover<a class="headerlink" href="#backup-recover" title="Permalink to this headline">¶</a></h2>
|
|
47
|
-
<p>The <tt class="docutils literal"><span class="pre">backup-recover</span></tt> subcommand is used to force the Chef server to attempt to become the backup server. This is the opposite of the <tt class="docutils literal"><span class="pre">master-recover</span></tt> subcommand.</p>
|
|
48
|
-
<div class="admonition warning">
|
|
49
|
-
<p class="first admonition-title">Warning</p>
|
|
50
|
-
<p class="last">If this command is run on both back-end servers, it will put the back-end cluster into a state where no server holds the DRBD resource.</p>
|
|
51
|
-
</div>
|
|
52
|
-
<p>This subcommand has the following syntax:</p>
|
|
53
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl backup-recover
|
|
54
|
-
</pre></div>
|
|
55
|
-
</div>
|
|
56
|
-
</div>
|
|
57
|
-
<div class="section" id="cleanse">
|
|
58
|
-
<h2>cleanse<a class="headerlink" href="#cleanse" title="Permalink to this headline">¶</a></h2>
|
|
59
|
-
<p>The <tt class="docutils literal"><span class="pre">cleanse</span></tt> subcommand is used to re-set the Chef server to the state it was in before the first time the <tt class="docutils literal"><span class="pre">reconfigure</span></tt> subcommand is run to destroy all data, configuration files, and logs.</p>
|
|
60
|
-
<p>This subcommand has the following syntax:</p>
|
|
61
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl cleanse
|
|
62
|
-
</pre></div>
|
|
63
|
-
</div>
|
|
64
|
-
</div>
|
|
65
|
-
<div class="section" id="gather-logs">
|
|
66
|
-
<h2>gather-logs<a class="headerlink" href="#gather-logs" title="Permalink to this headline">¶</a></h2>
|
|
67
|
-
<p>The <tt class="docutils literal"><span class="pre">gather-logs</span></tt> subcommand is used to gather the Chef server log files into a tarball that contains all of the important log files and system information.</p>
|
|
68
|
-
<p>This subcommand has the following syntax:</p>
|
|
69
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl gather-logs
|
|
70
|
-
</pre></div>
|
|
71
|
-
</div>
|
|
72
|
-
</div>
|
|
73
|
-
<div class="section" id="ha-status">
|
|
74
|
-
<h2>ha-status<a class="headerlink" href="#ha-status" title="Permalink to this headline">¶</a></h2>
|
|
75
|
-
<p>The <tt class="docutils literal"><span class="pre">ha-status</span></tt> subcommand is used to check the status for services running in a High Availability topology. This command will verify the following:</p>
|
|
76
|
-
<blockquote>
|
|
77
|
-
<div><ul class="simple">
|
|
78
|
-
<li>The Keepalived daemon is enabled in the config</li>
|
|
79
|
-
<li>The DRBD process is enabled in the config</li>
|
|
80
|
-
<li>The underlying block device or logical volume for DRBD has been created and configured</li>
|
|
81
|
-
<li>The DRBD device exists</li>
|
|
82
|
-
<li>The current state of the server is <tt class="docutils literal"><span class="pre">master</span></tt> or <tt class="docutils literal"><span class="pre">backup</span></tt>; any migration processes have completed</li>
|
|
83
|
-
<li>The failover virtual IP address is correctly attached to only the <tt class="docutils literal"><span class="pre">master</span></tt> node</li>
|
|
84
|
-
<li>The DRBD state is correct based on the state of the server being <tt class="docutils literal"><span class="pre">master</span></tt> or <tt class="docutils literal"><span class="pre">backup</span></tt></li>
|
|
85
|
-
<li>The DRBD mount point is correctly mounted to only the <tt class="docutils literal"><span class="pre">master</span></tt> node</li>
|
|
86
|
-
<li>The DRBD replication IP addresses are pingable</li>
|
|
87
|
-
<li>The <tt class="docutils literal"><span class="pre">runit</span></tt> status of the services are correct (up or down) based on the <tt class="docutils literal"><span class="pre">master</span></tt> or <tt class="docutils literal"><span class="pre">backup</span></tt> state of the server</li>
|
|
88
|
-
</ul>
|
|
89
|
-
</div></blockquote>
|
|
90
|
-
<p>This subcommand has the following syntax:</p>
|
|
91
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl ha-status
|
|
92
|
-
</pre></div>
|
|
93
|
-
</div>
|
|
94
|
-
<p>If this command runs successfully, it will return the following:</p>
|
|
95
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span><span class="o">[</span>OK<span class="o">]</span> all checks passed.
|
|
96
|
-
</pre></div>
|
|
97
|
-
</div>
|
|
98
|
-
<p>Otherwise it will print out a list of errors, similar to the following:</p>
|
|
99
|
-
<div class="highlight-bash"><div class="highlight"><pre>...
|
|
100
|
-
<span class="o">[</span>OK<span class="o">]</span> nginx is running correctly, and I am master.
|
|
101
|
-
<span class="o">[</span>ERROR<span class="o">]</span> redis_lb is not running.
|
|
102
|
-
<span class="o">[</span>OK<span class="o">]</span> opscode-erchef is running correctly, and I am master.
|
|
103
|
-
...
|
|
104
|
-
<span class="o">[</span>ERROR<span class="o">]</span> ERRORS WERE DETECTED.
|
|
105
|
-
</pre></div>
|
|
106
|
-
</div>
|
|
107
|
-
<p>For example:</p>
|
|
108
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="o">[</span>OK<span class="o">]</span> keepalived HA services enabled
|
|
109
|
-
<span class="o">[</span>OK<span class="o">]</span> DRBD disk replication enabled
|
|
110
|
-
<span class="o">[</span>OK<span class="o">]</span> DRBD partition /dev/opscode/drbd found
|
|
111
|
-
<span class="o">[</span>OK<span class="o">]</span> DRBD device /dev/drbd0 found
|
|
112
|
-
<span class="o">[</span>OK<span class="o">]</span> cluster <span class="nv">status</span> <span class="o">=</span> master
|
|
113
|
-
<span class="o">[</span>OK<span class="o">]</span> found VIP IP address and I am master
|
|
114
|
-
<span class="o">[</span>OK<span class="o">]</span> found VRRP communications interface eth1
|
|
115
|
-
<span class="o">[</span>OK<span class="o">]</span> my DRBD status is Connected/Primary/UpToDate and I am master
|
|
116
|
-
<span class="o">[</span>OK<span class="o">]</span> my DRBD partition is mounted and I am master
|
|
117
|
-
<span class="o">[</span>OK<span class="o">]</span> DRBD primary IP address pings
|
|
118
|
-
<span class="o">[</span>OK<span class="o">]</span> DRBD secondary IP address pings
|
|
119
|
-
...
|
|
120
|
-
<span class="o">[</span>OK<span class="o">]</span> all checks passed.
|
|
121
|
-
</pre></div>
|
|
122
|
-
</div>
|
|
123
|
-
</div>
|
|
124
|
-
<div class="section" id="help">
|
|
125
|
-
<h2>help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
|
|
126
|
-
<p>The <tt class="docutils literal"><span class="pre">help</span></tt> subcommand is used to print a list of all available chef-server-ctl commands.</p>
|
|
127
|
-
<p>This subcommand has the following syntax:</p>
|
|
128
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl <span class="nb">help</span>
|
|
129
|
-
</pre></div>
|
|
130
|
-
</div>
|
|
131
|
-
</div>
|
|
132
|
-
<div class="section" id="install">
|
|
133
|
-
<h2>install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
|
|
134
|
-
<p>The <tt class="docutils literal"><span class="pre">install</span></tt> subcommand is used to install premium features of the Chef server: Chef management console, Chef analytics, chef-client run reporting, high availability configurations, Chef push jobs, and Chef server replication.</p>
|
|
135
|
-
<p><strong>Syntax</strong></p>
|
|
136
|
-
<p>This subcommand has the following syntax:</p>
|
|
137
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl install name_of_premium_feature <span class="o">(</span>options<span class="o">)</span>
|
|
138
|
-
</pre></div>
|
|
139
|
-
</div>
|
|
140
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_premium_feature</span></tt> represents the command line value associated with the premium feature:</p>
|
|
141
|
-
<p><strong>Options</strong></p>
|
|
142
|
-
<p>This subcommand has the following options:</p>
|
|
143
|
-
<dl class="docutils">
|
|
144
|
-
<dt><tt class="docutils literal"><span class="pre">--path</span> <span class="pre">PATH</span></tt></dt>
|
|
145
|
-
<dd>Use to specify the location of a package. This option is not required when packages are downloaded from <a class="reference external" href="https://packagecloud.io/">https://packagecloud.io/</a>.</dd>
|
|
146
|
-
</dl>
|
|
147
|
-
<div class="section" id="use-downloads">
|
|
148
|
-
<h3>Use Downloads<a class="headerlink" href="#use-downloads" title="Permalink to this headline">¶</a></h3>
|
|
149
|
-
<p>The <tt class="docutils literal"><span class="pre">install</span></tt> subcommand downloads packages from <a class="reference external" href="https://packagecloud.io/">https://packagecloud.io/</a> by default. For systems that are not behind a firewall (and have connectivity to <a class="reference external" href="https://packagecloud.io/">https://packagecloud.io/</a>), these packages can be installed as described below.</p>
|
|
150
|
-
<table border="1" class="docutils">
|
|
151
|
-
<colgroup>
|
|
152
|
-
<col width="20%" />
|
|
153
|
-
<col width="80%" />
|
|
154
|
-
</colgroup>
|
|
155
|
-
<thead valign="bottom">
|
|
156
|
-
<tr class="row-odd"><th class="head">Feature</th>
|
|
157
|
-
<th class="head">Command</th>
|
|
158
|
-
</tr>
|
|
159
|
-
</thead>
|
|
160
|
-
<tbody valign="top">
|
|
161
|
-
<tr class="row-even"><td>Chef Manage</td>
|
|
162
|
-
<td><p class="first">Use Chef management console to manage data bags, attributes, run-lists, roles, environments, and cookbooks from a web user interface.</p>
|
|
163
|
-
<p>(Front end machines only.) Run:</p>
|
|
164
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl install opscode-manage
|
|
165
|
-
</pre></div>
|
|
166
|
-
</div>
|
|
167
|
-
<p>then:</p>
|
|
168
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ opscode-manage-ctl reconfigure
|
|
169
|
-
</pre></div>
|
|
170
|
-
</div>
|
|
171
|
-
<p>and then:</p>
|
|
172
|
-
<div class="last highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl reconfigure
|
|
173
|
-
</pre></div>
|
|
174
|
-
</div>
|
|
175
|
-
</td>
|
|
176
|
-
</tr>
|
|
177
|
-
<tr class="row-odd"><td>Chef Push Jobs</td>
|
|
178
|
-
<td><p class="first">Use Chef push jobs to run jobs—an action or a command to be executed—against nodes independently of a chef-client run.</p>
|
|
179
|
-
<p>Run:</p>
|
|
180
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl install opscode-push-jobs-server
|
|
181
|
-
</pre></div>
|
|
182
|
-
</div>
|
|
183
|
-
<p>then:</p>
|
|
184
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ opscode-push-jobs-server-ctl reconfigure
|
|
185
|
-
</pre></div>
|
|
186
|
-
</div>
|
|
187
|
-
<p>and then:</p>
|
|
188
|
-
<div class="last highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl reconfigure
|
|
189
|
-
</pre></div>
|
|
190
|
-
</div>
|
|
191
|
-
</td>
|
|
192
|
-
</tr>
|
|
193
|
-
<tr class="row-even"><td>Chef Replication</td>
|
|
194
|
-
<td><p class="first">Use Chef replication to asynchronously distribute cookbook, environment, role, and data bag data from a single, primary Chef server to one (or more) replicas of that Chef server.</p>
|
|
195
|
-
<p>Run:</p>
|
|
196
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl install chef-sync
|
|
197
|
-
</pre></div>
|
|
198
|
-
</div>
|
|
199
|
-
<p>and then:</p>
|
|
200
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ chef-sync-ctl reconfigure
|
|
201
|
-
</pre></div>
|
|
202
|
-
</div>
|
|
203
|
-
<p>and then:</p>
|
|
204
|
-
<div class="last highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl reconfigure
|
|
205
|
-
</pre></div>
|
|
206
|
-
</div>
|
|
207
|
-
</td>
|
|
208
|
-
</tr>
|
|
209
|
-
<tr class="row-odd"><td>Reporting</td>
|
|
210
|
-
<td><p class="first">Use Chef reporting to keep track of what happens during every chef-client runs across all of the infrastructure being managed by Chef. Run Chef reporting with Chef management console to view reports from a web user interface.</p>
|
|
211
|
-
<p>(Front end machines only.) Run:</p>
|
|
212
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl install opscode-reporting
|
|
213
|
-
</pre></div>
|
|
214
|
-
</div>
|
|
215
|
-
<p>then:</p>
|
|
216
|
-
<div class="highlight-ruby"><div class="highlight"><pre>$ opscode-reporting-ctl reconfigure
|
|
217
|
-
</pre></div>
|
|
218
|
-
</div>
|
|
219
|
-
<p>and then:</p>
|
|
220
|
-
<div class="last highlight-ruby"><div class="highlight"><pre>$ chef-server-ctl reconfigure
|
|
221
|
-
</pre></div>
|
|
222
|
-
</div>
|
|
223
|
-
</td>
|
|
224
|
-
</tr>
|
|
225
|
-
</tbody>
|
|
226
|
-
</table>
|
|
227
|
-
</div>
|
|
228
|
-
<div class="section" id="use-local-packages">
|
|
229
|
-
<h3>Use Local Packages<a class="headerlink" href="#use-local-packages" title="Permalink to this headline">¶</a></h3>
|
|
230
|
-
<p>The <tt class="docutils literal"><span class="pre">install</span></tt> subcommand downloads packages from <a class="reference external" href="https://packagecloud.io/">https://packagecloud.io/</a> by default. For systems that are behind a firewall (and do not have connectivity to <a class="reference external" href="https://packagecloud.io/">https://packagecloud.io/</a>), these packages can be installed manually. First download the package that is appropriate for the platform and save it to a local path. Then run the <tt class="docutils literal"><span class="pre">install</span></tt> command using the <tt class="docutils literal"><span class="pre">--path</span></tt> option to specify the location for the package:</p>
|
|
231
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl install NAME_OF_PACKAGE --path /path/to/package
|
|
232
|
-
</pre></div>
|
|
233
|
-
</div>
|
|
234
|
-
<p>For example:</p>
|
|
235
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl install opscode-manage-1.6.2-1.el6.x86_64 --path /home/vagrant
|
|
236
|
-
</pre></div>
|
|
237
|
-
</div>
|
|
238
|
-
</div>
|
|
239
|
-
</div>
|
|
240
|
-
<div class="section" id="master-recover">
|
|
241
|
-
<h2>master-recover<a class="headerlink" href="#master-recover" title="Permalink to this headline">¶</a></h2>
|
|
242
|
-
<p>The <tt class="docutils literal"><span class="pre">master-recover</span></tt> subcommand is used to force the Chef server to attempt to become the master server. This command is typically run in tandem with the <tt class="docutils literal"><span class="pre">backup-recover</span></tt> subcommand on the back-end peer, unless the back-end peer is no longer available.</p>
|
|
243
|
-
<p>This subcommand has the following syntax:</p>
|
|
244
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl master-recover
|
|
245
|
-
</pre></div>
|
|
246
|
-
</div>
|
|
247
|
-
</div>
|
|
248
|
-
<div class="section" id="org-create">
|
|
249
|
-
<h2>org-create<a class="headerlink" href="#org-create" title="Permalink to this headline">¶</a></h2>
|
|
250
|
-
<p>The <tt class="docutils literal"><span class="pre">org-create</span></tt> subcommand is used to create an organization. (The validation key for the organization is returned to <tt class="docutils literal"><span class="pre">STDOUT</span></tt> when creating an organization using this command.)</p>
|
|
251
|
-
<p><strong>Syntax</strong></p>
|
|
252
|
-
<p>This subcommand has the following syntax:</p>
|
|
253
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-create ORG_NAME ORG_FULL_NAME <span class="o">(</span>options<span class="o">)</span>
|
|
254
|
-
</pre></div>
|
|
255
|
-
</div>
|
|
256
|
-
<p><strong>Options</strong></p>
|
|
257
|
-
<p>This subcommand has the following options:</p>
|
|
258
|
-
<dl class="docutils">
|
|
259
|
-
<dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">USER_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--association_user</span> <span class="pre">USER_NAME</span></tt></dt>
|
|
260
|
-
<dd>Use to associate a user with an organization and add them to the <tt class="docutils literal"><span class="pre">admins</span></tt> and <tt class="docutils literal"><span class="pre">billing_admins</span></tt> security groups.</dd>
|
|
261
|
-
<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--filename</span> <span class="pre">FILE_NAME</span></tt></dt>
|
|
262
|
-
<dd>Use to write the private key to a file instead of <tt class="docutils literal"><span class="pre">STDOUT</span></tt>.</dd>
|
|
263
|
-
</dl>
|
|
264
|
-
<p><strong>Examples</strong></p>
|
|
265
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-create prod Production
|
|
266
|
-
</pre></div>
|
|
267
|
-
</div>
|
|
268
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-create staging Staging -a chef-admin
|
|
269
|
-
</pre></div>
|
|
270
|
-
</div>
|
|
271
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-create dev Development -f /tmp/id-dev.key
|
|
272
|
-
</pre></div>
|
|
273
|
-
</div>
|
|
274
|
-
</div>
|
|
275
|
-
<div class="section" id="org-delete">
|
|
276
|
-
<h2>org-delete<a class="headerlink" href="#org-delete" title="Permalink to this headline">¶</a></h2>
|
|
277
|
-
<p>The <tt class="docutils literal"><span class="pre">org-delete</span></tt> subcommand is used to delete an organization.</p>
|
|
278
|
-
<p><strong>Syntax</strong></p>
|
|
279
|
-
<p>This subcommand has the following syntax:</p>
|
|
280
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-delete ORG_NAME
|
|
281
|
-
</pre></div>
|
|
282
|
-
</div>
|
|
283
|
-
<p><strong>Examples</strong></p>
|
|
284
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-delete infra-testing-20140909
|
|
285
|
-
</pre></div>
|
|
286
|
-
</div>
|
|
287
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-delete pedant-testing-org
|
|
288
|
-
</pre></div>
|
|
289
|
-
</div>
|
|
290
|
-
</div>
|
|
291
|
-
<div class="section" id="org-list">
|
|
292
|
-
<h2>org-list<a class="headerlink" href="#org-list" title="Permalink to this headline">¶</a></h2>
|
|
293
|
-
<p>The <tt class="docutils literal"><span class="pre">org-list</span></tt> subcommand is used to list all of the organizations currently present on the Chef server.</p>
|
|
294
|
-
<p><strong>Syntax</strong></p>
|
|
295
|
-
<p>This subcommand has the following syntax:</p>
|
|
296
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-list <span class="o">(</span>options<span class="o">)</span>
|
|
297
|
-
</pre></div>
|
|
298
|
-
</div>
|
|
299
|
-
<p><strong>Options</strong></p>
|
|
300
|
-
<p>This subcommand has the following options:</p>
|
|
301
|
-
<dl class="docutils">
|
|
302
|
-
<dt><tt class="docutils literal"><span class="pre">-a</span></tt>, <tt class="docutils literal"><span class="pre">--all-orgs</span></tt></dt>
|
|
303
|
-
<dd>Use to show all organizations.</dd>
|
|
304
|
-
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
|
305
|
-
<dd>Use to show the corresponding URIs.</dd>
|
|
306
|
-
</dl>
|
|
307
|
-
</div>
|
|
308
|
-
<div class="section" id="org-show">
|
|
309
|
-
<h2>org-show<a class="headerlink" href="#org-show" title="Permalink to this headline">¶</a></h2>
|
|
310
|
-
<p>The <tt class="docutils literal"><span class="pre">org-show</span></tt> subcommand is used to show the details for an organization.</p>
|
|
311
|
-
<p><strong>Syntax</strong></p>
|
|
312
|
-
<p>This subcommand has the following syntax:</p>
|
|
313
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-show ORG_NAME
|
|
314
|
-
</pre></div>
|
|
315
|
-
</div>
|
|
316
|
-
</div>
|
|
317
|
-
<div class="section" id="org-user-add">
|
|
318
|
-
<h2>org-user-add<a class="headerlink" href="#org-user-add" title="Permalink to this headline">¶</a></h2>
|
|
319
|
-
<p>The <tt class="docutils literal"><span class="pre">org-user-add</span></tt> subcommand is used to add a user to an organization.</p>
|
|
320
|
-
<p><strong>Syntax</strong></p>
|
|
321
|
-
<p>This subcommand has the following syntax:</p>
|
|
322
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-add ORG_NAME USER_NAME <span class="o">(</span>options<span class="o">)</span>
|
|
323
|
-
</pre></div>
|
|
324
|
-
</div>
|
|
325
|
-
<p><strong>Options</strong></p>
|
|
326
|
-
<p>This subcommand has the following options:</p>
|
|
327
|
-
<dl class="docutils">
|
|
328
|
-
<dt><tt class="docutils literal"><span class="pre">--admin</span></tt></dt>
|
|
329
|
-
<dd>Use to add the user to the <tt class="docutils literal"><span class="pre">admins</span></tt> group.</dd>
|
|
330
|
-
</dl>
|
|
331
|
-
<p><strong>Examples</strong></p>
|
|
332
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-add prod john_smith
|
|
333
|
-
</pre></div>
|
|
334
|
-
</div>
|
|
335
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-add preprod testmaster
|
|
336
|
-
</pre></div>
|
|
337
|
-
</div>
|
|
338
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-add dev grantmc --admin
|
|
339
|
-
</pre></div>
|
|
340
|
-
</div>
|
|
341
|
-
</div>
|
|
342
|
-
<div class="section" id="org-user-remove">
|
|
343
|
-
<h2>org-user-remove<a class="headerlink" href="#org-user-remove" title="Permalink to this headline">¶</a></h2>
|
|
344
|
-
<p>The <tt class="docutils literal"><span class="pre">org-user-remove</span></tt> subcommand is used to remove a user from an organization.</p>
|
|
345
|
-
<p><strong>Syntax</strong></p>
|
|
346
|
-
<p>This subcommand has the following syntax:</p>
|
|
347
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-remove ORG_NAME USER_NAME
|
|
348
|
-
</pre></div>
|
|
349
|
-
</div>
|
|
350
|
-
<p><strong>Examples</strong></p>
|
|
351
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-remove prod john_smith
|
|
352
|
-
</pre></div>
|
|
353
|
-
</div>
|
|
354
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl org-user-remove prod testmaster
|
|
355
|
-
</pre></div>
|
|
356
|
-
</div>
|
|
357
|
-
</div>
|
|
358
|
-
<div class="section" id="password">
|
|
359
|
-
<h2>password<a class="headerlink" href="#password" title="Permalink to this headline">¶</a></h2>
|
|
360
|
-
<div class="admonition warning">
|
|
361
|
-
<p class="first admonition-title">Warning</p>
|
|
362
|
-
<p class="last">This subcommand is currently disabled.</p>
|
|
363
|
-
</div>
|
|
364
|
-
</div>
|
|
365
|
-
<div class="section" id="reconfigure">
|
|
366
|
-
<h2>reconfigure<a class="headerlink" href="#reconfigure" title="Permalink to this headline">¶</a></h2>
|
|
367
|
-
<p>The <tt class="docutils literal"><span class="pre">reconfigure</span></tt> subcommand is used when changes are made to the private-chef.rb file to reconfigure the server. When changes are made to the private-chef.rb file, they will not be applied to the Chef server configuration until after this command is run. This subcommand will also restart any services for which the <tt class="docutils literal"><span class="pre">service_name['enabled']</span></tt> setting is set to <tt class="docutils literal"><span class="pre">true</span></tt>.</p>
|
|
368
|
-
<p>This subcommand has the following syntax:</p>
|
|
369
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl reconfigure
|
|
370
|
-
</pre></div>
|
|
371
|
-
</div>
|
|
372
|
-
</div>
|
|
373
|
-
<div class="section" id="show-config">
|
|
374
|
-
<h2>show-config<a class="headerlink" href="#show-config" title="Permalink to this headline">¶</a></h2>
|
|
375
|
-
<p>The <tt class="docutils literal"><span class="pre">show-config</span></tt> subcommand is used to view the configuration that will be generated by the <tt class="docutils literal"><span class="pre">reconfigure</span></tt> subcommand. This command is most useful in the early stages of a deployment to ensure that everything is built properly prior to installation.</p>
|
|
376
|
-
<p>This subcommand has the following syntax:</p>
|
|
377
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl show-config
|
|
378
|
-
</pre></div>
|
|
379
|
-
</div>
|
|
380
|
-
</div>
|
|
381
|
-
<div class="section" id="uninstall">
|
|
382
|
-
<h2>uninstall<a class="headerlink" href="#uninstall" title="Permalink to this headline">¶</a></h2>
|
|
383
|
-
<p>The <tt class="docutils literal"><span class="pre">uninstall</span></tt> subcommand is used to remove the Chef server application, but without removing any of the data. This subcommand will shut down all services (including the <tt class="docutils literal"><span class="pre">runit</span></tt> process supervisor).</p>
|
|
384
|
-
<p>This subcommand has the following syntax:</p>
|
|
385
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl uninstall
|
|
386
|
-
</pre></div>
|
|
387
|
-
</div>
|
|
388
|
-
<div class="admonition note">
|
|
389
|
-
<p class="first admonition-title">Note</p>
|
|
390
|
-
<p class="last">To revert the <tt class="docutils literal"><span class="pre">uninstall</span></tt> subcommand, run the <tt class="docutils literal"><span class="pre">reconfigure</span></tt> subcommand (because the <tt class="docutils literal"><span class="pre">start</span></tt> subcommand is disabled by the <tt class="docutils literal"><span class="pre">uninstall</span></tt> command).</p>
|
|
391
|
-
</div>
|
|
392
|
-
</div>
|
|
393
|
-
<div class="section" id="upgrade">
|
|
394
|
-
<h2>upgrade<a class="headerlink" href="#upgrade" title="Permalink to this headline">¶</a></h2>
|
|
395
|
-
<p>The <tt class="docutils literal"><span class="pre">upgrade</span></tt> subcommand is used to upgrade the Chef server.</p>
|
|
396
|
-
<p><strong>Syntax</strong></p>
|
|
397
|
-
<p>This subcommand has the following syntax:</p>
|
|
398
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl upgrade <span class="o">(</span>options<span class="o">)</span>
|
|
399
|
-
</pre></div>
|
|
400
|
-
</div>
|
|
401
|
-
<p><strong>Options</strong></p>
|
|
402
|
-
<div class="admonition note">
|
|
403
|
-
<p class="first admonition-title">Note</p>
|
|
404
|
-
<p class="last">Options for the <tt class="docutils literal"><span class="pre">upgrade</span></tt> subcommand may only be used when upgrading from Open Source Chef 11 to Chef server 12.</p>
|
|
405
|
-
</div>
|
|
406
|
-
<p>This subcommand has the following options:</p>
|
|
407
|
-
<dl class="docutils">
|
|
408
|
-
<dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--chef11-data-dir</span> <span class="pre">DIRECTORY</span></tt></dt>
|
|
409
|
-
<dd>The directory in which Open Source Chef 11 data is located. Default value: a temporary directory.</dd>
|
|
410
|
-
<dt><tt class="docutils literal"><span class="pre">-e</span> <span class="pre">DIRECTORY</span></tt>, <tt class="docutils literal"><span class="pre">--chef12-data-dir</span> <span class="pre">DIRECTORY</span></tt></dt>
|
|
411
|
-
<dd>The directory in which Chef server 12 data is located. Default value: a temporary directory.</dd>
|
|
412
|
-
<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FULL_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--full-org-name</span> <span class="pre">FULL_NAME</span></tt></dt>
|
|
413
|
-
<dd>The full name of the Chef server organization. A full organization name must begin with a non-white space character and must be between 1 and 1023 characters. For example: <tt class="docutils literal"><span class="pre">Chef</span> <span class="pre">Software,</span> <span class="pre">Inc.</span></tt>. If this option is not specified, the <tt class="docutils literal"><span class="pre">upgrade</span></tt> command will prompt for it.</dd>
|
|
414
|
-
<dt><tt class="docutils literal"><span class="pre">-h</span></tt>, <tt class="docutils literal"><span class="pre">--help</span></tt></dt>
|
|
415
|
-
<dd>Use to show help for the <tt class="docutils literal"><span class="pre">chef-server-ctl</span> <span class="pre">upgrade</span></tt> subcommand.</dd>
|
|
416
|
-
<dt><tt class="docutils literal"><span class="pre">-k</span> <span class="pre">KEY</span></tt>, <tt class="docutils literal"><span class="pre">--key</span> <span class="pre">KEY</span></tt></dt>
|
|
417
|
-
<dd>All users are assigned a public key. Use to write the public key to a file. Default value: <tt class="docutils literal"><span class="pre">/etc/chef-server/admin.pem</span></tt>.</dd>
|
|
418
|
-
<dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">ORG_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--org-name</span> <span class="pre">ORG_NAME</span></tt></dt>
|
|
419
|
-
<dd>The name of the Chef server organization. An organization name must begin with a lower-case letter or digit, may only contain lower-case letters, digits, hyphens, and underscores, and must be between 1 and 255 characters. For example: <tt class="docutils literal"><span class="pre">chef</span></tt>. If this option is not specified, the <tt class="docutils literal"><span class="pre">upgrade</span></tt> command will prompt for it.</dd>
|
|
420
|
-
<dt><tt class="docutils literal"><span class="pre">-s</span> <span class="pre">URL</span></tt>, <tt class="docutils literal"><span class="pre">--chef11-server-url</span> <span class="pre">URL</span></tt></dt>
|
|
421
|
-
<dd>The URL for the Open Source Chef or Enterprise Chef server, version 11. Default value: <tt class="docutils literal"><span class="pre">https://localhost</span></tt>.</dd>
|
|
422
|
-
<dt><tt class="docutils literal"><span class="pre">-t</span> <span class="pre">NUMBER</span></tt>, <tt class="docutils literal"><span class="pre">--upload-threads</span> <span class="pre">NUMBER</span></tt></dt>
|
|
423
|
-
<dd>The number of threads to use when migrating cookbooks. Default value: <tt class="docutils literal"><span class="pre">10</span></tt>.</dd>
|
|
424
|
-
<dt><tt class="docutils literal"><span class="pre">-u</span> <span class="pre">USER</span></tt>, <tt class="docutils literal"><span class="pre">--user</span></tt></dt>
|
|
425
|
-
<dd>Use to create a client as an admin client. This is required for any user to access Open Source Chef as an administrator.</dd>
|
|
426
|
-
<dt><tt class="docutils literal"><span class="pre">-x</span> <span class="pre">URL</span></tt>, <tt class="docutils literal"><span class="pre">--chef12-server-url</span> <span class="pre">URL</span></tt></dt>
|
|
427
|
-
<dd>The URL for the Chef server, version 12. Default value: <tt class="docutils literal"><span class="pre">https://localhost</span></tt>.</dd>
|
|
428
|
-
<dt><tt class="docutils literal"><span class="pre">-y</span></tt>, <tt class="docutils literal"><span class="pre">--yes</span></tt></dt>
|
|
429
|
-
<dd>Use to skip confirmation prompts during the upgrade process.</dd>
|
|
430
|
-
</dl>
|
|
431
|
-
</div>
|
|
432
|
-
<div class="section" id="user-create">
|
|
433
|
-
<h2>user-create<a class="headerlink" href="#user-create" title="Permalink to this headline">¶</a></h2>
|
|
434
|
-
<p>The <tt class="docutils literal"><span class="pre">user-create</span></tt> subcommand is used to create a user.</p>
|
|
435
|
-
<p><strong>Syntax</strong></p>
|
|
436
|
-
<p>This subcommand has the following syntax:</p>
|
|
437
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-create USER_NAME FIRST_NAME <span class="o">[</span>MIDDLE_NAME<span class="o">]</span> LAST_NAME EMAIL PASSWORD <span class="o">(</span>options<span class="o">)</span>
|
|
438
|
-
</pre></div>
|
|
439
|
-
</div>
|
|
440
|
-
<p><strong>Options</strong></p>
|
|
441
|
-
<p>This subcommand has the following options:</p>
|
|
442
|
-
<dl class="docutils">
|
|
443
|
-
<dt><tt class="docutils literal"><span class="pre">-f</span> <span class="pre">FILE_NAME</span></tt>, <tt class="docutils literal"><span class="pre">--filename</span> <span class="pre">FILE_NAME</span></tt></dt>
|
|
444
|
-
<dd>Use to write the private key to a file instead of <tt class="docutils literal"><span class="pre">STDOUT</span></tt>.</dd>
|
|
445
|
-
</dl>
|
|
446
|
-
<p><strong>Examples</strong></p>
|
|
447
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-create john_smith John Smith john_smith@example.com insecure-passord
|
|
448
|
-
</pre></div>
|
|
449
|
-
</div>
|
|
450
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-create jane_doe Jane Doe jane_doe@example.com PaSSword -f /tmp/jane_doe.key
|
|
451
|
-
</pre></div>
|
|
452
|
-
</div>
|
|
453
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-create waldendude Henry David Thoreau waldendude@example.com excursions
|
|
454
|
-
</pre></div>
|
|
455
|
-
</div>
|
|
456
|
-
</div>
|
|
457
|
-
<div class="section" id="user-delete">
|
|
458
|
-
<h2>user-delete<a class="headerlink" href="#user-delete" title="Permalink to this headline">¶</a></h2>
|
|
459
|
-
<p>The <tt class="docutils literal"><span class="pre">user-delete</span></tt> subcommand is used to delete a user.</p>
|
|
460
|
-
<p><strong>Syntax</strong></p>
|
|
461
|
-
<p>This subcommand has the following syntax:</p>
|
|
462
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-delete USER_NAME
|
|
463
|
-
</pre></div>
|
|
464
|
-
</div>
|
|
465
|
-
<p><strong>Examples</strong></p>
|
|
466
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-delete john_smith
|
|
467
|
-
</pre></div>
|
|
468
|
-
</div>
|
|
469
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-delete jane_doe
|
|
470
|
-
</pre></div>
|
|
471
|
-
</div>
|
|
472
|
-
</div>
|
|
473
|
-
<div class="section" id="user-edit">
|
|
474
|
-
<h2>user-edit<a class="headerlink" href="#user-edit" title="Permalink to this headline">¶</a></h2>
|
|
475
|
-
<p>The <tt class="docutils literal"><span class="pre">user-edit</span></tt> subcommand is used to edit the details for a user. The data will be made available in the $EDITOR for editing.</p>
|
|
476
|
-
<p><strong>Syntax</strong></p>
|
|
477
|
-
<p>This subcommand has the following syntax:</p>
|
|
478
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-edit USER_NAME
|
|
479
|
-
</pre></div>
|
|
480
|
-
</div>
|
|
481
|
-
<p><strong>Examples</strong></p>
|
|
482
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-edit john_smith
|
|
483
|
-
</pre></div>
|
|
484
|
-
</div>
|
|
485
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-edit jane_doe
|
|
486
|
-
</pre></div>
|
|
487
|
-
</div>
|
|
488
|
-
</div>
|
|
489
|
-
<div class="section" id="user-list">
|
|
490
|
-
<h2>user-list<a class="headerlink" href="#user-list" title="Permalink to this headline">¶</a></h2>
|
|
491
|
-
<p>The <tt class="docutils literal"><span class="pre">user-list</span></tt> subcommand is used to view a list of users.</p>
|
|
492
|
-
<p><strong>Syntax</strong></p>
|
|
493
|
-
<p>This subcommand has the following syntax:</p>
|
|
494
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-list <span class="o">(</span>options<span class="o">)</span>
|
|
495
|
-
</pre></div>
|
|
496
|
-
</div>
|
|
497
|
-
<p><strong>Options</strong></p>
|
|
498
|
-
<p>This subcommand has the following options:</p>
|
|
499
|
-
<dl class="docutils">
|
|
500
|
-
<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt>
|
|
501
|
-
<dd>Use to show the corresponding URIs.</dd>
|
|
502
|
-
</dl>
|
|
503
|
-
</div>
|
|
504
|
-
<div class="section" id="user-show">
|
|
505
|
-
<h2>user-show<a class="headerlink" href="#user-show" title="Permalink to this headline">¶</a></h2>
|
|
506
|
-
<p>The <tt class="docutils literal"><span class="pre">user-show</span></tt> subcommand is used to show the details for a user.</p>
|
|
507
|
-
<p><strong>Syntax</strong></p>
|
|
508
|
-
<p>This subcommand has the following syntax:</p>
|
|
509
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl user-show USER_NAME <span class="o">(</span>options<span class="o">)</span>
|
|
510
|
-
</pre></div>
|
|
511
|
-
</div>
|
|
512
|
-
<p><strong>Options</strong></p>
|
|
513
|
-
<p>This subcommand has the following options:</p>
|
|
514
|
-
<dl class="docutils">
|
|
515
|
-
<dt><tt class="docutils literal"><span class="pre">-l</span></tt>, <tt class="docutils literal"><span class="pre">--with-orgs</span></tt></dt>
|
|
516
|
-
<dd>Use to show the corresponding organizations.</dd>
|
|
517
|
-
</dl>
|
|
518
|
-
</div>
|
|
519
|
-
<div class="section" id="service-subcommands">
|
|
520
|
-
<h2>Service Subcommands<a class="headerlink" href="#service-subcommands" title="Permalink to this headline">¶</a></h2>
|
|
521
|
-
<p>The Chef server has a built in process supervisor, which ensures that all of the required services are in the appropriate state at any given time. The supervisor starts two processes per service.</p>
|
|
522
|
-
<div class="section" id="hup">
|
|
523
|
-
<h3>hup<a class="headerlink" href="#hup" title="Permalink to this headline">¶</a></h3>
|
|
524
|
-
<p>The <tt class="docutils literal"><span class="pre">hup</span></tt> subcommand is used to send a <tt class="docutils literal"><span class="pre">SIGHUP</span></tt> to all services. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
525
|
-
<p>This subcommand has the following syntax:</p>
|
|
526
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl hup name_of_service
|
|
527
|
-
</pre></div>
|
|
528
|
-
</div>
|
|
529
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
530
|
-
</div>
|
|
531
|
-
<div class="section" id="int">
|
|
532
|
-
<h3>int<a class="headerlink" href="#int" title="Permalink to this headline">¶</a></h3>
|
|
533
|
-
<p>The <tt class="docutils literal"><span class="pre">int</span></tt> subcommand is used to send a <tt class="docutils literal"><span class="pre">SIGINT</span></tt> to all services. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
534
|
-
<p>This subcommand has the following syntax:</p>
|
|
535
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl int name_of_service
|
|
536
|
-
</pre></div>
|
|
537
|
-
</div>
|
|
538
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
539
|
-
</div>
|
|
540
|
-
<div class="section" id="kill">
|
|
541
|
-
<h3>kill<a class="headerlink" href="#kill" title="Permalink to this headline">¶</a></h3>
|
|
542
|
-
<p>The <tt class="docutils literal"><span class="pre">kill</span></tt> subcommand is used to send a <tt class="docutils literal"><span class="pre">SIGKILL</span></tt> to all services. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
543
|
-
<p>This subcommand has the following syntax:</p>
|
|
544
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl <span class="nb">kill </span>name_of_service
|
|
545
|
-
</pre></div>
|
|
546
|
-
</div>
|
|
547
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
548
|
-
</div>
|
|
549
|
-
<div class="section" id="once">
|
|
550
|
-
<h3>once<a class="headerlink" href="#once" title="Permalink to this headline">¶</a></h3>
|
|
551
|
-
<p>The supervisor for the Chef server is configured to restart any service that fails, unless that service has been asked to change its state. The <tt class="docutils literal"><span class="pre">once</span></tt> subcommand is used to tell the supervisor to not attempt to restart any service that fails.</p>
|
|
552
|
-
<p>This command is useful when troubleshooting configuration errors that prevent a service from starting. Run the <tt class="docutils literal"><span class="pre">once</span></tt> subcommand followed by the <tt class="docutils literal"><span class="pre">status</span></tt> subcommand to look for services in a down state and/or to identify which services are in trouble. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
553
|
-
<p>This subcommand has the following syntax:</p>
|
|
554
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl once name_of_service
|
|
555
|
-
</pre></div>
|
|
556
|
-
</div>
|
|
557
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
558
|
-
</div>
|
|
559
|
-
<div class="section" id="restart">
|
|
560
|
-
<h3>restart<a class="headerlink" href="#restart" title="Permalink to this headline">¶</a></h3>
|
|
561
|
-
<p>The <tt class="docutils literal"><span class="pre">restart</span></tt> subcommand is used to restart all services enabled on the Chef server or to restart an individual service by specifying the name of that service in the command.</p>
|
|
562
|
-
<div class="admonition warning">
|
|
563
|
-
<p class="first admonition-title">Warning</p>
|
|
564
|
-
<p class="last">When running the Chef server in a high availability configuration, restarting all services may trigger failover.</p>
|
|
565
|
-
</div>
|
|
566
|
-
<p>This subcommand has the following syntax:</p>
|
|
567
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl restart name_of_service
|
|
568
|
-
</pre></div>
|
|
569
|
-
</div>
|
|
570
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand. When a service is successfully restarted the output should be similar to:</p>
|
|
571
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>ok: run: service_name: <span class="o">(</span>pid 12345<span class="o">)</span> 1s
|
|
572
|
-
</pre></div>
|
|
573
|
-
</div>
|
|
574
|
-
</div>
|
|
575
|
-
<div class="section" id="service-list">
|
|
576
|
-
<h3>service-list<a class="headerlink" href="#service-list" title="Permalink to this headline">¶</a></h3>
|
|
577
|
-
<p>The <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand is used to display a list of all available services. A service that is enabled is labeled with an asterisk (*).</p>
|
|
578
|
-
<p>This subcommand has the following syntax:</p>
|
|
579
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl service-list
|
|
580
|
-
</pre></div>
|
|
581
|
-
</div>
|
|
582
|
-
</div>
|
|
583
|
-
<div class="section" id="start">
|
|
584
|
-
<h3>start<a class="headerlink" href="#start" title="Permalink to this headline">¶</a></h3>
|
|
585
|
-
<p>The <tt class="docutils literal"><span class="pre">start</span></tt> subcommand is used to start all services that are enabled in the Chef server. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
586
|
-
<p>This subcommand has the following syntax:</p>
|
|
587
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl start name_of_service
|
|
588
|
-
</pre></div>
|
|
589
|
-
</div>
|
|
590
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand. When a service is successfully started the output should be similar to:</p>
|
|
591
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>ok: run: service_name: <span class="o">(</span>pid 12345<span class="o">)</span> 1s
|
|
592
|
-
</pre></div>
|
|
593
|
-
</div>
|
|
594
|
-
<p>The supervisor for the Chef server is configured to wait seven seconds for a service to respond to a command from the supervisor. If you see output that references a timeout, it means that a signal has been sent to the process, but that the process has yet to actually comply. In general, processes that have timed out are not a big concern, unless they are failing to respond to the signals at all. If a process is not responding, use a command like the <tt class="docutils literal"><span class="pre">kill</span></tt> subcommand to stop the process, investigate the cause (if required), and then use the <tt class="docutils literal"><span class="pre">start</span></tt> subcommand to re-enable it.</p>
|
|
595
|
-
</div>
|
|
596
|
-
<div class="section" id="status">
|
|
597
|
-
<h3>status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h3>
|
|
598
|
-
<p>The <tt class="docutils literal"><span class="pre">status</span></tt> subcommand is used to show the status of all services available to the Chef server. The results will vary based on the configuration of a given server. This subcommand has the following syntax:</p>
|
|
599
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl status
|
|
600
|
-
</pre></div>
|
|
601
|
-
</div>
|
|
602
|
-
<p>and will return the status for all services. Status can be returned for individual services by specifying the name of the service as part of the command:</p>
|
|
603
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl status name_of_service
|
|
604
|
-
</pre></div>
|
|
605
|
-
</div>
|
|
606
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
607
|
-
<p>When service status is requested, the output should be similar to:</p>
|
|
608
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>run: service_name: <span class="o">(</span>pid 12345<span class="o">)</span> 12345s; run: log: <span class="o">(</span>pid 1234<span class="o">)</span> 67890s
|
|
609
|
-
</pre></div>
|
|
610
|
-
</div>
|
|
611
|
-
<p>where</p>
|
|
612
|
-
<ul class="simple">
|
|
613
|
-
<li><tt class="docutils literal"><span class="pre">run:</span></tt> is the state of the service (<tt class="docutils literal"><span class="pre">run:</span></tt> or <tt class="docutils literal"><span class="pre">down:</span></tt>)</li>
|
|
614
|
-
<li><tt class="docutils literal"><span class="pre">service_name:</span></tt> is the name of the service for which status is returned</li>
|
|
615
|
-
<li><tt class="docutils literal"><span class="pre">(pid</span> <span class="pre">12345)</span></tt> is the process identifier</li>
|
|
616
|
-
<li><tt class="docutils literal"><span class="pre">12345s</span></tt> is the uptime of the service, in seconds</li>
|
|
617
|
-
</ul>
|
|
618
|
-
<p>For example:</p>
|
|
619
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>down: opscode-erchef: <span class="o">(</span>pid 35546<span class="o">)</span> 10s
|
|
620
|
-
</pre></div>
|
|
621
|
-
</div>
|
|
622
|
-
<p>By default, runit will restart services automatically when the services fail. Therefore, runit may report the status of a service as <tt class="docutils literal"><span class="pre">run:</span></tt> even when there is an issue with that service. When investigating why a particular service is not running as it should be, look for the services with the shortest uptimes. For example, the list below indicates that the <strong>opscode-erchef</strong> should be investigated further:</p>
|
|
623
|
-
<div class="highlight-bash"><div class="highlight"><pre>run: oc-id
|
|
624
|
-
run: opscode-chef: <span class="o">(</span>pid 4327<span class="o">)</span> 13671s; run: log: <span class="o">(</span>pid 4326<span class="o">)</span> 13671s
|
|
625
|
-
run: opscode-erchef: <span class="o">(</span>pid 5383<span class="o">)</span> 5s; run: log: <span class="o">(</span>pid 4382<span class="o">)</span> 13669s
|
|
626
|
-
run: opscode-expander: <span class="o">(</span>pid 4078<span class="o">)</span> 13694s; run: log: <span class="o">(</span>pid 4077<span class="o">)</span> 13694s
|
|
627
|
-
run: opscode-expander-reindexer: <span class="o">(</span>pid 4130<span class="o">)</span> 13692s; run: log: <span class="o">(</span>pid 4114<span class="o">)</span> 13692s
|
|
628
|
-
</pre></div>
|
|
629
|
-
</div>
|
|
630
|
-
<div class="section" id="high-availability">
|
|
631
|
-
<h4>High Availability<a class="headerlink" href="#high-availability" title="Permalink to this headline">¶</a></h4>
|
|
632
|
-
<p>On back-end servers in a High Availability topology, Keepalived is used by the clustering service to determine whether a service should be running. If the <tt class="docutils literal"><span class="pre">status</span></tt> subcommand is run against any of these nodes, a few things change:</p>
|
|
633
|
-
<ul class="simple">
|
|
634
|
-
<li>On the back-end node that is currently the backup server, it is normal to see only one running process: Keepalived</li>
|
|
635
|
-
<li>On the back-end node that is currently the master server, it is normal to see all services running. It is also normal to see some services in a down state if the server, on reboot, did not attempt to start the services because Keepalived determines which services are restarted based on the state of the cluster</li>
|
|
636
|
-
</ul>
|
|
637
|
-
<p>A sample status line for a service that is running on the master server in a High Availability topology:</p>
|
|
638
|
-
<div class="highlight-bash"><div class="highlight"><pre>run: opscode-solr: <span class="o">(</span>pid 25341<span class="o">)</span> 239s, normally down; run: log: <span class="o">(</span>pid 5700<span class="o">)</span> 145308s
|
|
639
|
-
</pre></div>
|
|
640
|
-
</div>
|
|
641
|
-
</div>
|
|
642
|
-
<div class="section" id="log-files">
|
|
643
|
-
<h4>Log Files<a class="headerlink" href="#log-files" title="Permalink to this headline">¶</a></h4>
|
|
644
|
-
<p>A typical status line for a service that is running any of the Chef server front-end services is similar to the following:</p>
|
|
645
|
-
<div class="highlight-bash"><div class="highlight"><pre>run: name_of_service: <span class="o">(</span>pid 1486<span class="o">)</span> 7819s; run: log: <span class="o">(</span>pid 1485<span class="o">)</span> 7819s
|
|
646
|
-
</pre></div>
|
|
647
|
-
</div>
|
|
648
|
-
<p>where:</p>
|
|
649
|
-
<ul class="simple">
|
|
650
|
-
<li><tt class="docutils literal"><span class="pre">run</span></tt> describes the state in which the supervisor attempts to keep processes. This state is either <tt class="docutils literal"><span class="pre">run</span></tt> or <tt class="docutils literal"><span class="pre">down</span></tt>. If a service is in a <tt class="docutils literal"><span class="pre">down</span></tt> state, it should be stopped</li>
|
|
651
|
-
<li><tt class="docutils literal"><span class="pre">name_of_service</span></tt> is the service name, for example: <tt class="docutils literal"><span class="pre">opscode-solr4</span></tt></li>
|
|
652
|
-
<li><tt class="docutils literal"><span class="pre">(pid</span> <span class="pre">1486)</span> <span class="pre">7819s;</span></tt> is the process identifier followed by the amount of time (in seconds) the service has been running</li>
|
|
653
|
-
<li><tt class="docutils literal"><span class="pre">run:</span> <span class="pre">log:</span> <span class="pre">(pid</span> <span class="pre">1485)</span> <span class="pre">7819s</span></tt> is the log process. It is typical for a log process to have a longer run time than a service; this is because the supervisor does not need to restart the log process in order to connect the supervised process</li>
|
|
654
|
-
</ul>
|
|
655
|
-
<p>If the service is down, the status line will appear similar to the following:</p>
|
|
656
|
-
<div class="highlight-bash"><div class="highlight"><pre>down: opscode-solr4: 3s, normally up; run: log: <span class="o">(</span>pid 1485<span class="o">)</span> 8526s
|
|
657
|
-
</pre></div>
|
|
658
|
-
</div>
|
|
659
|
-
<p>where</p>
|
|
660
|
-
<ul class="simple">
|
|
661
|
-
<li><tt class="docutils literal"><span class="pre">down</span></tt> indicates that the service is in a down state</li>
|
|
662
|
-
<li><tt class="docutils literal"><span class="pre">3s,</span> <span class="pre">normally</span> <span class="pre">up;</span></tt> indicates that the service is normally in a run state and that the supervisor would attempt to restart this service after a reboot</li>
|
|
663
|
-
</ul>
|
|
664
|
-
</div>
|
|
665
|
-
</div>
|
|
666
|
-
<div class="section" id="stop">
|
|
667
|
-
<h3>stop<a class="headerlink" href="#stop" title="Permalink to this headline">¶</a></h3>
|
|
668
|
-
<p>The <tt class="docutils literal"><span class="pre">stop</span></tt> subcommand is used to stop all services enabled on the Chef server. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
669
|
-
<p>This subcommand has the following syntax:</p>
|
|
670
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl stop name_of_service
|
|
671
|
-
</pre></div>
|
|
672
|
-
</div>
|
|
673
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand. When a service is successfully stopped the output should be similar to:</p>
|
|
674
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>ok: diwb: service_name: 0s, normally up
|
|
675
|
-
</pre></div>
|
|
676
|
-
</div>
|
|
677
|
-
<p>For example:</p>
|
|
678
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl stop
|
|
679
|
-
</pre></div>
|
|
680
|
-
</div>
|
|
681
|
-
<p>will return something similar to:</p>
|
|
682
|
-
<div class="highlight-bash"><div class="highlight"><pre>ok: down: nginx: 393s, normally up
|
|
683
|
-
ok: down: opscode-chef: 391s, normally up
|
|
684
|
-
ok: down: opscode-erchef: 391s, normally up
|
|
685
|
-
ok: down: opscode-expander: 390s, normally up
|
|
686
|
-
ok: down: opscode-expander-reindexer: 389s, normally up
|
|
687
|
-
ok: down: opscode-solr4: 389s, normally up
|
|
688
|
-
ok: down: postgresql: 388s, normally up
|
|
689
|
-
ok: down: rabbitmq: 388s, normally up
|
|
690
|
-
ok: down: redis_lb: 387s, normally up
|
|
691
|
-
</pre></div>
|
|
692
|
-
</div>
|
|
693
|
-
</div>
|
|
694
|
-
<div class="section" id="tail">
|
|
695
|
-
<h3>tail<a class="headerlink" href="#tail" title="Permalink to this headline">¶</a></h3>
|
|
696
|
-
<p>The <tt class="docutils literal"><span class="pre">tail</span></tt> subcommand is used to follow all of the Chef server logs for all services. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
697
|
-
<p>This subcommand has the following syntax:</p>
|
|
698
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl tail name_of_service
|
|
699
|
-
</pre></div>
|
|
700
|
-
</div>
|
|
701
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
702
|
-
</div>
|
|
703
|
-
<div class="section" id="term">
|
|
704
|
-
<h3>term<a class="headerlink" href="#term" title="Permalink to this headline">¶</a></h3>
|
|
705
|
-
<p>The <tt class="docutils literal"><span class="pre">term</span></tt> subcommand is used to send a <tt class="docutils literal"><span class="pre">SIGTERM</span></tt> to all services. This command can also be run for an individual service by specifying the name of the service in the command.</p>
|
|
706
|
-
<p>This subcommand has the following syntax:</p>
|
|
707
|
-
<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>chef-server-ctl term name_of_service
|
|
708
|
-
</pre></div>
|
|
709
|
-
</div>
|
|
710
|
-
<p>where <tt class="docutils literal"><span class="pre">name_of_service</span></tt> represents the name of any service that is listed after running the <tt class="docutils literal"><span class="pre">service-list</span></tt> subcommand.</p>
|
|
711
|
-
</div>
|
|
712
|
-
</div>
|
|
713
|
-
</div>
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
</div>
|
|
717
|
-
|
|
718
|
-
</div>
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
<div class="clearer"></div>
|
|
722
|
-
</div>
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
</body>
|
|
728
|
-
</html>
|