Documentation

riak - This module handles some common Riak operations

Synopsis

  • This module can be used to join nodes to a cluster, check the status of the cluster.

Options

parameter required default choices comments
command
no
  • ping
  • kv_test
  • join
  • plan
  • commit
The command you would like to perform against the cluster.
config_dir
no /etc/riak
The path to the riak configuration directory
http_conn
no 127.0.0.1:8098
The ip address and port that is listening for Riak HTTP queries
target_node
no [email protected]
The target node for certain operations (join, ping)
validate_certs
(added in 1.5.1)
no yes
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
wait_for_handoffs
no
Number of seconds to wait for handoffs to complete.
wait_for_ring
no
Number of seconds to wait for all nodes to agree on the ring.
wait_for_service
no None
  • kv
Waits for a riak service to come online before continuing.

Examples

# Join's a Riak node to another node
- riak:
    command: join
    target_node: [email protected]

# Wait for handoffs to finish.  Use with async and poll.
- riak:
    wait_for_handoffs: yes

# Wait for riak_kv service to startup
- riak:
    wait_for_service: kv

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.