diff --git a/docs/managed-victoriametrics/README.md b/docs/managed-victoriametrics/README.md index 0f1aa62b34..6247569ec3 100644 --- a/docs/managed-victoriametrics/README.md +++ b/docs/managed-victoriametrics/README.md @@ -7,20 +7,16 @@ disableToc: true # Managed VictoriaMetrics -Product information: - * [Overview of Managed VictoriaMetrics](/managed-victoriametrics/overview.html) -* [User Management](/managed-victoriametrics/user-managment.html) - -Guides: - * [Quick Start](/managed-victoriametrics/quickstart.html) + +## Guides +* [User Management](/managed-victoriametrics/user-managment.html) * [Kubernetes Monitoring with Managed VictoriaMetrics](/managed-victoriametrics/how-to-monitor-k8s.html) * [Understand Your Setup Size](/guides/understand-your-setup-size.html) * [Setup Notifications](/managed-victoriametrics/setup-notifications.html) - -See more about Managed VictoriaMetrics in the following articles: +Learn more about Managed VictoriaMetrics: * [Managed VictoriaMetrics announcement](https://victoriametrics.com/blog/managed-victoriametrics-announcement) * [Pricing comparison for Managed Prometheus](https://victoriametrics.com/blog/managed-prometheus-pricing/) * [Monitoring Proxmox VE via Managed VictoriaMetrics and vmagent](https://victoriametrics.com/blog/proxmox-monitoring-with-dbaas/) diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-1.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-1.png deleted file mode 100644 index de40f9cf40..0000000000 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-1.png and /dev/null differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-2.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-2.png deleted file mode 100644 index da0c34edfd..0000000000 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-2.png and /dev/null differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-3.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-3.png deleted file mode 100644 index 1fc609efc5..0000000000 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-cluster-3.png and /dev/null differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-setup.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-setup.png index 11c00dc566..3ae875c5c8 100644 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-setup.png and b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-setup.png differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-1.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-1.png deleted file mode 100644 index f63ac7bbe0..0000000000 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-1.png and /dev/null differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-2.png b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-2.png deleted file mode 100644 index 3b36fb9b86..0000000000 Binary files a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics-single-2.png and /dev/null differ diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md index a2240828ab..c6fc73a9c6 100644 --- a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md +++ b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md @@ -55,14 +55,14 @@ For instructions on how to create tokens, please refer to this section of the [d #### Single-Node - - + + #### Cluster - - - + + + ### vmalert configuration @@ -71,7 +71,7 @@ For instructions on how to create tokens, please refer to this section of the [d ##### Binary ```console -export TOKEN=81e8226e-4e25-480d-9397-31ba4007f0bf +export TOKEN=81e8226e-****-****-****-************ export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com export ALERTMANAGER_URL=http://localhost:9093 ./vmalert -rule=alerts.yml -datasource.url=$MANAGED_VM_URL -datasource.bearerToken=$TOKEN -notifier.url=$ALERTMANAGER_URL -remoteWrite.url=$MANAGED_VM_URL -remoteWrite.bearerToken=$TOKEN -remoteRead.url=$MANAGED_VM_URL -remoteRead.bearerToken=$TOKEN @@ -80,7 +80,7 @@ export ALERTMANAGER_URL=http://localhost:9093 ##### Docker ```console -export TOKEN=81e8226e-4e25-480d-9397-31ba4007f0bf +export TOKEN=81e8226e-****-****-****-************ export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com export ALERTMANAGER_URL=http://alertmanager:9093 docker run -it -p 8080:8080 -v $(pwd)/alerts.yml:/etc/alerts/alerts.yml victoriametrics/vmalert:v1.87.1 -datasource.url=$MANAGED_VM_URL -datasource.bearerToken=$TOKEN -remoteRead.url=$MANAGED_VM_URL -remoteRead.bearerToken=$TOKEN -remoteWrite.url=$MANAGED_VM_URL -remoteWrite.bearerToken=$TOKEN -notifier.url=$ALERTMANAGER_URL -rule="/etc/alerts/*.yml" @@ -89,7 +89,7 @@ docker run -it -p 8080:8080 -v $(pwd)/alerts.yml:/etc/alerts/alerts.yml victoria ##### Helm Chart ```console -export TOKEN=81e8226e-4e25-480d-9397-31ba4007f0bf +export TOKEN=81e8226e-****-****-****-************ export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com export ALERTMANAGER=http://alertmanager:9093 cat < You can find your access token on the "Access" tab of your deployment - + 1. Set up a Helm repository using the following commands:
```bash diff --git a/docs/managed-victoriametrics/how-to-monitor-k8s_access-token.png b/docs/managed-victoriametrics/how-to-monitor-k8s_access-token.png deleted file mode 100644 index a2148810db..0000000000 Binary files a/docs/managed-victoriametrics/how-to-monitor-k8s_access-token.png and /dev/null differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_add_card.png b/docs/managed-victoriametrics/how_to_add_payment_method_add_card.png new file mode 100644 index 0000000000..4581c9b5a7 Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_add_card.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_aws_click.png b/docs/managed-victoriametrics/how_to_add_payment_method_aws_click.png new file mode 100644 index 0000000000..9318969ac2 Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_aws_click.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_aws_finish.png b/docs/managed-victoriametrics/how_to_add_payment_method_aws_finish.png new file mode 100644 index 0000000000..9209a2763d Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_aws_finish.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_card_added.png b/docs/managed-victoriametrics/how_to_add_payment_method_card_added.png new file mode 100644 index 0000000000..dac21fb93c Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_card_added.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_choose_method.png b/docs/managed-victoriametrics/how_to_add_payment_method_choose_method.png new file mode 100644 index 0000000000..ec4d2e5e58 Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_choose_method.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_invalid_card.png b/docs/managed-victoriametrics/how_to_add_payment_method_invalid_card.png new file mode 100644 index 0000000000..f66937af49 Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_invalid_card.png differ diff --git a/docs/managed-victoriametrics/how_to_add_payment_method_upgrade.png b/docs/managed-victoriametrics/how_to_add_payment_method_upgrade.png new file mode 100644 index 0000000000..45f3e22f52 Binary files /dev/null and b/docs/managed-victoriametrics/how_to_add_payment_method_upgrade.png differ diff --git a/docs/managed-victoriametrics/kubernetes_monitoring.png b/docs/managed-victoriametrics/kubernetes_monitoring.png new file mode 100644 index 0000000000..923039c050 Binary files /dev/null and b/docs/managed-victoriametrics/kubernetes_monitoring.png differ diff --git a/docs/managed-victoriametrics/modify_deployment.png b/docs/managed-victoriametrics/modify_deployment.png new file mode 100644 index 0000000000..8e93be1822 Binary files /dev/null and b/docs/managed-victoriametrics/modify_deployment.png differ diff --git a/docs/managed-victoriametrics/modify_deployment_additional_settings.png b/docs/managed-victoriametrics/modify_deployment_additional_settings.png new file mode 100644 index 0000000000..ccb9dd2252 Binary files /dev/null and b/docs/managed-victoriametrics/modify_deployment_additional_settings.png differ diff --git a/docs/managed-victoriametrics/notifications_email_test.png b/docs/managed-victoriametrics/notifications_email_test.png new file mode 100644 index 0000000000..dd83c06531 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_email_test.png differ diff --git a/docs/managed-victoriametrics/notifications_save_and_test.png b/docs/managed-victoriametrics/notifications_save_and_test.png new file mode 100644 index 0000000000..43ca17bd07 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_save_and_test.png differ diff --git a/docs/managed-victoriametrics/notifications_save_success.png b/docs/managed-victoriametrics/notifications_save_success.png new file mode 100644 index 0000000000..22ccbf3176 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_save_success.png differ diff --git a/docs/managed-victoriametrics/notifications_setup_emails.png b/docs/managed-victoriametrics/notifications_setup_emails.png new file mode 100644 index 0000000000..188266d6e8 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_setup_emails.png differ diff --git a/docs/managed-victoriametrics/notifications_setup_emails_input.png b/docs/managed-victoriametrics/notifications_setup_emails_input.png new file mode 100644 index 0000000000..cfcfb82bf7 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_setup_emails_input.png differ diff --git a/docs/managed-victoriametrics/notifications_setup_slack.png b/docs/managed-victoriametrics/notifications_setup_slack.png new file mode 100644 index 0000000000..02704c1b6a Binary files /dev/null and b/docs/managed-victoriametrics/notifications_setup_slack.png differ diff --git a/docs/managed-victoriametrics/notifications_setup_slack_enter_channel.png b/docs/managed-victoriametrics/notifications_setup_slack_enter_channel.png new file mode 100644 index 0000000000..04510badf8 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_setup_slack_enter_channel.png differ diff --git a/docs/managed-victoriametrics/setup-notifications-slack-test.png b/docs/managed-victoriametrics/notifications_slack_test.png similarity index 100% rename from docs/managed-victoriametrics/setup-notifications-slack-test.png rename to docs/managed-victoriametrics/notifications_slack_test.png diff --git a/docs/managed-victoriametrics/notifications_view.png b/docs/managed-victoriametrics/notifications_view.png new file mode 100644 index 0000000000..dfa5cd1e99 Binary files /dev/null and b/docs/managed-victoriametrics/notifications_view.png differ diff --git a/docs/managed-victoriametrics/overview.md b/docs/managed-victoriametrics/overview.md index 263db7690a..938bd5f7b9 100644 --- a/docs/managed-victoriametrics/overview.md +++ b/docs/managed-victoriametrics/overview.md @@ -22,15 +22,12 @@ The most common use cases for VictoriaMetrics are: * Replacement for InfluxDB and OpenTSDB, which uses lower amounts of RAM, CPU and disk; * Cost-efficient alternative for DataDog. -We are glad to announce the availability of Managed VictoriaMetrics -at AWS Marketplace - [try it right now](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc)! - -Managed VictoriaMetrics allows users running VictoriaMetrics at AWS without the need to perform typical +Managed VictoriaMetrics allows users to run Enterprise version of VictoriaMetrics, hosted on AWS, without the need to perform typical DevOps tasks such as proper configuration, monitoring, logs collection, access protection, software updates, -backups, etc. +backups, etc. [Try it right now](https://cloud.victoriametrics.com/signUp?utm_source=website&utm_campaign=docs_overview) -We run Managed VictoriaMetrics instances in our environment at AWS while providing easy-to-use endpoints -for data ingestion and querying. And the VictoriaMetrics team takes care of optimal configuration and software +We run Managed VictoriaMetrics instances in our environment on AWS and provide easy-to-use endpoints +for data ingestion and querying. The VictoriaMetrics team takes care of optimal configuration and software maintenance. Managed VictoriaMetrics comes with the following features: @@ -39,4 +36,4 @@ Managed VictoriaMetrics comes with the following features: * Every Managed VictoriaMetrics instance runs in an isolated environment, so instances cannot interfere with each other; * Managed VictoriaMetrics instance can be scaled up or scaled down in a few clicks; * Automated backups; -* Pay only for the actually used compute resources - instance type, disk and network. +* Pay only for the actually used resources - compute, storage, traffic. diff --git a/docs/managed-victoriametrics/quick_start_restore_password.png b/docs/managed-victoriametrics/quick_start_restore_password.png new file mode 100644 index 0000000000..7befb9395e Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password.png differ diff --git a/docs/managed-victoriametrics/quick_start_restore_password_email.png b/docs/managed-victoriametrics/quick_start_restore_password_email.png new file mode 100644 index 0000000000..81ff96b3ff Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password_email.png differ diff --git a/docs/managed-victoriametrics/quick_start_restore_password_email_field.png b/docs/managed-victoriametrics/quick_start_restore_password_email_field.png new file mode 100644 index 0000000000..399f38ed82 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password_email_field.png differ diff --git a/docs/managed-victoriametrics/quick_start_restore_password_message.png b/docs/managed-victoriametrics/quick_start_restore_password_message.png new file mode 100644 index 0000000000..afcc154ce0 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password_message.png differ diff --git a/docs/managed-victoriametrics/quick_start_restore_password_profile_click.png b/docs/managed-victoriametrics/quick_start_restore_password_profile_click.png new file mode 100644 index 0000000000..f9e424e677 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password_profile_click.png differ diff --git a/docs/managed-victoriametrics/quick_start_restore_password_profile_fields.png b/docs/managed-victoriametrics/quick_start_restore_password_profile_fields.png new file mode 100644 index 0000000000..b8df5f2ec8 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_restore_password_profile_fields.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup.png b/docs/managed-victoriametrics/quick_start_signup.png new file mode 100644 index 0000000000..0e0a8c8069 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_choose_google_account.png b/docs/managed-victoriametrics/quick_start_signup_choose_google_account.png new file mode 100644 index 0000000000..6e3b80c802 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_choose_google_account.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_create_account_click.png b/docs/managed-victoriametrics/quick_start_signup_create_account_click.png new file mode 100644 index 0000000000..f9b4dbfac0 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_create_account_click.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_email_confirm.png b/docs/managed-victoriametrics/quick_start_signup_email_confirm.png new file mode 100644 index 0000000000..1419fbf504 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_email_confirm.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_email_confirmed.png b/docs/managed-victoriametrics/quick_start_signup_email_confirmed.png new file mode 100644 index 0000000000..fcfbd04f36 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_email_confirmed.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_email_not_confirmed.png b/docs/managed-victoriametrics/quick_start_signup_email_not_confirmed.png new file mode 100644 index 0000000000..336386f6ba Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_email_not_confirmed.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_errors.png b/docs/managed-victoriametrics/quick_start_signup_errors.png new file mode 100644 index 0000000000..4b81f41286 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_errors.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_google_click.png b/docs/managed-victoriametrics/quick_start_signup_google_click.png new file mode 100644 index 0000000000..4185a244f3 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_google_click.png differ diff --git a/docs/managed-victoriametrics/quick_start_signup_success.png b/docs/managed-victoriametrics/quick_start_signup_success.png new file mode 100644 index 0000000000..b49ba1aa77 Binary files /dev/null and b/docs/managed-victoriametrics/quick_start_signup_success.png differ diff --git a/docs/managed-victoriametrics/quickstart.md b/docs/managed-victoriametrics/quickstart.md index b037efe9fa..b9666ffb0c 100644 --- a/docs/managed-victoriametrics/quickstart.md +++ b/docs/managed-victoriametrics/quickstart.md @@ -11,142 +11,229 @@ aliases: --- # Quick Start in Managed VictoriaMetrics - -Managed VictoriaMetrics - is a database-as-a-service platform, where users can run the VictoriaMetrics +Managed VictoriaMetrics – is a database-as-a-service platform, where users can run the VictoriaMetrics that they know and love on AWS without the need to perform typical DevOps tasks such as proper configuration, monitoring, logs collection, access protection, software updates, backups, etc. -The document covers the following topics -1. [How to register](#how-to-register) -1. [How to restore password](#how-to-restore-password) -1. [Creating deployment](#creating-deployment) -1. [Deployment access](#deployment-access) -1. [Modifying deployment](#modifying-deployment) +The document covers the following topics: +1. [Registration](#registration) +1. [Adding a payment method](#adding-a-payment-method) +1. [Restoring a password](#restoring-a-password) +1. [Creating deployments](#creating-deployments) +1. [Start writing and reading data](#start-writing-and-reading-data) +1. [Modifying an existing deployment](#modifying-an-existing-deployment) -## How to register +## Registration -Managed VictoriaMetrics id distributed via AWS Marketplace. -Please note, that initial registering is only possible via link from AWS Marketplace. -To start using the service, one should have already registered AWS account -and visit VictoriaMetrics product page. -On that page click on `View purchase option` and you will be redirected to login page or to subscribe page. +Start your registration process by visiting the [Sign Up](https://cloud.victoriametrics.com/signUp?utm_source=website&utm_campaign=docs_quickstart) page. -

- -

+There are two different methods to create an account: +1. Create an account via Google Auth service; +1. Create an account by filling in a registration form. -Then, go to the -VictoriaMetrics product page -and click `Continue to Subscribe` button: - -

- -

- -Then on product page press the `Subscribe` button: - -

- -

- -After that action you will be able to see success message where you should click `Set up your account` button: - -

- -

- -You'll be taken to Managed VictoriaMetrics sign up page: - -

- -

- -Choose to register manually or via Google Auth. - -If it was chosen manually registration, confirmation email wil be sent to your email address. - -

- -

- -After Google Auth process will redirect automatically to the main page. - -## How to restore password - -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): +### Create an account via Google Auth service: +1. Click `Continue with Google` button on the [Sign Up page](https://cloud.victoriametrics.com/signUp?utm_source=website&utm_campaign=docs_quickstart)

- + +

+1. Choose Google account you want to use for registration +

+ +

+1. You will be automatically redirected to the main page of the Managed VictoriaMetrics +

+

-1. Enter your email in the field and click `Send Email` button: - +### Create an account by filling in a registration form: +1. Fill in your email, password and password confirmation on [Sign Up page](https://cloud.victoriametrics.com/signUp?utm_source=website&utm_campaign=docs_quickstart).

- + +

+1. All fields are required. Any errors will be shown in the interface, so it is easy to understand what should be adjusted. +

+ +

+1. Press `Create account` button when all fields are filled in. +

+

-1. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account: - -

- -

- -1. Navigate to the Profile page by clicking the corresponding link at the top right corner: - -

- -

- -1. Enter new password at the Profile page and press `Save` button: - -

- -

- -## Creating deployment - -Deployments is a page where user can list and manage VictoriaMetrics deployments. -To create a deployment click on the button `Create Deployment` button or link in the message: - +You will be redirected to the main page with a notification message to confirm your email.

- +

-In the opened form, choose parameters of the new deployment such as: +You will also receive an email with a confirmation link as shown on the picture below: +

+ +

-* `Deployment type` from preset single or cluster deployments; -* `Region` where deployment should run; +It is necessary to confirm your email address. Otherwise, you won't be able to create a deployment. + +After successful confirmation of your email address, you'll be able to [create your first deployment](#creating-deployments) or [add a payment method](#adding-a-payment-method). +

+ +

+ +## Adding a payment method + +1. Navigate to a [Billing](https://cloud.victoriametrics.com/billing?utm_source=website&utm_campaign=docs_quickstart) page or click on `Upgrade` button as shown below: +

+ +

+ +1. Choose a payment method +

+ +

+ +### Pay with a card + +1. Click on an `Add card` panel and fill in all the fields in the form and press `Add card` button +

+ +

+1. An error message will appear if a card us invalid +

+ +

+1. Successfully added card will be shown on the page as follows: +

+ +

+ +### Link your AWS billing account via AWS Marketplace + +When you need to unify your AWS billing, you can start a subscription on AWS Marketplace. + +1. Click on the `Buy on AWS Marketplace` panel: +

+ +

+1. You will be redirected to the Managed VictoriaMetrics product page. +1. Click on `View purchase option` button, and you will be redirected to an AWS login page or to a subscribe page on AWS Marketplace. +

+ +

+1. Go to the Managed VictoriaMetrics product page and click `Continue to Subscribe` button: +

+ +

+1. Press the `Subscribe` button: +

+ +

+1. After that you will see a success message where you should click `Set up your account` button: +

+ +

+1. You'll be redirected back to Managed VictoriaMetrics billing page: +

+ +

+ +### Switching between payment methods + +If both payment methods are added, it is possible to easily switch between them. +Click on the radio button like on the picture below and confirm the change: + +

+ +

+ +

+ +

+ +If the payment method was changed successfully, the following message will appear: + +

+ +

+ +## Password restoration + +If you forgot your password, it can be restored in the following way: + +1. Click `Forgot password?` link on the [Sign In](https://cloud.victoriametrics.com/signIn?utm_source=website&utm_campaign=docs_quickstart) page: +

+ +

+ +1. Enter your email and click `Reset password` button: +

+ +

+ +

+ +

+ +1. Follow the instructions sent to your email in order to get access to your Managed VictoriaMetrics account: +

+ +

+ +1. Navigate to the Profile page by clicking the corresponding link in the top right corner: +

+ +

+ +1. Enter a new password on the Profile page and press `Save`: +

+ +

+ +## Creating deployments + +On the [Deployments](https://cloud.victoriametrics.com/deployments?utm_source=website&utm_campaign=docs_quickstart) page you +will see a list of your existing deployments and will be able to manage them. + +To create a deployment click on the button `Create Deployment` button: + +

+ +

+ +On the opened screen, choose parameters of your new deployment: + +* `Deployment type` + * Single - for affordable, performant single-node deployments; + * Cluster - for highly available and multi-tenant deployments; +* `Region` – AWS region where deployment will run; * Desired `storage capacity` for storing metrics (you always can expand disk size later); * `Retention` period for stored metrics. -* `Size` of your deployment +* `Size` of your deployment [based on your needs](https://docs.victoriametrics.com/guides/understand-your-setup-size.html)

- +

-When all parameters are entered, click on the `Create` button, and deployment will be created +When all parameters are configured, click on the `Create` button, and deployment will be created. Once created, deployment will remain for a short period of time in `PROVISIONING` status while the hardware spins-up, just wait for a couple of minutes and reload the page. -You'll also be notified via email once provisioning is finished: +You'll also be notified via email once your deployment is ready to use:

- +

- +

-## Deployment access +## Start writing and reading data -After transition from `PROVISIONING` to `RUNNING` state, VictoriaMetrics is fully operational -and ready to accept write or read requests. But first, click on deployment name to get the access token: +After transition from `PROVISIONING` to `RUNNING` state, Managed VictoriaMetrics deployment is fully operational +and is ready to accept write and read requests. + +Click on deployment name and navigate to the Access tab to get the access token:

- +

Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API. @@ -154,36 +241,39 @@ 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, +Follow usage examples in order to configure access to VictoriaMetrics for your Prometheus, Grafana or any other software. -## Modifying deployment +## Modifying an existing deployment -Remember, you always can add, remove or modify existing deployment by changing their size or any parameters on the -update form. +Remember, you can always add, remove or modify existing deployment by changing its size or any parameters on the +deployment's page. +It is important to know that downgrade for cluster is currently not available.

- +

- -There is another options present to customise you deployment setup. -To discover them click on `Customise` button + +To discover additional configuration options click on `Advanced Settings` button, so you should see the following:

- +

-In that section additional params can be set: +In that section, additional params can be set: -* `Deduplication` defines interval when deployment leaves a single raw sample with the biggest timestamp per each discrete interval; -* `Maintenance Window` when deployment should start upgrade process if needed; -* `Settings` allow to define different flags for the deployment. +* [`Deduplication`](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#deduplication) defines interval when deployment leaves a single raw sample with the biggest timestamp per each discrete interval; +* `Maintenance Window` when deployment should start an upgrade process if needed; +* `Settings` allow to define different flags for the deployment: -However, such an update requires a deployment restart and may result into a couple of minutes of downtime. + 1. [cluster components flags](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#list-of-command-line-flags). + 2. [single version flags](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#list-of-command-line-flags). + +Please note, such an update requires a deployment restart and may result in a short downtime for single-node deployments. diff --git a/docs/managed-victoriametrics/quickstart_deployment-access-token.png b/docs/managed-victoriametrics/quickstart_deployment-access-token.png deleted file mode 100644 index 5750603595..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_deployment-access-token.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_deployment-create.png b/docs/managed-victoriametrics/quickstart_deployment-create.png deleted file mode 100644 index 3575aeab1b..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_deployment-create.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_deployment-created.png b/docs/managed-victoriametrics/quickstart_deployment-created.png deleted file mode 100644 index 1e58b3f677..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_deployment-created.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_deployments-running.png b/docs/managed-victoriametrics/quickstart_deployments-running.png deleted file mode 100644 index d60ea7a2b4..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_deployments-running.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_password-restore-email.png b/docs/managed-victoriametrics/quickstart_password-restore-email.png deleted file mode 100644 index 370a770bd4..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_password-restore-email.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_read-token.png b/docs/managed-victoriametrics/quickstart_read-token.png deleted file mode 100644 index 7dca2c586e..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_read-token.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_restore-password-email.png b/docs/managed-victoriametrics/quickstart_restore-password-email.png deleted file mode 100644 index bac4045c93..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_restore-password-email.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_restore-password-profile.png b/docs/managed-victoriametrics/quickstart_restore-password-profile.png deleted file mode 100644 index 8cbca58ceb..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_restore-password-profile.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_restore-password-save-password.png b/docs/managed-victoriametrics/quickstart_restore-password-save-password.png deleted file mode 100644 index 3e9b23c082..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_restore-password-save-password.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_restore-password.png b/docs/managed-victoriametrics/quickstart_restore-password.png deleted file mode 100644 index 70b4fd9565..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_restore-password.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_update-deployment.png b/docs/managed-victoriametrics/quickstart_update-deployment.png deleted file mode 100644 index 8b047e98d2..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_update-deployment.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-buttons.png b/docs/managed-victoriametrics/setup-notifications-buttons.png deleted file mode 100644 index a1ef3dc31d..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-buttons.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-email-test.png b/docs/managed-victoriametrics/setup-notifications-email-test.png deleted file mode 100644 index d9e8ba5b47..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-email-test.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-emails-filled.png b/docs/managed-victoriametrics/setup-notifications-emails-filled.png deleted file mode 100644 index b0d12060d2..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-emails-filled.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-emails.png b/docs/managed-victoriametrics/setup-notifications-emails.png deleted file mode 100644 index 96ee922919..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-emails.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-save-and-test.png b/docs/managed-victoriametrics/setup-notifications-save-and-test.png deleted file mode 100644 index e3773ce45f..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-save-and-test.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-saved-successfully.png b/docs/managed-victoriametrics/setup-notifications-saved-successfully.png deleted file mode 100644 index c805934722..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-saved-successfully.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-slack-channel.png b/docs/managed-victoriametrics/setup-notifications-slack-channel.png deleted file mode 100644 index a63e36bfbe..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-slack-channel.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-slack-channels-webhook.png b/docs/managed-victoriametrics/setup-notifications-slack-channels-webhook.png deleted file mode 100644 index 6250046e39..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-slack-channels-webhook.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-slack-channels.png b/docs/managed-victoriametrics/setup-notifications-slack-channels.png deleted file mode 100644 index 305c74d40e..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-slack-channels.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications-start.png b/docs/managed-victoriametrics/setup-notifications-start.png deleted file mode 100644 index 42df62e696..0000000000 Binary files a/docs/managed-victoriametrics/setup-notifications-start.png and /dev/null differ diff --git a/docs/managed-victoriametrics/setup-notifications.md b/docs/managed-victoriametrics/setup-notifications.md index a5b04fde3b..f17b14dc5d 100644 --- a/docs/managed-victoriametrics/setup-notifications.md +++ b/docs/managed-victoriametrics/setup-notifications.md @@ -22,16 +22,17 @@ When you enter the notification section, you will be able to fill in the channel want to receive notifications

- +

## Setup Slack notifications 1. Setup Slack webhook - How to do this is indicated on the following link https://api.slack.com/messaging/webhooks + How to do this is indicated on the following link +https://api.slack.com/messaging/webhooks

- +

1. Specify Slack channels @@ -39,11 +40,11 @@ want to receive notifications Enter one or more channels into input and press enter or choose it after each input.

- +

- +

## Setup emails notifications @@ -52,11 +53,11 @@ You can specify one or multiple emails for notifications in the input field. By email notifications are enabled for the account owner

- +

- +

## Send test notification @@ -68,29 +69,25 @@ If only the emails are specified, you will receive notifications to those emails When both notifications are specified, all notifications will be sent to Slack channels and emails.

- +

If the Save button is pressed, then entered channels will be only saved, and you get a success message. -

- -

- If the Save and Test button is pressed, then all entered information will be saved, and test notifications will be sent to the entered channels

- +

Examples of the test notification messages:

- +

- +

diff --git a/docs/managed-victoriametrics/user-managment.md b/docs/managed-victoriametrics/user-managment.md index bbae30a1d8..3bd67da483 100644 --- a/docs/managed-victoriametrics/user-managment.md +++ b/docs/managed-victoriametrics/user-managment.md @@ -106,17 +106,13 @@ You assign the role to the user during the user creation procedure. You can chan It shows all users with different roles, and you can apply provided actions with them.

- +

In the table, there is additional information about the users: - - - - @@ -141,84 +137,85 @@ In the table, there is additional information about the users: ## How to Add User -Click on - - - +Click on `Invite user` button the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory.

- +

-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. +After filling out the form, click on the `Invite` 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. +To edit the user role and details, activate or deactivate a user, and click on

- +

+or `user email` 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. +To save changes, click the `Save changes` 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. +Click on `Delete` button 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

- + +

+ +## How to resend invitation + +If the invitation is expired, it is possible to resend email to the user + +Click `Resend invitation` button + +

+ +

+ +Confirm resend invitation by clicking `Resend` button in the modal dialog + +

+ +

+ +If invitation successfully resented to the user success message will appear + +

+

diff --git a/docs/managed-victoriametrics/user-managment_delete-user-button.png b/docs/managed-victoriametrics/user-managment_delete-user-button.png deleted file mode 100644 index 593c319305..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_delete-user-button.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_delete-user-confirm.png b/docs/managed-victoriametrics/user-managment_delete-user-confirm.png deleted file mode 100644 index 09734a8909..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_delete-user-confirm.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_delete-user-success.png b/docs/managed-victoriametrics/user-managment_delete-user-success.png deleted file mode 100644 index 5dfc827d7c..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_delete-user-success.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_invite-user-modal.png b/docs/managed-victoriametrics/user-managment_invite-user-modal.png deleted file mode 100644 index 5631830edb..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_invite-user-modal.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_success-invitation.png b/docs/managed-victoriametrics/user-managment_success-invitation.png deleted file mode 100644 index 8cfce34274..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_success-invitation.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_update-user-buttons.png b/docs/managed-victoriametrics/user-managment_update-user-buttons.png deleted file mode 100644 index 428b0c6d07..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_update-user-buttons.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_update-user-success.png b/docs/managed-victoriametrics/user-managment_update-user-success.png deleted file mode 100644 index 24b8ba1e75..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_update-user-success.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_update-user.png b/docs/managed-victoriametrics/user-managment_update-user.png deleted file mode 100644 index 8482101013..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_update-user.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user-managment_users-list.png b/docs/managed-victoriametrics/user-managment_users-list.png deleted file mode 100644 index acca183013..0000000000 Binary files a/docs/managed-victoriametrics/user-managment_users-list.png and /dev/null differ diff --git a/docs/managed-victoriametrics/user_management_confirm_resend_invitation.png b/docs/managed-victoriametrics/user_management_confirm_resend_invitation.png new file mode 100644 index 0000000000..a02e292e05 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_confirm_resend_invitation.png differ diff --git a/docs/managed-victoriametrics/user_management_delete_sucess.png b/docs/managed-victoriametrics/user_management_delete_sucess.png new file mode 100644 index 0000000000..dba39436a6 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_delete_sucess.png differ diff --git a/docs/managed-victoriametrics/user_management_delete_user_form.png b/docs/managed-victoriametrics/user_management_delete_user_form.png new file mode 100644 index 0000000000..3b16e5a0c1 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_delete_user_form.png differ diff --git a/docs/managed-victoriametrics/user_management_invite_success.png b/docs/managed-victoriametrics/user_management_invite_success.png new file mode 100644 index 0000000000..dc708e0e09 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_invite_success.png differ diff --git a/docs/managed-victoriametrics/user_management_invite_user.png b/docs/managed-victoriametrics/user_management_invite_user.png new file mode 100644 index 0000000000..151249e326 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_invite_user.png differ diff --git a/docs/managed-victoriametrics/user_management_list.png b/docs/managed-victoriametrics/user_management_list.png new file mode 100644 index 0000000000..24376000b9 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_list.png differ diff --git a/docs/managed-victoriametrics/user_management_resend_invitation.png b/docs/managed-victoriametrics/user_management_resend_invitation.png new file mode 100644 index 0000000000..dcb5dc0bd6 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_resend_invitation.png differ diff --git a/docs/managed-victoriametrics/user_management_resend_success.png b/docs/managed-victoriametrics/user_management_resend_success.png new file mode 100644 index 0000000000..2fae2bafd6 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_resend_success.png differ diff --git a/docs/managed-victoriametrics/user_management_update_user.png b/docs/managed-victoriametrics/user_management_update_user.png new file mode 100644 index 0000000000..fcad18b1d3 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_update_user.png differ diff --git a/docs/managed-victoriametrics/user_management_user_delete.png b/docs/managed-victoriametrics/user_management_user_delete.png new file mode 100644 index 0000000000..d26db4ac82 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_user_delete.png differ diff --git a/docs/managed-victoriametrics/user_management_user_update_form.png b/docs/managed-victoriametrics/user_management_user_update_form.png new file mode 100644 index 0000000000..1ddd1925e6 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_user_update_form.png differ diff --git a/docs/managed-victoriametrics/user_management_user_updated_success.png b/docs/managed-victoriametrics/user_management_user_updated_success.png new file mode 100644 index 0000000000..ed5e94edd8 Binary files /dev/null and b/docs/managed-victoriametrics/user_management_user_updated_success.png differ
User Name:First name and last name
Email: Registration user email