ansible.builtin.riak (v2.9.27) — module

This module handles some common Riak operations

| "added in version" 1.2 of ansible.builtin"

Authors: James Martin (@jsmartin), Drew Kerrigan (@drewkerrigan)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Join's a Riak node to another node
- riak:
    command: join
    target_node: riak@10.1.1.1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Wait for handoffs to finish.  Use with async and poll.
- riak:
    wait_for_handoffs: yes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Wait for riak_kv service to startup
- riak:
    wait_for_service: kv

Inputs

    
command:
    choices:
    - ping
    - kv_test
    - join
    - plan
    - commit
    description:
    - The command you would like to perform against the cluster.

http_conn:
    default: 127.0.0.1:8098
    description:
    - The ip address and port that is listening for Riak HTTP queries

config_dir:
    default: /etc/riak
    description:
    - The path to the riak configuration directory

target_node:
    default: riak@127.0.0.1
    description:
    - The target node for certain operations (join, ping)

wait_for_ring:
    description:
    - Number of seconds to wait for all nodes to agree on the ring.

validate_certs:
    default: 'yes'
    description:
    - If C(no), SSL certificates will not be validated. This should only be used on personally
      controlled sites using self-signed certificates.
    type: bool
    version_added: 1.5.1
    version_added_collection: ansible.builtin

wait_for_service:
    choices:
    - kv
    description:
    - Waits for a riak service to come online before continuing.

wait_for_handoffs:
    description:
    - Number of seconds to wait for handoffs to complete.