244 lines
4.9 KiB
Groff
244 lines
4.9 KiB
Groff
'\" t
|
|
.\" Title: heat-cfn
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 03/31/2012
|
|
.\" Manual: System administration commands
|
|
.\" Source: Heat 0.0.1
|
|
.\" Language: English
|
|
.\"
|
|
.TH "HEAT" "1" "03/31/2012" "HEAT 0\&.0\&.1" "System administration commands"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
heat-cfn \- perform a heat action via the heat API
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
heat-cfn COMMAND [OPTIONS]
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
\fBheat-cfn\fR is a tool to orchestrate the setup of multiple cloud applications\&.
|
|
|
|
.SH CONFIGURATION
|
|
|
|
heat-cfn uses keystone authentication, and expects some variables to be set in
|
|
your environment, without these heat will not be able to establish an
|
|
authenticated connection with the heat API server.
|
|
|
|
Example:
|
|
.br
|
|
export ADMIN_TOKEN=<keystone admin token>
|
|
.br
|
|
export OS_USERNAME=admin
|
|
.br
|
|
export OS_PASSWORD=verybadpass
|
|
.br
|
|
export OS_TENANT_NAME=admin
|
|
.br
|
|
export OS_AUTH_URL=http://127.0.0.1:5000/v2.0/
|
|
.br
|
|
export OS_AUTH_STRATEGY=keystone
|
|
.br
|
|
|
|
.SH "COMMANDS"
|
|
|
|
.PP
|
|
\fBcreate\fP
|
|
.RS 4
|
|
Create stack as defined in template file
|
|
.RE
|
|
.PP
|
|
\fBdelete\fP
|
|
.RS 4
|
|
Delete specified stack
|
|
.RE
|
|
.PP
|
|
\fBdescribe\fP
|
|
.RS 4
|
|
Provide detailed information about the specified stack, or if no arguments are given all stacks
|
|
.RE
|
|
.PP
|
|
\fBestimate-template-cost\fP
|
|
.RS 4
|
|
Currently not implemented
|
|
.RE
|
|
.PP
|
|
\fBevent-list\fP
|
|
.RS 4
|
|
List events related to specified stacks, or if no arguments are given all stacks
|
|
.RE
|
|
.PP
|
|
\fBgettemplate\fP
|
|
.RS 4
|
|
Get the template for a running stack
|
|
.RE
|
|
.PP
|
|
\fBhelp\fP
|
|
.RS 4
|
|
Provide help/usage information
|
|
.RE
|
|
.PP
|
|
\fBlist\fP
|
|
.RS 4
|
|
List summary information for all stacks
|
|
.RE
|
|
.PP
|
|
\fBresource\fP
|
|
.RS 4
|
|
List information about a specific resource
|
|
.RE
|
|
.PP
|
|
\fBresource-list\fP
|
|
.RS 4
|
|
List all resources for a specified stack
|
|
.RE
|
|
.PP
|
|
\fBresource-list-details\fP
|
|
.RS 4
|
|
List details of all resources for a specified stack or physical resource ID, optionally filtered by a logical resource ID
|
|
.RE
|
|
.PP
|
|
\fBupdate\fP
|
|
.RS 4
|
|
Update a running stack with a modified template or template parameters - currently not implemented
|
|
.RE
|
|
.PP
|
|
\fBvalidate\fP
|
|
.RS 4
|
|
Validate a template file syntax
|
|
.RE
|
|
|
|
.SH "OPTIONS"
|
|
.PP
|
|
\fB\-S\fR, \fB\-\-auth_strategy\fR
|
|
.RS 4
|
|
Authentication strategy
|
|
.RE
|
|
.PP
|
|
\fB\-A\fR, \fB\-\-auth_token\fR
|
|
.RS 4
|
|
Authentication token to use to identify the client to the heat server
|
|
.RE
|
|
.PP
|
|
\fB\-N\fR, \fB\-\-auth_url\fR
|
|
.RS 4
|
|
Authentication URL for keystone authentication
|
|
.RE
|
|
.PP
|
|
\fB\-d\fR, \fB\-\-debug\fR
|
|
.RS 4
|
|
Enable verbose debug level output
|
|
.RE
|
|
.PP
|
|
\fB\-H\fR, \fB\-\-host\fR
|
|
.RS 4
|
|
Specify the hostname running the heat API service
|
|
.RE
|
|
.PP
|
|
\fB\-k\fR, \fB\-\-insecure\fR
|
|
.RS 4
|
|
Use plain HTTP instead of HTTPS
|
|
.RE
|
|
.PP
|
|
\fB\-P\fR, \fB\-\-parameters\fR
|
|
.RS 4
|
|
Stack input parameters
|
|
.RE
|
|
.PP
|
|
\fB\-K\fR, \fB\-\-password\fR
|
|
.RS 4
|
|
Password used to acquire an authentication token
|
|
.RE
|
|
.PP
|
|
\fB\-p\fR, \fB\-\-port\fR
|
|
.RS 4
|
|
Specify the port to connect to for the heat API service
|
|
.RE
|
|
.PP
|
|
\fB\-R\fR, \fB\-\-region\fR
|
|
.RS 4
|
|
Region name. When using keystone authentication "version 2.0 or later this identifies the region
|
|
.RE
|
|
.PP
|
|
\fB\-f\fR, \fB\-\-template\fR-file
|
|
.RS 4
|
|
Path to file containing the stack template
|
|
.RE
|
|
.PP
|
|
\fB\-u\fR, \fB\-\-template\fR-url
|
|
.RS 4
|
|
URL to stack template
|
|
.RE
|
|
.PP
|
|
\fB\-T\fR, \fB\-\-tenant\fR
|
|
.RS 4
|
|
Tenant name used for Keystone authentication
|
|
.RE
|
|
.PP
|
|
\fB\-t\fR, \fB\-\-timeout\fR
|
|
.RS 4
|
|
Stack creation timeout (default is 60 minutes)
|
|
.RE
|
|
.PP
|
|
\fB\-U\fR, \fB\-\-url\fR
|
|
.RS 4
|
|
URL of heat service
|
|
.RE
|
|
.PP
|
|
\fB\-I\fR, \fB\-\-username\fR
|
|
.RS 4
|
|
User name used to acquire an authentication token
|
|
.RE
|
|
.PP
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
.RS 4
|
|
Enable verbose output
|
|
.RE
|
|
.PP
|
|
\fB\-y\fR, \fB\-\-yes\fR
|
|
.RS 4
|
|
Do not prompt for confirmation, assume yes
|
|
.RE
|
|
|
|
|
|
.PP
|
|
.SH "USAGE EXAMPLES"
|
|
.sp
|
|
|
|
heat-cfn -d create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key"
|
|
|
|
heat-cfn list
|
|
|
|
heat-cfn describe wordpress
|
|
|
|
heat-cfn resource-list wordpress
|
|
|
|
heat-cfn resource-list-details wordpress
|
|
|
|
heat-cfn resource-list-details wordpress WikiDatabase
|
|
|
|
heat-cfn resource wordpress WikiDatabase
|
|
|
|
heat-cfn event-list
|
|
|
|
heat-cfn delete wordpress
|
|
|
|
.SH "AUTHOR"
|
|
.sp
|
|
See the AUTHORS file for a complete list of contributors\&.
|
|
.SH "COPYRIGHT"
|
|
.sp
|
|
Copyright \(co 2012, Red Hat Inc
|
|
.sp
|
|
Heat is released under the terms of the ASL 2 License\&.
|
|
.sp
|
|
Extensive documentation as well as IRC and mailing list info is available on the heat home page: https://heat\&-api\&.org/
|