Resource Type: sensu_role_binding

Defined in:
lib/puppet/type/sensu_role_binding.rb
Providers:
sensuctl
sensu_api

Summary

Manages Sensu role bindings

Overview

Autorequires:

  • Package`

  • Service`

  • Sensuctl_configure`

  • Sensu_api_validator`

  • Sensu_user`

  • ‘sensu_role` - Puppet will autorequire `sensu_role` resource defined in `role_ref` property.

  • ‘sensu_namespace` - Puppet will autorequire `sensu_namespace` resource defined in `namespace` property.

  • ‘sensu_user` - Puppet will autorequire `sensu_user` resources based on users and groups defined for the `subjects` property.

Examples:

Add a role binding

sensu_role_binding { 'test':
  ensure   => 'present',
  role_ref => {'type' => 'Role', 'name' => 'test-role'},
  subjects => [
    { 'type' => 'User', 'name' => 'test-user' }
  ],
}

Add a role binding for a ClusterRole

sensu_role_binding { 'test':
  ensure   => 'present',
  role_ref => {'type' => 'ClusterRole', 'name' => 'test-role'},
  subjects => [
    { 'type' => 'User', 'name' => 'test-user' }
  ],
}

Add a role binding with namespace ‘dev` in the name

sensu_role_binding { 'test in dev':
  ensure   => 'present',
  role_ref => {'type' => 'Role', 'name' => 'test-role'},
  subjects => [
    { 'type' => 'User', 'name' => 'test-user' }
  ],
}

Properties

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • namespace (defaults to: default)

    Namespace the role binding is restricted to.

  • role_ref

    References a role in the current namespace or a cluster role.

  • subjects

    The users or groups being assigned.

Parameters

  • name (namevar)

    The name of the binding. The name supports composite names that can define the namespace. An example composite name to define resource named ‘test` in namespace `dev`: `test in dev`

  • provider

    The specific backend to use for this ‘sensu_role_binding` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • resource_name

    The name of the role binding.