Skip to content

Commit 30b67b5

Browse files
committed
chore(docs): fix github docs
Signed-off-by: Evgeniy Frolov <[email protected]>
1 parent 0029621 commit 30b67b5

4 files changed

Lines changed: 22 additions & 6 deletions

File tree

bin/configurator/static/_includes/en/configurator/partials/ci/buildah_install.md.liquid

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,29 @@
1515
```
1616

1717
- Install the package that provides the `/etc/subuid` and `/etc/subgid` files.
18+
{% if include.type == "github" %}
1819

20+
- Make sure that the `/etc/subuid` and `/etc/subgid` files have a line similar to `github-runner:1000000:65536`, where
21+
22+
* `github-runner` — name of the GitHub Runner user;
23+
{% else %}
1924
- Make sure that the `/etc/subuid` and `/etc/subgid` files have a line similar to `gitlab-runner:1000000:65536`, where
2025

2126
* `gitlab-runner` — name of the GitLab Runner user;
22-
27+
{% endif %}
2328
* `1000000` — the first subUID/subGID in the range to be allocated;
2429

2530
* `65536` — subUIDs/subGIDs range size (min `65536`).
2631

2732
Make sure there are no conflicts with other ranges, if any. Changing files may require a reboot. See `man subuid` and `man subgid` for details.
2833

2934
* (Linux 5.12 and below) Install the package that provides the `fuse-overlayfs` utility.
35+
{% if include.type == "github" %}
3036

37+
* Make sure that the `/home/github-runner/.local/share/containers` path is created and the `github-runner` user has read and write access.
38+
{% else %}
3139
* Make sure that the `/home/gitlab-runner/.local/share/containers` path is created and the `gitlab-runner` user has read and write access.
32-
40+
{% endif %}
3341
* The `sysctl -ne kernel.unprivileged_userns_clone` command should NOT return `0`, otherwise run `echo 'kernel.unprivileged_userns_clone = 1' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`.
3442

3543
* The `sysctl -n user.max_user_namespaces` command should return `15000` or more, otherwise run `echo 'user.max_user_namespaces = 15000' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`.

bin/configurator/static/_includes/en/configurator/tab/ci/github-actions/simple/host-runner/linux/buildah/infra.md.liquid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
Follow [official instructions](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners) to install and register the GitHub Runner on your dedicated host.
1818

19-
{% include configurator/partials/ci/buildah_install.md.liquid %}
19+
{% include configurator/partials/ci/buildah_install.md.liquid type="github" %}

bin/configurator/static/_includes/ru/configurator/partials/ci/buildah_install.md.liquid

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Настройка окружения для сборки с Buildah
22

3-
{% offtopic title="Ручная установка " %}
3+
{% offtopic title="Ручная установка" %}
44

55
* Установите пакет Buildah, следуя [официальным инструкциям](https://github.com/containers/buildah/blob/main/install.md), но не производите его дальнейшую настройку. Если для вашего дистрибутива нет готовых пакетов Buildah, используйте следующие инструкции:
66

@@ -15,20 +15,28 @@
1515
```
1616

1717
- Установите пакет, предоставляющий файлы `/etc/subuid` и `/etc/subgid`.
18+
{% if include.type == "github" %}
19+
- Убедитесь, что в файлах `/etc/subuid` и `/etc/subgid` имеется строка вида `github-runner:1000000:65536`, где:
1820

21+
- `github-runner` — имя пользователя GitHub Runner;
22+
{% else %}
1923
- Убедитесь, что в файлах `/etc/subuid` и `/etc/subgid` имеется строка вида `gitlab-runner:1000000:65536`, где:
2024

2125
- `gitlab-runner` — имя пользователя GitLab Runner;
22-
26+
{% endif %}
2327
- `1000000` — первый subUID/subGID в выделяемом диапазоне;
2428

2529
- `65536` — размер диапазона subUIDs/subGIDs (минимум `65536`).
2630

2731
Избегайте коллизий с другими диапазонами, если они имеются. Изменение файлов может потребовать перезагрузки. Подробнее в `man subuid` и `man subgid`.
2832

2933
* (Для Linux 5.12 и ниже) Установите пакет, предоставляющий программу `fuse-overlayfs`.
34+
{% if include.type == "github" %}
3035

36+
* Убедитесь, что путь `/home/github-runner/.local/share/containers` создан, и пользователь `github-runner` имеет доступ на чтение и запись.
37+
{% else %}
3138
* Убедитесь, что путь `/home/gitlab-runner/.local/share/containers` создан, и пользователь `gitlab-runner` имеет доступ на чтение и запись.
39+
{% endif %}
3240

3341
* Команда `sysctl -ne kernel.unprivileged_userns_clone` НЕ должна вернуть `0`, а иначе выполните `echo 'kernel.unprivileged_userns_clone = 1' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`.
3442

bin/configurator/static/_includes/ru/configurator/tab/ci/github-actions/simple/host-runner/linux/buildah/infra.md.liquid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616

1717
Установите и зарегистрируйте GitHub Runner на выделенный для него хост, следуя [официальным инструкциям](https://docs.github.com/ru/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners).
1818

19-
{% include configurator/partials/ci/buildah_install.md.liquid %}
19+
{% include configurator/partials/ci/buildah_install.md.liquid type="github" %}

0 commit comments

Comments
 (0)