diff options
Diffstat (limited to 'distro/common/html/knife_search.html')
| -rw-r--r-- | distro/common/html/knife_search.html | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/distro/common/html/knife_search.html b/distro/common/html/knife_search.html index 2444c4845f..c5006d155e 100644 --- a/distro/common/html/knife_search.html +++ b/distro/common/html/knife_search.html @@ -41,7 +41,7 @@ <div class="section" id="knife-search"> <h1>knife search<a class="headerlink" href="#knife-search" title="Permalink to this headline">¶</a></h1> -<p>Search indexes allow queries to be made for any type of data that is indexed by the Chef server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full-text query that can be done from several locations, including from within a recipe, by using the <tt class="docutils literal"><span class="pre">search</span></tt> subcommand in knife, or by using the <tt class="docutils literal"><span class="pre">/search</span></tt> or <tt class="docutils literal"><span class="pre">/search/INDEX</span></tt> endpoints in the Chef server API. The search engine is based on Apache Solr and is run from the Chef server.</p> +<p>Search indexes allow queries to be made for any type of data that is indexed by the Chef server, including data bags (and data bag items), environments, nodes, and roles. A defined query syntax is used to support search patterns like exact, wildcard, range, and fuzzy. A search is a full-text query that can be done from several locations, including from within a recipe, by using the <tt class="docutils literal"><span class="pre">search</span></tt> subcommand in knife, the <tt class="docutils literal"><span class="pre">search</span></tt> method in the Recipe DSL, and by using the <tt class="docutils literal"><span class="pre">/search</span></tt> or <tt class="docutils literal"><span class="pre">/search/INDEX</span></tt> endpoints in the Chef server API. The search engine is based on Apache Solr and is run from the Chef server.</p> <p>The <strong>knife search</strong> subcommand is used run a search query for information that is indexed on a Chef server.</p> <div class="section" id="syntax"> <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> @@ -97,9 +97,9 @@ win2k8-dev <dt><tt class="docutils literal"><span class="pre">INDEX</span></tt></dt> <dd>The name of the index to be queried: <tt class="docutils literal"><span class="pre">client</span></tt>, <tt class="docutils literal"><span class="pre">environment</span></tt>, <tt class="docutils literal"><span class="pre">node</span></tt>, <tt class="docutils literal"><span class="pre">role</span></tt>, or <tt class="docutils literal"><span class="pre">DATA_BAG_NAME</span></tt>. Default index: <tt class="docutils literal"><span class="pre">node</span></tt>.</dd> <dt><tt class="docutils literal"><span class="pre">-l</span></tt>, <tt class="docutils literal"><span class="pre">--long</span></tt></dt> -<dd>Display long output when searching nodes while using the default summary format.</dd> +<dd>Use to display all attributes in the output and to show the output as JSON.</dd> <dt><tt class="docutils literal"><span class="pre">-m</span></tt>, <tt class="docutils literal"><span class="pre">--medium</span></tt></dt> -<dd>Display more, but not all, of a node’s data when searching using the default summary format.</dd> +<dd>Use to display normal attributes in the output and to show the output as JSON.</dd> <dt><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">SORT</span></tt>, <tt class="docutils literal"><span class="pre">--sort</span> <span class="pre">SORT</span></tt></dt> <dd>The order in which search results will be sorted.</dd> <dt><tt class="docutils literal"><span class="pre">-q</span> <span class="pre">SEARCH_QUERY</span></tt>, <tt class="docutils literal"><span class="pre">--query</span> <span class="pre">SEARCH_QUERY</span></tt></dt> |