Resource Type: sensu_agent_entity_config

Defined in:

lib/puppet/type/sensu_agent_entity_config.rb

Providers:

sensuctl
sensu_api

Summary

Manages a Sensu agent subscription

Overview

Autorequires:

• Package[sensu-go-cli]
• Service[sensu-backend]
• Service[sensu-agent]
• Sensuctl_configure[puppet]
• Sensu_api_validator[sensu]
• Sensu_user[admin]
• sensu_namespace - Puppet will autorequire sensu_namespace resource defined in namespace property.

Examples:

Add a subscription to an agent using composite names

sensu_agent_entity_config { 'subscription value linux on sensu-agent.example.org in dev':
  ensure => 'present',
}

Add an annotation to an agent using composite names

sensu_agent_entity_config { 'annotations key contacts on sensu-agent.example.org in dev':
  ensure => 'present',
  value  => 'dev@example.com',
}

Add a subscription to an agent

sensu_agent_entity_config { 'subscription':
  ensure    => 'present',
  config    => 'subscription',
  value     => 'linux',
  entity    => 'sensu-agent.example.org',
  namespace => 'dev',
}

Add an annotation to an agent

sensu_agent_entity_config { 'annotation-contacts':
  ensure    => 'present',
  config    => 'annotation',
  key       => 'contacts',
  value     => 'dev@example.com',
  entity    => 'sensu-agent.example.org',
  namespace => 'dev',
}

Properties

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• value

  The value of the config for agent entity

Parameters

• agent_managed_entity (defaults to: false)

  PRIVATE - determined by looking at agent entity labels

  Supported values:

  • true
  • false
• config

  The name of the config to set.

• entity

  The entity to manage subscription

• key

  Key of config entry set, for labels and annotations

• name (namevar)

  The name of the agent subscription. The name supports composite names that can define the entity and namespace. An example composite name to define subscription named test on entity 'agent' in namespace dev: test on agent in dev

• namespace (defaults to: default)

  The Sensu RBAC namespace that this entity belongs to.

• provider

  The specific backend to use for this sensu_agent_entity_config resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.