diff options
Diffstat (limited to 'distro/common/man/man1/knife-cookbook-site.1')
| -rw-r--r-- | distro/common/man/man1/knife-cookbook-site.1 | 552 |
1 files changed, 0 insertions, 552 deletions
diff --git a/distro/common/man/man1/knife-cookbook-site.1 b/distro/common/man/man1/knife-cookbook-site.1 deleted file mode 100644 index acfcf6b882..0000000000 --- a/distro/common/man/man1/knife-cookbook-site.1 +++ /dev/null @@ -1,552 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-COOKBOOK-SITE" "1" "Chef 12.0" "" "knife cookbook site" -.SH NAME -knife-cookbook-site \- The man page for the knife cookbook site 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 -.. -.sp -The Cookbooks Site API is used to provide access to the cookbooks community hosted at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. All of the cookbooks in the community are accessible through a RESTful API located at \fI\%https://supermarket.getchef.com/api/v1/cookbooks\fP by using any of the supported endpoints. In most cases, using knife and the \fBknife cookbook site\fP sub\-command (and any of its arguments) is the recommended method of interacting with these cookbooks, but in some cases, using the Cookbooks Site API directly may make sense. -.sp -The \fBknife cookbook site\fP subcommand is used to interact with cookbooks that are located at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. A user account is required for any community actions that write data to this site. The following arguments do not require a user account: \fBdownload\fP, \fBsearch\fP, \fBinstall\fP, and \fBlist\fP\&. -.SH COMMON OPTIONS -.sp -The following options may be used with any of the arguments available to the \fBknife cookbook site\fP subcommand: -.INDENT 0.0 -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife 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 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 Chef server\&. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.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 -The user name used by knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client\&. -.TP -.B \fB\-y\fP, \fB\-\-yes\fP -Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation. -.TP -.B \fB\-z\fP, \fB\-\-local\-mode\fP -Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&. -.UNINDENT -.SH DOWNLOAD -.sp -The \fBdownload\fP argument is used to download a cookbook from the community website. A cookbook will be downloaded as a tar.gz archive and placed in the current working directory. If a cookbook (or cookbook version) has been deprecated and the \fB\-\-force\fP option is not used, knife will alert the user that the cookbook is deprecated and then will provide the name of the most recent non\-deprecated version of that cookbook. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site download COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be downloaded. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, the most recent version of the cookbook will be downloaded. -.TP -.B \fB\-f FILE\fP, \fB\-\-file FILE\fP -The file to which a cookbook download is written. -.TP -.B \fB\-\-force\fP -Use to overwrite an existing directory. -.UNINDENT -.sp -\fBExamples\fP -.sp -To download the cookbook \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site download getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Downloading getting\-started from the cookbooks site at version 0.3.0 to - /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz -Cookbook saved: /Users/sdanna/opscodesupport/getting\-started\-0.3.0.tar.gz -.ft P -.fi -.UNINDENT -.UNINDENT -.SH INSTALL -.sp -The \fBinstall\fP argument is used to install a cookbook that has been downloaded from the community site to a local git repository . This action uses the git version control system in conjunction with the \fI\%https://supermarket.getchef.com/cookbooks\fP site to install community\-contributed cookbooks to the local chef\-repo\&. Using this argument does the following: -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP 1. 3 -A new "pristine copy" branch is created in git for tracking the upstream. -.IP 2. 3 -All existing versions of a cookbook are removed from the branch. -.IP 3. 3 -The cookbook is downloaded from \fI\%https://supermarket.getchef.com/cookbooks\fP in the tar.gz format. -.IP 4. 3 -The downloaded cookbook is untarred and its contents are committed to git and a tag is created. -.IP 5. 3 -The "pristine copy" branch is merged into the master branch. -.UNINDENT -.UNINDENT -.UNINDENT -.sp -This process allows the upstream cookbook in the master branch to be modified while letting git maintain changes as a separate patch. When an updated upstream version becomes available, those changes can be merged while maintaining any local modifications. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site install COOKBOOK_NAME [COOKBOOK_VERSION] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-b\fP, \fB\-\-use\-current\-branch\fP -Use to ensure that the current branch is used. -.TP -.B \fB\-B BRANCH\fP, \fB\-\-branch BRANCH\fP -The name of the default branch. This will default to the master branch. -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of the cookbook to be installed. If a version is not specified, the most recent version of the cookbook will be installed. -.TP -.B \fB\-D\fP, \fB\-\-skip\-dependencies\fP -Use to ensure that all cookbooks to which the installed cookbook has a dependency will not be installed. -.TP -.B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP -The directory in which cookbooks are created. This can be a colon\-separated path. -.UNINDENT -.sp -\fBExamples\fP -.sp -To install the cookbook \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site install getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Installing getting\-started to /Users/sdanna/opscodesupport/.chef/../cookbooks -Checking out the master branch. -Creating pristine copy branch chef\-vendor\-getting\-started -Downloading getting\-started from the cookbooks site at version 0.3.0 to - /Users/sdanna/opscodesupport/.chef/../cookbooks/getting\-started.tar.gz -Cookbook saved: /Users/sdanna/opscodesupport/.chef/../cookbooks/getting\-started.tar.gz -Removing pre\-existing version. -Uncompressing getting\-started version /Users/sdanna/opscodesupport/.chef/../cookbooks. -removing downloaded tarball -1 files updated, committing changes -Creating tag cookbook\-site\-imported\-getting\-started\-0.3.0 -Checking out the master branch. -Updating 4d44b5b..b4c32f2 -Fast\-forward - cookbooks/getting\-started/README.rdoc | 4 +++ - cookbooks/getting\-started/attributes/default.rb | 1 + - cookbooks/getting\-started/metadata.json | 29 ++++++++++++++++++++ - cookbooks/getting\-started/metadata.rb | 6 ++++ - cookbooks/getting\-started/recipes/default.rb | 23 +++++++++++++++ - .../templates/default/chef\-getting\-started.txt.erb | 5 +++ - 6 files changed, 68 insertions(+), 0 deletions(\-) - create mode 100644 cookbooks/getting\-started/README.rdoc - create mode 100644 cookbooks/getting\-started/attributes/default.rb - create mode 100644 cookbooks/getting\-started/metadata.json - create mode 100644 cookbooks/getting\-started/metadata.rb - create mode 100644 cookbooks/getting\-started/recipes/default.rb - create mode 100644 cookbooks/getting\-started/templates/default/chef\-getting\-started.txt.erb -Cookbook getting\-started version 0.3.0 successfully installed -.ft P -.fi -.UNINDENT -.UNINDENT -.SH LIST -.sp -The \fBlist\fP argument is used to view a list of cookbooks that are currently available at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fB\-w\fP, \fB\-\-with\-uri\fP -Use to show the corresponding URIs. -.UNINDENT -.sp -\fBExamples\fP -.sp -To view a list of cookbooks at \fI\%https://supermarket.getchef.com/cookbooks\fP server, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site list -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -1password homesick rabbitmq -7\-zip hostname rabbitmq\-management -AmazonEC2Tag hosts rabbitmq_chef -R hosts\-awareness rackspaceknife -accounts htop radiant -ack\-grep hudson rails -activemq icinga rails_enterprise -ad id3lib redis\-package -ad\-likewise iftop redis2 -ant iis redmine -[...truncated...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SEARCH -.sp -The \fBsearch\fP argument is used to search for a cookbook at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. A search query is used to return a list of cookbooks at \fI\%https://supermarket.getchef.com/cookbooks\fP and uses the same syntax as the \fBknife search\fP sub\-command. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site search SEARCH_QUERY (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To search for all of the cookbooks that can be used with Apache, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site search apache* -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -apache2: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/apache2 - cookbook_description: Installs and configures apache2 using Debian symlinks with helper definitions - cookbook_maintainer: opscode - cookbook_name: apache2 -instiki: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/instiki - cookbook_description: Installs instiki, a Ruby on Rails wiki server under passenger+Apache2. - cookbook_maintainer: jtimberman - cookbook_name: instiki -kickstart: - cookbook: https://supermarket.chef.io/api/v1/cookbooks/kickstart - cookbook_description: Creates apache2 vhost and serves a kickstart file. - cookbook_maintainer: opscode - cookbook_name: kickstart -[...truncated...] -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHARE -.sp -The \fBshare\fP argument is used to add a cookbook to \fI\%https://supermarket.getchef.com/cookbooks\fP\&. This action will require a user account and a certificate for \fI\%https://supermarket.getchef.com\fP\&. By default, knife will use the user name and API key that is identified in the configuration file used during the upload; otherwise these values must be specified on the command line or in an alternate configuration file. If a cookbook already exists on \fI\%https://supermarket.getchef.com/cookbooks\fP, then only an owner or maintainer of that cookbook can make updates. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site share COOKBOOK_NAME CATEGORY (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCATEGORY\fP -The cookbook category: \fB"Databases"\fP, \fB"Web Servers"\fP, \fB"Process Management"\fP, \fB"Monitoring & Trending"\fP, \fB"Programming Languages"\fP, \fB"Package Management"\fP, \fB"Applications"\fP, \fB"Networking"\fP, \fB"Operating Systems & Virtualization"\fP, \fB"Utilities"\fP, or \fB"Other"\fP\&. -.TP -.B \fB\-n\fP, \fB\-\-dry\-run\fP -Use to take no action and only print out results. Default: \fBfalse\fP\&. -.TP -.B \fB\-o PATH:PATH\fP, \fB\-\-cookbook\-path PATH:PATH\fP -The directory in which cookbooks are created. This can be a colon\-separated path. -.UNINDENT -.sp -\fBExamples\fP -.sp -To share a cookbook named \fBapache2\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site share "apache2" "Web Servers" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH SHOW -.sp -The \fBshow\fP argument is used to view information about a cookbook on \fI\%https://supermarket.getchef.com/cookbooks\fP\&. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site show COOKBOOK_NAME [COOKBOOK_VERSION] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This argument has the following options: -.INDENT 0.0 -.TP -.B \fBCOOKBOOK_VERSION\fP -The version of a cookbook to be shown. If a cookbook has only one version, this option does not need to be specified. If a cookbook has more than one version and this option is not specified, a list of cookbook versions will be returned. -.UNINDENT -.sp -\fBExamples\fP -.sp -To show the details for a cookbook named \fBhaproxy\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site show haproxy -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -to return something like: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -average_rating: -category: Networking -created_at: 2009\-10\-25T23:51:07Z -description: Installs and configures haproxy -external_url: -latest_version: https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_3 -maintainer: opscode -name: haproxy -updated_at: 2011\-06\-30T21:53:25Z -versions: - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_3 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_2 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_1 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/1_0_0 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_8_1 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_8_0 - https://supermarket.chef.io/api/v1/cookbooks/haproxy/versions/0_7_0 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -To view information in JSON format, use the \fB\-F\fP common option as part of the command like this: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife role show devops \-F json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Other formats available include \fBtext\fP, \fByaml\fP, and \fBpp\fP\&. -.SH UNSHARE -.sp -The \fBunshare\fP argument is used to stop the sharing of a cookbook at \fI\%https://supermarket.getchef.com/cookbooks\fP\&. Only the maintainer of a cookbook may perform this action. -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site unshare COOKBOOK_NAME -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This command does not have any specific options. -.sp -\fBExamples\fP -.sp -To unshare a cookbook named \fBgetting\-started\fP, enter: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife cookbook site unshare getting\-started -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. |