TODO: Table of Contents
If you're writing or updating a plugin's README, review the Sensu Community plugin README style guide for content suggestions and guidance.
TODO: Write an overview of the plugin's functionality.
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 or later, you can use the following command to add the asset:
sensuctl asset add CHANGEME/sensu-CHANGEME:VERSION
If you're using an earlier version of sensuctl, you can find the asset on the Bonsai Asset Index.
TODO: Provide an example asset manifest
---
type: Asset
api_version: core/v2
metadata:
name: CHANGEME
spec:
url: https://CHANGEME
sha512: CHANGEMEExample Sensu Go definition:
---
api_version: core/v2
type: CHANGEME
metadata:
namespace: default
name: CHANGEME
spec:
"...": "..."
TODO: Document anything special needed for this plugin to function. Does it need an on-disk configuration? Does it require anything special to operate?
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 of the sensu-CHANGEME from releases or create an executable script from this source.
From the local path of the sensu-CHANGEME repository:
go build -o /usr/local/bin/sensu-CHANGEME main.go
For more information about contributing to this plugin, see https://github.com/sensu/sensu-go/blob/master/CONTRIBUTING.md