Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme #113

Merged
merged 2 commits into from
Oct 19, 2023
Merged

update readme #113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d2c433
update readme
mfleader Oct 17, 2023
b65804c
clarify workflow schema version and supported versions
mfleader Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
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
dbutenhof marked this conversation as resolved.
Show resolved Hide resolved

- 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