From 6199bd28a2029c65e04256f9be3c460f35032083 Mon Sep 17 00:00:00 2001 From: Denys Holius <5650611+denisgolius@users.noreply.github.com> Date: Mon, 11 Oct 2021 11:21:07 +0300 Subject: [PATCH] Added some fixes (#1690) * removed not needed description * added some fixes and fixed typos --- docs/guides/getting-started-with-vm-operator.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/guides/getting-started-with-vm-operator.md b/docs/guides/getting-started-with-vm-operator.md index e930739096..4a8ff83ee7 100644 --- a/docs/guides/getting-started-with-vm-operator.md +++ b/docs/guides/getting-started-with-vm-operator.md @@ -63,6 +63,7 @@ vmoperator-victoria-metrics-operator-67cff44cd6-s47n6 1/1 Running 0 ## 3. Install VictoriaMetrics Cluster > For this example we will use default value for `name: example-vmcluster-persistent`. Change it value up to your needs. + Run the following command to install [VictoriaMetrics Cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) via [VM Operator](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-operator):
@@ -92,14 +93,9 @@ The expected output: vmcluster.operator.victoriametrics.com/example-vmcluster-persistent created ``` -* By applying this CRD we install the [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) to the default [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) inside your cluster. +* By applying this CRD we install the [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) to the default [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) of your k8s cluster with following params: * `retentionPeriod: "12"` defines the [retention](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#retention) to 12 months. -* `replicationFactor: 2` refers to the replication factor for the ingested data, i.e. how many copies should be made among distinct `-storageNode` instances. If the replication factor is greater than one, the deduplication must be enabled on the remote storage side. -* `dedup.minScrapeInterval: 1ms` would de-duplicate data points on the same time series if they fall within the same discrete 1ms bucket. The earliest data point will be kept. In the case of equal timestamps, an arbitrary data point will be kept. See [Deduplication](https://docs.victoriametrics.com/#deduplication) . * `replicaCount: 2` creates two replicas of vmselect, vminsert and vmstorage. -* `storageDataPath: "/vm-data"` will create volume for `vmstorage` at `/vm-data` folder. -* `resources: ` configures resources for pod. See [k8s resource configuration docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers) to get more information. - Please note that it may take some time for the pods to start. To check that the pods are started, run the following command:
@@ -114,7 +110,6 @@ The expected output: NAME READY STATUS RESTARTS AGE vminsert-example-vmcluster-persistent-845849cb84-9vb6f 1/1 Running 0 5m15s vminsert-example-vmcluster-persistent-845849cb84-r7mmk 1/1 Running 0 5m15s -vmoperator-victoria-metrics-operator-67cff44cd6-s47n6 1/1 Running 0 7m16s vmselect-example-vmcluster-persistent-0 1/1 Running 0 5m21s vmselect-example-vmcluster-persistent-1 1/1 Running 0 5m21s vmstorage-example-vmcluster-persistent-0 1/1 Running 0 5m25s @@ -187,7 +182,7 @@ vmagent.operator.victoriametrics.com/example-vmagent created ``` >`remoteWrite.url` for VMAgent consists of the following parts: -> service_name + VMCLuster_namespace + svc + kubernetes_cluster_domain that in our case will look like vminsert-example-vmcluster-persistent.default.svc.cluster.local +> "service_name.VMCluster_namespace.svc.kubernetes_cluster_domain" that in our case will look like vminsert-example-vmcluster-persistent.default.svc.cluster.local Verify that `VMAgent` is up and running by executing the following command: @@ -319,5 +314,4 @@ The expected output is: ## 6. Summary * We set up Kubernetes Operator for VictoriaMetrics with using CRD. -* We collected metrics from all running services and stored them in the VictoriaMetrics database. -* We configured `dedup.minScrapeInterval` and `replicationFactor` for the VictoriaMetrics cluster for high availability purposes. \ No newline at end of file +* We collected metrics from all running services and stored them in the VictoriaMetrics database. \ No newline at end of file