https://github.com/bottlerocket-os/bottlerocket-bootstrap-container
https://github.com/bottlerocket-os/bottlerocket-bootstrap-container
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bottlerocket-os/bottlerocket-bootstrap-container
- Owner: bottlerocket-os
- License: apache-2.0
- Created: 2024-08-01T19:12:48.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-15T00:26:37.000Z (5 months ago)
- Last Synced: 2026-01-18T12:24:44.079Z (5 months ago)
- Language: Shell
- Size: 52.7 KB
- Stars: 8
- Watchers: 15
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Bottlerocket Bootstrap Container
This is the bootstrap container for the [Bottlerocket](https://github.com/bottlerocket-os/bottlerocket) operating system.
This container image allows the user to provide their own script to run bootstrap commands to setup their own configuration during runtime.
## Using the Container Image
For more information on settings, please refer to the [Bottlerocket Documentation](https://bottlerocket.dev/) in order to configure your files.
The automatically updated bootstrap container source will be used by default, if source is not specified in the configuration.
To use default container image, create a TOML file with the following configurations.
### Sample TOML configuration
```toml
[settings.bootstrap-containers.myscript]
mode="once"
user-data="user-base64-encoded-bootstrap-script"
```
Below is the configuration to use the custom source.
```toml
[settings.bootstrap-containers.myscript]
source=""
mode="once"
user-data="user-base64-encoded-bootstrap-script"
```
Afterwards, create the Bottlerocket instance using the TOML file.
The settings that you changed within the user's bootstrap script should be seen within the bottlerocket instance.
### Example Walkthrough
This example assumes that you have access to AWS services and the necessary permissions to create and manage EC2 instances.
Given a user data similar to the below:
```sh
#!/usr/bin/env sh
set -euo pipefail
# Create the directory
mkdir -p /var/lib/my_directory
# Set API client configurations
apiclient set --json '{"settings": {"oci-defaults": {"resource-limits": {"max-open-files": {"soft-limit": 4294967296, "hard-limit": 8589934592}}}}}'
# Load kernel module
if command -v modprobe > /dev/null 2>&1; then
modprobe dummy
fi
echo "User-data script executed."
```
The user-data script needs to be base64 encoded. Encode the script in base64.
Next, create a TOML file with the necessary settings to use the bootstrap container.
Replace with the actual URI of the ECR repository.
For example, the TOML file should look like the below if you base64 the given user-data:
```toml
[settings.bootstrap-containers.bear]
mode = "once"
user-data = "IyEvdXNyL2Jpbi9lbnYgc2gKc2V0IC1ldW8gcGlwZWZhaWwKCiMgQ3JlYXRlIHRoZSBkaXJlY3RvcnkKbWtkaXIgLXAgL3Zhci9saWIvbXlfZGlyZWN0b3J5CgojIFNldCBBUEkgY2xpZW50IGNvbmZpZ3VyYXRpb25zCmFwaWNsaWVudCBzZXQgLS1qc29uICd7InNldHRpbmdzIjogeyJvY2ktZGVmYXVsdHMiOiB7InJlc291cmNlLWxpbWl0cyI6IHsibWF4LW9wZW4tZmlsZXMiOiB7InNvZnQtbGltaXQiOiA0Mjk0OTY3Mjk2LCAiaGFyZC1saW1pdCI6IDg1ODk5MzQ1OTJ9fX19fScKCiMgTG9hZCBrZXJuZWwgbW9kdWxlCmlmIGNvbW1hbmQgLXYgbW9kcHJvYmUgPiAvZGV2L251bGwgMj4mMTsgdGhlbgogIG1vZHByb2JlIGR1bW15CmZpCgplY2hvICJVc2VyLWRhdGEgc2NyaXB0IGV4ZWN1dGVkLiIK"
```
Afterwards, you can run the Bottlerocket instance using the TOML file and the user-data configurations will be applied.
Once the instance is up and running, you can verify that the bootstrap process completed successfully.
#### Checking logs
You can check the logs of the bootstrap container using the apiclient tool from the admin container.
To check the logs of the `bear` container above, you can run the following commmand from the [control container](https://github.com/bottlerocket-os/bottlerocket-control-container) (assuming the [admin container](https://github.com/bottlerocket-os/bottlerocket-admin-container) is enabled):
```bash
apiclient exec admin journalctl -D /.bottlerocket/rootfs/var/log/journal/ -u bootstrap-containers@bear
```