diff options
| author | Raditya Surya <radityasurya1911@gmail.com> | 2023-06-07 10:55:10 +0300 |
|---|---|---|
| committer | Sami Hiltunen <shiltunen@gitlab.com> | 2023-06-07 10:55:10 +0300 |
| commit | a016c921a597e8068d72eca374c5d7a73b7277a9 (patch) | |
| tree | c9e12d08085f9ce58edfe94b065028c8b95ecf35 /doc/configuration/README.md | |
| parent | c68746b159bc3c4fb0e84331a002b1304dd24889 (diff) | |
Add configuration validation docs
Diffstat (limited to 'doc/configuration/README.md')
| -rw-r--r-- | doc/configuration/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/configuration/README.md b/doc/configuration/README.md index 6f3957e8f..877a4b9bd 100644 --- a/doc/configuration/README.md +++ b/doc/configuration/README.md @@ -159,3 +159,19 @@ pattern. All error messages are logged unconditionally. By default, health check gRPC messages are not logged. To enable them, set `GITALY_LOG_REQUEST_METHOD_ALLOW_PATTERN` to `.`. + +### Validation + +The `gitaly configuration validate` sub-command validates the provided configuration. Use `validate` before starting the service. + +`validate` prints all configuration problems to `STDOUT` in JSON format. +The output's structure includes: + +- A key, which is the path to the configuration field where the problem is detected. +- A message, with an explanation of the problem. + +#### Usage + +```shell +gitaly configuration validate +```
\ No newline at end of file |