Teaming/user management (#68)
* Assets restructured WIP, logical restructure of sidebar for teaming, added user guides + concepts for teaming and user management Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * Assets updated and structured, added additional user guides Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * Embedmd command run Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * litmus portal -> ChaosCenter Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * Review changes Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * Learn more/pre-requisites added Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * embedmd changes Signed-off-by: Vansh Bhatia <vansh@chaosnative.com> * user-guides learn more Signed-off-by: Vansh Bhatia <vansh@chaosnative.com>
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 148 KiB |
|
After Width: | Height: | Size: 135 KiB |
|
After Width: | Height: | Size: 127 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 119 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 134 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 137 KiB |
|
After Width: | Height: | Size: 114 KiB |
|
After Width: | Height: | Size: 131 KiB |
|
|
@ -4,4 +4,43 @@ title: Collaborate with Teams
|
|||
sidebar_label: Teaming
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
The ChaosCenter has a built in teaming feature to facilitate collaboration between users using project level role access, the core concepts of which are discussed below.
|
||||
|
||||
### Project level roles (Owner, Editor, Viewer)
|
||||
Each user has a default project created on user creation by the admin for which they maintain a project level `Owner` access. Every `Owner` has the ability to invite other users into their project with different permission levels, namely `Editor`, and `Viewer`.
|
||||
|
||||
Teaming is based on the following principles and each user can have one of the 3 project roles:
|
||||
|
||||
- **Owner:** One who created the project and owns it. Only the owner has permission to manage(invite or remove) the members in his/her project. The owner can schedule workflows, update workflows, delete workflows and view the analytics.
|
||||
- **Editor:** Members invited with the editor role can do everything an owner can except for managing the members in the project.
|
||||
- **Viewer:** Members having a viewer role can only view the analytics related to the workflows and the workflows themselves, but are not given the permission to schedule workflows in the project.
|
||||
|
||||
### Role privileges
|
||||
|
||||
> Note: A user will be the owner of his/her project by default.
|
||||
|
||||
***As the Project Owner you can:***
|
||||
- Invite other users for the following roles:
|
||||
- Viewer
|
||||
- Editor
|
||||
- View the list of team members with other details including their role in the project, email-id, date-time of joining the project team.
|
||||
- Rename your project.
|
||||
- Remove a member from your project.
|
||||
- Check the status of the invitation you sent to other members.
|
||||
- Edit the user role in case the invitation is pending.
|
||||
- Cancel the invitation.
|
||||
|
||||
***As a Viewer or Editor you can:***
|
||||
|
||||
- Check and Accept/Decline the received invitations.
|
||||
- Switch and browse any project you are a member of.
|
||||
- Can leave the project you are a part of, except your own.
|
||||
|
||||
>Note: The settings page will not be visible to you if you are browsing someone else’s project. You can only view it if you are the project owner.
|
||||
|
||||
### Learn more
|
||||
|
||||
- [Invite a team member](../user-guides/invite-team-member)
|
||||
- [Edit/Cancel an invite](../user-guides/edit-invite)
|
||||
- [Accept an invite](../user-guides/accept-invite)
|
||||
- [Remove a team member](../user-guides/remove-team-member)
|
||||
|
|
|
|||
|
|
@ -4,4 +4,27 @@ title: User Management
|
|||
sidebar_label: User Management
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
The ChaosCenter supports two different levels of hierarchy, a portal level access, and a project level access.
|
||||
|
||||
>This section discusses the detailed breakdown of the portal level roles a user may have. For project level roles refer [here](teaming).
|
||||
|
||||
### Portal level user Roles (Admin, Non-Admins)
|
||||
ChaosCenter supports two portal level roles for defining the privilege levels of a certain user:
|
||||
|
||||
**Admin:** the admin user is created by default on initial project setup and can log into the portal using the credentials `admin/litmus` once the server pod (auth container) is up.
|
||||
|
||||
**Non-admin users:** The admin of the portal has the exclusive ability to create any number of non-admin users.
|
||||
|
||||
### Role Privileges
|
||||
|
||||
**Admin** is the highest privilege level offered in the portal and the admin has complete access to all the features offered by the portal.
|
||||
|
||||
|
||||
**Non-admin users:** Non-admin users get all the same privileges as an admin level user, with the exception of the user management feature which is an admin exclusive feature to facilitate an admin to manage their teams on the portal. (Example: In an organization, multiple different teams might be formed to inject chaos on different agents which have no layover between each other.)
|
||||
|
||||
### Learn More
|
||||
|
||||
- [View Users](../user-guides/view-user)
|
||||
- [Create a user](../user-guides/create-user)
|
||||
- [Reset password of a user](../user-guides/reset-password)
|
||||
- [Deactivate a user](../user-guides/deactivate-user)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
id: accept-invite
|
||||
title: Accept an invite
|
||||
sidebar_label: Accept invite
|
||||
---
|
||||
|
||||
Once the invitation is received, you can take a look at details including the sender's name, role, and project name, then decide whether to accept or decline the invitation.
|
||||
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/accept-invite/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
Once accepted, you can switch to the project using the header or the `View Project` option as shown below:
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/accept-invite/step-2.png').default} width="1000" height="500" />
|
||||
|
|
@ -4,4 +4,32 @@ title: Create a User
|
|||
sidebar_label: Create User
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
|
||||
This feature enables the admin to create a new user by assigning a unique username and password for the user. In addition to this, the admin can also provide the name and email address of the new user which is optional.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Create a new user
|
||||
|
||||
Click the `Create new user` button as observed below:
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/create-user/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### 2. Add the details of the new user
|
||||
|
||||
Add all the details of the user to be created and hit the `Create` button.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/create-user/step-2.png').default} width="1000" height="500" />
|
||||
|
||||
### 3. Confirmation of creation
|
||||
|
||||
The user is created and you will receive a confirmation modal.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/create-user/step-3.png').default} width="1000" height="500" />
|
||||
|
||||
You will now be able to view the new user in the table in the user management tab.
|
||||
|
||||
### Learn more
|
||||
- [View users](view-user)
|
||||
- [Reset the password of a user](reset-password)
|
||||
- [Deactivate a user](deactivate-user)
|
||||
|
|
|
|||
|
|
@ -4,4 +4,27 @@ title: Deactivate a User
|
|||
sidebar_label: Deactivate User
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
The Account of a created user can be deactivated if required. Once the user is deactivated, the user won’t be able to log in or access any of the APIs. Along with this, the project in which the user was the owner of will also get deactivated and everyone who is a member of the project will lose access to that project. Admin can also reactivate the account of a deactivated user. Once the user is reactivated, complete data will get restored.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Locate and deactivate the user
|
||||
|
||||
In the user management tab, locate the user account that you'd like to deactivate and click on the horizontal options icon.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/deactivate-user/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### 2. Confirm the user is deactivated
|
||||
|
||||
Once deactivated, the indicator next to the user's username in the usermanagement table will turn gray.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/deactivate-user/step-2.png').default} width="1000" height="500" />
|
||||
|
||||
### 3. Re-activate a user (Optional step)
|
||||
|
||||
Similarly, the admin can re-activate the user from the same drop-down menu as shown:
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/deactivate-user/step-3.png').default} width="1000" height="500" />
|
||||
|
||||
### Learn more
|
||||
- [View users](view-user)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
id: edit-invite
|
||||
title: Edit or Cancel an invite
|
||||
sidebar_label: Edit/Cancel invite
|
||||
---
|
||||
|
||||
If you had a change of mind and you wanted to change the role of an invitation that has been already sent, we got you!
|
||||
|
||||
Just go to the invited tab, change the role, and hit the `Resend` button. You can also cancel the invitation by just clicking on the `bin` icon.
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/edit-invite/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### Learn more
|
||||
- [Accept an invitation](accept-invite)
|
||||
|
|
@ -4,4 +4,30 @@ title: Invite a Team Member
|
|||
sidebar_label: Invite Team Member
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
> In the `/settings` route (settings on the sidebar) the `Team` tab can be used to access the teaming feature by the `owner`. We recommend learning about the concept of [teaming](../concepts/teaming) before proceeding with the following user guides.
|
||||
|
||||
With this feature, you can select as many users you want, choose their roles individually and send the invitation at once! Once it is done successfully you can see the status of the sent invitation (whether it is in a pending/accepted/declined or exited state) along with all the other necessary details in the `Invited` tab.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Find the user you want to invite
|
||||
|
||||
In the team tab, click the `Invite new member` button as shown below:
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/invite-team-member/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### 2. Select all the members to be invited
|
||||
|
||||
From the list of all available members, choose the ones you want to collaborate on your chaos with and decide what project level access they should have to your project (Viewer/Editor) and hit the `Send Invite` button.
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/invite-team-member/step-2.png').default} width="1000" height="500" />
|
||||
|
||||
### 3. Collaborate over the chaos!
|
||||
|
||||
On successful invitation you will receive the confirmation dialog as shown below indicating selected members have been invited to your project.
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/invite-team-member/step-3.png').default} width="1000" height="500" />
|
||||
|
||||
### Learn more
|
||||
- [Edit an invitation](edit-invite)
|
||||
- [Accept invite](accept-invite)
|
||||
|
|
|
|||
|
|
@ -4,4 +4,18 @@ title: Remove a Team Member
|
|||
sidebar_label: Remove Team Member
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
If you are the project owner, you have the ability to remove any members from your project as required.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Identify the member to remove
|
||||
|
||||
In the `Team` tab in the settings page, scroll down to the `My project` table, here you will be able to see all the members who have their invitation status as `accepted` for your project collaboration invite. Here, identify the user to remove and click on the red `Remove` bin icon as shown.
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/remove-team-member/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### 2. Confirmation for removal
|
||||
|
||||
On hitting the `Remove` icon, you will be prompted to confirm the removal of the member, hit `Yes` to confirm and remove the member from your project.
|
||||
|
||||
<img src={require('../assets/user-guides/teaming/remove-team-member/step-2.png').default} width="1000" height="500" />
|
||||
|
|
|
|||
|
|
@ -4,4 +4,21 @@ title: Reset Password of a User
|
|||
sidebar_label: Reset Password
|
||||
---
|
||||
|
||||
## Coming soon
|
||||
The admin has the ability to reset the login password for any user in the portal.
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Locate the user
|
||||
|
||||
Under the `User management` tab find the user who's password needs to be updated and click on the options icon to open a drop-down and select `Edit Profile` option
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/reset-password/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
### 2. Change the password
|
||||
|
||||
In the `Login Details` section select the `New password` input field and type in the new password. Once done hit the `Save` button to update the password.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/reset-password/step-2.png').default} width="1000" height="500" />
|
||||
|
||||
### Learn more
|
||||
- [View users](view-user)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
id: view-user
|
||||
title: View all users
|
||||
sidebar_label: View users
|
||||
---
|
||||
|
||||
> In the `/settings` route (settings on the sidebar) the `User Management` tab can be used to access the user management feature by the admin. We recommend learning about the concept of [user management](../concepts/user-management) before proceeding with the following user guides.
|
||||
|
||||
### View users
|
||||
|
||||
The admin can access the user management tab to check the list of all users present in the portal.
|
||||
|
||||
<img src={require('../assets/user-guides/user-management/view-user/step-1.png').default} width="1000" height="500" />
|
||||
|
||||
|
||||
### Learn more
|
||||
|
||||
- [Create a user](create-user)
|
||||
- [Reset the password of a user](reset-password)
|
||||
- [Deactivate a user](deactivate-user)
|
||||
|
|
@ -40,8 +40,8 @@ module.exports = {
|
|||
{
|
||||
Observability: ['concepts/workflow-statistics', 'concepts/app-infra-monitoring', 'concepts/datasource']
|
||||
},
|
||||
'concepts/teaming',
|
||||
'concepts/user-management',
|
||||
'concepts/teaming',
|
||||
'concepts/gitops'
|
||||
]
|
||||
},
|
||||
|
|
@ -108,10 +108,10 @@ module.exports = {
|
|||
]
|
||||
},
|
||||
{
|
||||
Teaming: ['user-guides/invite-team-member', 'user-guides/remove-team-member']
|
||||
'User Management': ['user-guides/view-user', 'user-guides/create-user', 'user-guides/reset-password', 'user-guides/deactivate-user']
|
||||
},
|
||||
{
|
||||
'User Management': ['user-guides/create-user', 'user-guides/reset-password', 'user-guides/deactivate-user']
|
||||
'Teaming': ['user-guides/invite-team-member', 'user-guides/edit-invite', 'user-guides/accept-invite', 'user-guides/remove-team-member']
|
||||
},
|
||||
'user-guides/image-registry',
|
||||
'user-guides/uninstall-litmus'
|
||||
|
|
|
|||