-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix broken link and add schema versioning info (#70)
* fix broken link and add schema versioning info * describe changes to upgrade wf file * refer to type
- Loading branch information
Showing
3 changed files
with
66 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Workflow schema versions | ||
|
||
## Valid version string | ||
|
||
All workflow schema versions conform to [semantic version 2.0.0](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions) with a major, minor, and patch version. In this document, since the prepended `v` is unnecessary it is not used. However, it is required as a value for the version key in your workflow file. | ||
|
||
Invalid version string for `workflow.yaml`. | ||
|
||
```yaml | ||
version: 0.2.0 | ||
input: | ||
steps: | ||
outputs: | ||
``` | ||
**Valid** version string for `workflow.yaml`. | ||
|
||
```yaml | ||
version: v0.2.0 | ||
input: | ||
steps: | ||
outputs: | ||
``` | ||
|
||
## Supported versions | ||
|
||
* 0.2.0 | ||
|
||
## Compatibility Matrix | ||
|
||
|
||
| Workflow schema version | Arcaflow Engine release | | ||
|---|---| | ||
| 0.2.0 | 0.9.0 | | ||
|
||
## Upgrading | ||
|
||
### 0.2.0 | ||
|
||
For the configuration file, `config.yaml`, two types of deployers are now possible, `image` and `python`, so `deployer` has become `deployers`. Effectively, the `type` key has become the `deployer_name` key. The `deployer_name` key and value are **required** which means you must also have either the `image` key or the `python` key. | ||
|
||
```yaml | ||
deployers: | ||
image: | ||
deployer_name: docker|podman|kubernetes | ||
python: | ||
deployer_name: python | ||
``` | ||
|
||
For your workflow file, `workflow.yaml`, the `version` key and value are **required**, and they must be at the root of the file. | ||
|
||
```yaml | ||
version: v0.2.0 | ||
inputs: {} | ||
steps: {} | ||
outputs: {} | ||
``` |