docs/managed-victoriametrics: update documentation (#5135)

Co-authored-by: Ivan Yatskevich <ivan@yatskevich.com>
This commit is contained in:
Dmytro Kozlov 2023-10-10 13:48:22 +02:00 committed by Aliaksandr Valialkin
parent 8b2c30c51b
commit d0df4f7c7f
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
105 changed files with 281 additions and 204 deletions

View file

@ -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/)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 345 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 388 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 268 KiB

After

Width:  |  Height:  |  Size: 219 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 248 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 340 KiB

View file

@ -55,14 +55,14 @@ For instructions on how to create tokens, please refer to this section of the [d
#### Single-Node
<img src="alerting-vmalert-managed-victoria-metrics-single-1.png">
<img src="alerting-vmalert-managed-victoria-metrics-single-2.png">
<img src="alerting_token_created_single.png">
<img src="alerting_copy_datasource_single.png">
#### Cluster
<img src="alerting-vmalert-managed-victoria-metrics-cluster-1.png">
<img src="alerting-vmalert-managed-victoria-metrics-cluster-2.png">
<img src="alerting-vmalert-managed-victoria-metrics-cluster-3.png">
<img src="alerting_token_created_cluster.png">
<img src="alerting_copy_reading_datasource_cluster.png">
<img src="alerting_copy_writing_datasource_cluster.png">
### 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 <<EOF | helm install vmalert vm/victoria-metrics-alert -f -
@ -129,7 +129,7 @@ EOF
##### VMalert CRD for vmoperator
```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 << EOF | kubectl apply -f -
@ -174,7 +174,7 @@ EOF
You can ingest metric that will raise an alert
```console
export TOKEN=81e8226e-4e25-480d-9397-31ba4007f0bf
export TOKEN=81e8226e-****-****-****-*************
export MANAGED_VM_URL=https://gw-c15-1c.cloud.victoriametrics.com/
curl -H "Authorization: Bearer $TOKEN" -X POST "$MANAGED_VM_URLapi/v1/import/prometheus" -d 'up{job="vmalert-test", instance="localhost"} 0'
```
@ -184,7 +184,7 @@ curl -H "Authorization: Bearer $TOKEN" -X POST "$MANAGED_VM_URLapi/v1/import/pro
##### Binary
```console
export TOKEN=76bc5470-d340-4e5e-9574-49ed30911cc4
export TOKEN=76bc5470-****-****-****-************
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
export MANAGED_VM_WRITE_URL=https://gw-c15-1a.cloud.victoriametrics.com/insert/0/prometheus/
export ALERTMANAGER_URL=http://localhost:9093
@ -194,7 +194,7 @@ export ALERTMANAGER_URL=http://localhost:9093
##### Docker
```console
export TOKEN=76bc5470-d340-4e5e-9574-49ed30911cc4
export TOKEN=76bc5470-****-****-****-************
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
export MANAGED_VM_WRITE_URL=https://gw-c15-1a.cloud.victoriametrics.com/insert/0/prometheus/
export ALERTMANAGER_URL=http://alertmanager:9093
@ -204,7 +204,7 @@ docker run -it -p 8080:8080 -v $(pwd)/alerts.yml:/etc/alerts/alerts.yml victoria
##### Helm Chart
```console
export TOKEN=76bc5470-d340-4e5e-9574-49ed30911cc4
export TOKEN=76bc5470-****-****-****-************
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
export MANAGED_VM_WRITE_URL=https://gw-c15-1a.cloud.victoriametrics.com/insert/0/prometheus/
export ALERTMANAGER=http://alertmanager:9093
@ -245,7 +245,7 @@ EOF
##### VMalert CRD for vmoperator
```console
export TOKEN=76bc5470-d340-4e5e-9574-49ed30911cc4
export TOKEN=76bc5470-****-****-****-************
export MANAGED_VM_READ_URL=https://gw-c15-1a.cloud.victoriametrics.com/select/0/prometheus/
export MANAGED_VM_WRITE_URL=https://gw-c15-1a.cloud.victoriametrics.com/insert/0/prometheus/
export ALERTMANAGER=http://alertmanager:9093
@ -291,7 +291,7 @@ EOF
You can ingest metric that will raise an alert
```console
export TOKEN=76bc5470-d340-4e5e-9574-49ed30911cc4
export TOKEN=76bc5470-****-****-****-************
export MANAGED_VM_WRITE_URL=https://gw-c15-1a.cloud.victoriametrics.com/insert/0/prometheus/
curl -H "Authorization: Bearer $TOKEN" -X POST "$MANAGED_VM_WRITE_URLapi/v1/import/prometheus" -d 'up{job="vmalert-test", instance="localhost"} 0'
```
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 283 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 213 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 892 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 638 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 764 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

View file

@ -46,7 +46,7 @@ Install the Helm chart in a custom namespace
```
</div>
You can find your access token on the "Access" tab of your deployment
<img src="how-to-monitor-k8s_access-token.png" width="800">
<img src="kubernetes_monitoring.png" width="800">
1. Set up a Helm repository using the following commands:
<div class="with-copy" markdown="1">
```bash

Binary file not shown.

Before

Width:  |  Height:  |  Size: 949 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 880 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 762 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 784 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 424 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

View file

Before

Width:  |  Height:  |  Size: 253 KiB

After

Width:  |  Height:  |  Size: 253 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

View file

@ -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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 507 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 582 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 230 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 213 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 149 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 840 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 277 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 221 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

View file

@ -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 <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc" target="_blank">AWS Marketplace</a>.
Please note, that initial registering is only possible via link from <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc" target="_blank">AWS Marketplace</a>.
To start using the service, one should have already registered AWS account
and visit <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc" target="_blank">VictoriaMetrics product page</a>.
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.
<p>
<img src="quickstart_aws-purchase-click.png" width="800">
</p>
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
<a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc">VictoriaMetrics product page</a>
and click `Continue to Subscribe` button:
<p>
<img src="quickstart_continue-subscribe.png" width="800">
</p>
Then on product page press the `Subscribe` button:
<p>
<img src="quickstart_subscribe.png" width="800">
</p>
After that action you will be able to see success message where you should click `Set up your account` button:
<p>
<img src="quickstart_setup-your-account.png" width="800">
</p>
You'll be taken to <a href="https://dbaas.victoriametrics.com//signUp">Managed VictoriaMetrics sign up page</a>:
<p>
<img src="quickstart_signup-page.png" width="800">
</p>
Choose to register manually or via Google Auth.
If it was chosen manually registration, confirmation email wil be sent to your email address.
<p>
<img src="quickstart_email-confirm.png" width="800">
</p>
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)
<p>
<img src="quickstart_restore-password.png" width="800">
<img src="quick_start_signup_google_click.png" width="800">
</p>
1. Choose Google account you want to use for registration
<p>
<img src="quick_start_signup_choose_google_account.png" width="800">
</p>
1. You will be automatically redirected to the main page of the Managed VictoriaMetrics
<p>
<img src="quick_start_signup_success.png" width="800">
</p>
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).
<p>
<img src="quickstart_restore-password-email.png" width="800">
<img src="quick_start_signup.png" width="800">
</p>
1. All fields are required. Any errors will be shown in the interface, so it is easy to understand what should be adjusted.
<p>
<img src="quick_start_signup_errors.png" width="800">
</p>
1. Press `Create account` button when all fields are filled in.
<p>
<img src="quick_start_signup_create_account_click.png" width="800">
</p>
1. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account:
<p>
<img src="quickstart_password-restore-email.png" width="800">
</p>
1. Navigate to the Profile page by clicking the corresponding link at the top right corner:
<p>
<img src="quickstart_restore-password-profile.png" width="800">
</p>
1. Enter new password at the Profile page and press `Save` button:
<p>
<img src="quickstart_restore-password-save-password.png" width="800">
</p>
## 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.
<p>
<img src="quickstart_deployments.png" width="800">
<img src="quick_start_signup_success.png" width="800">
</p>
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:
<p>
<img src="quick_start_signup_email_confirm.png" width="800">
</p>
* `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).
<p>
<img src="quick_start_signup_email_confirmed.png" width="800">
</p>
## 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:
<p>
<img src="how_to_add_payment_method_upgrade.png" width="800">
</p>
1. Choose a payment method
<p>
<img src="how_to_add_payment_method_choose_method.png" width="800">
</p>
### 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
<p>
<img src="how_to_add_payment_method_add_card.png" width="800">
</p>
1. An error message will appear if a card us invalid
<p>
<img src="how_to_add_payment_method_invalid_card.png" width="800">
</p>
1. Successfully added card will be shown on the page as follows:
<p>
<img src="how_to_add_payment_method_card_added.png" width="800">
</p>
### 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:
<p>
<img src="how_to_add_payment_method_aws_click.png" width="800">
</p>
1. You will be redirected to the <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc" target="_blank">Managed VictoriaMetrics</a> 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.
<p>
<img src="quickstart_aws-purchase-click.png" width="800">
</p>
1. Go to the <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc">Managed VictoriaMetrics</a> product page and click `Continue to Subscribe` button:
<p>
<img src="quickstart_continue-subscribe.png" width="800">
</p>
1. Press the `Subscribe` button:
<p>
<img src="quickstart_subscribe.png" width="800">
</p>
1. After that you will see a success message where you should click `Set up your account` button:
<p>
<img src="quickstart_setup-your-account.png" width="800">
</p>
1. You'll be redirected back to Managed VictoriaMetrics <a href="https://cloud.victoriametrics.com/billing?utm_source=website&utm_campaign=docs_quickstart" target="_blank">billing page</a>:
<p>
<img src="how_to_add_payment_method_aws_finish.png" width="800">
</p>
### 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:
<p>
<img src="change_payment_method.png" width="800">
</p>
<p>
<img src="change_payment_confirmation.png" width="800">
</p>
If the payment method was changed successfully, the following message will appear:
<p>
<img src="change_payment_method_success.png" width="800">
</p>
## 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:
<p>
<img src="quick_start_restore_password.png" width="800">
</p>
1. Enter your email and click `Reset password` button:
<p>
<img src="quick_start_restore_password_email_field.png" width="800">
</p>
<p>
<img src="quick_start_restore_password_message.png" width="800">
</p>
1. Follow the instructions sent to your email in order to get access to your Managed VictoriaMetrics account:
<p>
<img src="quick_start_restore_password_email.png" width="800">
</p>
1. Navigate to the Profile page by clicking the corresponding link in the top right corner:
<p>
<img src="quick_start_restore_password_profile_click.png" width="800">
</p>
1. Enter a new password on the Profile page and press `Save`:
<p>
<img src="quick_start_restore_password_profile_fields.png" width="800">
</p>
## 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:
<p>
<img src="create_deployment_start.png" width="800">
</p>
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)
<p>
<img src="quickstart_deployment-create.png" width="800">
<img src="create_deployment_form.png" width="800">
</p>
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:
<p>
<img src="quickstart_deployment-created.png" width="800">
<img src="create_deployment_created.png" width="800">
</p>
<p>
<img src="quickstart_deployments-running.png" width="800">
<img src="create_deployment_active_email.png" width="800">
</p>
## 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:
<p>
<img src="quickstart_deployment-access-token.png" width="800">
<img src="deployment_access.png" width="800">
</p>
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:
<p>
<img src="quickstart_read-token.png" width="800">
<img src="deployment_access_write_example.png" width="800">
</p>
<p>
<img src="quickstart_write-token.png" width="800">
<img src="deployment_access_read_example.png" width="800">
</p>
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.
<p>
<img src="quickstart_update-deployment.png" width="800">
<img src="modify_deployment.png" width="800">
</p>
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:
<p>
<img src="quickstart_customise-deployment.png" width="800">
<img src="modify_deployment_additional_settings.png" width="800">
</p>
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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 496 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 729 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 558 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 568 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 533 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 503 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 375 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 372 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

