Skip to content

Commit 7d63d07

Browse files
mboersmaVaughn Dice
authored andcommitted
fix(charts): default registration mode to "admin_only" (#758)
fix(charts): default registration mode to "admin_only"
1 parent 427e49a commit 7d63d07

4 files changed

Lines changed: 30 additions & 16 deletions

File tree

charts/workflow/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ controller:
106106
# enabled - allows for open registration
107107
# disabled - turns off open registration
108108
# admin_only - allows for registration by an admin only.
109-
registration_mode: "enabled"
109+
registration_mode: "admin_only"
110110

111111
database:
112112
# The username and password to be used by the on-cluster database.

src/managing-workflow/production-deployments.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,26 @@ See [Configuring Object Storage][] for details on removing this operational comp
2626

2727
## Review Security Considerations
2828

29-
There are some additional security-related considerations when running Workflow in production, and
30-
users can consider enabling a firewall on the CoreOS hosts as well as the router component.
31-
29+
There are some additional security-related considerations when running Workflow in production.
3230
See [Security Considerations][] for details.
3331

3432

35-
## Change Registration Mode
33+
## Registration is Admin-Only
3634

37-
Changing the registration process is highly recommended in production. By default, registrations
38-
for a new cluster are open to anyone with the proper URL. Once the admin user has registered with a
39-
new cluster, it is recommended to either turn off registrations or enable the admin-only
40-
registration feature. It is also recommended to disable signups for the Grafana dashboards.
35+
By default, registration with the Workflow controller is in "admin_only" mode. The first user
36+
to run a `deis register` command becomes the initial "admin" user, and registrations after that
37+
are disallowed unless requested by an admin.
4138

42-
Please see the following documentation:
39+
Please see the following documentation to learn about changing registration mode:
4340

4441
- [Customizing Controller][]
42+
43+
## Disable Grafana Signups
44+
45+
It is also recommended to disable signups for the Grafana dashboards.
46+
47+
Please see the following documentation to learn about disabling Grafana signups:
48+
4549
- [Customizing Monitor][]
4650

4751

src/managing-workflow/tuning-component-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The following environment variables are tunable for the [Controller][] component
6060

6161
Setting | Description
6262
----------------------------------------------- | ---------------------------------
63-
REGISTRATION_MODE | set registration to "enabled", "disabled", or "admin_only" (default: "enabled")
63+
REGISTRATION_MODE | set registration to "enabled", "disabled", or "admin_only" (default: "admin_only")
6464
GUNICORN_WORKERS | number of [gunicorn][] workers spawned to process requests (default: CPU cores * 4 + 1)
6565
RESERVED_NAMES | a comma-separated list of names which applications cannot reserve for routing (default: "deis, deis-builder, deis-workflow-manager")
6666
SLUGRUNNER_IMAGE_NAME | the image used to run buildpack application slugs (default: "quay.io/deisci/slugrunner:canary")

src/users/registration.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,27 @@ You can verify your client configuration by running `deis whoami`.
4949
!!! note
5050
Session and client configuration is stored in the `~/.deis/client.json` file.
5151

52+
## Registering New Users
53+
54+
By default, new users are not allowed to register after an initial user does. That initial user
55+
becomes the first "admin" user. Others will now receive an error when trying to register, but when
56+
logged in, an admin user can register new users:
57+
58+
```shell
59+
$ deis register --login=false --username=newuser --password=changeme123 --email=newuser@deis.io
60+
```
61+
5262
## Controlling Registration Modes
5363

5464
After creating your first user, you may wish to change the registration mode for Deis Workflow.
5565

5666
Deis Workflow supports three registration modes:
5767

58-
| Mode | Description |
59-
| --- | --- |
60-
| enabled (default) | Registration is enabled and anyone can register |
61-
| disabled | Does not allow anyone to register new users. |
62-
| admin\_only | Only existing admins may register new users |
68+
| Mode | Description |
69+
| --- | --- |
70+
| admin\_only (default) | Only existing admins may register new users |
71+
| enabled | Registration is enabled and anyone can register |
72+
| disabled | Does not allow anyone to register new users. |
6373

6474
To modify the registration mode for Workflow you may add or modify the `REGISTRATION_MODE` environment variable for the
6575
controller component. If Deis Workflow is already running, use:

0 commit comments

Comments
 (0)