Skip to content
Snippets Groups Projects

Add praefect list virtual storages subcommand documentation

Merged John Cai requested to merge jc-docs-praefect-list-storages into master
All threads resolved!
1 file
+ 17
0
Compare changes
  • Side-by-side
  • Inline
@@ -425,3 +425,20 @@ This command fails if:
- The repository is already being tracked by the Praefect database.
- The repository does not exist on disk.
### List storages
> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4609) in GitLab 15.1.
The `list-storages` Praefect sub-command lists virtual storages and their associated storage nodes.
```shell
sudo /opt/gitlab/embedded/bin/praefect -config /var/opt/gitlab/praefect/config.toml list-storages -virtual-storage <virtual_storage_name>
```
The command outputs:
- Result to `STDOUT` and the command's logs.
- Errors to `STDERR`.
- `-virtual-storage` will list out only storage nodes for the specified virtual storage. Otherwise, all virtual storages and their associated storage nodes will be printed out in tabular format.
Loading