Skip to content

Commit

Permalink
docs: adds documentation for comupute backends
Browse files Browse the repository at this point in the history
  • Loading branch information
Rokas Maciulaitis committed Dec 3, 2019
1 parent 29c3356 commit f831418
Showing 1 changed file with 77 additions and 2 deletions.
79 changes: 77 additions & 2 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,8 @@ Declare necessary resources
You can declare other additional runtime dependencies that your workflow needs
for successful operation.

**CVMFS**
CVMFS
~~~~~

If your workflow needs to access `CVMFS <https://cernvm.cern.ch/portal/filesystem>`_
filesystem, you should provide a ``cvmfs`` sub-clause of the ``resources`` clause that
Expand All @@ -433,7 +434,8 @@ For example:
- ls -l /cvmfs/fcc.cern.ch/sw/views/releases/
**Kerberos**
Kerberos
~~~~~~~~

If your workflow requires Kerberos authentication, you should add ``kerberos: true``
for the steps in need. Please note that step's docker image
Expand Down Expand Up @@ -494,6 +496,79 @@ Yadage example:
resources:
- kerberos: true
Compute backends
~~~~~~~~~~~~~~~~

REANA supports Kubernetes as a primary compute backend alongside HTCondor and
Slurm.

In order to use HTCondor or Slurm clusters user should upload their CERN username
and keytab secrets using:

.. code-block:: console
$ reana-client secrets-add --env CERN_USER=johndoe
--env CERN_KEYTAB=.keytab
--file ~/.keytab
.. note::
Please note that CERN Slurm cluster access is not granted by
`default <https://batchdocs.web.cern.ch/linuxhpc/access.html>`_.
**Kubernetes**

Kubernetes is a default REANA job compute backend. If `step` does not contain
`compute_backend` specification, it will be executed on the default one.

.. code-block::
# Serial example
...
steps:
- name: reana_demo_helloworld_htcondorcern
environment: 'python:2.7-slim'
compute_backend: kubernetes
commands:
- python "${helloworld}"
...
**HTCondor**

In order to execute the job on the HTCondor cluster user must specify ``htcondorcern``
as the step's execution backend in the workflow specification.

.. code-block::
# Serial example
...
steps:
- name: reana_demo_helloworld_htcondorcern
environment: 'python:2.7-slim'
compute_backend: htcondorcern
commands:
- python "${helloworld}"
...
Examples for CWL and Yadage can be found in
`REANA example - "hello world"<https://github.com/reanahub/reana-demo-helloworld>``

**Slurm**

In order to execute the job on the Slurm cluster user must specify ``slurmcern``
as the step's execution backend in the workflow specification.

.. code-block::
# Serial example
...
steps:
- name: reana_demo_helloworld_htcondorcern
environment: 'python:2.7-slim'
compute_backend: slurmcern
commands:
- python "${helloworld}"
...
Run your analysis on REANA cloud
--------------------------------
Expand Down

0 comments on commit f831418

Please sign in to comment.