Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/reference/config/wave.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Forcefully apply compression option to all layers, including already existing la

<AddedInVersion version="24.04" />

The base image for the final stage in multi-stage Conda container builds (default: `ubuntu:24.04`). This option only applies when using `wave.build.template` set to `conda/micromamba:v2` or `conda/pixi:v1`.
The base image for the final stage in multi-stage Conda container builds (default: `ubuntu:24.04`). This option only applies when using `wave.build.template` set to `conda/micromamba:v2`, `conda/micromamba:v2-fast`, `conda/pixi:v1` or `conda/pixi:v1-fast`.

##### `wave.build.conda.basePackages`

Expand All @@ -99,10 +99,12 @@ The corresponding credentials must be provided in your Seqera Platform account.

The build template to use for container builds (default: `conda/micromamba:v1`). Supported values:

- `conda/micromamba:v1`Standard Micromamba 1.x single-stage build. Default when unspecified.
- `conda/micromamba:v2`Micromamba 2.x with multi-stage builds.
- `conda/pixi:v1`Pixi package manager with multi-stage builds for optimized image sizes.
- `cran/installr:v1`R/CRAN packages using installr.
- `conda/micromamba:v1`: Standard Micromamba 1.x single-stage build. Default when unspecified.
- `conda/micromamba:v2`: Micromamba 2.x with multi-stage builds.
- `conda/micromamba:v2-fast`: Micromamba 2.x with multi-stage builds, and the Conda environment split into multiple image layers of at most 512 MB. Docker images only.
- `conda/pixi:v1`: Pixi package manager with multi-stage builds for optimized image sizes.
- `conda/pixi:v1-fast`: Pixi package manager with multi-stage builds, and the Conda environment split into multiple image layers of at most 512 MB. Docker images only.
- `cran/installr:v1`: R/CRAN packages using installr.

Multi-stage templates produce smaller images by excluding build tools from the final image.

Expand Down
4 changes: 3 additions & 1 deletion docs/wave.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Packages from the [Python Package Index](https://pypi.org/) can also be added to

Wave supports different build templates for creating container images from Conda packages. Build templates control how packages are installed and how the final container image is structured.

Multi-stage build templates (`conda/pixi:v1` and `conda/micromamba:v2`) offer several advantages:
Multi-stage build templates (`conda/pixi:v1`, `conda/pixi:v1-fast`, `conda/micromamba:v2` and `conda/micromamba:v2-fast`) offer several advantages:

- **Smaller images**: Build tools and package managers are excluded from the final image (30-50% size reduction typical).
- **Reproducibility**: Lock files are generated for exact package version tracking.
Expand All @@ -117,7 +117,9 @@ Available templates:
|----------|-------------|
| `conda/micromamba:v1` | Standard Micromamba 1.x single-stage build. The final image includes the package manager. Default when unspecified. |
| `conda/micromamba:v2` | Multi-stage build using Micromamba 2.x. Produces smaller images without the package manager. |
| `conda/micromamba:v2-fast` | Like `conda/micromamba:v2`, with the Conda environment split into multiple image layers grouped by package, each at most 512 MB. Use it when a registry or proxy rejects large layers, or to speed up pulls. Docker images only. |
| `conda/pixi:v1` | Multi-stage build using [Pixi](https://pixi.sh/) package manager. Produces smaller images with faster dependency resolution. |
| `conda/pixi:v1-fast` | Like `conda/pixi:v1`, with the Conda environment split into multiple image layers grouped by package, each at most 512 MB. Use it when a registry or proxy rejects large layers, or to speed up pulls. Docker images only. |
| `cran/installr:v1` | Build template for R/CRAN packages using installr. |

When `wave.build.template` is not specified, Wave uses the standard `conda/micromamba:v1` template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ class WaveBuildConfig implements ConfigScope {

@ConfigOption
@Description("""
The build template to use for container builds. Supported values: `conda/pixi:v1` (Pixi with multi-stage builds), `conda/micromamba:v2` (Micromamba 2.x with multi-stage builds), `cran/installr:v1` (R/CRAN packages). Default: standard conda/micromamba:v1 template.
The build template to use for container builds. Supported values: `conda/pixi:v1` (Pixi with multi-stage builds), `conda/pixi:v1-fast` (like `conda/pixi:v1`, with the Conda environment split into multiple image layers, Docker only), `conda/micromamba:v2` (Micromamba 2.x with multi-stage builds), `conda/micromamba:v2-fast` (like `conda/micromamba:v2`, with the Conda environment split into multiple image layers, Docker only), `cran/installr:v1` (R/CRAN packages). Default: standard conda/micromamba:v1 template.
""")
final String template

Expand Down Expand Up @@ -329,7 +329,7 @@ class WaveBuildCondaConfig implements ConfigScope {

@ConfigOption
@Description("""
The base image for the final stage in multi-stage Conda container builds (default: `ubuntu:24.04`). This option only applies when `wave.build.template` is set to `conda/micromamba:v2` or `conda/pixi:v1`.
The base image for the final stage in multi-stage Conda container builds (default: `ubuntu:24.04`). This option only applies when `wave.build.template` is set to `conda/micromamba:v2`, `conda/micromamba:v2-fast`, `conda/pixi:v1` or `conda/pixi:v1-fast`.
""")
final String baseImage

Expand Down
Loading