chef 13.11.3 → 13.12.3

data/distro/common/markdown/man1/knife-role.mkd

@@ -1,85 +0,0 @@
-knife-role(1) -- Group common configuration settings
-========================================
-
-## SYNOPSIS
-
-__knife__ __role__ _sub-command_ _(options)_
-
-## ROLE SUB-COMMANDS
-The following `role` subcommands are available:
-
-## LIST
-__knife role list__ _(options)_
-
-  * `-w`, `--with-uri`:
-    Show corresponding URIs
-
-List roles.
-
-## SHOW
-__knife role show ROLE__ _(options)_
-
-  * `-a`, `--attribute ATTR`:
-    Show only one attribute
-
-Show a specific role.
-
-## CREATE
-__knife role create ROLE__ _(options)_
-
-  * `-d`, `--description`:
-    The role description
-
-Create a new role.
-
-## EDIT
-__knife role edit ROLE__ _(options)_
-
-Edit a role.
-
-## FROM FILE
-__knife role from file FILE__ _(options)_
-
-Create or update a role from a role Ruby DSL (`.rb`) or JSON file.
-
-## DELETE
-__knife role delete ROLE__ _(options)_
-
-Delete a role.
-
-## BULK DELETE
-__knife role bulk delete REGEX__ _(options)_
-
-Delete roles on the Chef Server based on a regular expression. The regular expression (_REGEX_) should be in quotes, not in //'s.
-
-## DESCRIPTION
-Roles provide a mechanism to group repeated configuration settings.
-Roles are data structures that contain __default\_attributes__, and
-__override_attributes__, which are nested hashes of configuration
-settings, and a __run_list__, which is an ordered list of recipes and
-roles that should be applied to a host by chef-client.
-
-__default_attributes__ will be overridden if they conflict with a value
-on a node that includes the role. Conversely, __override_attributes__
-will override any values set on nodes that apply them.
-
-When __chef-client__(8) configures a host, it will "expand" the
-__run_list__ included in that host's node data. The expansion process
-will recursively replace any roles in the run\_list with that role's
-run\_list.
-
-## SEE ALSO
-   __knife-node(1)__ __knife-environment(1)__
-   <http://docs.chef.io/roles.html>
-   <http://docs.chef.io/attributes.html>
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-

data/distro/common/markdown/man1/knife-search.mkd

