diff options
Diffstat (limited to 'distro/common/html/knife_data_bag.html')
| -rw-r--r-- | distro/common/html/knife_data_bag.html | 47 |
1 files changed, 24 insertions, 23 deletions
diff --git a/distro/common/html/knife_data_bag.html b/distro/common/html/knife_data_bag.html index 4e888c8963..6acb329669 100644 --- a/distro/common/html/knife_data_bag.html +++ b/distro/common/html/knife_data_bag.html @@ -1,4 +1,3 @@ - <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> @@ -14,7 +13,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', + URL_ROOT: './', VERSION: '', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', @@ -43,7 +42,7 @@ <div class="section" id="knife-data-bag"> <h1>knife data bag<a class="headerlink" href="#knife-data-bag" title="Permalink to this headline">¶</a></h1> -<p>A data bag is a global variable that is stored as JSON data and is accessible from a server. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search. The contents of a data bag can vary, but they often include sensitive information (such as database passwords).</p> +<p>A data bag is a global variable that is stored as JSON data and is accessible from a Chef server. A data bag is indexed for searching and can be loaded by a recipe or accessed during a search.</p> <p>A data bag item may be encrypted using <a class="reference external" href="https://en.wikipedia.org/wiki/Symmetric-key_algorithm">shared secret encryption</a>. This allows each data bag item to store confidential information (such as a database password) or to be managed in a source control system (without plain-text data appearing in revision history). Each data bag item may be encrypted individually; if a data bag contains multiple encrypted data bag items, these data bag items are not required to share the same encryption keys.</p> <p>The <strong>knife data bag</strong> subcommand is used to manage arbitrary stores of globally available JSON data.</p> <div class="admonition note"> @@ -52,7 +51,7 @@ </div> <div class="section" id="create"> <h2>create<a class="headerlink" href="#create" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to add a data bag to the server.</p> +<p>The <tt class="docutils literal"><span class="pre">create</span></tt> argument is used to add a data bag to the Chef server.</p> <div class="section" id="syntax"> <h3>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> @@ -92,7 +91,7 @@ </div> <div class="section" id="delete"> <h2>delete<a class="headerlink" href="#delete" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a data bag or a data bag item from a server.</p> +<p>The <tt class="docutils literal"><span class="pre">delete</span></tt> argument is used to delete a data bag or a data bag item from a Chef server.</p> <div class="section" id="id1"> <h3>Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> @@ -125,7 +124,7 @@ </div> <div class="section" id="edit"> <h2>edit<a class="headerlink" href="#edit" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">edit</span></tt> argument is used to edit the data contained in a data bag. If encryption is being used, the data bag will be decrypted, the data will be made available in the $EDITOR, and then encrypted again before saving it to the server.</p> +<p>The <tt class="docutils literal"><span class="pre">edit</span></tt> argument is used to edit the data contained in a data bag. If encryption is being used, the data bag will be decrypted, the data will be made available in the $EDITOR, and then encrypted again before saving it to the Chef server.</p> <div class="section" id="id4"> <h3>Syntax<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> @@ -162,7 +161,7 @@ <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife data bag edit admins charlie </pre></div> </div> -<p>to open the $EDITOR. Once opened, you can update the data before saving it to the server. For example, by changing:</p> +<p>to open the $EDITOR. Once opened, you can update the data before saving it to the Chef server. For example, by changing:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="o">{</span> <span class="s2">"id"</span>: <span class="s2">"charlie"</span> <span class="o">}</span> @@ -172,9 +171,9 @@ <div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"id"</span><span class="o">:</span> <span class="s2">"charlie"</span><span class="p">,</span> <span class="s2">"uid"</span><span class="o">:</span> <span class="mi">1005</span><span class="p">,</span> - <span class="s2">"gid"</span><span class="o">:</span><span class="s2">"ops"</span><span class="p">,</span> - <span class="s2">"shell"</span><span class="o">:</span><span class="s2">"/bin/zsh"</span><span class="p">,</span> - <span class="s2">"comment"</span><span class="o">:</span><span class="s2">"Crazy Charlie"</span> + <span class="s2">"gid"</span><span class="o">:</span> <span class="s2">"ops"</span><span class="p">,</span> + <span class="s2">"shell"</span><span class="o">:</span> <span class="s2">"/bin/zsh"</span><span class="p">,</span> + <span class="s2">"comment"</span><span class="o">:</span> <span class="s2">"Crazy Charlie"</span> <span class="p">}</span> </pre></div> </div> @@ -182,7 +181,7 @@ </div> <div class="section" id="from-file"> <h2>from file<a class="headerlink" href="#from-file" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to create a data bag on the server from a file. The path to the data bag file must specify one of the following:</p> +<p>The <tt class="docutils literal"><span class="pre">from</span> <span class="pre">file</span></tt> argument is used to create a data bag on the Chef server from a file. The path to the data bag file must specify one of the following:</p> <ul class="simple"> <li>the name of a data bag</li> <li>a relative or absolute path to a file</li> @@ -219,7 +218,7 @@ <h3>Examples<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Create a data bag from a file</strong></p> -<p>To create a data bag on the server from a file:</p> +<p>To create a data bag on the Chef server from a file:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife data bag from file <span class="s2">"path to JSON file"</span> </pre></div> </div> @@ -232,7 +231,7 @@ </div> <div class="section" id="list"> <h2>list<a class="headerlink" href="#list" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of data bags that are currently available on the server.</p> +<p>The <tt class="docutils literal"><span class="pre">list</span></tt> argument is used to view a list of data bags that are currently available on the Chef server.</p> <div class="section" id="id10"> <h3>Syntax<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> <p>This argument has the following syntax:</p> @@ -313,12 +312,13 @@ uid: 1005 </pre></div> </div> <p>to return:</p> -<div class="highlight-javascript"><pre>## sample: +<div class="highlight-javascript"><div class="highlight"><pre>## sample: { - "id": "mysql", - "pass": "trywgFA6R70NO28PNhMpGhEvKBZuxouemnbnAUQsUyo=\n", - "user": "e/p+8WJYVHY9fHcEgAAReg==\n" -}</pre> + "id": "mysql", + "pass": "trywgFA6R70NO28PNhMpGhEvKBZuxouemnbnAUQsUyo=\n", + "user": "e/p+8WJYVHY9fHcEgAAReg==\n" +} +</pre></div> </div> <p><strong>Show a data bag, decrypted</strong></p> <p>To show the decrypted contents of the same data bag, enter:</p> @@ -326,12 +326,13 @@ uid: 1005 </pre></div> </div> <p>to return:</p> -<div class="highlight-javascript"><pre>## sample: +<div class="highlight-javascript"><div class="highlight"><pre>## sample: { - "id": "mysql", - "pass": "thesecret123", - "user": "fred" -}</pre> + "id": "mysql", + "pass": "thesecret123", + "user": "fred" +} +</pre></div> </div> <p><strong>Show a data bag as JSON</strong></p> <p>To view information in JSON format, use the <tt class="docutils literal"><span class="pre">-F</span></tt> common option as part of the command like this:</p> |