diff options
author | Tommy Morgan <tmorgan@gitlab.com> | 2018-10-30 17:32:50 +0300 |
---|---|---|
committer | Tommy Morgan <tmorgan@gitlab.com> | 2018-10-30 17:32:50 +0300 |
commit | b5c511a87250fee5ba4c24daba0de6dd30dbe4d9 (patch) | |
tree | 5aad40d6f50af269050f5b19c05cd79cb65c72d3 | |
parent | ae5f633eb8ccd605a6fac3b13e9bf5f32bc23b76 (diff) | |
parent | 0f7150f76b83f90652a98fa305e2d2c326e4a65e (diff) |
Merge branch 'doc-gitaly-clients' into 'master'
Document which components are gitaly clients
See merge request gitlab-org/gitaly!950
-rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -91,6 +91,29 @@ High-level architecture overview: [Edit this diagram directly in Google Drawings](https://docs.google.com/drawings/d/14-5NHGvsOVaAJZl2w7pIli8iDUqed2eIbvXdff5jneo/edit) +### Gitaly clients + +As of Q4 2018, the following GitLab components act as Gitaly clients: + +- [gitlab-rails](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/gitaly_client.rb): + the main GitLab Rails application. +- [gitlab-shell](https://gitlab.com/gitlab-org/gitlab-shell/tree/master): + For `git clone`, `git push` etc. via SSH. +- [gitlab-workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse/blob/master/internal/gitaly/gitaly.go): + For `git clone` via HTTPS and for slow requests that serve raw Git + data + ([example](https://gitlab.com/gitlab-org/gitaly/raw/master/README.md)) +- [gitaly-ssh](https://gitlab.com/gitlab-org/gitaly/tree/master/cmd/gitaly-ssh): + For internal Git data transfers between Gitaly servers. +- [gitaly-ruby](https://gitlab.com/gitlab-org/gitaly/blob/master/ruby/lib/gitlab/git/gitaly_remote_repository.rb): + For RPC's that interact with more than one repository, such as + merging a branch. + +The clients written in Go (gitlab-shell, gitlab-workhorse, gitaly-ssh) +use library code from the +[gitlab.com/gitlab-org/gitaly/client](https://gitlab.com/gitlab-org/gitaly/tree/master/client) +package. + ## Presentations - [Git Paris meetup, 2017-02-22](https://docs.google.com/presentation/d/19OZUalFMIDM8WujXrrIyCuVb_oVeaUzpb-UdGThOvAo/edit?usp=sharing) a high-level overview of what our plans are and where we are. |