Allow specifying webhooks to get installer event notifications #57
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relate issue
harvester/harvester#469
With this change, the user can add webhooks in the config and the installer will send HTTP
requests to custom URLs on some predefined events.
The user can add webhooks under the
install
key of the harvester configuration file:The following is a configuration example:
Explanation of the fields:
event
: Event type to trigger HTTP action on the webhookSTARTED
: The installer just begins to perform installation.SUCCEEDED
: The installation completes without errors.FAILED
: The installation is failed.Example:
method
: HTTP methodExample:
url
*: The URL to send the HTTP request.insecure
: Do not verify server's certificate iftrue
. Default isfalse
.Example:
basicAuth
: Use 'Basic' HTTP Authentication.Example:
headers
: Include custom headers in the HTTP requests.Example:
Above configuration will includes
Content-Type: application/json; charset=utf-8
in the HTTP request.payload
*: The payload data to be sent with the request.Example:
* The values for
url
andpayload
can be written in Go template, the following variables will be substituted with appropriate values of the node that is being installed:Hostname
: the hostname of the node.MACAddr
: the MAC address of the management interfaceIPAddrV4
: the IPv4 address of the management interfaceIPAddrV6
: the IPv6 address of the management interfaceAdditional information