Document Custom Executor with examples
Overview
With the implementation of #2885 (closed) we introduce the concept of a Generic Executor to solve the problem of supporting hardware and software that either (a) we don't have access to or (b) would change the runner too much to keep it maintainable.
The generic executor exposes a lot of internals of GitLab Runner that needs to be documented. This issue will be done in parallel with !1385 (merged) which actually implements the generic executor. Apart from just adding documentation on the Generic executor, the Generic Executor alone would not be very valuable to the community without examples of how to use it as it will require some general knowledge of how the runner works in order to utilize. Eventually, we will be able to gather more and more examples from the community as the use cases grow, but we should seed these contributions with some example models first.
Proposal
-
Document the generic executor, how it works and how to use it !1416 (merged) -
Provide examples for executors that we don't support -
LXC !1439 (merged) -
libvirt !1456 (merged)
-
Example Use Cases
See #2885 (comment 173298620) for a list of use cases we consider part of this project.