diff options
| author | Matthias Beyer <mail@beyermatthias.de> | 2020-12-14 08:16:24 +0100 |
|---|---|---|
| committer | Matthias Beyer <mail@beyermatthias.de> | 2020-12-14 09:11:34 +0100 |
| commit | ae169092b539e98084dfb5609edd124e3aaea34a (patch) | |
| tree | a8afa69e77d916bfe7157a4d7067e82aa1aba69b /doc/containers.md | |
| parent | 8b9c1d6407268e61a6f337fbb0673acf04f018b9 (diff) | |
Add some more documentation
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'doc/containers.md')
| -rw-r--r-- | doc/containers.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/containers.md b/doc/containers.md new file mode 100644 index 0000000..cbb62a0 --- /dev/null +++ b/doc/containers.md @@ -0,0 +1,23 @@ +## Containers + +The containers you use to run your builds are handled the following way: + +1. Dependencies and sources are copied to the container at `/inputs`, + the compiled packaging script is copied to the container at `/script` +2. The script is started +3. The result artifacts are copied from `/outputs` to the staging store + + +### Conventions + +There are some conventions regarding packages, dependencies, sources and so +on. Those are listed here. + +1. Dependencies are named `/inputs/<packagename>-<packageversion>.pkg` inside the container +2. Sources are named `/inputs/src-<hashsum>.source` +3. Outputs are expected to be named `/outputs/<packagename>-<packageversion>.pkg` + +The reason for the names lies in the artifact parsing mechanism. +If the package is named differently, the artifact parsing mechanism is not able +to recognize the package and might fault, which causes butido to stop running. + |