Skip to content
This repository has been archived by the owner on Dec 1, 2023. It is now read-only.

Commit

Permalink
fix missing doc_fragments
Browse files Browse the repository at this point in the history
  • Loading branch information
resmo committed Jun 16, 2020
1 parent 543e4bb commit 8ab1b7d
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 2 deletions.
Empty file.
56 changes: 56 additions & 0 deletions plugins/doc_fragments/exoscale.py
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.
'''
2 changes: 1 addition & 1 deletion plugins/modules/exo_dns_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
default: present
choices: [ present, absent ]
type: str
extends_documentation_fragment: exoscale
extends_documentation_fragment: ngine_io.exoscale.exoscale
'''

EXAMPLES = '''
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/exo_dns_record.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
default: present
choices: [ present, absent ]
type: str
extends_documentation_fragment: exoscale
extends_documentation_fragment: ngine_io.exoscale.exoscale
'''

EXAMPLES = '''
Expand Down

0 comments on commit 8ab1b7d

Please sign in to comment.