<!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 configure — 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> <link rel="shortcut icon" href="_static/chef.ico"/> </head> <body> <div style="background-color: #212c35; text-align: left; padding: 0px 0px 0px 0px"> <a href="http://docs.opscode.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-configure"> <h1>knife configure<a class="headerlink" href="#knife-configure" title="Permalink to this headline">¶</a></h1> <p>The <strong>knife configure</strong> subcommand is used to create the knife.rb and client.rb files so that they can be distributed to workstations and nodes.</p> <div class="section" id="syntax"> <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This subcommand has the following syntax when creating a knife.rb file:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure <span class="o">(</span>options<span class="o">)</span> </pre></div> </div> <p>and the following syntax when creating a client.rb file:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client DIRECTORY </pre></div> </div> </div> <div class="section" id="options"> <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> <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> <p>This subcommand has the following options for use when configuring a knife.rb file:</p> <dl class="docutils"> <dt><tt class="docutils literal"><span class="pre">--admin-client-name</span> <span class="pre">NAME</span></tt></dt> <dd>The name of the client, typically the name of the admin client.</dd> <dt><tt class="docutils literal"><span class="pre">--admin-client-key</span> <span class="pre">PATH</span></tt></dt> <dd>The path to the private key used by the client, typically a file named <tt class="docutils literal"><span class="pre">admin.pem</span></tt>.</dd> <dt><tt class="docutils literal"><span class="pre">-i</span></tt>, <tt class="docutils literal"><span class="pre">--initial</span></tt></dt> <dd>Use to create a API client, typically an administrator client on a freshly-installed Chef server.</dd> <dt><tt class="docutils literal"><span class="pre">-r</span> <span class="pre">REPO</span></tt>, <tt class="docutils literal"><span class="pre">--repository</span> <span class="pre">REPO</span></tt></dt> <dd>The path to the chef-repo.</dd> <dt><tt class="docutils literal"><span class="pre">--validation-client-name</span> <span class="pre">NAME</span></tt></dt> <dd>The name of the validation client, typically a client named chef-validator</dd> <dt><tt class="docutils literal"><span class="pre">--validation-key</span> <span class="pre">PATH</span></tt></dt> <dd>The path to the validation key used by the client, typically a file named <tt class="docutils literal"><span class="pre">validation.pem</span></tt>.</dd> </dl> </div> <div class="section" id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2> <p>The following examples show how to use this Knife subcommand:</p> <p><strong>Configure knife.rb</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure </pre></div> </div> <p><strong>Configure client.rb</strong></p> <div class="highlight-bash"><div class="highlight"><pre><span class="nv">$ </span>knife configure client <span class="s1">'/directory'</span> </pre></div> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> </body> </html>