Create a stack (deprecated)

A stack is the grouping together of the build and run base images, represented by a unique ID.

Note: As of Platform API 0.12 and Buildpack API 0.10, stacks are deprecated in favor of existing constructs in the container image ecosystem such as operating system name, operating system distribution, and architecture.

You can still configure the build and run base images for your CNB build. To find out how, see create a build base image and create a run base image.

A stack ID identifies the configuration for the build and run base images, and it used to determined compatibility with available buildpacks, and rebasability when updated run images are available. If you’re on an older Platform API version, you may still need to create a custom stack. To find out how, read on…

Prerequisites

Before we get started, make sure you’ve got the following installed:

Creating a custom stack

We will create a sample stack based on Ubuntu Jammy Jellyfish. To create a custom stack, we need to create customized build and run images. To find out how, see create a build base image and create a run base image, then come back here.

Choose your stack ID

Choose a stack ID to uniquely identify your stack. The stack ID:

• must only contain numbers, letters, and the characters ., /, and -.
• must not be identical to any other stack ID when using a case-insensitive comparison.
• should use reverse domain notation to avoid name collisions - i.e. buildpacks.io will be io.buildpacks.

Example stack IDs:

• io.buildpacks.stacks.bionic
• io.buildpacks.stacks.jammy
• io.buildpacks.samples.stacks.bionic
• io.buildpacks.samples.stacks.jammy

Label your images

Add the following to the Dockerfiles used to create your build and run base images:

LABEL io.buildpacks.stack.id="your stack ID"

During build, this label will be read by platforms such as pack to determine if the build base image is compatible with available buildpacks (if those buildpacks require a specific stack). During rebase, this label will be read by the lifecycle to determine if the provided run image is compatible with the application.

Set CNB_STACK_ID

Add the following to the Dockerfile used to create your build base images:

ENV CNB_STACK_ID="your stack ID"

During build, this environment variable will be exposed to buildpacks, so that buildpacks can tailor their behavior for the specific stack.

Congratulations! You’ve got a custom stack!

Additional information

Mixins

Mixins provide a way to document OS-level dependencies that a stack provides to buildpacks. Mixins can be provided at build-time (name prefixed with build:), run-time (name prefixed with run:), or both (name unprefixed).

Declaring provided mixins

When declaring provided mixins, both the build and run image of a stack must contain the following label:

The following rules apply for mixin declarations:

• build:-prefixed mixins may not be declared on a run image
• run:-prefixed mixins may not be declared on a build image
• Unprefixed mixins must be declared on both build and run images

Example

Build image:

io.buildpacks.stack.mixins: ["build:git", "wget"]

Run image:

io.buildpacks.stack.mixins: ["run:imagemagick", "wget"]

Declaring required mixins

A buildpack must list any required mixins in the stacks section of its buildpack.toml file.

When validating whether the buildpack’s mixins are satisfied by a stack, the following rules apply:

• build:-prefixed mixins must be provided by stack’s build image
• run:-prefixed mixins must be provided by stack’s run image
• Unprefixed mixins must be provided by both stack images

Example

[[stacks]]
id = "io.buildpacks.stacks.jammy"
mixins = ["build:git", "run:imagemagick", "wget"]

Resources

For technical details on stacks, see the stack sections in the Platform and Buildpack specifications.