Skip to content
Snippets Groups Projects

Update docs for `gitaly check` command

Merged Justin Tobler requested to merge jt-update-docs-gitaly-check into master
All threads resolved!
6 files
+ 14
23
Compare changes
  • Side-by-side
  • Inline
Files
6
  • 6862a9d3
    The `check` subcommand in the `gitaly-hooks` binary has been moved to
    the main `gitaly` binary. This subcommand is used by GitLab admins to
    verify Gitaly is able to access the interal Rail API. Since this
    subcommand has been relocated the documenation was updated to reference
    the correct binary.
@@ -280,7 +280,7 @@ Updates to example must be made at:
```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure).
1. Run `sudo /opt/gitlab/embedded/bin/gitaly-hooks check /var/opt/gitlab/gitaly/config.toml`
1. Run `sudo /opt/gitlab/embedded/bin/gitaly check /var/opt/gitlab/gitaly/config.toml`
to confirm that Gitaly can perform callbacks to the GitLab internal API.
**For installations from source**
@@ -330,8 +330,9 @@ Updates to example must be made at:
```
1. Save the files and [restart GitLab](../restart_gitlab.md#installations-from-source).
1. Run `sudo -u git /home/git/gitaly/gitaly-hooks check /home/git/gitaly/config.toml`
to confirm that Gitaly can perform callbacks to the GitLab internal API.
1. Confirm that Gitaly can perform callbacks to the GitLab internal API:
- For Gitlab 15.3 and later, run `sudo /opt/gitlab/embedded/bin/gitaly check /var/opt/gitlab/gitaly/config.toml`.
- For GitLab 15.2 and earlier, run `sudo /opt/gitlab/embedded/bin/gitaly-hooks check /var/opt/gitlab/gitaly/config.toml`.
WARNING:
If directly copying repository data from a GitLab server to Gitaly, ensure that the metadata file,
Loading