Skip to content
Snippets Groups Projects
Commit 640a6052 authored by John Cai's avatar John Cai
Browse files

Merge branch 'jc-docs-praefect-list-storages' into 'master'

Add praefect list virtual storages subcommand documentation

See merge request !89936
parents 92d50658 3b3d1355
No related branches found
No related tags found
No related merge requests found
Pipeline #582962316 passed
......@@ -425,3 +425,21 @@ This command fails if:
- The repository is already being tracked by the Praefect database.
- The repository does not exist on disk.
### List virtual storage details
> [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. If a virtual storage is:
- Specified using `-virtual-storage`, it lists only storage nodes for the specified virtual storage.
- Not specified, all virtual storages and their associated storage nodes are listed in tabular format.
```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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment