diff options
| author | karthik nayak <knayak@gitlab.com> | 2022-10-27 11:01:11 +0300 |
|---|---|---|
| committer | karthik nayak <knayak@gitlab.com> | 2022-10-27 11:01:11 +0300 |
| commit | 86e3c5c6c1b238b81e7097acb7a1e45bda9975b0 (patch) | |
| tree | b0450f4152940c5ba60ea825b5724bfd9aeb7139 /ruby | |
| parent | 5301de8e03c8c76122ceffff3f74f31ef168575a (diff) | |
| parent | 1824a953bce1268269937a7a66684b642ebee505 (diff) | |
Merge branch 'eread/add-docs-testing-make-target-and-ci_cd-job' into 'master'
Add docs testing Make target and CI/CD job
See merge request https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4976
Merged-by: karthik nayak <knayak@gitlab.com>
Approved-by: karthik nayak <knayak@gitlab.com>
Co-authored-by: Evan Read <eread@gitlab.com>
Co-authored-by: Patrick Steinhardt <psteinhardt@gitlab.com>
Diffstat (limited to 'ruby')
| -rw-r--r-- | ruby/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/ruby/README.md b/ruby/README.md index 1ff0f473a..54fea399e 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -7,22 +7,22 @@ speed up the Gitaly migration project. ## Architecture -Gitaly-ruby is a minimal Ruby gRPC service which should only receive +`gitaly-ruby` is a minimal Ruby gRPC service which should only receive requests from its (Go) parent Gitaly process. The Gitaly parent handles authentication, logging, metrics, configuration file parsing etc. The Gitaly parent is also responsible for starting and (if necessary) -restarting Gitaly-ruby. +restarting `gitaly-ruby`. ## Authentication -Gitaly-ruby listens on a Unix socket in a temporary directory with +`gitaly-ruby` listens on a Unix socket in a temporary directory with mode 0700. It runs as the same user as the Gitaly parent process. ## Testing -There are three sets of test that exercise gitaly-ruby: +There are three sets of test that exercise `gitaly-ruby`: - Top-level Go integration tests - Rspec integration tests (`spec/gitaly`) @@ -37,7 +37,7 @@ tests only, without recompiling the Go parts then do the following: ## Development -Gitaly-ruby is only meant to be spawned by Gitaly itself. But, during +`gitaly-ruby` is only meant to be spawned by Gitaly itself. But, during development you may want to try spawning it in a terminal yourself. You can do that with the following incantation: |