sensu-deregistration-handler

README

Sensu Deregistration Handler

Table of Contents

• Overview
• Usage
• Configuration
  • Asset registration
  • Handler definition
• Installation from source
• Contributing

Overview

The Sensu Deregistration Handler is a simple handler that deletes entities from the Sensu Entities API. Any valid Sensu Event can be used to initiate a deregistration, including keepalive events.

Usage

Deregister Sensu entities on-demand! This handler take zero arguments and does not perform any validation. It simply consumes events and deletes the entity referenced in the event. Use with caution!

Usage:
  sensu-deregistration-handler [flags]
  sensu-deregistration-handler [command]

Available Commands:
  help        Help about any command
  version     Print the version number of this plugin

Flags:
      --access-token string      Sensu Access Token
      --api-key string           Sensu API Key
      --api-url string           Sensu API URL (default "http://127.0.0.1:8080")
  -h, --help                     help for sensu-deregistration-handler
      --namespace string         Sensu Namespace
      --trusted-ca-file string   Sensu Trusted Certificate Authority file

Use "sensu-deregistration-handler [command] --help" for more information about a command.

Configuration

Asset registration

Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the following command to add the asset:

sensuctl asset add calebhailey/sensu-deregistration-handler

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/calebhailey/sensu-deregistration-handler].

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-deregistration-handler
spec:
  type: pipe
  command: sensu-deregistration-handler
  runtime_assets:
  - calebhailey/sensu-deregistration-handler

Installation from source

The preferred way of installing and deploying this plugin is to use it as an Asset. If you would like to compile and install the plugin from source or contribute to it, download the latest version or create an executable script from this source.

From the local path of the sensu-deregistration-handler repository:

go build

Contributing

For more information about contributing to this plugin, see Contributing.