diff --git a/docs/managed_victoriametrics/quickstart-instance-create.png b/docs/assets/images/managed/quickstart/quickstart-instance-create.png similarity index 100% rename from docs/managed_victoriametrics/quickstart-instance-create.png rename to docs/assets/images/managed/quickstart/quickstart-instance-create.png diff --git a/docs/managed_victoriametrics/quickstart-instance-provisioning.png b/docs/assets/images/managed/quickstart/quickstart-instance-provisioning.png similarity index 100% rename from docs/managed_victoriametrics/quickstart-instance-provisioning.png rename to docs/assets/images/managed/quickstart/quickstart-instance-provisioning.png diff --git a/docs/managed_victoriametrics/quickstart-instances.png b/docs/assets/images/managed/quickstart/quickstart-instances.png similarity index 100% rename from docs/managed_victoriametrics/quickstart-instances.png rename to docs/assets/images/managed/quickstart/quickstart-instances.png diff --git a/docs/managed_victoriametrics/quickstart-token-usage.png b/docs/assets/images/managed/quickstart/quickstart-token-usage.png similarity index 100% rename from docs/managed_victoriametrics/quickstart-token-usage.png rename to docs/assets/images/managed/quickstart/quickstart-token-usage.png diff --git a/docs/managed_victoriametrics/quickstart-tokens.png b/docs/assets/images/managed/quickstart/quickstart-tokens.png similarity index 100% rename from docs/managed_victoriametrics/quickstart-tokens.png rename to docs/assets/images/managed/quickstart/quickstart-tokens.png diff --git a/docs/managed_victoriametrics/restore-password-email.png b/docs/assets/images/managed/quickstart/restore-password-email.png similarity index 100% rename from docs/managed_victoriametrics/restore-password-email.png rename to docs/assets/images/managed/quickstart/restore-password-email.png diff --git a/docs/managed_victoriametrics/restore-password-profile.png b/docs/assets/images/managed/quickstart/restore-password-profile.png similarity index 100% rename from docs/managed_victoriametrics/restore-password-profile.png rename to docs/assets/images/managed/quickstart/restore-password-profile.png diff --git a/docs/managed_victoriametrics/restore-password-save-password.png b/docs/assets/images/managed/quickstart/restore-password-save-password.png similarity index 100% rename from docs/managed_victoriametrics/restore-password-save-password.png rename to docs/assets/images/managed/quickstart/restore-password-save-password.png diff --git a/docs/managed_victoriametrics/restore-password.png b/docs/assets/images/managed/quickstart/restore-password.png similarity index 100% rename from docs/managed_victoriametrics/restore-password.png rename to docs/assets/images/managed/quickstart/restore-password.png diff --git a/docs/assets/images/managed/user-management/delete-user-btn.png b/docs/assets/images/managed/user-management/delete-user-btn.png new file mode 100644 index 0000000000..65025be993 Binary files /dev/null and b/docs/assets/images/managed/user-management/delete-user-btn.png differ diff --git a/docs/assets/images/managed/user-management/delete-user-button.png b/docs/assets/images/managed/user-management/delete-user-button.png new file mode 100644 index 0000000000..593c319305 Binary files /dev/null and b/docs/assets/images/managed/user-management/delete-user-button.png differ diff --git a/docs/assets/images/managed/user-management/delete-user-confirm.png b/docs/assets/images/managed/user-management/delete-user-confirm.png new file mode 100644 index 0000000000..09734a8909 Binary files /dev/null and b/docs/assets/images/managed/user-management/delete-user-confirm.png differ diff --git a/docs/assets/images/managed/user-management/delete-user-success.png b/docs/assets/images/managed/user-management/delete-user-success.png new file mode 100644 index 0000000000..5dfc827d7c Binary files /dev/null and b/docs/assets/images/managed/user-management/delete-user-success.png differ diff --git a/docs/assets/images/managed/user-management/edit-user-btn.png b/docs/assets/images/managed/user-management/edit-user-btn.png new file mode 100644 index 0000000000..1e139af8b1 Binary files /dev/null and b/docs/assets/images/managed/user-management/edit-user-btn.png differ diff --git a/docs/assets/images/managed/user-management/edit-user-link.png b/docs/assets/images/managed/user-management/edit-user-link.png new file mode 100644 index 0000000000..fb424e08e5 Binary files /dev/null and b/docs/assets/images/managed/user-management/edit-user-link.png differ diff --git a/docs/assets/images/managed/user-management/invite-button.png b/docs/assets/images/managed/user-management/invite-button.png new file mode 100644 index 0000000000..d9e3e5327d Binary files /dev/null and b/docs/assets/images/managed/user-management/invite-button.png differ diff --git a/docs/assets/images/managed/user-management/invite-user-button.png b/docs/assets/images/managed/user-management/invite-user-button.png new file mode 100644 index 0000000000..f0cbe003de Binary files /dev/null and b/docs/assets/images/managed/user-management/invite-user-button.png differ diff --git a/docs/assets/images/managed/user-management/invite-user-modal.png b/docs/assets/images/managed/user-management/invite-user-modal.png new file mode 100644 index 0000000000..5631830edb Binary files /dev/null and b/docs/assets/images/managed/user-management/invite-user-modal.png differ diff --git a/docs/assets/images/managed/user-management/success-invitation.png b/docs/assets/images/managed/user-management/success-invitation.png new file mode 100644 index 0000000000..8cfce34274 Binary files /dev/null and b/docs/assets/images/managed/user-management/success-invitation.png differ diff --git a/docs/assets/images/managed/user-management/update-user-buttons.png b/docs/assets/images/managed/user-management/update-user-buttons.png new file mode 100644 index 0000000000..428b0c6d07 Binary files /dev/null and b/docs/assets/images/managed/user-management/update-user-buttons.png differ diff --git a/docs/assets/images/managed/user-management/update-user-save-button.png b/docs/assets/images/managed/user-management/update-user-save-button.png new file mode 100644 index 0000000000..c1a3a2a6e3 Binary files /dev/null and b/docs/assets/images/managed/user-management/update-user-save-button.png differ diff --git a/docs/assets/images/managed/user-management/update-user-success.png b/docs/assets/images/managed/user-management/update-user-success.png new file mode 100644 index 0000000000..24b8ba1e75 Binary files /dev/null and b/docs/assets/images/managed/user-management/update-user-success.png differ diff --git a/docs/assets/images/managed/user-management/update-user.png b/docs/assets/images/managed/user-management/update-user.png new file mode 100644 index 0000000000..8482101013 Binary files /dev/null and b/docs/assets/images/managed/user-management/update-user.png differ diff --git a/docs/assets/images/managed/user-management/users-list.png b/docs/assets/images/managed/user-management/users-list.png new file mode 100644 index 0000000000..acca183013 Binary files /dev/null and b/docs/assets/images/managed/user-management/users-list.png differ diff --git a/docs/managed_victoriametrics/README.md b/docs/managed-victoriametrics/README.md similarity index 100% rename from docs/managed_victoriametrics/README.md rename to docs/managed-victoriametrics/README.md diff --git a/docs/managed_victoriametrics/quickstart.md b/docs/managed-victoriametrics/quickstart.md similarity index 80% rename from docs/managed_victoriametrics/quickstart.md rename to docs/managed-victoriametrics/quickstart.md index 16d20bf521..29b612a0ce 100644 --- a/docs/managed_victoriametrics/quickstart.md +++ b/docs/managed-victoriametrics/quickstart.md @@ -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):
- +
2. Enter your email in the field and click `Send Email` button:- +
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:- +
5. Enter new password at the Profile page and press `Save` button:- +
@@ -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`:- +
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.- +
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:- +
## 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:- +
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:- +
Follow usage example in order to configure access to VictoriaMetrics for your Prometheus, diff --git a/docs/managed-victoriametrics/user-managment.md b/docs/managed-victoriametrics/user-managment.md new file mode 100644 index 0000000000..b775c9b928 --- /dev/null +++ b/docs/managed-victoriametrics/user-managment.md @@ -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 + +User Role | +Categories | +Description | +
Admin | +Deployments | +
+ Access to all deployments tabs and information
+ Create, update and delete deployment + |
+
Billing Details | +Check billing information | +|
Notifications | +Create and update notifications | +|
Audit Logs | +Can check all information in audit logs | +|
User Management | +Add, edit and delete users | +|
Editor | +Deployments | +
+ Access to all deployments tabs and information
+ Create, update and delete deployment + |
+
Notifications | +Create and update notifications | +|
Audit Logs | +Can check all information in audit logs | +|
Viewer | +Deployments | +Access to Overview, Monitoring, Explore and Alerts deployments tabs and information | +
Active | +The user can log in and use Managed VictoriaMetrics. The user role defines the access level. | +
Pending Invitation | +An invitation was sent. The user must accept this. | +
Inactive | +The user is registered in the Managed VictoriaMetrics but has no access to perform any actions. Admin can active or completely delete the user. | +
+ +
+ +In the table, there is additional information about the users: + + +User Name: | +First name and last name | +
Email: | +Registration user email | +
Status: | +Active, Inactive or Pending Invitation | +
User Role: | +Admin, Editor or Viewer | +
Last Active: | +Last login date and time | +
Auth method: | +Auth options to login into the Managed VictoriaMetrics | +
+ +
+ +After filling out the form, click on the + + + +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. + ++ +
+ +## How to Update User + +To edit the user role and details, activate or deactivate a user, and click on + + + +or + + + +to edit the user. + ++ +
+ +User editing form: + ++ +
+ +To save changes, click the + + + +button. If changes are saved successfully, you will see a message at the top of the page. + ++ +
+ +## 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. + +Click on + + + +to delete the user. + ++ +
+ +To confirm the deletion of a user, you will need to re-enter their email address and press the **Delete** button + ++ +
+ +You will be redirected to the main page with a success or error message + ++ +