Skip to content

Commit

Permalink
docs: update README and TODO
Browse files Browse the repository at this point in the history
  • Loading branch information
jsanant committed Nov 22, 2022
1 parent 3eaea51 commit 03d82f5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ A CLI tool to generate [multi-tenant](https://docs.victoriametrics.com/Cluster-V
```
$ ./bin/vmtctl -h
--config string Path to the .toml config file (default "sample_config.toml")
--csv Create a CSV file with endpoints
--gen-endpoints Generate only endpoints
```
Expand All @@ -19,6 +20,13 @@ $ ./bin/vmtctl -h
- Build the binary
- Generate the multi-tenant endpoints
- Populate the vmselect and vminsert endpoints in `datasource.yml` and `docker-compose.yml` files respectively and bring up victoria-metrics clustered version

- To generate a CSV file with the endpoints, you can run this command:
```
./bin/vmtctl --csv
```
This will create a file called `vmtctl.csv`.

- If you want to generate only the endpoints and not run victoria-metrics, you can run this command:

```
Expand Down
4 changes: 2 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [ ] Show APIs mentioned in the [examples page](https://docs.victoriametrics.com/url-examples.html) on the terminal
- [x] Store data in csv file - Done
- [x] ~~Explore [multitenancy](https://docs.victoriametrics.com/vmagent.html#multitenancy) in vmagent~~ - This is handled at scrape level.
- [ ] Store tenant details in [sqlite3](https://github.com/mattn/go-sqlite3)
- [x] ~~Store data in csv file~~ - The data stored in sqlite3 can be fetched in CSV format.
- [x] ~~Store tenant details in [sqlite3](https://github.com/mattn/go-sqlite3)~~ - Store data directly in a CSV file.

0 comments on commit 03d82f5

Please sign in to comment.