path: root/distro/common/man/man1/knife-upload.1

.\" Man page generated from reStructuredText.
.
.TH "KNIFE-UPLOAD" "1" "Chef 11.16" "" "knife upload"
.SH NAME
knife-upload \- The man page for the knife upload 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 \fBknife upload\fP subcommand is used to upload roles, cookbooks, environments, and data bags to the Chef server from the current working directory in the chef\-repo\&. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be uploaded, and then \fBknife download\fP, which does the opposite of \fBknife upload\fP\&.
.sp
\fBSyntax\fP
.sp
This subcommand has the following syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload [PATTERN...] (options)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBOptions\fP
.sp
This subcommand has the following options:
.INDENT 0.0
.TP
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
The configuration file to use.
.TP
.B \fB\-\-chef\-repo\-path PATH\fP
The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb.
.TP
.B \fB\-\-chef\-zero\-port PORT\fP
The port on which chef\-zero will listen.
.TP
.B \fB\-\-[no\-]color\fP
Use to view colored output.
.TP
.B \fB\-\-concurrency\fP
The number of allowed concurrent connections. Default: \fB10\fP\&.
.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\-\-[no\-]diff\fP
Use to upload only new and modified files. Set to \fBfalse\fP to upload all files. Default: \fBtrue\fP\&.
.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\-\-[no\-]force\fP
Use \fB\-\-force\fP to upload roles, cookbooks, etc. even if the file in the directory is identical (by default, no \fBPOST\fP or \fBPUT\fP is performed unless an actual change would be made). Default: \fB\-\-no\-force\fP\&.
.TP
.B \fB\-\-[no\-]freeze\fP
Use to require changes to a cookbook be included as a new version. Only the \fB\-\-force\fP option can override this setting. Default: \fBfalse\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\-n\fP, \fB\-\-dry\-run\fP
Use to take no action and only print out results. Default: \fBfalse\fP\&.
.TP
.B \fB\-\-print\-after\fP
Use to show data after a destructive operation.
.TP
.B \fB\-\-[no\-]purge\fP
Use \fB\-\-purge\fP to delete roles, cookbooks, etc. from the Chef server if their corresponding files do not exist in the chef\-repo\&. By default, such objects are left alone and NOT purged. Default: \fB\-\-no\-purge\fP\&.
.TP
.B \fB\-\-[no\-]recurse\fP
Use \fB\-\-no\-recurse\fP to disable uploading a directory recursively. Default: \fB\-\-recurse\fP\&.
.TP
.B \fB\-\-repo\-mode MODE\fP
The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\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
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\-\-version\fP
The version of the chef\-client\&.
.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
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
.sp
\fBExamples\fP
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload /
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload cookbooks
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload /cookbooks
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload environments
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload /environments
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload environments/production.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from the \fBenvironments/\fP directory, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload production.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload roles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload /roles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload cookbooks/apache\e* roles/webserver.json
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife upload \(gaknife deps nodes/*.json\(ga
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Chef
.\" Generated by docutils manpage writer.
.