mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
[PR #9354/97514612 backport][stable-10] r*: normalize docs (#9377)
r*: normalize docs (#9354)
* r*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* Apply suggestions from code review
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 9751461295
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
899fcb8749
commit
f6fa7fb273
22 changed files with 1858 additions and 1947 deletions
|
@ -9,18 +9,16 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: riak
|
||||
short_description: This module handles some common Riak operations
|
||||
description:
|
||||
- This module can be used to join nodes to a cluster, check
|
||||
the status of the cluster.
|
||||
- This module can be used to join nodes to a cluster, check the status of the cluster.
|
||||
author:
|
||||
- "James Martin (@jsmartin)"
|
||||
- "Drew Kerrigan (@drewkerrigan)"
|
||||
- "James Martin (@jsmartin)"
|
||||
- "Drew Kerrigan (@drewkerrigan)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
|
@ -34,17 +32,17 @@ options:
|
|||
type: str
|
||||
config_dir:
|
||||
description:
|
||||
- The path to the riak configuration directory
|
||||
- The path to the riak configuration directory.
|
||||
default: /etc/riak
|
||||
type: path
|
||||
http_conn:
|
||||
description:
|
||||
- The ip address and port that is listening for Riak HTTP queries
|
||||
- The ip address and port that is listening for Riak HTTP queries.
|
||||
default: 127.0.0.1:8098
|
||||
type: str
|
||||
target_node:
|
||||
description:
|
||||
- The target node for certain operations (join, ping)
|
||||
- The target node for certain operations (join, ping).
|
||||
default: riak@127.0.0.1
|
||||
type: str
|
||||
wait_for_handoffs:
|
||||
|
@ -64,13 +62,12 @@ options:
|
|||
type: str
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
||||
type: bool
|
||||
default: true
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: "Join's a Riak node to another node"
|
||||
community.general.riak:
|
||||
command: join
|
||||
|
@ -83,7 +80,7 @@ EXAMPLES = '''
|
|||
- name: Wait for riak_kv service to startup
|
||||
community.general.riak:
|
||||
wait_for_service: kv
|
||||
'''
|
||||
"""
|
||||
|
||||
import json
|
||||
import time
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue