chef 0.10.0.beta.7 → 0.10.0.beta.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. data/distro/common/html/knife-bootstrap.1.html +182 -0
  2. data/distro/common/html/knife-client.1.html +216 -0
  3. data/distro/common/html/knife-configure.1.html +170 -0
  4. data/distro/common/html/knife-cookbook-site.1.html +166 -0
  5. data/distro/common/html/knife-cookbook.1.html +233 -0
  6. data/distro/common/html/knife-data-bag.1.html +234 -0
  7. data/distro/common/html/knife-environment.1.html +93 -0
  8. data/distro/common/html/knife-exec.1.html +93 -0
  9. data/distro/common/html/knife-index.1.html +125 -0
  10. data/distro/common/html/knife-node.1.html +268 -0
  11. data/distro/common/html/knife-recipe.1.html +92 -0
  12. data/distro/common/html/knife-role.1.html +136 -0
  13. data/distro/common/html/knife-search.1.html +102 -0
  14. data/distro/common/html/knife-ssh.1.html +101 -0
  15. data/distro/common/html/knife-status.1.html +97 -0
  16. data/distro/common/html/knife-tag.1.html +93 -0
  17. data/distro/common/html/knife.1.html +362 -0
  18. data/distro/common/man/man1/knife-bootstrap.1 +137 -0
  19. data/distro/common/man/man1/knife-client.1 +98 -0
  20. data/distro/common/man/man1/knife-configure.1 +88 -0
  21. data/distro/common/man/man1/knife-cookbook-site.1 +91 -0
  22. data/distro/common/man/man1/knife-cookbook.1 +242 -0
  23. data/distro/common/man/man1/knife-data-bag.1 +130 -0
  24. data/distro/common/man/man1/knife-environment.1 +13 -0
  25. data/distro/common/man/man1/knife-exec.1 +13 -0
  26. data/distro/common/man/man1/knife-index.1 +29 -0
  27. data/distro/common/man/man1/knife-node.1 +153 -0
  28. data/distro/common/man/man1/knife-recipe.1 +13 -0
  29. data/distro/common/man/man1/knife-role.1 +64 -0
  30. data/distro/common/man/man1/knife-search.1 +37 -0
  31. data/distro/common/man/man1/knife-ssh.1 +33 -0
  32. data/distro/common/man/man1/knife-status.1 +17 -0
  33. data/distro/common/man/man1/knife-tag.1 +13 -0
  34. data/distro/common/man/man1/knife.1 +346 -0
  35. data/distro/common/man/{man8/shef.8 → man1/shef.1} +0 -0
  36. data/distro/common/man/{man1/chef-server-webui.1 → man8/chef-server-webui.8} +0 -0
  37. data/distro/common/man/{man1/chef-server.1 → man8/chef-server.8} +0 -0
  38. data/distro/common/man/{man1/chef-solr.1 → man8/chef-solr.8} +0 -0
  39. data/distro/common/markdown/man1/knife-bootstrap.mkd +88 -0
  40. data/distro/common/markdown/man1/knife-client.mkd +101 -0
  41. data/distro/common/markdown/man1/knife-configure.mkd +70 -0
  42. data/distro/common/markdown/man1/knife-cookbook-site.mkd +69 -0
  43. data/distro/common/markdown/man1/knife-cookbook.mkd +136 -0
  44. data/distro/common/markdown/man1/knife-data-bag.mkd +117 -0
  45. data/distro/common/markdown/man1/knife-environment.mkd +8 -0
  46. data/distro/common/markdown/man1/knife-exec.mkd +9 -0
  47. data/distro/common/markdown/man1/knife-index.mkd +30 -0
  48. data/distro/common/markdown/man1/knife-node.mkd +147 -0
  49. data/distro/common/markdown/man1/knife-recipe.mkd +24 -0
  50. data/distro/common/markdown/man1/knife-role.mkd +79 -0
  51. data/distro/common/markdown/man1/knife-search.mkd +56 -0
  52. data/distro/common/markdown/man1/knife-ssh.mkd +64 -0
  53. data/distro/common/markdown/man1/knife-status.mkd +38 -0
  54. data/distro/common/markdown/man1/knife-tag.mkd +8 -0
  55. data/distro/common/markdown/man1/knife.mkd +261 -0
  56. data/lib/chef/cookbook/metadata.rb +76 -40
  57. data/lib/chef/cookbook_version.rb +86 -2
  58. data/lib/chef/cookbook_version_selector.rb +7 -2
  59. data/lib/chef/environment.rb +41 -0
  60. data/lib/chef/knife/configure.rb +4 -0
  61. data/lib/chef/knife/cookbook_upload.rb +4 -1
  62. data/lib/chef/knife/help.rb +98 -0
  63. data/lib/chef/rest.rb +1 -0
  64. data/lib/chef/version.rb +1 -1
  65. metadata +58 -11
  66. data/distro/common/man/man1/chef-indexer.1 +0 -42
  67. data/distro/common/man/man1/chef-solr-indexer.1 +0 -55
  68. data/distro/common/man/man8/chef-solr-rebuild.8 +0 -37
  69. data/distro/common/man/man8/knife.8 +0 -1349
  70. data/distro/common/markdown/knife.mkd +0 -865
data/distro/common/html/knife-cookbook-site.1.html ADDED
@@ -0,0 +1,166 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
+ <title>knife-cookbook-site(1) - Install and update open source cookbooks</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ <style type='text/css' media='all'>
45
+ /* style: toc */
46
+ .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
47
+ .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
48
+ .man-navigation a:hover {color:#111;text-decoration:underline}
49
+ </style>
50
+ </head>
51
+ <!--
52
+ The following styles are deprecated and will be removed at some point:
53
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
54
+
55
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
56
+ .man-navigation should be used instead.
57
+ -->
58
+ <body id='manpage'>
59
+ <div class='mp' id='man'>
60
+
61
+ <div class='man-navigation' style='display:none'>
62
+ <a href="#NAME">NAME</a>
63
+ <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</a>
65
+ <a href="#SEE-ALSO">SEE ALSO</a>
66
+ <a href="#AUTHOR">AUTHOR</a>
67
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
68
+ <a href="#CHEF">CHEF</a>
69
+ </div>
70
+
71
+ <ol class='man-decor man-head man head'>
72
+ <li class='tl'>knife-cookbook-site(1)</li>
73
+ <li class='tc'>Chef Manual</li>
74
+ <li class='tr'>knife-cookbook-site(1)</li>
75
+ </ol>
76
+
77
+ <h2 id="NAME">NAME</h2>
78
+ <p class="man-name">
79
+ <code>knife-cookbook-site</code> - <span class="man-whatis">Install and update open source cookbooks</span>
80
+ </p>
81
+
82
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
83
+
84
+ <p><strong>knife</strong> <strong>cookbook site</strong> <em>sub-command</em> <em>(options)</em></p>
85
+
86
+ <h2 id="COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</h2>
87
+
88
+ <p>The following sub-commands are still in the context of cookbooks, but they make use of Opscode's Cookbook Community site, <em>http://cookbooks.opscode.com/</em>. That site has an API, and these sub-commands utilize that API, rather than the Chef Server API.</p>
89
+
90
+ <p><strong>cookbook site download COOKBOOK [VERSION]</strong> <em>(options)</em></p>
91
+
92
+ <dl>
93
+ <dt><code>-f</code>, <code>--file FILE</code></dt><dd>The filename to write to</dd>
94
+ </dl>
95
+
96
+
97
+ <p>Downloads a specific cookbook from the Community site, optionally specifying a certain version.</p>
98
+
99
+ <p><strong>cookbook site list</strong> <em>(options)</em></p>
100
+
101
+ <dl>
102
+ <dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd>
103
+ </dl>
104
+
105
+
106
+ <p>Lists available cookbooks from the Community site.</p>
107
+
108
+ <p><strong>cookbook site search QUERY</strong> <em>(options)</em></p>
109
+
110
+ <p>Searches the Community site with the specified query.</p>
111
+
112
+ <p><strong>cookbook site share COOKBOOK CATEGORY</strong> <em>(options)</em></p>
113
+
114
+ <dl>
115
+ <dt><code>-k</code>, <code>--key KEY</code></dt><dd>API Client Key</dd>
116
+ <dt><code>-u</code>, <code>--user USER</code></dt><dd>API Client Username</dd>
117
+ <dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd>
118
+ </dl>
119
+
120
+
121
+ <p>Uploads the specified cookbook using the given category to the Opscode cookbooks site. Requires a login user and certificate for the Opscode Cookbooks site. See <strong>EXAMPLES</strong> for usage if the Opscode user and certificate pair are not used for authenticating with the Chef Server. In other words, if the Chef Server is not the Opscode Platform.</p>
122
+
123
+ <p><strong>cookbook site unshare COOKBOOK</strong></p>
124
+
125
+ <p>Stops sharing the specified cookbook on the Opscode cookbooks site.</p>
126
+
127
+ <p><strong>cookbook site show COOKBOOK [VERSION]</strong> <em>(options)</em></p>
128
+
129
+ <p>Shows information from the site about a particular cookbook.</p>
130
+
131
+ <p><strong>cookbook site vendor COOKBOOK [VERSION]</strong> <em>(options)</em></p>
132
+
133
+ <dl>
134
+ <dt><code>-d</code>, <code>--dependencies</code></dt><dd>Grab dependencies automatically</dd>
135
+ </dl>
136
+
137
+
138
+ <p>Uses <code>git</code> version control in conjunction with the cookbook site to download upstream cookbooks. A new vendor branch is created in git, the cookbook downloaded from the site and untarred, then the master branch is merged. This allows the user to track upstream changes to cookbooks while merging in customizations. If <em>-d</em> is specified, all the cookbooks it depends on (via metadata <em>dependencies</em>) are downloaded and untarred as well, each using their own vendor branch.</p>
139
+
140
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
141
+
142
+ <p> <strong>knife-environment</strong>(1)</p>
143
+
144
+ <h2 id="AUTHOR">AUTHOR</h2>
145
+
146
+ <p> Chef was written by Adam Jacob <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#111;&#x3a;&#97;&#100;&#x61;&#109;&#64;&#111;&#x70;&#115;&#99;&#111;&#100;&#x65;&#x2e;&#99;&#x6f;&#109;" data-bare-link="true">&#x61;&#x64;&#x61;&#x6d;&#x40;&#111;&#x70;&#x73;&#x63;&#111;&#x64;&#101;&#x2e;&#x63;&#111;&#x6d;</a> with many contributions from the community.</p>
147
+
148
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
149
+
150
+ <p> This manual page was written by Joshua Timberman <a href="&#109;&#x61;&#105;&#108;&#x74;&#x6f;&#58;&#x6a;&#111;&#115;&#x68;&#x75;&#97;&#64;&#x6f;&#x70;&#x73;&#x63;&#111;&#100;&#x65;&#46;&#99;&#111;&#109;" data-bare-link="true">&#x6a;&#x6f;&#115;&#104;&#x75;&#x61;&#64;&#111;&#x70;&#115;&#99;&#x6f;&#x64;&#x65;&#x2e;&#x63;&#111;&#109;</a>.
151
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
152
+
153
+ <h2 id="CHEF">CHEF</h2>
154
+
155
+ <p> Knife is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>
156
+
157
+
158
+ <ol class='man-decor man-foot man foot'>
159
+ <li class='tl'>Chef 0.10.0.beta.8</li>
160
+ <li class='tc'>April 2011</li>
161
+ <li class='tr'>knife-cookbook-site(1)</li>
162
+ </ol>
163
+
164
+ </div>
165
+ </body>
166
+ </html>
data/distro/common/html/knife-cookbook.1.html ADDED
@@ -0,0 +1,233 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
+ <title>knife-cookbook(1) - Upload and manage Chef cookbooks</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ <style type='text/css' media='all'>
45
+ /* style: toc */
46
+ .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
47
+ .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
48
+ .man-navigation a:hover {color:#111;text-decoration:underline}
49
+ </style>
50
+ </head>
51
+ <!--
52
+ The following styles are deprecated and will be removed at some point:
53
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
54
+
55
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
56
+ .man-navigation should be used instead.
57
+ -->
58
+ <body id='manpage'>
59
+ <div class='mp' id='man'>
60
+
61
+ <div class='man-navigation' style='display:none'>
62
+ <a href="#NAME">NAME</a>
63
+ <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#COOKBOOK-SUB-COMMANDS">COOKBOOK SUB-COMMANDS</a>
65
+ </div>
66
+
67
+ <ol class='man-decor man-head man head'>
68
+ <li class='tl'>knife-cookbook(1)</li>
69
+ <li class='tc'>Chef Manual</li>
70
+ <li class='tr'>knife-cookbook(1)</li>
71
+ </ol>
72
+
73
+ <h2 id="NAME">NAME</h2>
74
+ <p class="man-name">
75
+ <code>knife-cookbook</code> - <span class="man-whatis">Upload and manage Chef cookbooks</span>
76
+ </p>
77
+
78
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
79
+
80
+ <p><strong>knife</strong> <strong>cookbook</strong> <em>sub-command</em> <em>(options)</em></p>
81
+
82
+ <h2 id="COOKBOOK-SUB-COMMANDS">COOKBOOK SUB-COMMANDS</h2>
83
+
84
+ <p>Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all recipes of resources and assets used to configure a particular aspect of the infrastructure. The following sub-commands can be used to manipulate the cookbooks stored on the Chef Server.</p>
85
+
86
+ <p><strong>cookbook bulk delete REGEX</strong> <em>(options)</em></p>
87
+
88
+ <dl>
89
+ <dt><code>-p</code>, <code>--purge</code></dt><dd>Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.</dd>
90
+ </dl>
91
+
92
+
93
+ <p>Delete cookbooks on the Chef Server based on a regular expression. The regular expression (<em>REGEX</em>) should be in quotes, not in //'s.</p>
94
+
95
+ <p><strong>cookbook create COOKBOOK</strong> <em>(options)</em></p>
96
+
97
+ <dl>
98
+ <dt><code>-o</code>, <code>--cookbook-path PATH</code></dt><dd>The directory where the cookbook will be created</dd>
99
+ <dt><code>-r</code>, <code>--readme-format FORMAT</code></dt><dd>Format of the README file</dd>
100
+ <dt><code>-C</code>, <code>--copyright COPYRIGHT</code></dt><dd>Name of Copyright holder</dd>
101
+ <dt><code>-I</code>, <code>--license LICENSE</code></dt><dd>License for cookbook, apachev2 or none</dd>
102
+ <dt><code>-E</code>, <code>--email EMAIL</code></dt><dd>Email address of cookbook maintainer</dd>
103
+ </dl>
104
+
105
+
106
+ <p>This is a helper command that creates a new cookbook directory in the <code>cookbook_path</code>. The following directories and files are created for the named cookbook.</p>
107
+
108
+ <ul>
109
+ <li>COOKBOOK/attributes</li>
110
+ <li>COOKBOOK/definitions</li>
111
+ <li>COOKBOOK/files/default</li>
112
+ <li>COOKBOOK/libraries</li>
113
+ <li>COOKBOOK/metadata.rb</li>
114
+ <li>COOKBOOK/providers</li>
115
+ <li>COOKBOOK/README.rdoc</li>
116
+ <li>COOKBOOK/recipes/default.rb</li>
117
+ <li>COOKBOOK/resources</li>
118
+ <li>COOKBOOK/templates/default</li>
119
+ </ul>
120
+
121
+
122
+ <p>Supported README formats are 'rdoc' (default), 'md', 'mkd', 'txt'. The README file will be written with the specified extension and a set of helpful starting headers.</p>
123
+
124
+ <p>Specify <code>-C</code> or <code>--copyright</code> with the name of the copyright holder as your name or your company/organization name in a quoted string. If this value is not specified an all-caps string <code>YOUR_COMPANY_NAME</code> is used which can be easily changed with find/replace.</p>
125
+
126
+ <p>Specify <code>-I</code> or <code>--license</code> with the license that the cookbook is distributed under for sharing with other people or posting to the Opscode Cookbooks site. Be aware of the licenses of files you put inside the cookbook and follow any restrictions they describe. When using <code>none</code> (default) or <code>apachev2</code>, comment header text and metadata file are pre-filled. The <code>none</code> license will be treated as non-redistributable.</p>
127
+
128
+ <p>Specify <code>-E</code> or <code>--email</code> with the email address of the cookbook's maintainer. If this value is not specified, an all-caps string <code>YOUR_EMAIL</code> is used which can easily be changed with find/replace.</p>
129
+
130
+ <p>The cookbook copyright, license and email settings can be filled in the <code>knife.rb</code>, for example with default values:</p>
131
+
132
+ <pre><code>cookbook_copyright "YOUR_COMPANY_NAME"
133
+ cookbook_license "none"
134
+ cookbook_email "YOUR_EMAIL"
135
+ </code></pre>
136
+
137
+ <p><strong>cookbook delete COOKBOOK [VERSION]</strong> <em>(options)</em></p>
138
+
139
+ <dl>
140
+ <dt><code>-a</code>, <code>--all</code></dt><dd>Delete all versions</dd>
141
+ <dt><code>-p</code>, <code>--purge</code></dt><dd>Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.</dd>
142
+ </dl>
143
+
144
+
145
+ <p>Delete the specified <em>VERSION</em> of the named <em>COOKBOOK</em>. If no version is specified, and only one version exists on the server, that version will be deleted. If multiple versions are available on the server, you will be prompted for a version to delete.</p>
146
+
147
+ <p><strong>cookbook download COOKBOOK [VERSION]</strong> <em>(options)</em></p>
148
+
149
+ <dl>
150
+ <dt><code>-d</code>, <code>--dir DOWNLOAD_DIRECTORY</code></dt><dd>The directory to download the cookbook into</dd>
151
+ <dt><code>-f</code>, <code>--force</code></dt><dd>Overwrite an existing directory with the download</dd>
152
+ <dt><code>-N</code>, <code>--latest</code></dt><dd>Download the latest version of the cookbook</dd>
153
+ </dl>
154
+
155
+
156
+ <p>Download a cookbook from the Chef Server. If no version is specified and only one version exists on the server, that version will be downloaded. If no version is specified and multiple versions are available on the server, you will be prompted for a version to download.</p>
157
+
158
+ <p><strong>cookbook list</strong> <em>(options)</em></p>
159
+
160
+ <dl>
161
+ <dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd>
162
+ </dl>
163
+
164
+
165
+ <p>List all the cookbooks.</p>
166
+
167
+ <p><strong>cookbook metadata COOKBOOK</strong> <em>(options)</em></p>
168
+
169
+ <dl>
170
+ <dt><code>-a</code>, <code>--all</code></dt><dd>Generate metadata for all cookbooks, rather than just a single cookbook</dd>
171
+ <dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd>
172
+ </dl>
173
+
174
+
175
+ <p>Generate cookbook metadata for the named <em>COOKBOOK</em>. The <em>PATH</em> used here specifies where the cookbooks directory is located and corresponds to the <code>cookbook_path</code> configuration option.</p>
176
+
177
+ <p><strong>cookbook metadata from FILE</strong> <em>(options)</em></p>
178
+
179
+ <p>Load the cookbook metadata from a specified file.</p>
180
+
181
+ <p><strong>cookbook show COOKBOOK [VERSION] [PART] [FILENAME]</strong> <em>(options)</em></p>
182
+
183
+ <dl>
184
+ <dt><code>-f</code>, <code>--fqdn FQDN </code></dt><dd>The FQDN of the host to see the file for</dd>
185
+ <dt><code>-p</code>, <code>--platform PLATFORM </code></dt><dd>The platform to see the file for</dd>
186
+ <dt><code>-V</code>, <code>--platform-version VERSION</code></dt><dd>The platform version to see the file for</dd>
187
+ </dl>
188
+
189
+
190
+ <p>Show a particular part of a <em>COOKBOOK</em> for the specified <em>VERSION</em>. <em>PART</em> can be one of:</p>
191
+
192
+ <ul>
193
+ <li><em>attributes</em></li>
194
+ <li><em>definitions</em></li>
195
+ <li><em>files</em></li>
196
+ <li><em>libraries</em></li>
197
+ <li><em>providers</em></li>
198
+ <li><em>recipes</em></li>
199
+ <li><em>resources</em></li>
200
+ <li><em>templates</em></li>
201
+ </ul>
202
+
203
+
204
+ <p><strong>cookbook test [COOKBOOKS...]</strong> <em>(options)</em></p>
205
+
206
+ <dl>
207
+ <dt><code>-a</code>, <code>--all</code></dt><dd>Test all cookbooks, rather than just a single cookbook</dd>
208
+ <dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd>
209
+ </dl>
210
+
211
+
212
+ <p>Test the specified cookbooks for syntax errors. This uses the built-in Ruby syntax checking option for files in the cookbook ending in <code>.rb</code>, and the ERB syntax check for files ending in <code>.erb</code> (templates).</p>
213
+
214
+ <p><strong>cookbook upload [COOKBOOKS...]</strong> <em>(options)</em></p>
215
+
216
+ <dl>
217
+ <dt><code>-a</code>, <code>--all</code></dt><dd>Upload all cookbooks, rather than just a single cookbook</dd>
218
+ <dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd>
219
+ </dl>
220
+
221
+
222
+ <p>Uploads the specified cookbooks to the Chef Server. The actual upload executes a number of commands, most of which occur on the local machine. The cookbook is staged in a temporary location. Then the <code>cookbook_path</code> (or <code>-o PATH</code>) is processed to search for the named cookbook, and each occurance is copied in the order specified. A syntax check is performed a la <code>cookbook test</code>, above. The metadata is generated, a la <code>cookbook metadata</code>. A <span class="man-ref">gzip<span class="s">(1)</span></span>'ed, <span class="man-ref">tar<span class="s">(1)</span></span> file is created, and is uploaded to the server.</p>
223
+
224
+
225
+ <ol class='man-decor man-foot man foot'>
226
+ <li class='tl'>Chef 0.10.0.beta.8</li>
227
+ <li class='tc'>April 2011</li>
228
+ <li class='tr'>knife-cookbook(1)</li>
229
+ </ol>
230
+
231
+ </div>
232
+ </body>
233
+ </html>
data/distro/common/html/knife-data-bag.1.html ADDED
@@ -0,0 +1,234 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
5
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
6
+ <title>knife-data-bag(1) - Store arbitrary data on a Chef Server</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ <style type='text/css' media='all'>
45
+ /* style: toc */
46
+ .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
47
+ .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
48
+ .man-navigation a:hover {color:#111;text-decoration:underline}
49
+ </style>
50
+ </head>
51
+ <!--
52
+ The following styles are deprecated and will be removed at some point:
53
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
54
+
55
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
56
+ .man-navigation should be used instead.
57
+ -->
58
+ <body id='manpage'>
59
+ <div class='mp' id='man'>
60
+
61
+ <div class='man-navigation' style='display:none'>
62
+ <a href="#NAME">NAME</a>
63
+ <a href="#SYNOPSIS">SYNOPSIS</a>
64
+ <a href="#DESCRIPTION">DESCRIPTION</a>
65
+ <a href="#DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</a>
66
+ <a href="#CREATE">CREATE</a>
67
+ <a href="#DELETE">DELETE</a>
68
+ <a href="#EDIT">EDIT</a>
69
+ <a href="#FROM-FILE">FROM FILE</a>
70
+ <a href="#LIST">LIST</a>
71
+ <a href="#SHOW">SHOW</a>
72
+ <a href="#ENCRYPTION-SUPPORT">ENCRYPTION SUPPORT</a>
73
+ <a href="#SEE-ALSO">SEE ALSO</a>
74
+ <a href="#AUTHOR">AUTHOR</a>
75
+ <a href="#DOCUMENTATION">DOCUMENTATION</a>
76
+ <a href="#CHEF">CHEF</a>
77
+ </div>
78
+
79
+ <ol class='man-decor man-head man head'>
80
+ <li class='tl'>knife-data-bag(1)</li>
81
+ <li class='tc'>Chef Manual</li>
82
+ <li class='tr'>knife-data-bag(1)</li>
83
+ </ol>
84
+
85
+ <h2 id="NAME">NAME</h2>
86
+ <p class="man-name">
87
+ <code>knife-data-bag</code> - <span class="man-whatis">Store arbitrary data on a Chef Server</span>
88
+ </p>
89
+
90
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
91
+
92
+ <p><strong>knife</strong> <strong>data bag</strong> <em>sub-command</em> <em>(options)</em></p>
93
+
94
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
95
+
96
+ <p>Data bags are stores of arbitrary JSON data. Each data bag is a
97
+ collection that may contain many items. Data Bag Items are indexed by
98
+ the Chef Server and can be searched via <strong>knife-search</strong>(1).</p>
99
+
100
+ <p>Data bags are available to all nodes configured by <strong>chef-client</strong>(8),
101
+ and are therefore a convenient mechanism to store global information,
102
+ such as lists of administrative accounts that should be configured on
103
+ all hosts.</p>
104
+
105
+ <h2 id="DATA-BAG-SUB-COMMANDS">DATA BAG SUB-COMMANDS</h2>
106
+
107
+ <h2 id="CREATE">CREATE</h2>
108
+
109
+ <p><strong>knife data bag create</strong> <em>bag name</em> [item id] <em>(options)</em></p>
110
+
111
+ <dl>
112
+ <dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd>
113
+ <dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt
114
+ the data bag item.</dd>
115
+ </dl>
116
+
117
+
118
+ <p>If <em>item id</em> is given, creates a new, empty data bag item and opens it for
119
+ editing in your editor. The data bag will be created if it does not
120
+ exist.</p>
121
+
122
+ <p>If <em>item id</em> is not given, the data bag will be created.</p>
123
+
124
+ <h2 id="DELETE">DELETE</h2>
125
+
126
+ <p><strong>knife data bag delete</strong> <em>bag name</em> [item id] <em>(options)</em></p>
127
+
128
+ <p>Delete a data bag, or an item from a data bag.</p>
129
+
130
+ <h2 id="EDIT">EDIT</h2>
131
+
132
+ <p><strong>knife data bag edit</strong> <em>bag name</em> <em>item id</em> <em>(options)</em></p>
133
+
134
+ <dl>
135
+ <dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd>
136
+ <dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt
137
+ the data bag item.</dd>
138
+ </dl>
139
+
140
+
141
+ <p>Edit an item in a data bag.</p>
142
+
143
+ <h2 id="FROM-FILE">FROM FILE</h2>
144
+
145
+ <p><strong>knife data bag from file</strong> <em>bag name</em> <em>file</em> <em>(options)</em></p>
146
+
147
+ <dl>
148
+ <dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd>
149
+ <dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt
150
+ the data bag item.</dd>
151
+ </dl>
152
+
153
+
154
+ <p>Load a data bag item from a JSON file. If <em>file</em> is a relative or
155
+ absolute path to the file, that file will be used. Otherwise, the <em>file</em>
156
+ parameter is treated as the base name of a data bag file in a Chef
157
+ repository, and <code>knife</code> will search for the file in
158
+ <code>./data_bags/bag_name/file</code>. For example <code>knife data bag from file users
159
+ dan.json</code> would attempt to load the file <code>./data_bags/users/dan.json</code>.</p>
160
+
161
+ <h2 id="LIST">LIST</h2>
162
+
163
+ <p><strong>knife data bag list</strong> <em>(options)</em></p>
164
+
165
+ <dl>
166
+ <dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd>
167
+ </dl>
168
+
169
+
170
+ <p>Lists the data bags that exist on the Chef Server.</p>
171
+
172
+ <h2 id="SHOW">SHOW</h2>
173
+
174
+ <p><strong>knife data bag show BAG [ITEM]</strong> <em>(options)</em></p>
175
+
176
+ <dl>
177
+ <dt><code>-s</code>, <code>--secret SECRET</code></dt><dd>A secret key used to encrypt the data bag item. See <strong>encryption support</strong> below.</dd>
178
+ <dt><code>--secret-file SECRET_FILE</code></dt><dd>The path to a file containing the secret key to be used to encrypt
179
+ the data bag item.</dd>
180
+ </dl>
181
+
182
+
183
+ <p>Show a specific data bag or an item in a data bag. The output will be
184
+ formatted according to the --format option.</p>
185
+
186
+ <h2 id="ENCRYPTION-SUPPORT">ENCRYPTION SUPPORT</h2>
187
+
188
+ <p>Data Bag Items may be encrypted to keep their contents secret. This may
189
+ be desireable when storing sensitive information such as database
190
+ passwords, API keys, etc.</p>
191
+
192
+ <p>Data Bag Item encryption uses the AES-256 CBC symmetric key algorithm.</p>
193
+
194
+ <p><strong>CAVEATS:</strong> Keys are not encrypted; only values are encrypted. The "id"
195
+ of a Data Bag Item is not encrypted, since it is used by Chef Server to
196
+ store the item in its database. For example, given the following data bag item:</p>
197
+
198
+ <pre><code>{"id": "important_passwords", "secret_password": "opensesame"}
199
+ </code></pre>
200
+
201
+ <p>The key "secret_password" will be visible to an evesdropper, but the
202
+ value "opensesame" will be protected. Both the key "id" and its value
203
+ "important_passwords" will be visible to an evesdropper.</p>
204
+
205
+ <p>Chef Server does not provide a secure mechanism for distributing
206
+ encryption keys.</p>
207
+
208
+ <h2 id="SEE-ALSO">SEE ALSO</h2>
209
+
210
+ <p> <strong>knife-search</strong>(1)</p>
211
+
212
+ <h2 id="AUTHOR">AUTHOR</h2>
213
+
214
+ <p> Chef was written by Adam Jacob <a href="&#109;&#97;&#105;&#108;&#x74;&#111;&#x3a;&#x61;&#100;&#97;&#109;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#101;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#x61;&#x64;&#97;&#x6d;&#x40;&#x6f;&#x70;&#115;&#x63;&#x6f;&#100;&#x65;&#46;&#x63;&#x6f;&#x6d;</a> with many contributions from the community.</p>
215
+
216
+ <h2 id="DOCUMENTATION">DOCUMENTATION</h2>
217
+
218
+ <p> This manual page was written by Joshua Timberman <a href="&#x6d;&#x61;&#x69;&#108;&#116;&#x6f;&#58;&#106;&#111;&#115;&#104;&#117;&#x61;&#64;&#x6f;&#112;&#x73;&#x63;&#111;&#100;&#x65;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#x6a;&#111;&#x73;&#104;&#x75;&#x61;&#x40;&#111;&#112;&#x73;&#x63;&#x6f;&#x64;&#x65;&#46;&#99;&#x6f;&#109;</a>.
219
+ Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
220
+
221
+ <h2 id="CHEF">CHEF</h2>
222
+
223
+ <p> Knife is distributed with Chef. http://wiki.opscode.com/display/chef/Home</p>
224
+
225
+
226
+ <ol class='man-decor man-foot man foot'>
227
+ <li class='tl'>Chef 0.10.0.beta.8</li>
228
+ <li class='tc'>April 2011</li>
229
+ <li class='tr'>knife-data-bag(1)</li>
230
+ </ol>
231
+
232
+ </div>
233
+ </body>
234
+ </html>