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.

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

cli: verify embedded examples #373

Open
tiborsimko opened this issue Feb 7, 2020 · 0 comments
Open

cli: verify embedded examples #373

tiborsimko opened this issue Feb 7, 2020 · 0 comments

Comments

@tiborsimko
Copy link
Member

Epic

Go through embedded docs (reana-client --help) and verify all its content and provided examples.

Current behaviour

For example, for secrets-add command, we are showing how to add PASSWORD, but this is not a good thing to advocate security wise, and moreover it is not the technique we are using anywhere, so it would be better to show keytab-related example.

$ reana-client secrets-add --help

  Examples:

       $ reana-client secrets-add --env PASSWORD=password

       $ reana-client secrets-add --file ~/.keytab

       $ reana-client secrets-add --env USER=reanauser

                                  --env PASSWORD=password

                                  --file ~/.keytab

Expected behaviour

The same help but with less critical example, such as

  MYSECRET=mysecretvalue

or even better targeted to CERN users:

  CERN_USER=johndoe

so that the output of --help command could be readily used by people wanting to run CERN HTCondor/Slurm scenarios without even having to refer to external documentation.

Note

PASSWORD example is used in a few places:

$ git grep PASSWORD
reana_client/cli/secrets.py:40:         'e.g. PASSWORD=password123')
reana_client/cli/secrets.py:60:    \t $ reana-client secrets-add --env PASSWORD=password \n
reana_client/cli/secrets.py:63:    \t                            --env PASSWORD=password \n
reana_client/cli/secrets.py:109:    \t $ reana-client secrets-delete PASSWORD
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant