host-containers
settings.host-containers.*
)You can use the host-containers
settings to alter the settings for the control and admin containers, or you can define your own host containers with these settings.
Setting list for settings.host-containers
settings.host-containers.<container>.enabled
settings.host-containers.<container>.source
settings.host-containers.<container>.superpowered
settings.host-containers.<container>.user-data
Full Reference
settings.host-containers.<container>.enabled
If true
the container starts automatically at boot. Bottlerocket requires this key alongside source
and superpowered
to start a host container.
true
false
settings.host-containers.<container>.source
The URI for the container to run as a host container. Bottlerocket requires this key alongside enabled
and superpowered
to start a host container.
[settings.host-containers.mycontainer]
enabled = true
source = "uri.to.container.in.oci-compatible-registry.example.com/foo:1.0.0"
superpowered = false
apiclient set \
settings.host-containers.mycontainer.enabled=true \
settings.host-containers.mycontainer.source="uri.to.container.in.oci-compatible-registry.example.com/foo:1.0.0" \
settings.host-containers.mycontainer.superpowered=false
settings.host-containers.<container>.superpowered
If true
, effectively grants the container root access to the host. Bottlerocket requires this key alongside enabled
and source
to start a host container.
true
false
settings.host-containers.<container>.user-data
An optional field that stores arbitrary base64-encoded data.
The data in this field is accessible by the host container at /.bottlerocket/host-containers/<container>/user-data
and /.bottlerocket/host-containers/current/user-data
.
Warning
The Bottlerocket admin container decodes JSON for SSH keys from user data. If you provide user data to the admin container, no SSH keys will be automatically passed into the admin container by Bottlerocket. If using custom user data with the admin container, you must also provide your own authentication information in this user data. See Authenticating with the Admin Container for more information.
Note
Despite the common name, host container user-data
and instance user-data
function differently.
Host container user-data
may consist of anything and it is up to the container to interepret the data.