Skip to content

Commit b4f6a60

Browse files
author
Matthew Fisher
committed
Merge pull request #140 from bacongobbler/operational-tasks
feat(managing-workflow): add back operational tasks
2 parents 30f0c80 + 535fed6 commit b4f6a60

1 file changed

Lines changed: 48 additions & 1 deletion

File tree

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
11
# Operational Tasks
22

3-
TODO (bacongobbler): rewrite for v2
3+
Below are some common operational tasks for managing the platform.
4+
5+
6+
## Managing users
7+
8+
There are two classes of Workflow users: normal users and administrators.
9+
10+
* Users can use most of the features of Workflow - creating and deploying applications, adding/removing domains, etc.
11+
* Administrators can perform all the actions that users can, but they also have owner access to all applications.
12+
13+
The first user created on a Workflow installation is automatically an administrator.
14+
15+
16+
## Promoting users to Administrators
17+
18+
You can use the `deis perms` command to promote a user to an administrator:
19+
20+
$ deis perms:create john --admin
21+
22+
23+
## Re-issuing User Authentication Tokens
24+
25+
The controller API uses a simple token-based HTTP Authentication scheme. Token authentication is
26+
appropriate for client-server setups, such as native desktop and mobile clients. Each user of the
27+
platform is issued a token the first time that they sign up on the platform. If this token is
28+
compromised, it will need to be regenerated.
29+
30+
A user can regenerate their own token like this:
31+
32+
$ deis auth:regenerate
33+
34+
An administrator can also regenerate the token of another user like this:
35+
36+
$ deis auth:regenerate -u test-user
37+
38+
At this point, the user will no longer be able to authenticate against the controller with his auth
39+
token:
40+
41+
$ deis apps
42+
401 UNAUTHORIZED
43+
Detail:
44+
Invalid token
45+
46+
They will need to log back in to use their new auth token.
47+
48+
If there is a cluster wide security breach, an administrator can regenerate everybody's auth token like this:
49+
50+
$ deis auth:regenerate --all=true

0 commit comments

Comments
 (0)