diff options
Diffstat (limited to 'distro/common/html/knife_role.html')
-rw-r--r-- | distro/common/html/knife_role.html | 295 |
1 files changed, 0 insertions, 295 deletions
diff --git a/distro/common/html/knife_role.html b/distro/common/html/knife_role.html deleted file mode 100644 index 844de48d37..0000000000 --- a/distro/common/html/knife_role.html +++ /dev/null @@ -1,295 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>knife role — chef-client Man Pages</title> - - <link rel="stylesheet" href="_static/guide.css" type="text/css" /> - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: './', - VERSION: '', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </script> - <script type="text/javascript" src="_static/jquery.js"></script> - <script type="text/javascript" src="_static/underscore.js"></script> - <script type="text/javascript" src="_static/doctools.js"></script> - - - </head> - <body> -<div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> -<a href="http://docs.getchef.com/"><img src="_static/chef_html_logo.png" border="0" alt="Chef"/></a> -</div> - - - - - <div class="document"> - <div class="documentwrapper"> - - <div class="body"> - - <div class="section" id="knife-role"> -<h1>knife role<a class="headerlink" href="#knife-role" title="Permalink to this headline">¶</a></h1> -<p>A role is a way to define certain patterns and processes that exist across nodes in an organization as belonging to a single job function. Each role consists of zero (or more) attributes and a run-list. Each node can have zero (or more) roles assigned to it. When a role is run against a node, the configuration details of that node are compared against the attributes of the role, and then the contents of that role’s run-list are applied to the node’s configuration details. When a chef-client runs, it merges its own attributes and run-lists with those contained within each assigned role.</p> -<p>The <strong>knife role</strong> subcommand is used to manage the roles that are associated with one or more nodes on a Chef server.</p> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">To add a role to a node and then build out the run-list for that node, use the <a class="reference internal" href="knife_node.html"><em>knife node</em></a> sub-command and its <tt class="docutils literal"><span class="pre">run_list</span> <span class="pre">add</span></tt> argument.</p> -</div> -<div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Review the list of <a class="reference internal" href="knife_common_options.html"><em>common options</em></a> available to this (and all) knife subcommands and plugins.</p> -</div> -<div class="section" id="bulk-delete"> -<h2>bulk delete<a class="headerlink" href="#bulk-delete" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">bulk</span> <span class="pre">delete</span></tt> argument is used to delete one or more roles that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/).</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> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role bulk delete REGEX -</pre></div> -</div> -</div> -<div class="section" id="options"> -<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="examples"> -<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Bulk delete roles</strong></p> -<p>Use a regular expression to define the pattern used to bulk delete roles:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role bulk delete <span class="s2">"^[0-9]{3}$"</span> -</pre></div> -</div> -</div> -</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 role to the Chef server. Role data is saved as JSON on the 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> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role create ROLE_NAME <span class="o">(</span>options<span class="o">)</span> -</pre></div> -</div> -</div> -<div class="section" id="id2"> -<h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-d</span> <span class="pre">DESCRIPTION</span></tt>, <tt class="docutils literal"><span class="pre">--description</span> <span class="pre">DESCRIPTION</span></tt></dt> -<dd>The description of the role. This value will populate the description field for the role on the Chef server.</dd> -</dl> -</div> -<div class="section" id="id3"> -<h3>Examples<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Create a role</strong></p> -<p>To add a role named <tt class="docutils literal"><span class="pre">role1</span></tt>, enter:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role create role1 -</pre></div> -</div> -<p>In the $EDITOR enter the role data in JSON:</p> -<div class="highlight-javascript"><div class="highlight"><pre>## sample: -{ - "name": "role1", - "default_attributes": { - }, - "json_class": "Chef::Role", - "run_list": ['recipe[cookbook_name::recipe_name], - role[role_name]' - ], - "description": "", - "chef_type": "role", - "override_attributes": { - } -} -</pre></div> -</div> -<p>When finished, save it.</p> -</div> -</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 role from 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> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role delete ROLE_NAME -</pre></div> -</div> -</div> -<div class="section" id="id5"> -<h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="id6"> -<h3>Examples<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Delete a role</strong></p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role delete devops -</pre></div> -</div> -<p>Type <tt class="docutils literal"><span class="pre">Y</span></tt> to confirm a deletion.</p> -</div> -</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 role details on the Chef server.</p> -<div class="section" id="id7"> -<h3>Syntax<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role edit ROLE_NAME -</pre></div> -</div> -</div> -<div class="section" id="id8"> -<h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="id9"> -<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>Edit a role</strong></p> -<p>To edit the data for a role named <tt class="docutils literal"><span class="pre">role1</span></tt>, enter:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role edit role1 -</pre></div> -</div> -<p>Update the role data in JSON:</p> -<div class="highlight-javascript"><div class="highlight"><pre>## sample: -{ - "name": "role1", - "default_attributes": { - }, - "json_class": "Chef::Role", - "run_list": ['recipe[cookbook_name::recipe_name], - role[role_name]' - ], - "description": "This is the description for the role1 role.", - "chef_type": "role", - "override_attributes": { - } -} -</pre></div> -</div> -<p>When finished, save it.</p> -</div> -</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 role using existing JSON data as a template.</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> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role from file FILE -</pre></div> -</div> -</div> -<div class="section" id="id11"> -<h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> -<p>This command does not have any specific options.</p> -</div> -<div class="section" id="id12"> -<h3>Examples<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Create a role using JSON data</strong></p> -<p>To view role details based on the values contained in a JSON file:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role from file <span class="s2">"path to JSON file"</span> -</pre></div> -</div> -</div> -</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 roles that are currently available on the Chef server.</p> -<div class="section" id="id13"> -<h3>Syntax<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role list -</pre></div> -</div> -</div> -<div class="section" id="id14"> -<h3>Options<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-w</span></tt>, <tt class="docutils literal"><span class="pre">--with-uri</span></tt></dt> -<dd>Use to show the corresponding URIs.</dd> -</dl> -</div> -<div class="section" id="id15"> -<h3>Examples<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>View a list of roles</strong></p> -<p>To view a list of roles on the Chef server and display the URI for each role returned, enter:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role list -w -</pre></div> -</div> -</div> -</div> -<div class="section" id="show"> -<h2>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h2> -<p>The <tt class="docutils literal"><span class="pre">show</span></tt> argument is used to view the details of a role.</p> -<div class="section" id="id16"> -<h3>Syntax<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following syntax:</p> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show ROLE_NAME -</pre></div> -</div> -</div> -<div class="section" id="id17"> -<h3>Options<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> -<p>This argument has the following options:</p> -<dl class="docutils"> -<dt><tt class="docutils literal"><span class="pre">-a</span> <span class="pre">ATTR</span></tt>, <tt class="docutils literal"><span class="pre">--attribute</span> <span class="pre">ATTR</span></tt></dt> -<dd>The attribute (or attributes) to show.</dd> -</dl> -</div> -<div class="section" id="id18"> -<h3>Examples<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3> -<p>The following examples show how to use this knife subcommand:</p> -<p><strong>Show as JSON data</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> -<div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife role show devops -F json -</pre></div> -</div> -<p>Other formats available include <tt class="docutils literal"><span class="pre">text</span></tt>, <tt class="docutils literal"><span class="pre">yaml</span></tt>, and <tt class="docutils literal"><span class="pre">pp</span></tt>.</p> -<p><strong>Show as raw JSON data</strong></p> -<p>To view node information in raw JSON, use the <tt class="docutils literal"><span class="pre">-l</span></tt> or <tt class="docutils literal"><span class="pre">--long</span></tt> option:</p> -<div class="highlight-bash"><div class="highlight"><pre>knife node show -l -F json <node_name> -</pre></div> -</div> -<p>and/or:</p> -<div class="highlight-bash"><div class="highlight"><pre>knife node show -l --format<span class="o">=</span>json <node_name> -</pre></div> -</div> -</div> -</div> -</div> - - - </div> - - </div> - - - <div class="clearer"></div> - </div> - - - - - </body> -</html>
\ No newline at end of file |