You are viewing documentation for version 1.18.x.
The most current version is 1.20.x. This documentation is available for 1.20.x.
bootstrap-containers
Settings related to bootstrap containers (
settings.bootstrap-containers.*
)Setting list for settings.bootstrap-containers
settings.bootstrap-containers.<name>.essential
settings.bootstrap-containers.<name>.mode
settings.bootstrap-containers.<name>.source
settings.bootstrap-containers.<name>.user-data
Full Reference
settings.bootstrap-containers.<name>.essential
If essential
is set to true
the bootstrap container will halt the boot process when it exits with a non-zero exit code.
Default: false
true
false
settings.bootstrap-containers.<name>.source
for a full example withsettings.bootstrap-containers.<name>.essential
.- The bootstrap container lifecycle conceptual documentationion
settings.bootstrap-containers.<name>.mode
Specifies how (or if) a container starts at boot. If you set the value to:
"always"
, the container will start on every boot,"off"
, the container will not start at boot,"once"
, the container will start on the first boot but after exit, themode
changes tooff
.
"always"
"off"
"once"
settings.bootstrap-containers.<name>.source
for a full example withsettings.bootstrap-containers.<name>.mode
.- The bootstrap container lifecycle conceptual documentation
settings.bootstrap-containers.<name>.source
Defines the URI for a container to run as a bootstrap container.
# Creates a bootstrap container called `mybootstrap`
# It runs only one time and if exits with a non-zero code, will halt the boot process
[settings.bootstrap-containers.mybootstrap]
source = "uri.to.container.in.oci-compatible-registry.example.com/foo:1.0.0"
mode = "once"
essential = true
# Creates a bootstrap container called `mybootstrap`
# It runs only one time and if exits with a non-zero code, will halt the boot process
apiclient set \
bootstrap-containers.mybootstrap.source="uri.to.container.in.oci-compatible-registry.example.com/foo:1.0.0" \
bootstrap-containers.mybootstrap.mode="once" \
bootstrap-containers.mybootstrap.mode=true
settings.bootstrap-containers.<name>.user-data
An optional field that allows you to pass arbitrary base64-encoded data to the bootstrap container.
The data is avaliable to the bootstrap container at /.bottlerocket/bootstrap-containers/<container>/user-data
or /.bottlerocket/bootstrap-containers/current/user-data
.