View file

@ -22,16 +22,17 @@ When you enter the notification section, you will be able to fill in the channel
want to receive notifications
<p>
<img src="setup-notifications-start.png" width="800">
<img src="notifications_view.png" width="800">
</p>
## 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
<a href="https://api.slack.com/messaging/webhooks" target="_blank">https://api.slack.com/messaging/webhooks</a>
<p>
<img src="setup-notifications-slack-channels-webhook.png" width="800">
<img src="notifications_view.png" width="800">
</p>
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.
<p>
<img src="setup-notifications-slack-channel.png" width="800">
<img src="notifications_setup_slack.png" width="800">
</p>
<p>
<img src="setup-notifications-slack-channels.png" width="800">
<img src="notifications_setup_slack_enter_channel.png" width="800">
</p>
## 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
<p>
<img src="setup-notifications-emails.png" width="800">
<img src="notifications_setup_emails.png" width="800">
</p>
<p>
<img src="setup-notifications-emails-filled.png" width="800">
<img src="notifications_setup_emails_input.png" width="800">
</p>
## 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.
<p>
<img src="setup-notifications-buttons.png" width="800">
<img src="notifications_save_and_test.png" width="800">
</p>
If the Save button is pressed, then entered channels will be only saved, and you get a success message.
<p>
<img src="setup-notifications-saved-successfully.png" width="800">
</p>
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
<p>
<img src="setup-notifications-save-and-test.png" width="800">
<img src="notifications_save_success.png" width="800">
</p>
Examples of the test notification messages:
<p>
<img src="setup-notifications-slack-test.png" width="800">
<img src="notifications_slack_test.png" width="800">
</p>
<p>
<img src="setup-notifications-email-test.png" width="800">
<img src="notifications_email_test.png" width="800">
</p>

