diff options
Diffstat (limited to 'distro/common/man/man1/knife-role.1')
-rw-r--r-- | distro/common/man/man1/knife-role.1 | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/distro/common/man/man1/knife-role.1 b/distro/common/man/man1/knife-role.1 new file mode 100644 index 0000000000..c9fee15c19 --- /dev/null +++ b/distro/common/man/man1/knife-role.1 @@ -0,0 +1,88 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "KNIFE\-ROLE" "1" "September 2012" "Chef 11.0.0.alpha" "Chef Manual" +. +.SH "NAME" +\fBknife\-role\fR \- Group common configuration settings +. +.SH "SYNOPSIS" +\fBknife\fR \fBrole\fR \fIsub\-command\fR \fI(options)\fR +. +.SH "ROLE SUB\-COMMANDS" +The following \fBrole\fR subcommands are available: +. +.SH "LIST" +\fBknife role list\fR \fI(options)\fR +. +.TP +\fB\-w\fR, \fB\-\-with\-uri\fR +Show corresponding URIs +. +.P +List roles\. +. +.SH "SHOW" +\fBknife role show ROLE\fR \fI(options)\fR +. +.TP +\fB\-a\fR, \fB\-\-attribute ATTR\fR +Show only one attribute +. +.P +Show a specific role\. +. +.SH "CREATE" +\fBknife role create ROLE\fR \fI(options)\fR +. +.TP +\fB\-d\fR, \fB\-\-description\fR +The role description +. +.P +Create a new role\. +. +.SH "EDIT" +\fBknife role edit ROLE\fR \fI(options)\fR +. +.P +Edit a role\. +. +.SH "FROM FILE" +\fBknife role from file FILE\fR \fI(options)\fR +. +.P +Create or update a role from a role Ruby DSL (\fB\.rb\fR) or JSON file\. +. +.SH "DELETE" +\fBknife role delete ROLE\fR \fI(options)\fR +. +.P +Delete a role\. +. +.SH "BULK DELETE" +\fBknife role bulk delete REGEX\fR \fI(options)\fR +. +.P +Delete roles on the Chef Server based on a regular expression\. The regular expression (\fIREGEX\fR) should be in quotes, not in //\'s\. +. +.SH "DESCRIPTION" +Roles provide a mechanism to group repeated configuration settings\. Roles are data structures that contain \fBdefault_attributes\fR, and \fBoverride_attributes\fR, which are nested hashes of configuration settings, and a \fBrun_list\fR, which is an ordered list of recipes and roles that should be applied to a host by chef\-client\. +. +.P +\fBdefault_attributes\fR will be overridden if they conflict with a value on a node that includes the role\. Conversely, \fBoverride_attributes\fR will override any values set on nodes that apply them\. +. +.P +When \fBchef\-client\fR(8) configures a host, it will "expand" the \fBrun_list\fR 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\. +. +.SH "SEE ALSO" +\fBknife\-node(1)\fR \fBknife\-environment(1)\fR \fIhttp://wiki\.opscode\.com/display/chef/Roles\fR \fIhttp://wiki\.opscode\.com/display/chef/Attributes\fR +. +.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 |