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

docs: adds krb5s example #199

Merged
merged 1 commit into from
Oct 8, 2019
Merged

docs: adds krb5s example #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 70 additions & 3 deletions docs/userguide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,9 +410,14 @@ Declare necessary resources
---------------------------

You can declare other additional runtime dependencies that your workflow needs
for successful operation, such as access to `CVMFS
<https://cernvm.cern.ch/portal/filesystem>`_. This is achieved by means of
providing a ``resources`` clause in ``reana.yaml``. For example:
for successful operation.

**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
would list all the CVMFS volumes that would be mounted for the workflow execution.
For example:

.. code-block:: yaml

Expand All @@ -427,6 +432,68 @@ providing a ``resources`` clause in ``reana.yaml``. For example:
commands:
- ls -l /cvmfs/fcc.cern.ch/sw/views/releases/


**Kerberos**

If your workflow requires Kerberos authentication, you should add ``kerberos: true``
for the steps that needs it. Please note that you should
`upload keytab <https://reana-client.readthedocs.io/en/latest/userguide.html#adding-secrets>`_
file for the Kerberos authentication to work.

Serial example:

.. code-block:: yaml

workflow:
type: serial
resources:
cvmfs:
- fcc.cern.ch
specification:
steps:
kerberos: true
- environment: 'cern/slc6-base'
commands:
- ls -l /cvmfs/fcc.cern.ch/sw/views/releases/

CWL example:

.. code-block:: yaml

steps:
first:
hints:
reana:
kerberos: true
run: helloworld.tool
in:
helloworld: helloworld

inputfile: inputfile
sleeptime: sleeptime
outputfile: outputfile
out: [result]

Yadage example:

.. code-block:: yaml

step:
process:
process_type: 'string-interpolated-cmd'
cmd: 'python "{helloworld}" --sleeptime {sleeptime} --inputfile "{inputfile}" --outputfile "{outputfile}"'
publisher:
publisher_type: 'frompar-pub'
outputmap:
outputfile: outputfile
environment:
environment_type: 'docker-encapsulated'
image: 'python'
imagetag: '2.7-slim'
resources:
- kerberos: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @roksys thanks for this!. This will require some changes on yadage side to work correctly. Right now we see support only string entries in the resources

resources:
- KRB5Auth

would this work for you as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @lukasheinrich ,

Yap, should work :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah I see you already extended the yadage schema to your needs (using loophole that we don't restrict the type of resource you can request) :-p

https://github.com/reanahub/reana-workflow-engine-yadage/blob/master/reana_workflow_engine_yadage/externalbackend.py#L77



Run your analysis on REANA cloud
--------------------------------

Expand Down