View file

@ -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.
<p>
<img src="user-managment_users-list.png" width="800">
<img src="user_management_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>
@ -141,84 +137,85 @@ In the table, there is additional information about the users:
## How to Add User
<span>Click on</span>
<span>
<img src="user-managment_invite-user-button.png" width="100" height="50">
</span>
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.
<p>
<img src="user-managment_invite-user-modal.png" width="800">
<img src="user_management_invite_user.png" width="800">
</p>
<span>After filling out the form, click on the</span>
<span>
<img src="user-managment_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.
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.
<p>
<img src="user-managment_success-invitation.png" width="800">
<img src="user_management_invite_success.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="user-managment_edit-user-btn.png" width="70" height="70">
</span>
<span>or</span>
<span>
<img src="user-managment_edit-user-link.png" width="100" height="70">
</span>
to edit the user.
To edit the user role and details, activate or deactivate a user, and click on
<p>
<img src="user-managment_update-user-buttons.png" width="800">
<img src="user_management_update_user.png" width="800">
</p>
or `user email` to edit the user.
User editing form:
<p>
<img src="user-managment_update-user.png" width="800">
<img src="user_management_user_update_form.png" width="800">
</p>
<span>To save changes, click the</span>
<span>
<img src="user-managment_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.
To save changes, click the `Save changes` button. If changes are saved successfully, you will see a message at the top of the page.
<p>
<img src="user-managment_update-user-success.png" width="800">
<img src="user_management_user_updated_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="user-managment_delete-user-btn.png" width="40" height="40">
</span>
to delete the user.
Click on `Delete` button to delete the user.
<p>
<img src="user-managment_delete-user-button.png" width="800">
<img src="user_management_user_delete.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="user-managment_delete-user-confirm.png" width="800">
<img src="user_management_delete_user_form.png" width="800">
</p>
You will be redirected to the main page with a success or error message
<p>
<img src="user-managment_delete-user-success.png" width="800">
<img src="user_management_delete_sucess.png" width="800">
</p>
## How to resend invitation
If the invitation is expired, it is possible to resend email to the user
Click `Resend invitation` button
<p>
<img src="user_management_resend_invitation.png" width="800">
</p>
Confirm resend invitation by clicking `Resend` button in the modal dialog
<p>
<img src="user_management_confirm_resend_invitation.png" width="800">
</p>
If invitation successfully resented to the user success message will appear
<p>
<img src="user_management_resend_success.png" width="800">
</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 289 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 301 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 329 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 281 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 297 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 307 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 684 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 756 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 498 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 580 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 842 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Some files were not shown because too many files have changed in this diff Show more