Skip to content

Introduce Action rollback proposal #83

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

Merged
pkosiec merged 8 commits into from
Jan 20, 2021
Merged

Introduce Action rollback proposal #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4d417d0
Fix typo in TypeInstances proposal filename
pkosiec Dec 9, 2020
ec4cb78
Introduce Action rollback proposal
pkosiec Jan 12, 2021
f2fa8ed
Rework headers
pkosiec Jan 12, 2021
6165116
Improve document after review
pkosiec Jan 14, 2021
cb6a1e6
Format document
pkosiec Jan 14, 2021
93dbd74
Update Rollback CR input with just a single TypeInstance
pkosiec Jan 15, 2021
b822e3b
Add example for Action rollback which creates and modifies TypeInstance
pkosiec Jan 15, 2021
f475ab6
Clarify what is the ancestor and dependant in TypeInstance tree
pkosiec Jan 20, 2021
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
10 changes: 5 additions & 5 deletions docs/proposal/20201102-typinstances-flow.md → docs/proposal/20201102-typeinstances-flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@ Currently, we are struggling with defining the flow for passing, creating, and d

## Proposal

Terminology
### Terminology

| Term | Definition |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| Artifacts | Input/Output object returned by steps in a given workflow. |
| TypeInstance | An instance of a given Type that is stored in the Local OCH. Artifacts uploaded from workflow to Local OCH becomes TypeInstances. |
| Action developer | Person who defines the `action` property in Implementation manifest. |

General notes
### General notes

1. The required input TypeInstances are defined on Interfaces only.
2. The optional input TypeInstances are defined on Implementation only.
3. The input and output TypeInstances always have a name. This solves the problem when there are multiple input/output TypeInstances which refer to the same Type (e.g. backup and main database)
4. Action can produce only TypeInstances. We don't support output parameters, outputted for user (e.g. similar to `NOTES.txt` from Helm). We can revisit it after GA as this won't be a breaking change.

### Required input and output TypeInstances
### Required input and output TypeInstances

Actors

- Action developer

#### Suggested solution
#### Suggested solution

We have the Interface entity which defines the input and output parameters. To fulfill a given Interface, Implementation needs to accept the same input and returns the same output parameters.

Expand Down Expand Up @@ -547,7 +547,7 @@ Actors

#### Suggested solution

If Action requires input TypeInstance, the Voltron Engine adds an initial download step to the Workflow. This step runs the core Action which connects to Local OCH and downloads TypeInstances and exposes them as a [global Argo artifacts](https://github.com/argoproj/argo/blob/6016ebdd94115ae3fb13cadbecd27cf2bc390657/examples/global-outputs.yaml#L33-L36), so they can be accessed by other steps via `{{workflow.outputs.artifacts.<name>}}`.
If Action requires input TypeInstance, the Voltron Engine adds an initial download step to the Workflow. This step runs the core Action which connects to Local OCH and downloads TypeInstances and exposes them as a [global Argo artifacts](https://github.com/argoproj/argo/blob/6016ebdd94115ae3fb13cadbecd27cf2bc390657/examples/global-outputs.yaml#L33-L36), so they can be accessed by other steps via `{{inputs.artifacts.<name>}}`.

The global Argo artifacts seem to be the only possible solution as the steps output artifacts are scoped to a given template. This assumption is based on [argo-workflows investigation](../investigation/argo-workflows/README.md) document.

Expand Down
Loading