Initial commit

plugins/doc_fragments/rackspace.py

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2014, Matt Martz <matt@sivel.net>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+
+class ModuleDocFragment(object):
+
+    # Standard Rackspace only documentation fragment
+    DOCUMENTATION = r'''
+options:
+  api_key:
+    description:
+      - Rackspace API key, overrides I(credentials).
+    type: str
+    aliases: [ password ]
+  credentials:
+    description:
+      - File to find the Rackspace credentials in. Ignored if I(api_key) and
+        I(username) are provided.
+    type: path
+    aliases: [ creds_file ]
+  env:
+    description:
+      - Environment as configured in I(~/.pyrax.cfg),
+        see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
+    type: str
+  region:
+    description:
+      - Region to create an instance in.
+    type: str
+    default: DFW
+  username:
+    description:
+      - Rackspace username, overrides I(credentials).
+    type: str
+  validate_certs:
+    description:
+      - Whether or not to require SSL validation of API endpoints.
+    type: bool
+    aliases: [ verify_ssl ]
+requirements:
+  - python >= 2.6
+  - pyrax
+notes:
+  - The following environment variables can be used, C(RAX_USERNAME),
+    C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
+  - C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
+    appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
+  - C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
+  - C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
+'''
+
+    # Documentation fragment including attributes to enable communication
+    # of other OpenStack clouds. Not all rax modules support this.
+    OPENSTACK = r'''
+options:
+  api_key:
+    description:
+      - Rackspace API key, overrides I(credentials).
+    aliases: [ password ]
+  auth_endpoint:
+    description:
+      - The URI of the authentication service.
+    default: https://identity.api.rackspacecloud.com/v2.0/
+    version_added: '1.5'
+  credentials:
+    description:
+      - File to find the Rackspace credentials in. Ignored if I(api_key) and
+        I(username) are provided.
+    aliases: [ creds_file ]
+  env:
+    description:
+      - Environment as configured in I(~/.pyrax.cfg),
+        see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
+    version_added: '1.5'
+  identity_type:
+    description:
+      - Authentication mechanism to use, such as rackspace or keystone.
+    default: rackspace
+    version_added: '1.5'
+  region:
+    description:
+      - Region to create an instance in.
+    default: DFW
+  tenant_id:
+    description:
+      - The tenant ID used for authentication.
+    version_added: '1.5'
+  tenant_name:
+    description:
+      - The tenant name used for authentication.
+    version_added: '1.5'
+  username:
+    description:
+      - Rackspace username, overrides I(credentials).
+  validate_certs:
+    description:
+      - Whether or not to require SSL validation of API endpoints.
+    version_added: '1.5'
+    type: bool
+    aliases: [ verify_ssl ]
+requirements:
+  - python >= 2.6
+  - pyrax
+notes:
+  - The following environment variables can be used, C(RAX_USERNAME),
+    C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
+  - C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
+    appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
+  - C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
+  - C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
+'''