@sendanor/pipeline-runner
Pipeline Processor for NodeJS v8 and newer.
For the library, check out @sendanor/pipeline.
For the documentation about our pipeline format, see Getting started with Pipeline model.
What are pipelines?
Minimal pipeline step is just a single instruction to run a command:
{
"name": "Print_date",
"command": "date"
}
This step runs a date
command.
Full pipeline may contain multiple stages, jobs and steps:
{
"name": "TestPipeline",
"stages": [
{
"name": "Print_stuff_1",
"jobs": [
{
"name": "Print_date",
"steps": [
{
"name": "Print_date",
"command": "date"
}
]
}
]
}
]
}
Install the command line tool
Install in your project:
npm i --save @sendanor/pipeline-runner
...or install globally:
npm i -g @sendanor/pipeline-runner
Usage
USAGE: nor-pipeline-runner ARG(1) [...ARG(N)]
Executes instructions from various sources.
Instructions in the resource may be type of:
...where ARG
is one of:
Instructions from HTTP or HTTPS resource:
http[s]:// [ USER:PASSWORD@ | _bearer:ACCESS_TOKEN@ ] HOSTNAME [:PORT] [/PATH]
The resource will be executed once loaded.
Optionally uses HTTP Basic Authentication if USER
and PASSWORD
is provided.
Optionally uses Bearer Token Authentication if ACCESS_TOKEN
is provided.
See also PIPELINE_AUTHENTICATION
environment variable.
Instructions from a Matrix room:
matrix:// [ USER:PASSWORD@ | [_bearer:]ACCESS_TOKEN@ ] SERVER [/ POOL]
POOL
Will look up work items to do from Matrix.
If the agent belongs to multiple pools (which are Matrix rooms), and no pool is defined, one will be picked up by random.
If multiple work items are available, one will be picked by random.
Uses Bearer authentication with ACCESS_TOKEN by default. Optionally will log in Matrix using USER and PASSWORD.
See also PIPELINE_AUTHENTICATION and PIPELINE_SERVER environment variable.
Instructions from the local system:
[file://]FILE
The resource will be loaded from the local filesystem and executed.
OPT
is one of:
...and Short | Long | Description |
---|---|---|
-h |
--help |
Print help |
-v |
--version |
Print version |
-w |
--wait |
Waits for work to appear if no work is available |
-- |
Disables option parsing |
Environment variables:
PIPELINE_SERVER
The default Matrix server.
By default, io.nor.fi
.
PIPELINE_AUTHENTICATION
as one of:
USER:PASSWORD
_bearer:ACCESS_TOKEN
ACCESS_TOKEN
PIPELINE_LOG_LEVEL
as one of:
ALL
DEBUG
-
INFO
(default) WARN
ERROR
NONE
Installing as an agent using Docker
Build the container image:
git clone https://github.com/sendanor/pipeline-runner.git pipeline-runner
cd pipeline-runner
docker build -t pipeline-runner .
Next create a local environment file, for example ~/.nor-pipeline/agent1.env
, and save your
agent's access token in it:
PIPELINE_AUTHENTICATION=auth-token-from-lomake-app
Make sure file permissions are secure:
chmod 700 ~/.nor-pipeline
chmod 600 ~/.nor-pipeline/agent1.env
Then start an agent container named agent-1
:
docker run \
--detach \
--name=agent-1 \
--restart=always \
--env-file ~/.nor-pipeline/agent1.env \
pipeline-runner
If you also need access to your local SSH key (using ssh-agent
), then add --volume $SSH_AUTH_SOCK:/ssh-agent --env SSH_AUTH_SOCK=/ssh-agent
:
docker run \
--detach \
--name=agent-1 \
--volume $SSH_AUTH_SOCK:/ssh-agent \
--env SSH_AUTH_SOCK=/ssh-agent \
--restart=always \
--env-file ~/.nor-pipeline/agent1.env \
pipeline-runner
Stop & remove the agent-1
container:
docker update --restart=no agent-1
docker stop agent-1
docker rm agent-1
Check which containers are running:
docker ps
You can also attach to the container:
docker attach agent-1
It's MIT licenced
It doesn't have any runtime dependencies
Except NodeJS LTS v8 or newer.
It compiles as a single standalone 164 kB script
Including all the dependencies as well!
It's well tested
Our unit tests exists beside the code. To run tests, check out our test repository @sendanor/test.
We don't have traditional releases
This project evolves directly to our git repository in an agile manner.
Stable releases available for a commercial customer
For tailored commercial release, you may contact our sales.
General rule for pricing is 500 € (or $600) / feature. One full stable release containing multiple components is 8000 €.
The payment includes a month of agile development with the customer, and a year of support for that release branch.
Build the source
npm run build