x
/
flame
Code Issues Proposed changes

Sync the usage doc with the actual options 

Flame's documentation was lagging behind regarding the actual options
provided by the CLI. This patch fixes the documentation of flame by
syncing it with the output of flame --help.

Change-Id: I6c32665b269405c983c38a3314392904bf3ac7e6
This commit is contained in:
Guillaume Espanel 2016-09-02 11:53:51 +02:00
parent 7d28f871ba
commit 73e1f7795e
2 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -34,8 +34,9 @@ Usage
usage: flame [-h] [--username USERNAME] [--password PASSWORD]
[--project PROJECT] [--region REGION] [--auth_url AUTH_URL]
[--insecure] [--exclude-servers] [--exclude-volumes]
[--generate-stack-data]
[--os-auth-token OS_AUTH_TOKEN] [--insecure]
[--endpoint_type ENDPOINT_TYPE] [--exclude-servers]
[--exclude-volumes] [--exclude-keypairs] [--generate-stack-data]
Heat template and data file generator
@ -53,6 +54,8 @@ Usage
(https) requests. The server's certificate will not be
verified against any certificate authorities. This
option should be used with caution.
--endpoint_type ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE] or publicURL
--exclude-servers Do not export in template server resources
--exclude-volumes Do not export in template volume resources
--exclude-keypairs Do not export in template key pair resources

43
doc/source/usage.rst
View File

@ -9,30 +9,35 @@ To use install flame in a project::
To use the CLI of flame::
usage: flame [-h] [--username USERNAME] [--password PASSWORD]
[--project PROJECT] [--os-auth-token OS_AUTH_TOKEN]
[--auth_url AUTH_URL] [--insecure] [--exclude_servers]
[--exclude_volumes]
[--project PROJECT] [--region REGION] [--auth_url AUTH_URL]
[--os-auth-token OS_AUTH_TOKEN] [--insecure]
[--endpoint_type ENDPOINT_TYPE] [--exclude-servers]
[--exclude-volumes] [--exclude-keypairs] [--generate-stack-data]
Generate Heat Template
Heat template and data file generator
optional arguments:
-h, --help show this help message and exit
--username USERNAME A user name with access to the project. Defaults to
env[OS_USERNAME]
--password PASSWORD The user's password. Defaults to env[OS_PASSWORD]
--project PROJECT Name of project. Defaults to env[OS_TENANT_NAME]
--auth_url AUTH_URL Authentication URL. Defaults to env[OS_AUTH_URL].
-h, --help show this help message and exit
--username USERNAME A user name with access to the project. Defaults to
env[OS_USERNAME]
--password PASSWORD The user's password. Defaults to env[OS_PASSWORD]
--project PROJECT Name of project. Defaults to env[OS_TENANT_NAME]
--region REGION Name of region. Defaults to env[OS_REGION_NAME]
--auth_url AUTH_URL Authentication URL. Defaults to env[OS_AUTH_URL].
--os-auth-token OS_AUTH_TOKEN
User's auth token. Defaults to env[OS_AUTH_TOKEN].
--insecure Explicitly allow clients 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.
--exclude_servers Do not export in template server resources
--exclude_volumes Do not export in template volume resources
User's auth token. Defaults to env[OS_AUTH_TOKEN].
--insecure Explicitly allow clients 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.
--endpoint_type ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE] or publicURL
--exclude-servers Do not export in template server resources
--exclude-volumes Do not export in template volume resources
--exclude-keypairs Do not export in template key pair resources
--generate-stack-data
In addition to template, generate Heat stack data
file.
In addition to template, generate Heat stack data
file.
Example