https://github.com/calebhailey/sensu-deregistration-handler
Deregister Sensu Entities on-demand
https://github.com/calebhailey/sensu-deregistration-handler
Last synced: 5 months ago
JSON representation
Deregister Sensu Entities on-demand
- Host: GitHub
- URL: https://github.com/calebhailey/sensu-deregistration-handler
- Owner: calebhailey
- License: mit
- Archived: true
- Created: 2020-08-20T01:37:08.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-07T14:02:39.000Z (over 5 years ago)
- Last Synced: 2025-10-10T04:57:12.089Z (9 months ago)
- Language: Go
- Size: 34.2 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bonsai.sensu.io/assets/calebhailey/sensu-deregistration-handler)
# Sensu Deregistration Handler
## Table of Contents
- [Overview](#overview)
- [Usage](#usage)
- [Configuration](#configuration)
- [Asset registration](#asset-registration)
- [Handler definition](#handler-definition)
- [Installation from source](#installation-from-source)
- [Contributing](#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][10] 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
```yml
---
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][1].
[1]: https://github.com/sensu/sensu-go/blob/master/CONTRIBUTING.md
[2]: https://github.com/sensu-community/sensu-plugin-sdk
[3]: https://github.com/sensu-plugins/community/blob/master/PLUGIN_STYLEGUIDE.md
[4]: https://github.com/sensu-community/handler-plugin-template/blob/master/.github/workflows/release.yml
[5]: https://github.com/sensu-community/handler-plugin-template/actions
[6]: https://docs.sensu.io/sensu-go/latest/reference/handlers/
[7]: https://github.com/sensu-community/handler-plugin-template/blob/master/main.go
[8]: https://bonsai.sensu.io/
[9]: https://github.com/sensu-community/sensu-plugin-tool
[10]: https://docs.sensu.io/sensu-go/latest/reference/assets/