community.general.riak – This module handles some common Riak operations

Note

This plugin is part of the community.general collection (version 1.3.6).

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 Choices/Defaults Comments
command
string
    Choices:
  • ping
  • kv_test
  • join
  • plan
  • commit
The command you would like to perform against the cluster.
config_dir
string
Default:
"/etc/riak"
The path to the riak configuration directory
http_conn
string
Default:
"127.0.0.1:8098"
The ip address and port that is listening for Riak HTTP queries
target_node
string
Default:
The target node for certain operations (join, ping)
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
wait_for_handoffs
string
Number of seconds to wait for handoffs to complete.
wait_for_ring
string
Number of seconds to wait for all nodes to agree on the ring.
wait_for_service
string
    Choices:
  • kv
Waits for a riak service to come online before continuing.

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: yes

- name: Wait for riak_kv service to startup
  community.general.riak:
    wait_for_service: kv

Authors

  • James Martin (@jsmartin)

  • Drew Kerrigan (@drewkerrigan)