diff options
Diffstat (limited to 'distro/common/man/man1/knife-node.1')
| -rw-r--r-- | distro/common/man/man1/knife-node.1 | 692 |
1 files changed, 123 insertions, 569 deletions
diff --git a/distro/common/man/man1/knife-node.1 b/distro/common/man/man1/knife-node.1 index 9b36a04228..c30ea0f49b 100644 --- a/distro/common/man/man1/knife-node.1 +++ b/distro/common/man/man1/knife-node.1 @@ -1,580 +1,134 @@ -.TH "KNIFE-NODE" "1" "Chef 11.8" "" "knife node" -.SH NAME -knife-node \- The man page for the knife node subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.\" Man page generated from reStructuredText. -. -.sp -A node is any physical, virtual, or cloud machine that is configured to be maintained by a chef\-client. -.sp -The \fBknife node\fP subcommand is used to manage the nodes that exist on a server. -.sp -This subcommand has the following syntax: -.sp -.nf -.ft C -$ knife node [ARGUMENT] (options) -.ft P -.fi -.SH COMMON OPTIONS -.sp -The following options can be run with all Knife sub\-commands and plug\-ins: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP -The configuration file to use. -.TP -.B \fB\-\-color\fP -Indicates that colored output will be used. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. -.TP -.B \fB\-\-defaults\fP -Indicates that Knife will use the default value, instead of asking a user to provide one. -.TP -.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP -The $EDITOR that is used for all interactive commands. -.TP -.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP -The name of the environment. When this option is added to a command, the command will run only against the named environment. -.TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. -.TP -.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. -.TP -.B \fB\-h\fP, \fB\-\-help\fP -Shows help for the command. -.TP -.B \fB\-k KEY\fP, \fB\-\-key KEY\fP -The private key that Knife will use to sign requests made by the API client to the server. -.TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. -.TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. -.TP -.B \fB\-\-print\-after\fP -Indicates that data will be shown after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -The URL for the server. -.TP -.B \fB\-u USER\fP, \fB\-\-user USER\fP -The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key. +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "KNIFE\-NODE" "1" "October 2013" "Chef 11.8.0.rc.0" "Chef Manual" +. +.SH "NAME" +\fBknife\-node\fR \- Manage the hosts in your infrastructure +. +.SH "SYNOPSIS" +\fBknife\fR \fBnode\fR \fIsub\-command\fR \fI(options)\fR +. +.SH "DESCRIPTION" +Nodes are data structures that represent hosts configured with Chef\. Nodes have a \fBname\fR, a String that uniquely identifies the node, \fBattributes\fR, a nested Hash of properties that describe how the host should be configured, a \fBchef_environment\fR, a String representing the environment to which the node belongs, and a \fBrun_list\fR, an ordered list of \fBrecipes\fR or \fBroles\fR that chef\-client should apply when configuring a host\. +. +.P +When a host communicates with a Chef Server, it authenticates using its \fBnode_name\fR for identification and signs its reqests with a private key\. The Server validates the request by looking up a \fBclient\fR object with a name identical to the \fBnode_name\fR submitted with the request and verifes the signature using the public key for that \fBclient\fR object\. \fBNOTE\fR that the \fBclient\fR is a different object in the system\. It is associated with a node by virtue of having a matching name\. +. +.P +By default \fBchef\-client\fR(8) will create a node using the FQDN of the host for the node name, though this may be overridden by configuration settings\. +. +.SH "NODE SUB\-COMMANDS" +The following \fBnode\fR subcommands are available: +. +.SH "BULK DELETE" +\fBknife node bulk delete\fR \fIregex\fR \fI(options)\fR +. +.P +Deletes nodes for which the name matches the regular expression \fIregex\fR on the Chef Server\. The regular expression should be given in quotes, and should not be surrounded with forward slashes (as is typical of regular expression literals in scripting languages)\. +. +.SH "CREATE" +\fBknife node create\fR \fIname\fR \fI(options)\fR +. +.P +Create a new node\. Unless the \-\-disable\-editing option is given, an empty node object will be created and displayed in your text editor\. If the editor exits with a successful exit status, the node data will be posted to the Chef Server to create the node\. +. +.SH "DELETE" +\fBknife node delete\fR \fIname\fR \fI(options)\fR +. +.P +Deletes the node identified by \fIname\fR on the Chef Server\. +. +.SH "EDIT" +\fBknife node edit\fR \fIname\fR \fI(options)\fR +. .TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +\fB\-a\fR, \fB\-\-all\fR +Display all node data in the editor\. By default, default, override, and automatic attributes are not shown\. +. +.P +Edit the node identified by \fIname\fR\. Like \fBknife node create\fR, the node will be displayed in your text editor unless the \-n option is present\. +. +.SH "FROM FILE" +\fBknife node from file\fR \fIfile\fR \fI(options)\fR +. +.P +Create a node from a JSON format \fIfile\fR\. +. +.SH "LIST" +\fBknife node list\fR \fI(options)\fR +. .TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. +\fB\-w\fR, \fB\-\-with\-uri\fR +Show corresponding URIs +. +.P +List all nodes\. +. +.SH "RUN_LIST ADD" +\fBknife node run_list add\fR \fIname\fR \fIrun list item\fR \fI(options)\fR +. .TP -.B \fB\-y\fP, \fB\-\-yes\fP -Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.SH BULK DELETE -.sp -The \fBbulk delete\fP argument is used to delete one or more nodes that match a pattern defined by a regular expression. The regular expression must be within quotes and not be surrounded by forward slashes (/). -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node bulk delete REGEX -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To bulk delete many nodes, use a regular expression to define the pattern: -.sp -.nf -.ft C -$ knife node bulk delete "^[0\-9]{3}$" -.ft P -.fi -.sp -Type \fBY\fP to confirm a deletion. -.SH CREATE -.sp -The \fBcreate\fP argument is used to add a node to the server. Node data is stored as JSON on the server. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node create NODE_NAME -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To add a node, enter: -.sp -.nf -.ft C -$ knife node create node1 -.ft P -.fi -.sp -In the $EDITOR enter the node data in JSON: -.sp -.nf -.ft C -## sample: -{ - "normal": { - }, - "name": "foobar", - "override": { - }, - "default": { - }, - "json_class": "Chef::Node", - "automatic": { - }, - "run_list": [ - "recipe[zsh]", - "role[webserver]" - ], - "chef_type": "node" -} -.ft P -.fi -.sp -When finished, save it. -.SH DELETE -.sp -The \fBdelete\fP argument is used to delete a node from the server. -.IP Note -Deleting a node will not delete any corresponding API clients. -.RE -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node delete NODE_NAME -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To delete a node called "dev", enter: -.sp -.nf -.ft C -$ knife node delete dev -.ft P -.fi -.SH EDIT -.sp -The \fBedit\fP argument is used to edit the details of a node on a server. Node data is stored as JSON on the server. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node edit NODE_NAME (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 +\fB\-a\fR, \fB\-\-after ITEM\fR +Place the ENTRY in the run list after ITEM +. +.P +Add the \fIrun list item\fR to the node\'s \fBrun_list\fR\. See Run list +. +.SH "RUN_LIST REMOVE" +\fBknife node run_list remove\fR \fInode name\fR \fIrun list item\fR \fI(options)\fR +. +.P +Remove the \fIrun list item\fR from the node\'s \fBrun_list\fR\. +. +.SH "SHOW" +\fBknife node show\fR \fInode name\fR \fI(options)\fR +. .TP -.B \fB\-a\fP, \fB\-\-all\fP -Displays a node in the $EDITOR. By default, attributes that are default, override, or automatic are not shown. -.UNINDENT -.sp -\fBExamples\fP -.sp -To edit the data for a node named "node1", enter: -.sp -.nf -.ft C -$ knife node edit node1 \-a -.ft P -.fi -.sp -Update the role data in JSON: -.sp -.nf -.ft C -## sample: -{ - "normal": { - }, - "name": "node1", - "override": { - }, - "default": { - }, - "json_class": "Chef::Node", - "automatic": { - }, - "run_list": [ - "recipe[devops]", - "role[webserver]" - ], - "chef_type": "node" -} -.ft P -.fi -.sp -When finished, save it. -.SH FROM FILE -.sp -The \fBfrom file\fP argument is used to create a node using existing node data as a template. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node from file FILE -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To add a node using data contained in a JSON file: -.sp -.nf -.ft C -$ knife node from file "path to JSON file" -.ft P -.fi -.SH LIST -.sp -The \fBlist\fP argument is used to view all of the nodes that exist on a server. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node list (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 +\fB\-a\fR, \fB\-\-attribute [ATTR]\fR +Show only one attribute +. .TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Indicates that the corresponding URIs will be shown. -.UNINDENT -.sp -\fBExamples\fP -.sp -To verify the list of nodes that are registered with the server, enter: -.sp -.nf -.ft C -$ knife node list -.ft P -.fi -.sp -to return something similar to: -.sp -.nf -.ft C -i\-12345678 -rs\-123456 -.ft P -.fi -.SH RUN_LIST ADD -.sp -The \fBrun_list add\fP argument is used to add run list items (roles or recipes) to a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: \fB\(aqrole[ROLE_NAME]\(aq\fP or \fB\(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq\fP. Use a comma to separate roles and recipes when adding more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node run_list add NODE_NAME RUN_LIST_ITEM (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 +\fB\-r\fR, \fB\-\-run\-list\fR +Show only the run list +. .TP -.B \fB\-a ITEM\fP, \fB\-\-after ITEM\fP -Use this to add the run list item after the specified run list item. -.UNINDENT -.sp -\fBExamples\fP -.sp -To add a role to a run list, enter: -.sp -.nf -.ft C -$ knife node run_list add node \(aqrole[ROLE_NAME]\(aq -.ft P -.fi -.sp -To add roles and recipes to a run list, enter: -.sp -.nf -.ft C -$ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]\(aq -.ft P -.fi -.sp -To add a recipe to a run list using the fully qualified format, enter: -.sp -.nf -.ft C -$ knife node run_list add node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq -.ft P -.fi -.sp -To add a recipe to a run list using the cookbook format, enter: -.sp -.nf -.ft C -$ knife node run_list add node \(aqCOOKBOOK::RECIPE_NAME\(aq -.ft P -.fi -.sp -To add the default recipe of a cookbook to a run list, enter: -.sp -.nf -.ft C -$ knife node run_list add node \(aqCOOKBOOK\(aq -.ft P -.fi -.SH RUN_LIST REMOVE -.sp -The \fBrun_list remove\fP argument is used to remove run list items (roles or recipes) from a node. A recipe must be in one of the following formats: fully qualified, cookbook, or default. Both roles and recipes must be in quotes, for example: \fB\(aqrole[ROLE_NAME]\(aq\fP or \fB\(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq\fP. Use a comma to separate roles and recipes when removing more than one, like this: \fB\(aqrecipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]\(aq\fP. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node run_list remove NODE_NAME RUN_LIST_ITEM -.ft P -.fi -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To remove a role from a run list, enter: -.sp -.nf -.ft C -$ knife node run_list remove node \(aqrole[ROLE_NAME]\(aq -.ft P -.fi -.sp -To remove a recipe from a run list using the fully qualified format, enter: -.sp -.nf -.ft C -$ knife node run_list remove node \(aqrecipe[COOKBOOK::RECIPE_NAME]\(aq -.ft P -.fi -.SH SHOW -.sp -The \fBshow\fP argument is used to display information about a node. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife node show NODE_NAME (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 +\fB\-F\fR, \fB\-\-format FORMAT\fR +Display the node in a different format\. +. .TP -.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP -The attribute (or attributes) to show. +\fB\-m\fR, \fB\-\-medium\fR +Display more, but not all, of the node\'s data when using the default \fIsummary\fR format +. +.P +Displays the node identified by \fInode name\fR on stdout\. +. +.SH "RUN LIST ITEM FORMAT" +Run list items may be either roles or recipes\. When adding a role to a run list, the correct syntax is "role[ROLE_NAME]" +. +.P +When adding a recipe to a run list, there are several valid formats: +. .TP -.B \fB\-l\fP, \fB\-\-long\fP -Display long output when searching nodes while using the default summary format. +Fully Qualified Format +"recipe[COOKBOOK::RECIPE_NAME]", for example, "recipe[chef::client]" +. .TP -.B \fB\-m\fP, \fB\-\-medium\fP -Display more, but not all, of a node\(aqs data when searching using the default summary format. +Cookbook Recipe Format +For brevity, the recipe part of the fully qualified format may be omitted, and recipes specified as "COOKBOOK::RECIPE_NAME", e\.g\., "chef::client" +. .TP -.B \fB\-r\fP, \fB\-\-run\-list\fP -Indicates that only the run\-list will be shown. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view all data for a node named "build", enter: -.sp -.nf -.ft C -$ knife node show build -.ft P -.fi -.sp -to return: -.sp -.nf -.ft C -Node Name: build -Environment: _default -FQDN: -IP: -Run List: -Roles: -Recipes: -Platform: -.ft P -.fi -.sp -To show basic information about a node, truncated and nicely formatted: -.sp -.nf -.ft C -knife node show <node_name> -.ft P -.fi -.sp -To show all information about a node, nicely formatted: -.sp -.nf -.ft C -knife node show \-l <node_name> -.ft P -.fi -.sp -To list a single node attribute: -.sp -.nf -.ft C -knife node show <node_name> \-a <attribute_name> -.ft P -.fi -.sp -where \fB<attribute_name>\fP is something like kernel or platform. (This doesn\(aqt work for nested attributes like \fBnode[kernel][machine]\fP because \fBknife node show\fP doesn\(aqt understand nested attributes.) -.sp -To view the FQDN for a node named "i\-12345678", enter: -.sp -.nf -.ft C -$ knife node show i\-12345678 \-a fqdn -.ft P -.fi -.sp -to return: -.sp -.nf -.ft C -fqdn: ip\-10\-251\-75\-20.ec2.internal -.ft P -.fi -.sp -To view the run list for a node named "dev", enter: -.sp -.nf -.ft C -$ knife node show dev \-r -.ft P -.fi -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP. -.sp -To view node information in raw JSON, use the \fB\-l\fP or \fB\-\-long\fP option: -.sp -.nf -.ft C -knife node show \-l \-F json <node_name> -.ft P -.fi -.sp -and/or: -.sp -.nf -.ft C -knife node show \-l \-\-format=json <node_name> -.ft P -.fi -.SH AUTHOR -Opscode -.SH COPYRIGHT -This work is licensed under a Creative Commons Attribution 3.0 Unported License -.\" Generated by docutils manpage writer. +Default Recipe Format +When adding the default recipe of a cookbook to a run list, the recipe name may be omitted as well, e\.g\., "chef::default" may be written as just "chef" +. +.SH "SEE ALSO" +\fBknife\-client\fR(1) \fBknife\-search\fR(1) \fBknife\-role\fR(1) +. +.SH "AUTHOR" +Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\. +. +.SH "DOCUMENTATION" +This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\. . +.SH "CHEF" +Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR |