This repository has been archived by the owner on Dec 1, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
58 additions
and
2 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
# Copyright: (c) 2017, René Moser <[email protected]> | ||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) | ||
|
||
from __future__ import absolute_import, division, print_function | ||
__metaclass__ = type | ||
|
||
|
||
class ModuleDocFragment(object): | ||
|
||
# Standard exoscale documentation fragment | ||
DOCUMENTATION = r''' | ||
options: | ||
api_key: | ||
description: | ||
- API key of the Exoscale DNS API. | ||
- The ENV variable C(CLOUDSTACK_KEY) is used as default, when defined. | ||
type: str | ||
api_secret: | ||
description: | ||
- Secret key of the Exoscale DNS API. | ||
- The ENV variable C(CLOUDSTACK_SECRET) is used as default, when defined. | ||
type: str | ||
api_timeout: | ||
description: | ||
- HTTP timeout to Exoscale DNS API. | ||
- The ENV variable C(CLOUDSTACK_TIMEOUT) is used as default, when defined. | ||
type: int | ||
default: 10 | ||
api_region: | ||
description: | ||
- Name of the ini section in the C(cloustack.ini) file. | ||
- The ENV variable C(CLOUDSTACK_REGION) is used as default, when defined. | ||
type: str | ||
default: cloudstack | ||
validate_certs: | ||
description: | ||
- Validate SSL certs of the Exoscale DNS API. | ||
type: bool | ||
default: yes | ||
requirements: | ||
- python >= 2.6 | ||
notes: | ||
- As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack. | ||
The config is read from several locations, in the following order. | ||
The C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) environment variables. | ||
A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file, | ||
A C(cloudstack.ini) file in the current working directory. | ||
A C(.cloudstack.ini) file in the users home directory. | ||
Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini). | ||
Use the argument C(api_region) to select the section name, default section is C(cloudstack). | ||
- This module does not support multiple A records and will complain properly if you try. | ||
- More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/. | ||
- This module supports check mode and diff. | ||
''' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters