app/vmctl: update managed quickstart guide

This commit is contained in:
dmitryk-dk 2023-03-14 15:41:14 +02:00 committed by Aliaksandr Valialkin
parent 5375e789fd
commit e1c2c91bb6
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
22 changed files with 82 additions and 37 deletions

View file

@ -7,46 +7,67 @@ menu:
parent: "managed"
weight: 2
---
# Quick Start
# Quick Start in Managed 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)
2. [How to restore password](#how-to-restore-password)
3. [Creating instance](#creating-instance)
4. [Instance access](#instance-access)
5. [Modifying instance](#modifying-instance)
## How to register
Managed VictoriaMetrics id distributed via [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc).
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 [VictoriaMetrics product page](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc).
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.
### Amazon Web Services
<p>
<img src="quickstart_aws-purchase-click.png" width="800">
</p>
Managed VictoriaMetrics id distributed via <a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc">AWS Marketplace</a>.
To start using the service, one should have already registered AWS account. Then, go to the
Then, go to the
<a href="https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc">VictoriaMetrics product page</a>
and click "Continue to Subscribe" button:
and click `Continue to Subscribe` button:
<p>
<img src="quickstart_continue-subscribe.png" width="800">
</p>
Then on product page press the "Subscribe" button:
Then on product page press the `Subscribe` button:
<p>
<img src="quickstart_subscribe.png" width="800">
</p>
You'll be taken to <a href="https://dbaas.victoriametrics.com/signIn">Managed VictoriaMetrics auth page</a>:
After that action you will be able to see success message where you should click `Set up your account` button:
<p>
<img src="quickstart_signin.png" width="800">
<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.
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>.
If it was chosen manually registration, confirmation email wil be sent to your email address.
See what to do after registering in Quick Start guide.
<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
@ -66,15 +87,9 @@ If you forgot password, it can be restored in the following way:
3. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account:
```
Victoria Metrics Cloud password restore
Follow https://dbaas.victoriametrics.com/login_by_link/{id} the link in order to restore access to Victoria Metrics Cloud.
Access link expires once you login successfully or after 30min.
You can change your password after login https://dbaas.victoriametrics.com/profile profile
Please, ignore this email if you didn't init this action on Victoria Metrics Cloud.
In case of questions contact our support support@victoriametrics.com
```
<p>
<img src="quickstart_password-restore-email.png" width="800">
</p>
4. Navigate to the Profile page by clicking the corresponding link at the top right corner:
@ -91,39 +106,46 @@ In case of questions contact our support support@victoriametrics.com
## Creating instance
Instances is a page where user can list and manage VictoriaMetrics single-node instances.
To create an instance click on the button `Create`:
Deployments is a page where user can list and manage VictoriaMetrics deployments.
To create an instance click on the button `Create Deployments` button or link in the message:
<p>
<img src="quickstart_instances.png" width="800">
<img src="quickstart_deployments.png" width="800">
</p>
In the opened form, choose parameters of the new instance such as:
* `Instance type` from preset of AWS instances (you always can change the type later);
* `Region` and `Zone` where instance should run;
* Desired `disk size` for storing metrics (you always can expand disk size later);
* `Deployment type` from preset single or cluster deployments;
* `Region` where deployment should run;
* Desired `storage capacity` for storing metrics (you always can expand disk size later);
* `Retention` period for stored metrics.
* `Size` of your deployment
<p>
<img src="quickstart_instance-create.png" width="800">
<img src="quickstart_deployment-create.png" width="800">
</p>
Once created, instance will remain for a short period of time in `PROVISIONING` status
When all parameters are entered, 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:
<p>
<img src="quickstart_instance-provisioning.png" width="800">
<img src="quickstart_deployment-created.png" width="800">
</p>
## Access
<p>
<img src="quickstart_deployments-running.png" width="800">
</p>
## Instance access
After transition from `PROVISIONING` to `RUNNING` state, VictoriaMetrics is fully operational
and ready to accept write or read requests. But first, click on instance name to get the access token:
and ready to accept write or read requests. But first, click on deployment name to get the access token:
<p>
<img src="quickstart_tokens.png" width="800">
<img src="quickstart_deployment-access-token.png" width="800">
</p>
Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API.
@ -131,13 +153,36 @@ Supported token types are `Read-Only`, `Write-Only` and `Read-Write`. Click on t
to see usage examples:
<p>
<img src="quickstart_token-usage.png" width="800">
<img src="quickstart_read-token.png" width="800">
</p>
<p>
<img src="quickstart_write-token.png" width="800">
</p>
Follow usage example in order to configure access to VictoriaMetrics for your Prometheus,
Grafana or any other software.
## Modifying
## Modifying instance
Remember, you always can add, remove or modify existing instances by changing their type or increasing the disk space.
However, such an update requires an instance restart and may result into a couple of minutes of downtime.
Remember, you always can add, remove or modify existing deployment by changing their size or any parameters on the
update form.
<p>
<img src="quickstart_update-deployment.png" width="800">
</p>
There is another options present to customise you deployment setup.
To discover them click on `Customise` button
<p>
<img src="quickstart_customise-deployment.png" width="800">
</p>
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.
However, such an update requires an deployment restart and may result into a couple of minutes of downtime.

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 810 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 496 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 729 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 558 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 542 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 478 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 296 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 568 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 228 KiB

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 426 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 256 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 533 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB