docs: add documentation of user management on managed-vm

This commit is contained in:
dmitryk-dk 2023-01-26 18:18:02 +02:00 committed by Aliaksandr Valialkin
parent 7dc38fba72
commit 6ed4e70a00
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
27 changed files with 222 additions and 9 deletions

View File

Before

Width:  |  Height:  |  Size: 296 KiB

After

Width:  |  Height:  |  Size: 296 KiB

View File

Before

Width:  |  Height:  |  Size: 156 KiB

After

Width:  |  Height:  |  Size: 156 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 426 KiB

After

Width:  |  Height:  |  Size: 426 KiB

View File

Before

Width:  |  Height:  |  Size: 256 KiB

After

Width:  |  Height:  |  Size: 256 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 112 KiB

View File

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 289 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 301 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 329 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 281 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 297 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

View File

@ -18,13 +18,13 @@ If you forgot password, it can be restored in the following way:
1. Click `Forgot your password?` link at [this page](https://dbaas.victoriametrics.com/signIn): 1. Click `Forgot your password?` link at [this page](https://dbaas.victoriametrics.com/signIn):
<p> <p>
<img src="restore-password.png" width="800"> <img src="../assets/images/managed/quickstart/restore-password.png" width="800">
</p> </p>
2. Enter your email in the field and click `Send Email` button: 2. Enter your email in the field and click `Send Email` button:
<p> <p>
<img src="restore-password-email.png" width="800"> <img src="../assets/images/managed/quickstart/restore-password-email.png" width="800">
</p> </p>
3. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account: 3. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account:
@ -42,13 +42,13 @@ In case of questions contact our support support@victoriametrics.com
4. Navigate to the Profile page by clicking the corresponding link at the top right corner: 4. Navigate to the Profile page by clicking the corresponding link at the top right corner:
<p> <p>
<img src="restore-password-profile.png" width="800"> <img src="../assets/images/managed/quickstart/restore-password-profile.png" width="800">
</p> </p>
5. Enter new password at the Profile page and press `Save` button: 5. Enter new password at the Profile page and press `Save` button:
<p> <p>
<img src="restore-password-save-password.png" width="800"> <img src="../assets/images/managed/quickstart/restore-password-save-password.png" width="800">
</p> </p>
@ -58,7 +58,7 @@ Instances is a page where user can list and manage VictoriaMetrics single-node i
To create an instance click on the button `Create`: To create an instance click on the button `Create`:
<p> <p>
<img src="quickstart-instances.png" width="800"> <img src="../assets/images/managed/quickstart/quickstart-instances.png" width="800">
</p> </p>
In the opened form, choose parameters of the new instance such as: In the opened form, choose parameters of the new instance such as:
@ -69,7 +69,7 @@ In the opened form, choose parameters of the new instance such as:
* `Retention` period for stored metrics. * `Retention` period for stored metrics.
<p> <p>
<img src="quickstart-instance-create.png" width="800"> <img src="../assets/images/managed/quickstart/quickstart-instance-create.png" width="800">
</p> </p>
Once created, instance will remain for a short period of time in `PROVISIONING` status Once created, instance will remain for a short period of time in `PROVISIONING` status
@ -77,7 +77,7 @@ while the hardware spins-up, just wait for a couple of minutes and reload the pa
You'll also be notified via email once provisioning is finished: You'll also be notified via email once provisioning is finished:
<p> <p>
<img src="quickstart-instance-provisioning.png" width="800"> <img src="../assets/images/managed/quickstart/quickstart-instance-provisioning.png" width="800">
</p> </p>
## Access ## Access
@ -86,7 +86,7 @@ After transition from `PROVISIONING` to `RUNNING` state, VictoriaMetrics is full
and ready to accept write or read requests. But first, click on instance name to get the access token: and ready to accept write or read requests. But first, click on instance name to get the access token:
<p> <p>
<img src="quickstart-tokens.png" width="800"> <img src="../assets/images/managed/quickstart/quickstart-tokens.png" width="800">
</p> </p>
Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API. Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API.
@ -94,7 +94,7 @@ Supported token types are `Read-Only`, `Write-Only` and `Read-Write`. Click on t
to see usage examples: to see usage examples:
<p> <p>
<img src="quickstart-token-usage.png" width="800"> <img src="../assets/images/managed/quickstart/quickstart-token-usage.png" width="800">
</p> </p>
Follow usage example in order to configure access to VictoriaMetrics for your Prometheus, Follow usage example in order to configure access to VictoriaMetrics for your Prometheus,

View File

@ -0,0 +1,213 @@
# User Management in Managed VictoriaMetrics
The user management system enables admins to control user access and onboard and offboard users to the Managed VictoriaMetrics. It organizes users according to their needs and role.
The document covers the following topics
1. [User Roles](#user-roles)
2. [User List](#user-list)
3. [How to Add User](#how-to-add-user)
4. [How to Update User](#how-to-update-user)
5. [How to Delete User](#how-to-delete-user)
## User roles
Managed VictoriaMetrics provides different levels of user access. It defines what information users can access and edit in your account.
You assign the role to the user during the user creation procedure. You can change the role after the creation
#### Roles definition
<table>
<tr>
<td><strong>User Role</strong></td>
<td><strong>Categories</strong></td>
<td><strong>Description</strong></td>
</tr>
<tr>
<td rowspan="5" ><strong>Admin</strong></td>
<td>Deployments</td>
<td>
Access to all deployments tabs and information
<p>Create, update and delete deployment</p>
</td>
</tr>
<tr>
<td>Billing Details</td>
<td>Check billing information</td>
</tr>
<tr>
<td>Notifications</td>
<td>Create and update notifications</td>
</tr>
<tr>
<td>Audit Logs</td>
<td>Can check all information in audit logs</td>
</tr>
<tr>
<td>User Management</td>
<td>Add, edit and delete users</td>
</tr>
<tr>
<td rowspan="3"><strong>Editor</strong></td>
<td>Deployments</td>
<td>
Access to all deployments tabs and information
<p>Create, update and delete deployment</p>
</td>
</tr>
<tr>
<td>Notifications</td>
<td>Create and update notifications</td>
</tr>
<tr>
<td>Audit Logs</td>
<td>Can check all information in audit logs</td>
</tr>
<tr>
<td><strong>Viewer</strong></td>
<td>Deployments</td>
<td>Access to Overview, Monitoring, Explore and Alerts deployments tabs and information</td>
</tr>
</table>
#### User statuses
<table>
<tr>
<td class="highlight"><strong class="sr">Active</strong></td>
<td>The user can log in and use Managed VictoriaMetrics. The user role defines the access level.</td>
</tr>
<tr>
<td class="highlight"><strong class="s1">Pending Invitation</strong></td>
<td>An invitation was sent. The user must accept this.</td>
</tr>
<tr>
<td class="highlight"><strong class="nn">Inactive</strong></td>
<td>The user is registered in the Managed VictoriaMetrics but has no access to perform any actions. Admin can active or completely delete the user.</td>
</tr>
</table>
## User list
It shows all users with different roles, and you can apply provided actions with them.
<p>
<img src="../assets/images/managed/user-management/users-list.png" width="800">
</p>
In the table, there is additional information about the users:
<table>
<tr>
<td>User Name:</td>
<td>First name and last name</td>
</tr>
<tr>
<td>Email:</td>
<td>Registration user email</td>
</tr>
<tr>
<td>Status:</td>
<td>Active, Inactive or Pending Invitation</td>
</tr>
<tr>
<td>User Role:</td>
<td>Admin, Editor or Viewer</td>
</tr>
<tr>
<td>Last Active:</td>
<td>Last login date and time</td>
</tr>
<tr>
<td>Auth method:</td>
<td>Auth options to login into the Managed VictoriaMetrics</td>
</tr>
</table>
## How to Add User
<span>Click on</span>
<span>
<img src="../assets/images/managed/user-management/invite-user-button.png" width="100" height="50">
</span>
the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory.
<p>
<img src="../assets/images/managed/user-management/invite-user-modal.png" width="800">
</p>
<span>After filling out the form, click on the</span>
<span>
<img src="../assets/images/managed/user-management/invite-button.png" width="70" height="50">
</span>
button. The user will be saved, and an invitation email to the provided email address will be sent. As a confirmation, you will see the success message.
**The invitation link is only active for 24 hours.**
The user will be at Pending Invitation status. After accepting the invitation user status changes to Active.
<p>
<img src="../assets/images/managed/user-management/success-invitation.png" width="800">
</p>
## How to Update User
<span>To edit the user role and details, activate or deactivate a user, and click on</span>
<span>
<img src="../assets/images/managed/user-management/edit-user-btn.png" width="70" height="70">
</span>
<span>or</span>
<span>
<img src="../assets/images/managed/user-management/edit-user-link.png" width="100" height="70">
</span>
to edit the user.
<p>
<img src="../assets/images/managed/user-management/update-user-buttons.png" width="800">
</p>
User editing form:
<p>
<img src="../assets/images/managed/user-management/update-user.png" width="800">
</p>
<span>To save changes, click the</span>
<span>
<img src="../assets/images/managed/user-management/update-user-save-button.png" width="80" height="40">
</span>
button. If changes are saved successfully, you will see a message at the top of the page.
<p>
<img src="../assets/images/managed/user-management/update-user-success.png" width="800">
</p>
## How to Delete User
You can delete a user from your account. However, you will need to invite them again if you want to give them access.
<span>Click on</span>
<span>
<img src="../assets/images/managed/user-management/delete-user-btn.png" width="40" height="40">
</span>
to delete the user.
<p>
<img src="../assets/images/managed/user-management/delete-user-button.png" width="800">
</p>
To confirm the deletion of a user, you will need to re-enter their email address and press the **Delete** button
<p>
<img src="../assets/images/managed/user-management/delete-user-confirm.png" width="800">
</p>
You will be redirected to the main page with a success or error message
<p>
<img src="../assets/images/managed/user-management/delete-user-success.png" width="800">
</p>