Skip to content

Commit

Permalink
update readme (#113)
Browse files Browse the repository at this point in the history
* update readme

* clarify workflow schema version and supported versions
  • Loading branch information
mfleader authored Oct 19, 2023
1 parent 3815fc3 commit dcd3de3
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ This binary can then be used to run Arcaflow workflows.

## Building a simple workflow

The simplest workflow is the example plugin workflow: (save it to workflow.yaml)
The simplest workflow is the example plugin workflow using the workflow schema version `v0.1.0`: (save it to workflow.yaml)

```yaml
version: v0.1.0
input:
root: RootObject
objects:
Expand All @@ -43,7 +44,7 @@ output:
message: !expr $.steps.example.outputs.success.message
```
As you can see, it has an input, a list of steps, and an output definition. These can be linked together using JSONPath expressions (not all features are supported). The expressions also determine the execution order of plugins.
As you can see, it has a `version`, `input`, a list of `steps`, and an `output` definition. Each of these keys is required in a workflow. These can be linked together using JSONPath expressions (not all features are supported). The expressions also determine the execution order of plugins.

You can now create an input YAML for this workflow: (save it to input.yaml)

Expand All @@ -69,6 +70,10 @@ log:

You can load this config by passing the `-config` flag to Arcaflow.

### Supported Workflow Schema Versions

- v0.1.0

## Deployer options

Currently, the two deployer types supported are Docker and Kubernetes.
Expand All @@ -89,7 +94,7 @@ deployment:
host: # Host options, see https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate
network: # Network options, see https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate
platform: # Platform options, see https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate
# Pull policy, similar to Kubernetes
imagePullPolicy: Always|IfNotPresent|Never
timeouts:
Expand Down

0 comments on commit dcd3de3

Please sign in to comment.