/ home / community / community.general / 8.5.0 / module / riak

community.general.riak (8.5.0) — module

This module handles some common Riak operations

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

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

Usage examples

Scanned by Steampunk Spotter

- name: "Join's a Riak node to another node"
  community.general.riak:
    command: join
    target_node: riak@10.1.1.1

Scanned by Steampunk Spotter

- name: Wait for handoffs to finish. Use with async and poll.
  community.general.riak:
    wait_for_handoffs: true

Scanned by Steampunk Spotter

- name: Wait for riak_kv service to startup
  community.general.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.
    type: str

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

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

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

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

validate_certs:
    default: true
    description:
    - If V(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    type: bool

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

wait_for_handoffs:
    default: 0
    description:
    - Number of seconds to wait for handoffs to complete.
    type: int