cluster_role_binding – Manage Sensu cluster role bindings

Create, update or delete Sensu cluster role binding.

For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings.

New in version 1.0.0.

Requirements

The below requirements are needed on the host that executes this module:

• python >= 2.7

Examples

- name: Create a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    cluster_role: cluster-admin
    groups:
      - cluster-admins
    users:
      - alice

- name: Delete a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    state: absent

See Also

See also

• cluster_role_binding_info – List Sensu cluster role bindings

• cluster_role – Manage Sensu cluster roles

• role_binding – Manage Sensu role bindings

Parameters

auth (optional)

Authentication parameters. Can define each of them with ENV as well.

type: dict

api_key (optional)

The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.

This replaces auth.user and auth.password parameters.

For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

type: str

ca_path (optional)

Path to the CA bundle that should be used to validate the backend certificate.

If this parameter is not set, module will use the CA bundle that python is using.

It is also possible to set this parameter via the SENSU_CA_PATH environment variable.

type: path

password (optional)

The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str

default: P@ssw0rd!

url (optional)

Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.

type: str

default: http://localhost:8080

user (optional)

The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str

default: admin

verify (optional)

Flag that controls the certificate validation.

If you are using self-signed certificates, you can set this parameter to false.

ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.

It is also possible to set this parameter via the SENSU_VERIFY environment variable.

type: bool

default: True

cluster_role (optional)

Name of the cluster role.

Required if state is present.

type: str

groups (optional)

List of groups to bind to the cluster role.

Note that at least one of users and groups must be specified when creating a cluster role binding.

type: list

name (required)

The Sensu resource’s name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on.

If the resource with selected name already exists, Ansible module will update it to match the specification in the task.

Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.

type: str

state (optional)

Target state of the Sensu object.

type: str

default: present

choices: present, absent

users (optional)

List of users to bind to the cluster role.

Note that at least one of users and groups must be specified when creating a cluster role binding.

type: list

Return Values

object

Object representing Sensu cluster role binding.

sample:

metadata:
  name: cluster-admin
role_ref:
  name: cluster-admin
  type: ClusterRole
subjects:
- name: cluster-admins
  type: Group