-
Notifications
You must be signed in to change notification settings - Fork 38
feat(docs): add cache sections to gitlab docker kubernetes executors #792
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
0cfed7d
to
fb1b21f
Compare
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
4f60511
to
640471a
Compare
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
Signed-off-by: Evgeniy Frolov <[email protected]>
@@ -28,7 +28,40 @@ On the GitLab Runner host, open its `config.toml` configuration file and add the | |||
volumes = ["/home/build/.werf"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This volume is also related to caching and requires running werf host cleanup.
Let’s stick to a single approach that uses caching — users can decide which parts to disable if needed.
It would also be helpful to add a comment to each volume for clarity.
Signed-off-by: Evgeniy Frolov <[email protected]>
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Show resolved
Hide resolved
"/home/ubuntu/.local/share/containers:/home/build/.local/share/containers", | ||
# werf cache | ||
"/home/ubuntu/.werf:/home/build/.werf" | ||
] | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm kinda confused. Initially this file was an instruction for any kind of GitLab Runner. Now it's only for GitLab Runner in Docker. Is GitLab Runner in Docker really a requirement? Note that Executor is a different thing, you can have GitLab Runner on a bare OS, but with Docker Executor.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Originally, the documentation seemed to support both scenarios:
- GitLab Runner installed directly on the host OS
- GitLab Runner running inside a Docker container
However, the cache configuration provided didn't actually work in either case.
I'm now updating the documentation to include a working cache configuration, but the setup differs depending on how GitLab Runner itself is deployed (not just the executor type).
Should I provide instructions for both cases, or do we want to support only one of them going forward?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How much it differs? Can we just say "go to GitLab docs to install GitLab Runner the way you want", then explain extra steps needed for different types of the GitLab Runners? Maybe we can even explain it in a generic way, like there was instructions on what to add to config.toml
without specifying how to update the config.toml
(depends on how the Runner installed).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary:
We'll use named Docker volumes to mount cache directories in the GitLab Runner configuration. This approach works consistently regardless of how the Runner itself is deployed — whether it's running directly on the host or inside a Docker container. It also avoids relying on $HOME
or UID-specific paths, making the setup more robust and portable.
As a result, the documentation can stay generic: we’ll point users to the [official GitLab docs](https://docs.gitlab.com/runner/install/) for installation and registration steps, and only highlight the specific additions needed in config.toml
to support caching and other features.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs changes
Signed-off-by: Evgeniy Frolov <[email protected]>
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
...nfigurator/static/_includes/en/configurator/partials/ci/gitlab_docker_main_section.md.liquid
Outdated
Show resolved
Hide resolved
"/home/ubuntu/.local/share/containers:/home/build/.local/share/containers", | ||
# werf cache | ||
"/home/ubuntu/.werf:/home/build/.werf" | ||
] | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How much it differs? Can we just say "go to GitLab docs to install GitLab Runner the way you want", then explain extra steps needed for different types of the GitLab Runners? Maybe we can even explain it in a generic way, like there was instructions on what to add to config.toml
without specifying how to update the config.toml
(depends on how the Runner installed).
Signed-off-by: Evgeniy Frolov <[email protected]>
No description provided.