Skip to content

Commit

Permalink
Update documentation (#4876)
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Quandt <[email protected]>
  • Loading branch information
thquad authored and richard-cox committed Apr 16, 2021
1 parent 5a500e2 commit 329fdc5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion deploy/kubernetes/console/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"userEndpointsEnabled": {
"type": "string",
"enum": ["disabled", "admin_only", "enabled"],
"description": "Enable, disable or let only admins view user endpoints"
"description": "Enable, disable or let only admins view and create user endpoints"
},
"autoRegisterCF": {
"type": ["string", "null"]
Expand Down
9 changes: 4 additions & 5 deletions website/docs/endpoints/cf/user-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Configuring User Endpoints

Stratos provides a way for users to create endpoints without the need to be an administrator.

> Note: Admin endpoint-ID's are generated through a SHA-1 encryption of the URL. Endpoints created by a user will differ in their ID, by using the URL + user-ID for encryption. This should pose no problem in the usual Stratos workflow, but if you depend on the ID to be based solely on the URL, then use this feature with caution.
> Note: Admin endpoint-ID's are generated through a SHA-1 encryption of the URL. Personal endpoints will differ in their ID, by using the URL + user-ID for encryption. This should pose no problem in the usual Stratos workflow, but if you depend on the ID to be based solely on the URL, then use this feature with caution.
## Set up

Expand All @@ -15,16 +15,15 @@ In order to enable User Endpoints support in Stratos:
2. The UAA client used by Stratos needs an additional scope `stratos.endpointadmin`
3. Users need to have the `stratos.endpointadmin` group attached to them

Once all steps have been completed, user within the `stratos.endpointadmin` group are allowed to create endpoints. Endpoints created by users are only visible to their respective user and all admins.
Once all steps have been completed, user within the `stratos.endpointadmin` group are allowed to create personal user endpoints. Endpoints created that way are only visible to their respective user and all admins. Admins will be able to create personal user endpoints after step 1 has been completed.

## Environment variable

`USER_ENDPOINTS_ENABLED` or helm chart value `console.userEndpointsEnabled` can be set to three different states:

1. `disabled` (default) will disable this feature. Neither admins nor users will see user endpoints.
2. `admin_only` will hide user endpoints from users. Admins can still see all endpoints created by users.
3. `enabled` will allow users within the `stratos.endpointadmin` group to create endpoints. The endpoints will only be visible to them or admins.

2. `admin_only` will hide user endpoints from users. Admins can create and see all user endpoints.
3. `enabled` will allow users within the `stratos.endpointadmin` group and admins to create personal user endpoints. These endpoints will only be visible to them or admins.

## Adding scopes to the UAA client

Expand Down

0 comments on commit 329fdc5

Please sign in to comment.