Commit 2ebbc23b authored by Georges Racinet's avatar Georges Racinet 🦑
Browse files

Heptapod Workhorse: install instructions

let's label it a "technology preview" for the 0.12.x series

--HG--
branch : heptapod-stable
parent b78fb9152121
......@@ -52,6 +52,7 @@ Please use the mirror URL for initial and repetitive clonings.
- Rails application (replacement for `gitlab`): https://mirror.octobus.net/heptapod/heptapod
- Heptapod Shell (replacement for GitLab Shell): https://mirror.octobus.net/heptapod/heptapod-shell
- Optional in Heptapod < 0.13, Heptapod Workhorse (replacement for GitLab Workhorse): https://mirror.octobus.net/heptapod/heptapod-workhorse
Example:
......@@ -61,9 +62,9 @@ Example:
hg update heptapod-0.8.0rc1
```
All other standard GitLab components (Workhorse, etc) have to be taken
All other standard GitLab components (Gitaly, etc) have to be taken
from the canonical upstream locations, at the version specified at the root
of the Rails application sources (`GITLAB_WORKHORSE_VERSION` etc).
of the Rails application sources (`GITALY_SERVER_VERSION` etc).
### Installing the Mercurial component
......@@ -193,6 +194,30 @@ changes in repositories. This is prone to disappear in favour of a more direct
approach in forthcoming Heptapod versions.
### Using Heptapod Workhorse
Heptapod Workhorse is a technology preview in Heptapod 0.12.1 and following,
expected to become the standard in Heptapod 0.13.
Its benefits should be:
- better concurrency support by reducing involvement of the Rails application
in interaction with Mercurial HTTP clients to the minimum, i.e.,
permissions assessment.
- better RAM usage, with Mercurial bundles being streamed from the `hgserve`
service to the HTTP client instead of being loaded in RAM
- no need to up the timeout of the Rails application for longer Mercurial
operation over HTTP.
To use Heptapod Workhorse:
- fetch it like any other Heptapod component (see "Fetching source" above)
- compile it in the same way as GitLab Workhorse
- set `mercurial:workhorse_enabled` to `true` in `config/gitlab.yml`.
If you're using Heptapod Workhorse, please help us making it the standard by
providing your feedback, thanks!
### Validation with the functional tests
- start from an empty set of data (do not even set the instance root password)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment