community.general.riak module – This module handles some common Riak operations
Note
This module is part of the community.general collection (version 9.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.riak
.
Synopsis
This module can be used to join nodes to a cluster, check the status of the cluster.
Parameters
Parameter |
Comments |
---|---|
The command you would like to perform against the cluster. Choices:
|
|
The path to the riak configuration directory Default: |
|
The ip address and port that is listening for Riak HTTP queries Default: |
|
The target node for certain operations (join, ping) Default: |
|
If Choices:
|
|
Number of seconds to wait for handoffs to complete. Default: |
|
Number of seconds to wait for all nodes to agree on the ring. Default: |
|
Waits for a riak service to come online before continuing. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: "Join's a Riak node to another node"
community.general.riak:
command: join
target_node: [email protected]
- name: Wait for handoffs to finish. Use with async and poll.
community.general.riak:
wait_for_handoffs: true
- name: Wait for riak_kv service to startup
community.general.riak:
wait_for_service: kv