Skip to content

Commit

Permalink
More updates for user guide and other related books
Browse files Browse the repository at this point in the history 
Started to update and pull in files from command ref
I will get rid of command ref once user guide is completely built
patchset - df

Patchset makes license cc-by

bug: #1110146

Change-Id: I93e1416b16fc8aac7169b83d2a89d910755bd820
author: diane fleming
  • Loading branch information
@dian4554 @annegentle
dian4554 authored and annegentle committed Jul 15, 2013
1 parent bf5d83f commit d787ea6
Show file tree
Hide file tree
Showing 45 changed files with 24,925 additions and 2,896 deletions.
11 changes: 7 additions & 4 deletions doc/src/docbkx/cli-guide/pom.xml
View file
Expand Up @@ -15,8 +15,7 @@
<!-- ################################################ -->

<build>
<plugins>

<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
Expand All @@ -38,7 +37,7 @@
appendix toc,title
article/appendix nop
article toc,title
book title,figure,table,example,equation
book toc,title,figure,table,example,equation
chapter toc,title
part toc,title
preface toc,title
Expand All @@ -49,8 +48,12 @@
</generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<chapterAutolabel>0</chapterAutolabel>
<exampleAutoLabel>0</exampleAutoLabel>
<appendixAutolabel>0</appendixAutolabel>
<tocSectionDepth>1</tocSectionDepth>
<formalProcedures>0</formalProcedures>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>

<webhelpDirname>cli-guide</webhelpDirname>
<includeDateInPdfFilename>0</includeDateInPdfFilename>
<pdfFilenameBase>cli-guide</pdfFilenameBase>
Expand Down
70 changes: 48 additions & 22 deletions doc/src/docbkx/cli-guide/src/cinder_cli_commands.xml
View file
@@ -1,23 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cinder_commands">
<title>cinder Command Reference</title>
<literallayout class="monospaced">
Command-line interface to the OpenStack Volume API.

Positional arguments:
&lt;subcommand>
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cinder_commands">
<title>cinder commands</title>
<para>Describes commands for cinder, which is the command-line
interface for the OpenStack Identity API.</para>
<para>For help on a specific cinder command, enter:</para>
<screen><userinput><command>cinder</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>cinder [--version] [--debug] [--os-username &lt;auth-user-name>]
[--os-password &lt;auth-password>]
[--os-tenant-name &lt;auth-tenant-name>]
[--os-tenant-id &lt;auth-tenant-id>] [--os-auth-url &lt;auth-url>]
[--os-region-name &lt;region-name>] [--service-type &lt;service-type>]
[--service-name &lt;service-name>]
[--volume-service-name &lt;volume-service-name>]
[--endpoint-type &lt;endpoint-type>]
[--os-volume-api-version &lt;compute-api-ver>]
[--os-cacert &lt;ca-certificate>] [--retries &lt;retries>]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
absolute-limits Print a list of absolute limits for a user
backup-create Creates a backup.
backup-delete Remove a backup.
backup-list List all the backups.
backup-restore Restore a backup.
backup-show Show details about a backup.
create Add a new volume.
credentials Show user credentials returned from auth
credentials Show user credentials returned from auth.
delete Remove a volume.
endpoints Discover endpoints that get returned from the
authenticate services
authenticate services.
extra-specs-list Print a list of current 'volume types and extra specs'
(Admin Only).
force-delete Attempt forced removal of a volume, regardless of its
state.
list List all the volumes.
metadata Set or Delete metadata on a volume.
quota-class-show List the quotas for a quota class.
quota-class-update Update the quotas for a quota class.
quota-defaults List the default quotas for a tenant.
Expand All @@ -32,23 +56,27 @@ Positional arguments:
snapshot-rename Rename a snapshot.
snapshot-show Show details about a snapshot.
type-create Create a new volume type.
type-delete Delete a specific volume type
type-delete Delete a specific volume type.
type-key Set or unset extra_spec for a volume type.
type-list Print a list of available 'volume types'.
bash-completion Prints all of the commands and options to stdout so
that the
upload-to-image Upload volume to image service as image.
bash-completion Print arguments for bash_completion.
help Display help about this program or one of its
subcommands.
list-extensions List all the os-api extensions that are available.

Optional arguments:
list-extensions List all the os-api extensions that are available.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
--debug Print debugging output
--os-username &lt;auth-user-name>
Defaults to env[OS_USERNAME].
--os-password &lt;auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name &lt;auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-tenant-id &lt;auth-tenant-id>
Defaults to env[OS_TENANT_ID].
--os-auth-url &lt;auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name &lt;region-name>
Expand All @@ -62,12 +90,10 @@ Optional arguments:
--endpoint-type &lt;endpoint-type>
Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL.
--os-volume-api-version &lt;compute-api-ver>
Accepts 1,defaults to env[OS_VOLUME_API_VERSION].
Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION].
--os-cacert &lt;ca-certificate>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT]
--retries &lt;retries> Number of retries.

See "cinder help COMMAND" for help on a specific command.
</literallayout>
--retries &lt;retries> Number of retries.</computeroutput></screen>
</example>
</section>
81 changes: 43 additions & 38 deletions doc/src/docbkx/cli-guide/src/glance_cli_commands.xml
View file
@@ -1,29 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="glance_commands">
<title>glance Command Reference</title>
<para><literallayout role="monospace">usage: glance [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--os-cacert &lt;ca-certificate-file>]
[--ca-file OS_CACERT] [--timeout TIMEOUT] [--no-ssl-compression]
[-f] [--dry-run] [--ssl] [-H ADDRESS] [-p PORT]
[--os-username OS_USERNAME] [-I OS_USERNAME]
[--os-password OS_PASSWORD] [-K OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[-T OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [-N OS_AUTH_URL]
[--os-region-name OS_REGION_NAME] [-R OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [-A OS_AUTH_TOKEN]
[--os-image-url OS_IMAGE_URL] [-U OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand> ...

Command-line interface to the OpenStack Images API.

Positional arguments:
&lt;subcommand>
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="glance_commands">
<title>glance commands</title>
<para>Describes commands for glance, which is the command-line
interface for the OpenStack Image Service API.</para>
<para>For help on a specific glance command, enter:</para>
<screen><userinput><command>glance</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput> glance [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
[--key-file KEY_FILE] [--os-cacert &lt;ca-certificate-file>]
[--ca-file OS_CACERT] [--timeout TIMEOUT] [--no-ssl-compression]
[-f] [--dry-run] [--ssl] [-H ADDRESS] [-p PORT]
[--os-username OS_USERNAME] [-I OS_USERNAME]
[--os-password OS_PASSWORD] [-K OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[-T OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [-N OS_AUTH_URL]
[--os-region-name OS_REGION_NAME] [-R OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [-A OS_AUTH_TOKEN]
[--os-image-url OS_IMAGE_URL] [-U OS_IMAGE_URL]
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
add DEPRECATED! Use image-create instead.
clear DEPRECATED!
delete DEPRECATED! Use image-delete instead.
Expand All @@ -45,16 +50,17 @@ Positional arguments:
show DEPRECATED! Use image-show instead.
update DEPRECATED! Use image-update instead.
help Display help about this program or one of its
subcommands.

Optional arguments:
--version show program's version number and exit
subcommands.</computeroutput></screen>
</example>
<example>
<title>Optional arguments</title>
<screen><computeroutput> --version show program's version number and exit
-d, --debug Defaults to env[GLANCECLIENT_DEBUG]
-v, --verbose Print more verbose output
-k, --insecure Explicitly allow glanceclient to perform"insecure SSL"
(https) requests. The server certificate will not be
verified against anycertificate authorities. This
option should be used with caution.
-k, --insecure Explicitly allow glanceclient to perform "insecure
SSL" (https) requests. The server's certificate will
not be verified against any certificate authorities.
This option should be used with caution.
--cert-file CERT_FILE
Path of certificate file to use in SSL connection.
This file can optionally be prepended with the private
Expand All @@ -63,9 +69,9 @@ Optional arguments:
option is not necessary if your key is prepended to
your cert file.
--os-cacert &lt;ca-certificate-file>
Path of CA TLS certificate(s) used to verify the remote
server's certificate. Without this option glance looks
for the default system CA certificates.
Path of CA TLS certificate(s) used to verify the
remote server's certificate. Without this option
glance looks for the default system CA certificates.
--ca-file OS_CACERT DEPRECATED! Use --os-cacert.
--timeout TIMEOUT Number of seconds to wait for a response
--no-ssl-compression Disable SSL compression when using https.
Expand Down Expand Up @@ -111,7 +117,6 @@ Optional arguments:
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE]
-S OS_AUTH_STRATEGY, --os_auth_strategy OS_AUTH_STRATEGY
DEPRECATED! This option is completely ignored.

See "glance help COMMAND" for help on a specific command.</literallayout></para>
DEPRECATED! This option is completely ignored.</computeroutput></screen>
</example>
</section>
88 changes: 54 additions & 34 deletions doc/src/docbkx/cli-guide/src/heat_cli_commands.xml
View file
@@ -1,36 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="heat_client_commands">
<title>Heat command reference</title>
<literallayout class="monospaced">usage: heat [-d] [-v] [-k] [--cert-file CERT_FILE] [--key-file KEY_FILE]
[--ca-file CA_FILE] [--timeout TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-t]
&lt;subcommand> ...
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="heat_client_commands">
<title>heat commands</title>
<para>Describes the commands for heat, which is the command-line
interface for the OpenStack Heat API.</para>
<para>For help on a specific heat command, enter:</para>
<screen><userinput><command>heat</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<example>
<title>Usage</title>
<screen><computeroutput>heat [-d] [-v] [-k] [--cert-file CERT_FILE] [--key-file KEY_FILE]
[--ca-file CA_FILE] [--timeout TIMEOUT]
[--os-username OS_USERNAME] [--os-password OS_PASSWORD]
[--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-auth-token OS_AUTH_TOKEN] [--os-no-client-auth]
[--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-t]
&lt;subcommand> ...</computeroutput></screen>
</example>
<example>
<title>Positional arguments</title>
<screen><computeroutput>&lt;subcommand>
create DEPRECATED! Use stack-create instead
delete DEPRECATED! Use stack-delete instead
describe DEPRECATED! Use stack-show instead
event DEPRECATED! Use event-show instead
event-list List events for a stack
event-show Describe the event
gettemplate DEPRECATED! Use template-show instead
list DEPRECATED! Use stack-list instead
resource DEPRECATED! Use resource-show instead
resource-list Show list of resources belonging to a stack
resource-metadata List resource metadata
resource-show Describe the resource
stack-create Create the stack
stack-delete Delete the stack
stack-list List the user's stacks
stack-show Describe the stack
stack-update Update the stack
template-show Get the template for the specified stack
template-validate Validate a template with parameters
update DEPRECATED! Use stack-update instead
validate DEPRECATED! Use template-validate instead
help Display help about this program or one of its
subcommands.</computeroutput></screen>
</example>

stack-create Create the stack
stack-delete Delete the stack
stack-list List the user's stacks
stack-show Describe the stack
stack-update Update the stack
resource-list Show list of resources belonging to a stack
resource-metadata List resource metadata
resource-show Describe the resource
event-list List events for a stack
event-show Describe the event
template-show Get the template for the specified stack
template-validate Validate a template with parameters
help Display help about this program or one of its subcommands.

Optional arguments:
-d, --debug Defaults to env[HEATCLIENT_DEBUG]
<example>
<title>Optional arguments</title>
<screen><computeroutput> -d, --debug Defaults to env[HEATCLIENT_DEBUG]
-v, --verbose Print more verbose output
-k, --insecure Explicitly allow the client to perform "insecure" SSL
(https) requests. The server's certificate will not be
Expand Down Expand Up @@ -61,7 +82,7 @@ Optional arguments:
Defaults to env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN]
--os-no-client-auth Do not contact keystone for a token. Defaults to
--os-no-client-auth Do not contact heat for a token. Defaults to
env[OS_NO_CLIENT_AUTH]
--heat-url HEAT_URL Defaults to env[HEAT_URL]
--heat-api-version HEAT_API_VERSION
Expand All @@ -71,7 +92,6 @@ Optional arguments:
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE]
-t, --token-only Only send a token for auth, do not send username and
password as well.

See "heat help COMMAND" for help on a specific command.</literallayout>
password as well.</computeroutput></screen>
</example>
</section>

0 comments on commit d787ea6

Please sign in to comment.