Skip to content

Commit 7a99b3a

Browse files
docs(customizing_deis): clarify usage of registrationMode
1 parent 3d705a0 commit 7a99b3a

2 files changed

Lines changed: 32 additions & 3 deletions

File tree

docs/customizing_deis/controller_settings.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,33 @@ server
109109
every application or scaling them down and up.
110110
The change is only detected when a container unit is deployed.
111111

112+
Changing the Registration Mode
113+
------------------------------
114+
115+
By default, anybody can register a user with the Deis controller.
116+
However, this is often undesirable from a security point of view.
117+
118+
Deis supports configuring the registration mode through the ``registrationMode`` setting.
119+
120+
Registration Modes
121+
^^^^^^^^^^^^^^^^^^
122+
========== =========================================================
123+
mode description
124+
========== =========================================================
125+
enabled Default. Anybody can register a user with the controller.
126+
disabled Nobody can register a user with the controller.
127+
admin_only Only admins can register a user with the controller.
128+
========== =========================================================
129+
130+
This will set the registration mode to admin_only.
131+
132+
.. code-block:: console
133+
134+
$ deisctl config controller set registrationMode="admin_only"
135+
112136
Using a LDAP Auth
113137
-----------------
114-
Deis Controller supports Single Sign On access control, for now Deis is able to authenticate using LDAP or Active Directory.
138+
The Deis controller supports Single Sign On access control, for now Deis is able to authenticate using LDAP or Active Directory.
115139

116140
Settings used by LDAP
117141
^^^^^^^^^^^^^^^^^^^^^

docs/managing_deis/operational_tasks.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,17 @@ You can use the ``deis perms`` command to promote a user to an administrator:
3434
Disabling user registration
3535
---------------------------
3636

37-
You can disallow all users from registering with the Deis cluster using the following command:
37+
You can disable user registration for everybody except admins:
3838

3939
.. code-block:: console
4040
41-
$ deisctl config controller set registrationEnabled=0
41+
$ deisctl config controller set registrationMode="admin_only"
4242
43+
If you want to entirely disable user registration:
44+
45+
.. code-block:: console
46+
47+
$ deisctl config controller set registrationMode="disabled"
4348
4449
Re-issuing User Authentication Tokens
4550
-------------------------------------

0 commit comments

Comments
 (0)