You are viewing documentation for version 1.15.x. The most current version is 1.19.x.  This documentation is available for 1.19.x.

host-containers

Settings related to 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


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.

Accepted values:
  • true
  • false
Also see: 

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.

Accepted values:
  • true
  • false
Also see: 

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.