mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
701f47a658
Added salt-proxy release notes topic Added note to pip state for Refs #21845 Regenerated and versioned man pages
382 lines
9.6 KiB
Groff
382 lines
9.6 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SALT-CLOUD" "1" "September 01, 2015" "2015.8.0" "Salt"
|
|
.SH NAME
|
|
salt-cloud \- Salt Cloud Command
|
|
.
|
|
.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
|
|
Provision virtual machines in the cloud with Salt
|
|
.SH SYNOPSIS
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /etc/salt/cloud.map
|
|
|
|
salt\-cloud \-m /etc/salt/cloud.map NAME
|
|
|
|
salt\-cloud \-m /etc/salt/cloud.map NAME1 NAME2
|
|
|
|
salt\-cloud \-p PROFILE NAME
|
|
|
|
salt\-cloud \-p PROFILE NAME1 NAME2 NAME3 NAME4 NAME5 NAME6
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Salt Cloud is the system used to provision virtual machines on various public
|
|
clouds via a cleanly controlled profile and mapping system.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-version
|
|
Print the version of Salt that is running.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-versions\-report
|
|
Show program\(aqs dependencies and version number, and then exit
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Show the help message and exit
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
|
|
The location of the Salt configuration directory. This directory contains
|
|
the configuration files for Salt master and minions. The default location
|
|
on most systems is \fB/etc/salt\fP\&.
|
|
.UNINDENT
|
|
.SS Execution Options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-L LOCATION, \-\-location=LOCATION
|
|
Specify which region to connect to.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-a ACTION, \-\-action=ACTION
|
|
Perform an action that may be specific to this cloud provider. This
|
|
argument requires one or more instance names to be specified.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-f <FUNC\-NAME> <PROVIDER>, \-\-function=<FUNC\-NAME> <PROVIDER>
|
|
Perform an function that may be specific to this cloud provider, that does
|
|
not apply to an instance. This argument requires a provider to be specified
|
|
(i.e.: nova).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-p PROFILE, \-\-profile=PROFILE
|
|
Select a single profile to build the named cloud VMs from. The profile must
|
|
be defined in the specified profiles file.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-m MAP, \-\-map=MAP
|
|
Specify a map file to use. If used without any other options, this option
|
|
will ensure that all of the mapped VMs are created. If the named VM already
|
|
exists then it will be skipped.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-H, \-\-hard
|
|
When specifying a map file, the default behavior is to ensure that all of
|
|
the VMs specified in the map file are created. If the \-\-hard option is
|
|
set, then any VMs that exist on configured cloud providers that are
|
|
not specified in the map file will be destroyed. Be advised that this can
|
|
be a destructive operation and should be used with care.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-d, \-\-destroy
|
|
Pass in the name(s) of VMs to destroy, salt\-cloud will search the
|
|
configured cloud providers for the specified names and destroy the
|
|
VMs. Be advised that this is a destructive operation and should be used
|
|
with care. Can be used in conjunction with the \-m option to specify a map
|
|
of VMs to be deleted.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-P, \-\-parallel
|
|
Normally when building many cloud VMs they are executed serially. The \-P
|
|
option will run each cloud vm build in a separate process allowing for
|
|
large groups of VMs to be build at once.
|
|
.sp
|
|
Be advised that some cloud provider\(aqs systems don\(aqt seem to be well suited
|
|
for this influx of vm creation. When creating large groups of VMs watch the
|
|
cloud provider carefully.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-u, \-\-update\-bootstrap
|
|
Update salt\-bootstrap to the latest develop version on GitHub.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-y, \-\-assume\-yes
|
|
Default yes in answer to all confirmation questions.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-k, \-\-keep\-tmp
|
|
Do not remove files from /tmp/ after deploy.sh finishes.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-show\-deploy\-args
|
|
Include the options used to deploy the minion in the data returned.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-script\-args=SCRIPT_ARGS
|
|
Script arguments to be fed to the bootstrap script when deploying the VM.
|
|
.UNINDENT
|
|
.SS Query Options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-Q, \-\-query
|
|
Execute a query and return some information about the nodes running on
|
|
configured cloud providers
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-F, \-\-full\-query
|
|
Execute a query and print out all available information about all cloud VMs.
|
|
Can be used in conjunction with \-m to display only information about the
|
|
specified map.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-S, \-\-select\-query
|
|
Execute a query and print out selected information about all cloud VMs.
|
|
Can be used in conjunction with \-m to display only information about the
|
|
specified map.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list\-providers
|
|
Display a list of configured providers.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list\-profiles
|
|
New in version 2014.7.0.
|
|
|
|
.sp
|
|
Display a list of configured profiles. Pass in a cloud provider to view
|
|
the provider\(aqs associated profiles, such as \fBdigital_ocean\fP, or pass in
|
|
\fBall\fP to list all the configured profiles.
|
|
.UNINDENT
|
|
.SS Cloud Providers Listings
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list\-locations=LIST_LOCATIONS
|
|
Display a list of locations available in configured cloud providers. Pass
|
|
the cloud provider that available locations are desired on, aka "linode",
|
|
or pass "all" to list locations for all configured cloud providers
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list\-images=LIST_IMAGES
|
|
Display a list of images available in configured cloud providers. Pass the
|
|
cloud provider that available images are desired on, aka "linode", or pass
|
|
"all" to list images for all configured cloud providers
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list\-sizes=LIST_SIZES
|
|
Display a list of sizes available in configured cloud providers. Pass the
|
|
cloud provider that available sizes are desired on, aka "AWS", or pass
|
|
"all" to list sizes for all configured cloud providers
|
|
.UNINDENT
|
|
.SS Cloud Credentials
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-set\-password=<USERNAME> <PROVIDER>
|
|
Configure password for a cloud provider and save it to the keyring.
|
|
PROVIDER can be specified with or without a driver, for example:
|
|
"\-\-set\-password bob rackspace" or more specific "\-\-set\-password bob
|
|
rackspace:openstack" DEPRECATED!
|
|
.UNINDENT
|
|
.SS Output Options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-out
|
|
Pass in an alternative outputter to display the return of data. This
|
|
outputter can be any of the available outputters:
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
\fBgrains\fP, \fBhighstate\fP, \fBjson\fP, \fBkey\fP, \fBoverstatestage\fP, \fBpprint\fP, \fBraw\fP, \fBtxt\fP, \fByaml\fP
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Some outputters are formatted only for data returned from specific
|
|
functions; for instance, the \fBgrains\fP outputter will not work for non\-grains
|
|
data.
|
|
.sp
|
|
If an outputter is used that does not support the data passed into it, then
|
|
Salt will fall back on the \fBpprint\fP outputter and display the return data
|
|
using the Python \fBpprint\fP standard library module.
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
If using \fB\-\-out=json\fP, you will probably want \fB\-\-static\fP as well.
|
|
Without the static option, you will get a separate JSON string per minion
|
|
which makes JSON output invalid as a whole.
|
|
This is due to using an iterative outputter. So if you want to feed it
|
|
to a JSON parser, use \fB\-\-static\fP as well.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
|
|
Print the output indented by the provided value in spaces. Negative values
|
|
disable indentation. Only applicable in outputters that support
|
|
indentation.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-out\-file=OUTPUT_FILE, \-\-output\-file=OUTPUT_FILE
|
|
Write the output to the specified file.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-no\-color
|
|
Disable all colored output
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-force\-color
|
|
Force colored output
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
When using colored output the color codes are as follows:
|
|
.sp
|
|
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
|
|
changes and success and \fByellow\fP denotes a expected future change in configuration.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.sp
|
|
To create 4 VMs named web1, web2, db1, and db2 from specified profiles:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-p fedora_rackspace web1 web2 db1 db2
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To read in a map file and create all VMs specified therein:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /path/to/cloud.map
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To read in a map file and create all VMs specified therein in parallel:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /path/to/cloud.map \-P
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To delete any VMs specified in the map file:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /path/to/cloud.map \-d
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To delete any VMs NOT specified in the map file:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /path/to/cloud.map \-H
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
To display the status of all VMs specified in the map file:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
salt\-cloud \-m /path/to/cloud.map \-Q
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIsalt\-cloud(7)\fP
|
|
\fIsalt(7)\fP
|
|
\fIsalt\-master(1)\fP
|
|
\fIsalt\-minion(1)\fP
|
|
.SH AUTHOR
|
|
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
|
.SH COPYRIGHT
|
|
2015 SaltStack, Inc.
|
|
.\" Generated by docutils manpage writer.
|
|
.
|