File: //lib/python3.9/site-packages/ansible_collections/sensu/sensu_go/plugins/modules/role_binding.py
# -*- coding: utf-8 -*-
# Copyright: (c) 2019, Paul Arthur <[email protected]>
# Copyright: (c) 2019, XLAB Steampunk <[email protected]>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
"metadata_version": "1.1",
"status": ["stableinterface"],
"supported_by": "certified",
}
DOCUMENTATION = '''
module: role_binding
author:
- Paul Arthur (@flowerysong)
- Manca Bizjak (@mancabizjak)
- Aljaz Kosir (@aljazkosir)
- Tadej Borovsak (@tadeboro)
short_description: Manage Sensu role bindings
description:
- Create, update or delete Sensu role binding.
- For more information, refer to the Sensu documentation at
U(https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings).
version_added: 1.0.0
extends_documentation_fragment:
- sensu.sensu_go.requirements
- sensu.sensu_go.auth
- sensu.sensu_go.name
- sensu.sensu_go.namespace
- sensu.sensu_go.state
seealso:
- module: sensu.sensu_go.role_binding_info
- module: sensu.sensu_go.role
- module: sensu.sensu_go.cluster_role
- module: sensu.sensu_go.cluster_role_binding
options:
role:
description:
- Name of the role.
- This parameter is mutually exclusive with I(cluster_role).
type: str
cluster_role:
description:
- Name of the cluster role. Note that the resulting role
binding grants the cluster role to the provided users and
groups in the context of I(auth.namespace) only.
- This parameter is mutually exclusive with I(role).
type: str
users:
description:
- List of users to bind to the role or cluster role.
- Note that at least one of I(users) and I(groups) must be
specified when creating a role binding.
type: list
elements: str
groups:
description:
- List of groups to bind to the role or cluster role.
- Note that at least one of I(users) and I(groups) must be
specified when creating a role binding.
type: list
elements: str
'''
EXAMPLES = '''
- name: Create a role binding
sensu.sensu_go.role_binding:
name: dev_and_testing
role: testers_permissive
groups:
- testers
- dev
- ops
users:
- alice
- name: Create a role binding for admins
sensu.sensu_go.role_binding:
name: org-admins
cluster_role: admin
groups:
- team1-admins
- team2-admins
- name: Delete a role binding
sensu.sensu_go.role_binding:
name: org-admins
state: absent
'''
RETURN = '''
object:
description: Object representing Sensu role binding.
returned: success
type: dict
sample:
metadata:
name: event-reader-binding
namespace: default
role_ref:
name: event-reader
type: Role
subjects:
- name: bob
type: User
'''
from ansible.module_utils.basic import AnsibleModule
from ..module_utils import arguments, errors, utils, role_utils
def infer_role(params):
if params["role"]:
return "Role", params["role"]
return "ClusterRole", params["cluster_role"]
def build_api_payload(params):
payload = arguments.get_mutation_payload(params)
payload["subjects"] = role_utils.build_subjects(params["groups"], params["users"])
payload["role_ref"] = role_utils.type_name_dict(*infer_role(params))
return payload
def main():
required_if = [
("state", "present", ["role", "cluster_role"], True) # True means any of role, cluster_role
]
mutually_exclusive = [
["role", "cluster_role"]
]
module = AnsibleModule(
required_if=required_if,
mutually_exclusive=mutually_exclusive,
supports_check_mode=True,
argument_spec=dict(
arguments.get_spec("auth", "name", "state", "namespace"),
role=dict(),
cluster_role=dict(),
users=dict(
type="list", elements="str",
),
groups=dict(
type="list", elements="str",
),
)
)
msg = role_utils.validate_binding_module_params(module.params)
if msg:
module.fail_json(msg=msg)
client = arguments.get_sensu_client(module.params["auth"])
path = utils.build_core_v2_path(
module.params["namespace"], "rolebindings", module.params["name"],
)
payload = build_api_payload(module.params)
try:
changed, role_binding = utils.sync(
module.params["state"], client, path, payload, module.check_mode, role_utils.do_role_bindings_differ
)
module.exit_json(changed=changed, object=role_binding)
except errors.Error as e:
module.fail_json(msg=str(e))
if __name__ == '__main__':
main()