diff options
| author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-09-27 10:42:21 +0300 |
|---|---|---|
| committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-09-27 10:42:21 +0300 |
| commit | 00eac98c0248c0b279acbed33582055f0220df1e (patch) | |
| tree | 6764c5cb6aece8c2fd346a90595187e1a4e6c7a2 | |
| parent | 35ffd294858ec3511457a2a95950da5806038fed (diff) | |
| parent | 1eda233db080a25773e13276ddf7cdeaf9c5011a (diff) | |
Merge branch 'pks-docs-document-rpc-business-boundary' into 'master'
doc: Clarify GitLab/Gitaly boundary for RPCs
See merge request https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4878
Merged-by: Patrick Steinhardt <psteinhardt@gitlab.com>
Approved-by: Andras Horvath <ahorvath@gitlab.com>
Approved-by: Mark Wood <mwood@gitlab.com>
| -rw-r--r-- | doc/protobuf.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/protobuf.md b/doc/protobuf.md index 4ed62296f..b5ce7b913 100644 --- a/doc/protobuf.md +++ b/doc/protobuf.md @@ -129,6 +129,16 @@ Common concepts that can be considered: with ambiguity and makes it possible to use RPCs for references which are not branches. +RPCs should not implement business-specific logic and policy, but should only +provide the means to handle data in the problem-domain of Gitaly and/or +Praefect. The goal of this is to ensure that the Gitaly project creates an +interface to manage Git data, but does not make business decisions around how to +manage the data. + +For example, Gitaly can provide a robust and efficient set of APIs to move Git +repositories between storage solutions, but it would be up to the calling +application to decide when such moves should occur. + ### RPC naming conventions Gitaly has RPCs that are resource based, for example when querying for a commit. |