Documentation updates
This commit is contained in:
parent
d3c8832414
commit
ccc607eaa5
1 changed files with 7 additions and 12 deletions
|
@ -57,22 +57,17 @@ options:
|
||||||
- File to find the Rackspace Public Cloud credentials in
|
- File to find the Rackspace Public Cloud credentials in
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
region_name:
|
authors:
|
||||||
description:
|
- Jesse Keating <jesse.keating@rackspace.com>
|
||||||
- Region name to use in request
|
- Paul Durivage <paul.durivage@rackspace.com>
|
||||||
required: false
|
|
||||||
default: DFW
|
|
||||||
author: Jesse Keating
|
|
||||||
notes:
|
notes:
|
||||||
- Two environment variables need to be set, RAX_CREDS and RAX_REGION.
|
- One environment variable needs to be set: RAX_CREDS_FILE.
|
||||||
- RAX_CREDS points to a credentials file appropriate for pyrax
|
- RAX_CREDS_FILE points to a credentials file appropriate for pyrax.
|
||||||
- RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
- See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
|
||||||
requirements: [ "pyrax" ]
|
requirements: [ "pyrax" ]
|
||||||
examples:
|
examples:
|
||||||
- description: List server instances
|
- description: List server instances
|
||||||
code: RAX_CREDS_FILE=~/.raxpub RAX_REGION=ORD rax.py --list
|
code: RAX_CREDS_FILE=~/.raxpub rax.py --list
|
||||||
- description: List server instance properties
|
|
||||||
code: RAX_CREDS_FILE=~/.raxpub RAX_REGION=ORD rax.py --host <HOST_IP>
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
Loading…
Add table
Reference in a new issue