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

Note

This module is part of the community.general collection (version 6.6.2).

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

command

string

The command you would like to perform against the cluster.

Choices:

  • "ping"

  • "kv_test"

  • "join"

  • "plan"

  • "commit"

config_dir

path

The path to the riak configuration directory

Default: "/etc/riak"

http_conn

string

The ip address and port that is listening for Riak HTTP queries

Default: "127.0.0.1:8098"

target_node

string

The target node for certain operations (join, ping)

Default: "riak@127.0.0.1"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

wait_for_handoffs

integer

Number of seconds to wait for handoffs to complete.

Default: 0

wait_for_ring

integer

Number of seconds to wait for all nodes to agree on the ring.

Default: 0

wait_for_service

string

Waits for a riak service to come online before continuing.

Choices:

  • "kv"

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Authors

  • James Martin (@jsmartin)

  • Drew Kerrigan (@drewkerrigan)