|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +# Copyright: (c) 2017, René Moser <mail@renemoser.net> |
| 4 | +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 5 | + |
| 6 | +from __future__ import absolute_import, division, print_function |
| 7 | +__metaclass__ = type |
| 8 | + |
| 9 | + |
| 10 | +class ModuleDocFragment(object): |
| 11 | + |
| 12 | + # Standard exoscale documentation fragment |
| 13 | + DOCUMENTATION = r''' |
| 14 | +options: |
| 15 | + api_key: |
| 16 | + description: |
| 17 | + - API key of the Exoscale DNS API. |
| 18 | + - The ENV variable C(CLOUDSTACK_KEY) is used as default, when defined. |
| 19 | + type: str |
| 20 | + api_secret: |
| 21 | + description: |
| 22 | + - Secret key of the Exoscale DNS API. |
| 23 | + - The ENV variable C(CLOUDSTACK_SECRET) is used as default, when defined. |
| 24 | + type: str |
| 25 | + api_timeout: |
| 26 | + description: |
| 27 | + - HTTP timeout to Exoscale DNS API. |
| 28 | + - The ENV variable C(CLOUDSTACK_TIMEOUT) is used as default, when defined. |
| 29 | + type: int |
| 30 | + default: 10 |
| 31 | + api_region: |
| 32 | + description: |
| 33 | + - Name of the ini section in the C(cloustack.ini) file. |
| 34 | + - The ENV variable C(CLOUDSTACK_REGION) is used as default, when defined. |
| 35 | + type: str |
| 36 | + default: cloudstack |
| 37 | + validate_certs: |
| 38 | + description: |
| 39 | + - Validate SSL certs of the Exoscale DNS API. |
| 40 | + type: bool |
| 41 | + default: yes |
| 42 | +requirements: |
| 43 | + - python >= 2.6 |
| 44 | +notes: |
| 45 | + - As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack. |
| 46 | + The config is read from several locations, in the following order. |
| 47 | + The C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) environment variables. |
| 48 | + A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file, |
| 49 | + A C(cloudstack.ini) file in the current working directory. |
| 50 | + A C(.cloudstack.ini) file in the users home directory. |
| 51 | + Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini). |
| 52 | + Use the argument C(api_region) to select the section name, default section is C(cloudstack). |
| 53 | + - This module does not support multiple A records and will complain properly if you try. |
| 54 | + - More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/. |
| 55 | + - This module supports check mode and diff. |
| 56 | +''' |
0 commit comments