Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-01-20 07:19:17 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs/Cluster-VictoriaMetrics.md: use 1. instead of N. in numbered bullets, so they are automatically adjusted by Github Markdown engine

Browse Source 
See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
This commit is contained in:
Aliaksandr Valialkin 2023-07-26 14:11:28 -07:00
parent da61f5dd34
commit 98676a5223
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -130,7 +130,7 @@ vmstorage-prod
### Development Builds ### Development Builds
1. [Install go](https://golang.org/doc/install). The minimum supported version is Go 1.18. 1. [Install go](https://golang.org/doc/install). The minimum supported version is Go 1.18.
2. Run `make` from [the repository root](https://github.com/VictoriaMetrics/VictoriaMetrics). It should build `vmstorage`, `vmselect` 1. Run `make` from [the repository root](https://github.com/VictoriaMetrics/VictoriaMetrics). It should build `vmstorage`, `vmselect`
and `vminsert` binaries and put them into the `bin` folder. and `vminsert` binaries and put them into the `bin` folder.
### Building docker images ### Building docker images
@ -412,8 +412,8 @@ General recommendations for cluster scalability:
Steps to add `vmstorage` node: Steps to add `vmstorage` node:
1. Start new `vmstorage` node with the same `-retentionPeriod` as existing nodes in the cluster. 1. Start new `vmstorage` node with the same `-retentionPeriod` as existing nodes in the cluster.
2. Gradually restart all the `vmselect` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`. 1. Gradually restart all the `vmselect` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
3. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`. 1. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
## Updating / reconfiguring cluster nodes ## Updating / reconfiguring cluster nodes
@ -430,8 +430,8 @@ Gracefully restart every node in the cluster one-by-one with the updated config
It is recommended restarting the nodes in the following order: It is recommended restarting the nodes in the following order:
1. Restart `vmstorage` nodes. 1. Restart `vmstorage` nodes.
2. Restart `vminsert` nodes. 1. Restart `vminsert` nodes.
3. Restart `vmselect` nodes. 1. Restart `vmselect` nodes.
This strategy allows upgrading the cluster without downtime if the following conditions are met: This strategy allows upgrading the cluster without downtime if the following conditions are met:
@ -450,8 +450,8 @@ This strategy allows upgrading the cluster without downtime if the following con
### Minimum downtime strategy ### Minimum downtime strategy
1. Gracefully stop all the `vminsert` and `vmselect` nodes in parallel. 1. Gracefully stop all the `vminsert` and `vmselect` nodes in parallel.
2. Gracefully restart all the `vmstorage` nodes in parallel. 1. Gracefully restart all the `vmstorage` nodes in parallel.
3. Start all the `vminsert` and `vmselect` nodes in parallel. 1. Start all the `vminsert` and `vmselect` nodes in parallel.
The cluster is unavailable for data ingestion and querying when performing the steps above. The cluster is unavailable for data ingestion and querying when performing the steps above.
The downtime is minimized by restarting cluster nodes in parallel at every step above. The downtime is minimized by restarting cluster nodes in parallel at every step above.
@ -681,17 +681,17 @@ for protecting from user errors such as accidental data deletion.
The following steps must be performed for each `vmstorage` node for creating a backup: The following steps must be performed for each `vmstorage` node for creating a backup:
1. Create an instant snapshot by navigating to `/snapshot/create` HTTP handler. It will create snapshot and return its name. 1. Create an instant snapshot by navigating to `/snapshot/create` HTTP handler. It will create snapshot and return its name.
2. Archive the created snapshot from `<-storageDataPath>/snapshots/<snapshot_name>` folder using [vmbackup](https://docs.victoriametrics.com/vmbackup.html). 1. Archive the created snapshot from `<-storageDataPath>/snapshots/<snapshot_name>` folder using [vmbackup](https://docs.victoriametrics.com/vmbackup.html).
The archival process doesn't interfere with `vmstorage` work, so it may be performed at any suitable time. The archival process doesn't interfere with `vmstorage` work, so it may be performed at any suitable time.
3. Delete unused snapshots via `/snapshot/delete?snapshot=<snapshot_name>` or `/snapshot/delete_all` in order to free up occupied storage space. 1. Delete unused snapshots via `/snapshot/delete?snapshot=<snapshot_name>` or `/snapshot/delete_all` in order to free up occupied storage space.
There is no need in synchronizing backups among all the `vmstorage` nodes. There is no need in synchronizing backups among all the `vmstorage` nodes.
Restoring from backup: Restoring from backup:
1. Stop `vmstorage` node with `kill -INT`. 1. Stop `vmstorage` node with `kill -INT`.
2. Restore data from backup using [vmrestore](https://docs.victoriametrics.com/vmrestore.html) into `-storageDataPath` directory. 1. Restore data from backup using [vmrestore](https://docs.victoriametrics.com/vmrestore.html) into `-storageDataPath` directory.
3. Start `vmstorage` node. 1. Start `vmstorage` node.
## Retention filters ## Retention filters

22
docs/Cluster-VictoriaMetrics.md
View File

@ -141,7 +141,7 @@ vmstorage-prod
### Development Builds ### Development Builds
1. [Install go](https://golang.org/doc/install). The minimum supported version is Go 1.18. 1. [Install go](https://golang.org/doc/install). The minimum supported version is Go 1.18.
2. Run `make` from [the repository root](https://github.com/VictoriaMetrics/VictoriaMetrics). It should build `vmstorage`, `vmselect` 1. Run `make` from [the repository root](https://github.com/VictoriaMetrics/VictoriaMetrics). It should build `vmstorage`, `vmselect`
and `vminsert` binaries and put them into the `bin` folder. and `vminsert` binaries and put them into the `bin` folder.
### Building docker images ### Building docker images
@ -423,8 +423,8 @@ General recommendations for cluster scalability:
Steps to add `vmstorage` node: Steps to add `vmstorage` node:
1. Start new `vmstorage` node with the same `-retentionPeriod` as existing nodes in the cluster. 1. Start new `vmstorage` node with the same `-retentionPeriod` as existing nodes in the cluster.
2. Gradually restart all the `vmselect` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`. 1. Gradually restart all the `vmselect` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
3. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`. 1. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `<new_vmstorage_host>`.
## Updating / reconfiguring cluster nodes ## Updating / reconfiguring cluster nodes
@ -441,8 +441,8 @@ Gracefully restart every node in the cluster one-by-one with the updated config
It is recommended restarting the nodes in the following order: It is recommended restarting the nodes in the following order:
1. Restart `vmstorage` nodes. 1. Restart `vmstorage` nodes.
2. Restart `vminsert` nodes. 1. Restart `vminsert` nodes.
3. Restart `vmselect` nodes. 1. Restart `vmselect` nodes.
This strategy allows upgrading the cluster without downtime if the following conditions are met: This strategy allows upgrading the cluster without downtime if the following conditions are met:
@ -461,8 +461,8 @@ This strategy allows upgrading the cluster without downtime if the following con
### Minimum downtime strategy ### Minimum downtime strategy
1. Gracefully stop all the `vminsert` and `vmselect` nodes in parallel. 1. Gracefully stop all the `vminsert` and `vmselect` nodes in parallel.
2. Gracefully restart all the `vmstorage` nodes in parallel. 1. Gracefully restart all the `vmstorage` nodes in parallel.
3. Start all the `vminsert` and `vmselect` nodes in parallel. 1. Start all the `vminsert` and `vmselect` nodes in parallel.
The cluster is unavailable for data ingestion and querying when performing the steps above. The cluster is unavailable for data ingestion and querying when performing the steps above.
The downtime is minimized by restarting cluster nodes in parallel at every step above. The downtime is minimized by restarting cluster nodes in parallel at every step above.
@ -692,17 +692,17 @@ for protecting from user errors such as accidental data deletion.
The following steps must be performed for each `vmstorage` node for creating a backup: The following steps must be performed for each `vmstorage` node for creating a backup:
1. Create an instant snapshot by navigating to `/snapshot/create` HTTP handler. It will create snapshot and return its name. 1. Create an instant snapshot by navigating to `/snapshot/create` HTTP handler. It will create snapshot and return its name.
2. Archive the created snapshot from `<-storageDataPath>/snapshots/<snapshot_name>` folder using [vmbackup](https://docs.victoriametrics.com/vmbackup.html). 1. Archive the created snapshot from `<-storageDataPath>/snapshots/<snapshot_name>` folder using [vmbackup](https://docs.victoriametrics.com/vmbackup.html).
The archival process doesn't interfere with `vmstorage` work, so it may be performed at any suitable time. The archival process doesn't interfere with `vmstorage` work, so it may be performed at any suitable time.
3. Delete unused snapshots via `/snapshot/delete?snapshot=<snapshot_name>` or `/snapshot/delete_all` in order to free up occupied storage space. 1. Delete unused snapshots via `/snapshot/delete?snapshot=<snapshot_name>` or `/snapshot/delete_all` in order to free up occupied storage space.
There is no need in synchronizing backups among all the `vmstorage` nodes. There is no need in synchronizing backups among all the `vmstorage` nodes.
Restoring from backup: Restoring from backup:
1. Stop `vmstorage` node with `kill -INT`. 1. Stop `vmstorage` node with `kill -INT`.
2. Restore data from backup using [vmrestore](https://docs.victoriametrics.com/vmrestore.html) into `-storageDataPath` directory. 1. Restore data from backup using [vmrestore](https://docs.victoriametrics.com/vmrestore.html) into `-storageDataPath` directory.
3. Start `vmstorage` node. 1. Start `vmstorage` node.
## Retention filters ## Retention filters