Killswitch Service¶
A killswitch service can be used to cancel a currently executing workflow.
Due to the asynchronous nature of workflow executions, some actions may still occur on execution environments and SUT when a workflow is canceled.
Configuration¶
This module has a configuration file (killswitch.yaml
by default)
that describes the host, port, ssl_context, trusted_authorities, and
logfile to use. It can also enable insecure logins.
If no configuration file is found it will default to the following values:
apiVersion: opentestfactory.org/v1beta2
kind: SSHServiceConfig
current-context: default
contexts:
- context:
port: 443
host: 127.0.0.1
ssl_context: adhoc
eventbus:
endpoint: https://127.0.0.1:38368
token: invalid
name: default
ssl_context
is either adhoc
, a list of two items (certificate file
path and private key file path), or disabled
(not recommended, will
switch to plain HTTP).
A context can also contain a trusted_authorities
, which is a list of
public key files, used for token validation.
A context can also allow for insecure (token-less) logins, if
enable_insecure_login
is set to true
(by default, insecure logins are
disabled).
Insecure logins, if enabled, are only allowed from a given address (127.0.0.1
by default). This can be overridden by specifying insecure_bind_address
.
Usage¶
The following command starts the killswitch service:
python3 -m opentf.core.killswitch [--context context] [--config configfile]
Endpoints¶
This module exposes one endpoint:
- /workflows/{uuid} (DELETE)
Whenever calling this endpoint, a signed token must be specified
via the Authorization
header.
This header will be of form:
Authorization: Bearer xxxxxxxx
It must be signed with one of the trusted authorities specified in the current context.