Skip to content

Commit

Permalink
docs: add new page over the workspaces configuration, and adding corr…
Browse files Browse the repository at this point in the history
…esponding documentation on the exposure to reana.yaml

Closes #93
  • Loading branch information
marcdiazsan committed Sep 22, 2021
1 parent 1a2702c commit 081be3a
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/administration/configuration/configuring-workspaces/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Configuring workspaces

REANA configuration allows administrators to define new workspaces, in
which the workflow can run. The users can then state the desired workspace
in the `reana.yaml` file.

If you would like to configure this additional workspaces, you can configure
[`workspaces.paths`](https://github.com/reanahub/reana/tree/master/helm/reana) Helm value
to the desired list of workspaces, consisting of strings as `hostPath:mountPath`.

Under this configuration, the first workspace listed will be the default
workspace path.

The [`shared_storage.shared_volume_mount_path`](https://github.com/reanahub/reana/tree/master/helm/reana) Helm value
is also an accepted workspace.
1 change: 1 addition & 0 deletions docs/administration/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

- [Configuring user access](configuration/configuring-access)
- [Configuring workflow scheduler](configuration/configuring-scheduler)
- [Configuring workspaces](configuration/configuring-workspaces)
1 change: 1 addition & 0 deletions docs/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

- [Configuring user access](configuration/configuring-access)
- [Configuring workflow scheduler](configuration/configuring-scheduler)
- [Configuring workspaces](configuration/configuring-workspaces)

**Managing REANA platform?**

Expand Down
28 changes: 27 additions & 1 deletion docs/reference/reana-yaml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This reference guide describes how the Four Questions are transcribed into
## Understanding `reana.yaml`

The `reana.yaml` file describes the analysis as a computational workflow with
its inputs, workflow specification, and its outputs. The overall structure of
its inputs, workflow specification, workspace ,and its outputs. The overall structure of
`reana.yaml` looks as follows:

| Property | Type | Mandatory? | Description |
Expand All @@ -34,6 +34,7 @@ its inputs, workflow specification, and its outputs. The overall structure of
| inputs | *dictionary* | *optional* | Specifies all the high-level inputs to the workflow. Can be composed of "files", "directories", "parameters", "options". |
| workflow | *dictionary* | *mandatory* | Defines computational workflow, using CWL, Serial or Yadage specifications. |
| outputs | *dictionary* | *optional* | Specifies all the high-level outputs of the workflow. Can be composed of "files" and "directories". |
| workspace| *dictionary* | *optional* | Specifies the workspace in which the workflow run. |

Each property will be described in detail in the following sections.

Expand Down Expand Up @@ -193,6 +194,27 @@ outputs:
- mydir
```

### reana.yaml workspace

The **workspace** property of `reana.yaml` specifies the workspace path in which
the workflow will run. REANA currently supports POSIX files systems mounted by the
administrator. The `reana-client workspaces` command will list all the available
workspaces and the default workspace used if this property is not specified.
Note that the property is optional.

The **workspace** property is composed of:

| Property | Type | Mandatory? | Description |
| -------- | ---- | ---------- | ----------- |
| root_path | *string* | *optional* | Full path of the desired workspace. |

The **workspace** property example:

```yaml
workspace:
root_path: /eos/myworkflows
```

## Validating `reana.yaml`

You can use `reana-client validate` command to make sure that your `reana.yaml`
Expand All @@ -204,6 +226,8 @@ $ reana-client validate
-> SUCCESS: Valid REANA specification file.
==> Verifying workflow parameters and commands...
-> SUCCESS: Workflow parameters and commands appear valid.
==> Verifying workspace in REANA specification file...
-> SUCCESS: REANA workspace appear valid.
```

If your workflow specification file is not named `reana.yaml` (or `reana.yml`),
Expand All @@ -216,6 +240,8 @@ $ reana-client validate -f reana-debug.yaml
-> SUCCESS: Valid REANA specification file.
==> Verifying workflow parameters and commands...
-> SUCCESS: Workflow parameters and commands appear valid.
==> Verifying workspace in REANA specification file...
-> SUCCESS: REANA workspace appear valid.
```

The `reana-client validate` command will warn you about any errors or problems
Expand Down

0 comments on commit 081be3a

Please sign in to comment.