diff --git a/docs/managed-victoriametrics/quickstart.md b/docs/managed-victoriametrics/quickstart.md index 3d51ae8533..c000cd6950 100644 --- a/docs/managed-victoriametrics/quickstart.md +++ b/docs/managed-victoriametrics/quickstart.md @@ -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 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](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc). +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. -### Amazon Web Services +

+ +

-Managed VictoriaMetrics id distributed via AWS Marketplace. -To start using the service, one should have already registered AWS account. Then, go to the +Then, go to the VictoriaMetrics product page -and click "Continue to Subscribe" button: +and click `Continue to Subscribe` button:

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

-You'll be taken to Managed VictoriaMetrics auth page: +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. -Please note, that initial registering is only possible via link from AWS Marketplace. +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. +

+ +

+ +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 -``` +

+ +

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:

- +

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

- +

-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:

- +

-## Access +

+ +

+ +## 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:

- +

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:

- + +

+ +

+

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

+ +

+ +There is another options present to customise you deployment setup. +To discover them click on `Customise` button + +

+ +

+ +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. diff --git a/docs/managed-victoriametrics/quickstart_aws-purchase-click.png b/docs/managed-victoriametrics/quickstart_aws-purchase-click.png new file mode 100644 index 0000000000..b490e52999 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_aws-purchase-click.png differ diff --git a/docs/managed-victoriametrics/quickstart_continue-subscribe.png b/docs/managed-victoriametrics/quickstart_continue-subscribe.png index f2bd6638b5..fc9eb249d1 100644 Binary files a/docs/managed-victoriametrics/quickstart_continue-subscribe.png and b/docs/managed-victoriametrics/quickstart_continue-subscribe.png differ diff --git a/docs/managed-victoriametrics/quickstart_customise-deployment.png b/docs/managed-victoriametrics/quickstart_customise-deployment.png new file mode 100644 index 0000000000..21a4450b2e Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_customise-deployment.png differ diff --git a/docs/managed-victoriametrics/quickstart_deployment-access-token.png b/docs/managed-victoriametrics/quickstart_deployment-access-token.png new file mode 100644 index 0000000000..5750603595 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_deployment-access-token.png differ diff --git a/docs/managed-victoriametrics/quickstart_deployment-create.png b/docs/managed-victoriametrics/quickstart_deployment-create.png new file mode 100644 index 0000000000..3575aeab1b Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_deployment-create.png differ diff --git a/docs/managed-victoriametrics/quickstart_deployment-created.png b/docs/managed-victoriametrics/quickstart_deployment-created.png new file mode 100644 index 0000000000..1e58b3f677 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_deployment-created.png differ diff --git a/docs/managed-victoriametrics/quickstart_deployments-running.png b/docs/managed-victoriametrics/quickstart_deployments-running.png new file mode 100644 index 0000000000..d60ea7a2b4 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_deployments-running.png differ diff --git a/docs/managed-victoriametrics/quickstart_deployments.png b/docs/managed-victoriametrics/quickstart_deployments.png new file mode 100644 index 0000000000..68099b9944 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_deployments.png differ diff --git a/docs/managed-victoriametrics/quickstart_email-confirm.png b/docs/managed-victoriametrics/quickstart_email-confirm.png new file mode 100644 index 0000000000..7b415ca4d9 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_email-confirm.png differ diff --git a/docs/managed-victoriametrics/quickstart_instance-create.png b/docs/managed-victoriametrics/quickstart_instance-create.png deleted file mode 100644 index 3afb68288b..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_instance-create.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_instance-provisioning.png b/docs/managed-victoriametrics/quickstart_instance-provisioning.png deleted file mode 100644 index f05c961051..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_instance-provisioning.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_instances.png b/docs/managed-victoriametrics/quickstart_instances.png deleted file mode 100644 index 3af5ab20e7..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_instances.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 new file mode 100644 index 0000000000..370a770bd4 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_password-restore-email.png differ diff --git a/docs/managed-victoriametrics/quickstart_read-token.png b/docs/managed-victoriametrics/quickstart_read-token.png new file mode 100644 index 0000000000..7dca2c586e Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_read-token.png differ diff --git a/docs/managed-victoriametrics/quickstart_setup-your-account.png b/docs/managed-victoriametrics/quickstart_setup-your-account.png new file mode 100644 index 0000000000..dc19b95a9f Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_setup-your-account.png differ diff --git a/docs/managed-victoriametrics/quickstart_signup-page.png b/docs/managed-victoriametrics/quickstart_signup-page.png new file mode 100644 index 0000000000..8f6c7d1bee Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_signup-page.png differ diff --git a/docs/managed-victoriametrics/quickstart_subscribe.png b/docs/managed-victoriametrics/quickstart_subscribe.png index 6405bbf24e..f96c26b429 100644 Binary files a/docs/managed-victoriametrics/quickstart_subscribe.png and b/docs/managed-victoriametrics/quickstart_subscribe.png differ diff --git a/docs/managed-victoriametrics/quickstart_token-usage.png b/docs/managed-victoriametrics/quickstart_token-usage.png deleted file mode 100644 index 3ba2e5543e..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_token-usage.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_tokens.png b/docs/managed-victoriametrics/quickstart_tokens.png deleted file mode 100644 index 8629263152..0000000000 Binary files a/docs/managed-victoriametrics/quickstart_tokens.png and /dev/null differ diff --git a/docs/managed-victoriametrics/quickstart_update-deployment.png b/docs/managed-victoriametrics/quickstart_update-deployment.png new file mode 100644 index 0000000000..8b047e98d2 Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_update-deployment.png differ diff --git a/docs/managed-victoriametrics/quickstart_write-token.png b/docs/managed-victoriametrics/quickstart_write-token.png new file mode 100644 index 0000000000..26ed937c3e Binary files /dev/null and b/docs/managed-victoriametrics/quickstart_write-token.png differ