Codefresh Cron Event Provider, code named cronus, sends (periodically, defined by cron
expression) a short text message to the Hermes trigger manager service.
POST ${HERMES_SERVICE}/trigger/${event}
{
"secret": "<config secret>",
"variables": {
"message": "<config text message>",
"timestamp": "<RFC3339 formated timestamp>"
}
}
- URL
event
- cronus event URI - PAYLOAD
secret
- event secret - PAYLOAD
variables
- set of variables - PAYLOAD
variables:message
- event short text message (as specified when created) - PAYLOAD
variables:timestamp
- event timestamp{time RFC 3339}
cron:codefresh:{{cron-expression}}:{{message}}[:{{account}}]
cron-expression '+'
- cron expression format (see below)message
- message to be send with each cron trigger event; should be short and alpha-numeric only (no space characters);[a-z0-9]+
regexaccount
- optional Codefresh account short hash
When using cron event URI with cronus
REST API, make sure to apply URL encoding to it.
Run the cronus server
command to start cronus CRON Event Provider.
NAME:
cronus server - start cronus server
USAGE:
cronus server [command options] [arguments...]
DESCRIPTION:
Run Cronus CRON Event Provider server. Cronus generates time-based events and sends normalized event payload to the Codefresh Hermes trigger manager service to invoke associated Codefresh pipelines.
Event URI Pattern: cron:codefresh:{{cron-expression}}:{{message}}
OPTIONS:
--hermes value Codefresh Hermes service (default: "http://hermes/") [$HERMES_SERVICE]
--token value, -t value Codefresh Hermes API token (default: "TOKEN") [$HERMES_TOKEN]
--port value TCP port for the dockerhub provider server (default: 8080)
--dry-run do not execute commands, just log
cronus
requires Go SDK to build.
- Clone this repository into
$GOPATH/src/github.com/codefresh-io/cronus
- Run
hack/build.sh
helper script orgo build cmd/main.go
% - Run
hack/test.sh
to run all tests