Added references to 'st2 login' and 'st2 whoami' commands #380
Conversation
Signed-off-by: Matt Oswalt <oswaltm@brocade.com>
docs/source/reference/cli.rst
Outdated
| configured user. | ||
|
|
||
| The ``st2 login`` command is a good option if you want an easy way to authenticate | ||
| via the CLI without storing your password in plain text. Switching between users is also |
There was a problem hiding this comment.
consider a ref to the CLI 101 section that talks about plain text option.
There was a problem hiding this comment.
and m.b. warn that it'll override the ./st2/config credentials?
There was a problem hiding this comment.
Okay, I took a stab at adding these in a6f4612 - hopefully that's on target
Signed-off-by: Matt Oswalt <oswaltm@brocade.com>
Signed-off-by: Matt Oswalt <oswaltm@brocade.com>
Signed-off-by: Matt Oswalt <oswaltm@brocade.com>
|
LGTM, now that the crisis of the missing period has been resolved. |
| retrieve an auth token. | ||
| If you don't wish to store your password in plain-text as shown in the previous section, | ||
| the ``st2 login`` command offers an alternative. Similar to ``st2 auth``, you must provide your | ||
| username and password: |
There was a problem hiding this comment.
It's maybe also worth adding a note that since this command doesn't store password by default in the config and it relies on a cached auth token it will only work until the token expires (which is 24 hours by default, IIRC).
After that, the user will need to re-login. And / or perhaps also document the --write-password option.
| If you specify username and password as authentication credentials in the | ||
| configuration file, the CLI will try to use those credentials to authenticate and | ||
| retrieve an auth token. | ||
| If you don't wish to store your password in plain-text as shown in the previous section, |
There was a problem hiding this comment.
Also, I think we should probably still keep part of this paragraph somewhere here explaining how authentication works in the CLI if username and password are specific in the config.
There was a problem hiding this comment.
I moved this further down to line 116. Clarified in 8e3dc46
Signed-off-by: Matt Oswalt <oswaltm@brocade.com>
This PR adds an explanation of the new
st2 loginandst2 whoamicommands that were introduced in StackStorm/st2#3123