mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
272 lines
6.6 KiB
Groff
272 lines
6.6 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SALT-CLOUD" "1" "January 02, 2014" "2014.1.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 \-h, \-\-help
|
|
Print a usage message briefly summarizing these command\-line options.
|
|
.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 VM names are
|
|
also passed as arguments, they will be used to filter the map file.
|
|
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 \-Q, \-\-query
|
|
Execute a query and print out 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 \-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\-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
|
|
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
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-C CLOUD_CONFIG, \-\-cloud\-config=CLOUD_CONFIG
|
|
Specify an alternative location for the salt cloud configuration file.
|
|
Default location is /etc/salt/cloud.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-M MASTER_CONFIG, \-\-master\-config=MASTER_CONFIG
|
|
Specify an alternative location for the salt master configuration file.
|
|
The salt master configuration file is used to determine how to handle the
|
|
minion RSA keys. Default location is /etc/salt/master.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-V VM_CONFIG, \-\-profiles=VM_CONFIG, \-\-vm_config=VM_CONFIG
|
|
Specify an alternative location for the salt cloud profiles file.
|
|
Default location is /etc/salt/cloud.profiles.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-raw\-out
|
|
Print the output from the salt command in raw python
|
|
form, this is suitable for re\-reading the output into
|
|
an executing python script with eval.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-text\-out
|
|
Print the output from the salt command in the same form the shell would.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-yaml\-out
|
|
Print the output from the salt command in yaml.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-json\-out
|
|
Print the output from the salt command in json.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-no\-color
|
|
Disable all colored output.
|
|
.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
|
|
2013 SaltStack, Inc.
|
|
.\" Generated by docutils manpage writer.
|
|
.
|