Permalink
Browse files

add man page for ``knife role``

  • Loading branch information...
1 parent d8db19d commit 2e236e99262845251a346d4c813b83d2c999d3f7 jamescott committed Dec 20, 2012
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,343 @@
+.TH "KNIFE-ROLE" "1" "December 20, 2012" "0.0.1" "knife-role"
+.SH NAME
+knife-role \- Man page for knife-role.
+.
+.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 role is a way to define certain patterns and processes that exist across nodes in a Chef 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\(aqs run list are applied to the node\(aqs configuration details. When a chef\-client runs, it merges its own attributes and run lists with those contained within each assigned role.
+.sp
+The \fBrole\fP sub\-command is used to manage the roles that are associated with one or more nodes on a Chef server.
+.sp
+This sub\-command has the following syntax:
+.sp
+.nf
+.ft C
+knife role [ARGUMENT] (options)
+.ft P
+.fi
+.IP Note
+Use the \fBnode\fP sub\-command (and the \fBrun_list add node\fP argument) to add a role to a node on the Chef server.
+.RE
+.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 Chef server environment. When this option is added to a command, the command will run only against the named environment.
+.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 Knife or for a sub\-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 Chef server.
+.TP
+.B \fB\-\-no\-color\fP
+Indicates that color will not be used in the output.
+.TP
+.B \fB\-\-print\-after\fP
+Indicates that data will be shown after a destructive operation.
+.TP
+.B \fB\-\-repo\-mode MODE\fP
+The layout of the local repository. The \fBdefault\fP repository includes cookbooks, data bags, environments, and roles. The \fBeverything\fP repository adds nodes, API client, and users. Default value: \fBdefault\fP.
+.TP
+.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
+The URL for the Chef server.
+.TP
+.B \fB\-u USER\fP, \fB\-\-user USER\fP
+A user name that Knife will use to sign requests made by the API client to the Chef server. If this option is used, be sure to ensure that the user name matches the private key or authentication will fail.
+.TP
+.B \fB\-v\fP, \fB\-\-version\fP
+Shows the version of Chef.
+.TP
+.B \fB\-V\fP, \fB\-\-verbose\fP
+Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
+.TP
+.B \fB\-y\fP, \fB\-\-yes\fP
+Indicates that "yes" will be the response to all confirmation prompts (and that Knife will not ask a user for confirmation).
+.UNINDENT
+.SH BULK DELETE
+.sp
+The \fBbulk delete\fP 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 (/).
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role bulk delete REGEX
+.ft P
+.fi
+.sp
+This argument does not have any argument\-specific options.
+.sp
+\fBExamples\fP
+.sp
+For example:
+.sp
+.nf
+.ft C
+$ knife role bulk delete "^[0\-9]{3}$"
+.ft P
+.fi
+.SH CREATE
+.sp
+The \fBcreate\fP argument is used to add a role to the Chef server. To add a role to a node, you must use the \fBnode\fP sub\-command and the \fBrun\-list add\fP argument. Role data is saved as JSON on the Chef server.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role create ROLE_NAME (options)
+.ft P
+.fi
+.sp
+This argument has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-d DESCRIPTION\fP, \fB\-\-description DESCRIPTION\fP
+The description of the role. This value will populate the description field for the role on the Chef server.
+.UNINDENT
+.sp
+\fBExamples\fP
+.sp
+For example, to add a role named "role1", enter:
+.sp
+.nf
+.ft C
+$ knife role create role1
+.ft P
+.fi
+.sp
+In the $EDITOR enter the role data in JSON:
+.sp
+.nf
+.ft C
+## sample:
+{
+ "name": "role1",
+ "default_attributes": {
+ },
+ "json_class": "Chef::Role",
+ "run_list": [
+
+ ],
+ "description": "",
+ "chef_type": "role",
+ "override_attributes": {
+ }
+}
+.ft P
+.fi
+.sp
+When finished, save it.
+.SH DELETE
+.sp
+The \fBdelete\fP argument is used to delete a role from the Chef server.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role delete ROLE_NAME
+.ft P
+.fi
+.sp
+This argument does not have any argument\-specific options.
+.sp
+\fBExamples\fP
+.sp
+For example:
+.sp
+.nf
+.ft C
+$ knife role delete devops
+.ft P
+.fi
+.sp
+Type \fBY\fP to confirm a deletion.
+.SH EDIT
+.sp
+The \fBedit\fP argument is used to edit role details on the Chef server.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role edit ROLE_NAME
+.ft P
+.fi
+.sp
+This argument does not have any argument\-specific options.
+.sp
+\fBExamples\fP
+.sp
+For example, to edit the data for a role named "role1", enter:
+.sp
+.nf
+.ft C
+$ knife role edit role1
+.ft P
+.fi
+.sp
+Update the role data in JSON:
+.sp
+.nf
+.ft C
+## sample:
+{
+ "name": "role1",
+ "default_attributes": {
+ },
+ "json_class": "Chef::Role",
+ "run_list": [
+
+ ],
+ "description": "This is the description for the role1 role.",
+ "chef_type": "role",
+ "override_attributes": {
+ }
+}
+.ft P
+.fi
+.sp
+When finished, save it.
+.SH FROM FILE
+.sp
+The \fBfrom file\fP argument is used to create a role using existing JSON data as a template.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role from file FILE
+.ft P
+.fi
+.sp
+This argument does not have any argument\-specific options.
+.sp
+\fBExamples\fP
+.sp
+For example:
+.sp
+.nf
+.ft C
+$ knife role from file "path to JSON file"
+.ft P
+.fi
+.SH LIST
+.sp
+The \fBlist\fP argument is used to view a list of roles that are currently available on the Chef server.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role list
+.ft P
+.fi
+.sp
+This argument has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-w\fP, \fB\-\-with\-uri\fP
+Indicates that the corresponding URIs will be shown.
+.UNINDENT
+.sp
+\fBExamples\fP
+.sp
+For example, to view a list of roles on the Chef server and display the URI for each role returned, enter:
+.sp
+.nf
+.ft C
+$ knife role list \-w
+.ft P
+.fi
+.SH SHOW
+.sp
+The \fBshow\fP argument is used to view the details of a role.
+.sp
+This argument has the following syntax:
+.sp
+.nf
+.ft C
+knife role show ROLE_NAME
+.ft P
+.fi
+.sp
+This argument has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-a ATTR\fP, \fB\-\-attribute ATTR\fP
+Indicates that only a single attribute is shown, as defined by the \fBATTR\fP value.
+.UNINDENT
+.sp
+\fBExamples\fP
+.sp
+For example:
+.sp
+.nf
+.ft C
+$ knife role show devops
+.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.
+.SH AUTHOR
+Opscode
+.SH COPYRIGHT
+2012, Opscode, Inc
+.\" Generated by docutils manpage writer.
+.

0 comments on commit 2e236e9

Please sign in to comment.