Skip to content

Commit

Permalink
Merge pull request #383 from sap-contributions/extension-contexts-ext…
Browse files Browse the repository at this point in the history
…ension-md

Changes for image extension build contexts
  • Loading branch information
natalieparellano authored Feb 1, 2024
2 parents 7eb38d1 + 43c7cd9 commit e7f547c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions image_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,27 @@ Correspondingly, each `/bin/generate` executable:
- MAY log output from the build process to `stdout`.
- MAY emit error, warning, or debug messages to `stderr`.
- MAY write either or both of `build.Dockerfile` and `run.Dockerfile` to the `<output>` directory. This file MUST adhere to the requirements listed below.
- MAY create the following folders in the `<output>` directory with an arbitrary content:

either:

- `context`

or the image-specific folders:

- `context.run`
- `context.build`
- MAY write key-value pairs to `<output>/extend-config.toml` that are provided as build args to build.Dockerfile when extending the build image.
- MUST NOT write SBOM (Software-Bill-of-Materials) files as described in the [Software-Bill-of-Materials](#software-bill-of-materials) section.

#### Context Folders

- The `<output>/context` folder MUST NOT be created together with any combination of the image-specific folders.
- If the folder `<output>/context` is present it will be set as the build context during the `extend` phase of the build and run images.
- If the folder `<output>/context.run` is present it will be set as the build context during the `extend` phase of the run image only.
- If the folder `<output>/context.build` is present it will be set as the build context during the `extend` phase of the build image only.
- If none of these folders is not present, the build context defaults to the `<app>` folder.

#### Dockerfile Requirements

A `run.Dockerfile`
Expand Down

0 comments on commit e7f547c

Please sign in to comment.