@@ -1,180 +0,0 @@
-knife-search(1) -- Find objects on a Chef Server by query
-========================================
-
-## SYNOPSIS
-
-__knife__ __search INDEX QUERY__ _(options)_
-
-  * `-a`, `--attribute ATTR`:
-    Show only one attribute
-  * `-i`, `--id-only`:
-    Show only the ID of matching objects
-  * `-q`, `--query QUERY`:
-    The search query; useful to protect queries starting with -
-  * `-R`, `--rows INT`:
-    The number of rows to return
-  * `-r`, `--run-list`:
-    Show only the run list
-  * `-o`, `--sort SORT`:
-    The order to sort the results in
-  * `-b`, `--start ROW`:
-    The row to start returning results at
-  * `-m`, `--medium`:
-    Display medium sized output when searching nodes using the default
-    summary format
-  * `-l`, `--long`:
-    Display long output when searching nodes using the default summary
-    format
-
-## DESCRIPTION
-
-Search is a feature of the Chef Server that allows you to use a
-full-text search engine to query information about your infrastructure
-and applications. You can utilize this service via search calls in a
-recipe or the knife search command.  The search syntax is based on
-Lucene.
-
-
-## INDEXES
-
-Search indexes are a feature of the Chef Server and the search
-sub-command allows querying any of the available indexes using SOLR
-query syntax. The following data types are indexed for search:
-
-  * _node_
-  * _role_
-  * _environment_
-  * _clients_
-  * _data bag_
-
-Data bags are indexed by the data bag's name. For example, to search a
-data bag named "admins":
-
-    knife search admins "field:search_pattern"
-
-## QUERY SYNTAX
-
-Queries have the form `field:search_pattern` where `field` is a key in
-the JSON description of the relevant objects (nodes, roles,
-environments, or data bags).  Both `field` and `search_pattern` are
-case-sensitive.  `search_pattern` can be an exact, wildcard,
-range, or fuzzy match (see below).  The `field` supports exact
-matching and limited wildcard matching.
-
-Searches will return the relevant objects (nodes, roles, environments,
-or data bags) where the `search_pattern` matches the object's value of
-`field`.
-
-### FIELD NAMES
-
-Field names are the keys within the JSON description of the object
-being searched.  Nested Keys can be searched by placing an underscore
-("_") between key names.
-
-### WILDCARD MATCHING FOR FIELD NAMES
-
-The field name also has limited support for wildcard matching. Both
-the "*" and "?" wildcards (see below) can be used within a field name;
-however, they cannot be the first character of the field name.
-
-### EXACT MATCHES
-Without any search modifiers, a search returns those fields for which
-the `search_pattern` exactly matches the value of `field` in the JSON
-description of the object.
-
-### WILDCARD MATCHES
-
-Search support both single- and multi-character wildcard searches
-within a search pattern.
-
-'?' matches exactly one character.
-
-'*' matches zero or more characters.
-
-### RANGE MATCHES
-Range searches allows one to match values between two given values.  To
-match values between X and Y, inclusively, use square brackets:
-
-    knife search INDEX 'field:[X TO Y]
-
-To match values between X and Y, exclusively, use curly brackets:
-
-    knife search INDEX 'field:{X TO Y}'
-
-Values are sorted in lexicographic order.
-
-### FUZZY MATCHES
-
-Fuzzy searches allows one to match values based on the Levenshtein
-Distance algorithm.  To perform a fuzzy match, append a tilda (~) to
-the search term:
-
-    knife search INDEX 'field:term~'
-
-This search would return nodes whose `field` was 'perm' or 'germ'.
-
-### BOOLEAN OPERATORS
-
-The boolean operators NOT, AND, and OR are supported.  To find values
-of `field` that are not X:
-
-    knife search INDEX 'field:(NOT X)'
-
-To find records where `field1` is X and `field2` is Y:
-
-    knife search INDEX 'field1:X AND field2:Y'
-
-To find records where `field` is X or Y:
-
-    knife search INDEX 'field:X OR field:Y'
-
-### QUOTING AND SPECIAL CHARACTERS
-
-In order to avoid having special characters and escape sequences
-within your search term interpreted by either Ruby or the shell,
-enclose them in single quotes.
-
-Search terms that include spaces should be enclosed in double-quotes:
-
-    knife search INDEX 'field:"term with spaces"'
-
-The following characters must be escaped:
-
-    + - && || ! ( ) { } [ ] ^ " ~ * ? : \
-
-## EXAMPLES
-
-Find the nodes with the fully-qualified domain name (FQDN)
-www.example.com:
-
-    knife search node 'fqdn:www.example.com'
-
-Find the nodes running a version of Ubuntu:
-
-    knife search node 'platform:ubuntu*'
-
-Find all nodes running CentOS in the production environment:
-
-    knife search node 'chef_environment:production AND platform:centos'
-
-## KNOWN BUGS
-
-  * Searches against the client index return no results in most cases. (CHEF-2477)
-  * Searches using the fuzzy match operator (~) produce an error. (CHEF-2478)
-
-## SEE ALSO
-   __knife-ssh__(1)
-   <http://docs.chef.io/attributes.html>
-   [Lucene Query Parser Syntax](http://lucene.apache.org/java/2_3_2/queryparsersyntax.html)
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
-

data/distro/common/markdown/man1/knife-ssh.mkd

@@ -1,69 +0,0 @@
-knife-ssh(1) -- Run a command or interactive session on multiple remote hosts
-========================================
-
-## SYNOPSIS
-
-__knife__ __ssh QUERY COMMAND__ _(options)_
-
-  * `-a`, `--attribute ATTR       `:
-    The attribute to use for opening the connection - default is fqdn
-  * `-C`, `--concurrency NUM      `:
-    The number of concurrent connections
-  * `-m`, `--manual-list          `:
-    QUERY is a space separated list of servers
-  * `-P`, `--ssh-password PASSWORD`:
-    The ssh password
-  * `-x`, `--ssh-user USERNAME    `:
-    The ssh username
-  * `-i`, `--identity-file IDENTITY_FILE`:
-    The SSH identity file used for authentication
-  * `-p`, `--ssh-port PORT`:
-    The ssh port
-  * `--[no-]host-key-verify`:
-    Verify host key, enabled by default.
-
-## DESCRIPTION
-
-The _ssh_ sub-command opens an ssh session to each of the nodes in the
-search results of the _QUERY_. This sub-command requires that the
-net-ssh-multi and highline Ruby libraries are installed. On Debian
-systems, these are the libnet-ssh-multi-ruby and libhighline-ruby
-packages. They can also be installed as RubyGems (net-ssh-multi and
-highline, respectively).
-
-## TERMINAL MULTIPLEXING AND TERMINAL TAB SUPPORT
-`knife ssh` integrates with several terminal multiplexer programs to
-provide a more convenient means of managing multiple ssh sessions. When
-the _COMMAND_ option matches one of these, `knife ssh` will create
-multiple interactive ssh sessions running locally in the terminal
-multiplexer instead of invoking the command on the remote host.
-
-The available multiplexers are:
-
-  * `interactive`:
-    A built-in multiplexer. `interactive` supports running commands on a
-    subset of the connected hosts in parallel
-  * __screen__(1):
-    Runs ssh interactively inside `screen`. ~/.screenrc will be sourced
-    if it exists.
-  * __tmux__(1):
-    Runs ssh interactively inside tmux.
-  * `macterm` (Mac OS X only):
-    Opens a Terminal.app window and creates a tab for each ssh session.
-    You must install the rb-appscript gem before you can use this
-    option.
-
-## SEE ALSO
-   __knife-search__(1)
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
-

data/distro/common/markdown/man1/knife-status.mkd

@@ -1,36 +0,0 @@
-knife-status(1) -- Display status information for the nodes in your infrastructure
-========================================
-
-## SYNOPSIS
-
-__knife__ __status__ _(options)_
-
-  * `-r`, `--run-list RUN_LIST`:
-    Show the run list
-
-## DESCRIPTION
-
-The _status_ sub-command searches the Chef Server for all nodes and
-displays information about the last time the node checked into the
-server and executed a `node.save`. The fields displayed are the relative
-checkin time, the node name, it's operating system platform and version,
-the fully-qualified domain name and the default IP address. If the `-r`
-option is given, the node's run list will also be displayed. Note that
-depending on the configuration of the nodes, the FQDN and IP displayed
-may not be publicly reachable.
-
-
-## SEE ALSO
-   __knife-search__(1)
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-
-

data/distro/common/markdown/man1/knife-tag.mkd

@@ -1,39 +0,0 @@
-knife-tag(1) -- Apply tags to nodes on a Chef Server
-========================================
-
-## SYNOPSIS
-
-__knife__ __tag__ _subcommand_ _(options)_
-
-## TAG SUBCOMMANDS
-The following `tag` subcommands are available:
-
-## CREATE
-__knife tag create__ _node_ _tag_ [_..._]
-
-Adds one or more tags to _node_
-
-## DELETE
-__knife tag delete__ _node_ _tag_ [_..._]
-
-Removes one or more tags from _node_
-
-## LIST
-__knife tag list__ _node_
-
-Lists the tags applied to _node_
-
-
-## SEE ALSO
-   __knife-node(1)__
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> with many contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Daniel DeLeo <dan@opscode.com>.
-   Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io>
-

data/distro/common/markdown/man1/knife.mkd

@@ -1,213 +0,0 @@
-knife(1) -- Chef Server API client utility
-========================================
-
-## SYNOPSIS
-
-__knife__ _sub-command_ [_argument_...] _(options)_
-
-## DESCRIPTION
-
-Knife is a command-line utility used to manage data on a Chef server
-through the HTTP(S) API. Knife is organized into groups of subcommands
-centered around the various object types in Chef. Each category of
-subcommand is documented in its own manual page. Available topics are:
-
-  * bootstrap
-  * client
-  * configure
-  * cookbook-site
-  * cookbook
-  * data-bag
-  * environment
-  * exec
-  * index
-  * node
-  * recipe
-  * role
-  * search
-  * ssh
-  * status
-  * tag
-
-If the knife manuals are in your `MANPATH`, you can access help for the
-above topics using `man knife-TOPIC`; otherwise, you can view the
-documentation using `knife help TOPIC`.
-
-## OPTIONS
-  * `-s`, `--server-url` URL:
-    Chef Server URL, corresponds to `Chef::Config` `chef_server_url`.
-  * `-k`, `--key` KEY:
-    API Client Key, corresponds to `Chef::Config` `client_key`.
-  * `-c`, `--config` CONFIG:
-    The configuration file to use
-  * `-E`, `--environment ENVIRONMENT`:
-    Set the Chef environment (except for in searches, where this will be flagrantly ignored)
-  * `-e`, `--editor` EDITOR:
-    Set the editor to use for interactive commands
-  * `-F`, `--format` FORMAT:
-    Which format to use for output. See FORMATS for details.
-  * `-d`, `--disable-editing`:
-    Do not open EDITOR, just accept the data as is
-  * `-u`, `--user` USER:
-    API Client Username, corresponds to `Chef::Config` `node_name`.
-  * `-p`, `--print-after`:
-    Show the data after a destructive operation
-  * `-v`, `--version`:
-    Show chef version
-  * `-V`, `--verbose`:
-    More verbose output. Use twice for max verbosity.
-  * `-y`, `--yes`:
-    Say yes to all prompts for confirmation
-  * `--defaults`:
-    Accept default values for all questions
-  * `--[no-]color`:
-    Use colored output. Color enabled by default.
-  * `-h`, `--help`:
-    Show the available options for a command.
-
-## SUB-COMMANDS
-
-Sub-commands that operate on the basic Chef data types are structured as
-_NOUN verb NOUN (options)_. For all data types, the following commands
-are available:
-
-* create (create)
-* list and show (read)
-* edit (update)
-* delete (destroy)
-
-Knife also includes commands that take actions other than displaying or
-modifying data on the Chef Server, such as __knife-ssh(1)__.
-
-## CONFIGURATION
-
-The knife configuration file is a Ruby DSL to set configuration
-parameters for Knife's __GENERAL OPTIONS__. The default location for the
-config file is `~/.chef/knife.rb`. If managing multiple Chef
-repositories, per-repository config files can be created. The file must
-be `.chef/knife.rb` in the current directory of the repository.
-
-If the config file exists, knife uses these settings for __GENERAL OPTIONS__ defaults.
-
-  * `node_name`:
-    User or client identity (i.e., _name_) to use for authenticating
-    requests to the Chef Server.
-  * `client_key`:
-    Private key file to authenticate to the Chef server. Corresponds to the
-    `-k` or `--key` option.
-  * `chef_server_url`:
-    URL of the Chef server. Corresponds to the `-s` or `--server-url`
-    option. This is requested from the user when running this sub-command.
-  * `syntax_check_cache_path`:
-    Specifies the path to a directory where knife caches information
-    about files that it has syntax checked.
-  * `validation_client_name`:
-    Specifies the name of the client used to validate new clients.
-  * `validation_key`:
-    Specifies the private key file to use when bootstrapping new hosts.
-    See knife-client(1) for more information about the validation
-    client.
-  * `cookbook_copyright`, `cookbook_email`, `cookbook_license`, `readme_format`
-    Used by `knife cookbook create` sub-command to specify the copyright
-    holder, maintainer email, license and readme format (respectively) for new cookbooks.
-    The copyright holder is listed as the maintainer in the cookbook's
-    metadata and as the Copyright in the comments of the default recipe. The
-    maintainer email is used in the cookbook metadata. The license
-    determines what preamble to put in the comment of the default recipe,
-    and is listed as the license in the cookbook metadata. Currently
-    supported licenses are "apachev2" and "none". Any other values will
-    result in an empty license in the metadata (needs to be filled in by the
-    author), and no comment preamble in the default recipe. Currently supported
-    readme formats are "md", "mkd", "txt", and "rdoc".  Any other value will
-    result in an unformatted README.
-
-## FILES
-
-_~/.chef/knife.rb_
-
-Ruby DSL configuration file for knife. See __CONFIGURATION__.
-
-## FORMATS
-
-The amount of content displayed and the output format are
-modified by the `--format` option. If no alternate format is selected,
-the default is summary.
-
-Valid formats are:
-
-  * `summary`:
-    displays the node in a custom, summarized format (default)
-  * `text`:
-    displays the node data in its entirety using the colorized tree display
-  * `json`:
-    displays the node in JSON format
-  * `yaml`:
-    displays the node in YAML format
-  * `pp`:
-    displays the node using Ruby's pretty printer.
-
-For brevity, only the first character of the format is required, for
-example, -Fj will produce JSON format output.
-
-## CHEF WORKFLOW
-
-When working with Chef and Knife in the local repository, the recommended workflow outline looks like:
-
-* Create repository. A skeleton sample is provided at _http://github.com/opscode/chef-repo/_.
-* Configure knife, see __CONFIGURATION__.
-* Download cookbooks from the Opscode cookbooks site, see __COOKBOOK SITE SUB-COMMANDS__.
-* Or, create new cookbooks, see `cookbook create` sub-command.
-* Commit changes to the version control system. See your tool's documentation.
-* Upload cookbooks to the Chef Server, see __COOKBOOK SUB-COMMANDS__.
-* Launch instances in the Cloud, OR provision new hosts; see __CLOUD COMPUTING SUB-COMMANDS__ and __BOOTSTRAP SUB-COMMANDS__.
-* Watch Chef configure systems!
-
-A note about git: Opscode and many folks in the Chef community use git,
-but it is not required, except in the case of the `cookbook site vendor`
-sub-command, as it uses git directly. Version control is strongly
-recommended though, and git fits with a lot of the workflow paradigms.
-
-
-## EXAMPLES
-
-
-## ENVIRONMENT
-  * `EDITOR`:
-    The text editor to use for editing data. The --editor option takes
-    precedence over this value, and the --disable-editing option suppresses
-    data editing entirely.
-
-## SEE ALSO
-  __chef-client(8)__ __chef-server(8)__ __chef-shell(1)__
-
-  __knife-bootstrap(1)__ __knife-client(1)__ __knife-configure(1)__
-  __knife-cookbook-site(1)__ __knife-cookbook(1)__ __knife-data-bag(1)__
-  __knife-environment(1)__ __knife-exec(1)__ __knife-index(1)__
-  __knife-node(1)__ __knife-recipe(1)__ __knife-role(1)__
-  __knife-search(1)__ __knife-ssh(1)__ __knife-tag(1)__
-
-  Complete Chef documentation is available online: <http://docs.chef.io/>
-
-  JSON is JavaScript Object Notation <http://json.org/>
-
-  SOLR is an open source search engine. <http://lucene.apache.org/solr/>
-
-  __git(1)__ is a version control system <http://git-scm.com/>
-
-  This manual page was generated from Markdown with __ronn(1)__ <http://rtomayko.github.com/ronn/ronn.1.html>
-
-## AUTHOR
-   Chef was written by Adam Jacob <adam@opscode.com> of Opscode
-   (<http://www.opscode.com>), with contributions from the community.
-
-## DOCUMENTATION
-   This manual page was written by Joshua Timberman <joshua@opscode.com>.
-
-## LICENSE
-   Both Chef and this documentation are released under the terms of the
-   Apache 2.0 License. You may view the license online: <http://www.apache.org/licenses/LICENSE-2.0.html>
-   On some systems, the complete text of the Apache 2.0 License may be found in `/usr/share/common-licenses/Apache-2.0`.
-
-## CHEF
-   Knife is distributed with Chef. <http://docs.chef.io/>
-