Skip to content

Commit

Permalink
readme: describe alpha sdk build process
Browse files Browse the repository at this point in the history
Co-authored-by: Ethan Pullen <[email protected]>
Co-authored-by: Matthew James Briggs <[email protected]>
  • Loading branch information
webern and ecpullen committed Nov 30, 2023
1 parent 302ef13 commit 66fc9f3
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions local/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,55 @@
# Building The Alpha SDK

## Required tools
* git
* cargo
* docker

## Clone Bottlerocket

We will start by cloning Bottlerocket so it can be used to create the alpha variant.

```bash
git clone https://github.com/bottlerocket-os/bottlerocket.git
```

## Clone Twoliter

Next we will clone the twoliter project.

```bash
git clone https://github.com/bottlerocket-os/twoliter.git
```

## Build the alpha sdk

The alpha sdk script will build bottlerocket from the main repo, so we need to provide it's path.
Add the path to the command below.

```bash
BOTTLEROCKET_PROJECT_DIR=
```

Next we need to configure the image that is created by twoliter.
```bash
# The ecr registry the alpha sdk should be pushed to
ALPHA_SDK_REGISTRY=
# The version for this alpha sdk
ALPHA_SDK_VERSION=
```

To build the sdk we need to call the `alpha-sdk.sh` script.

```bash
# From within the twoliter project
cd local
./alpha-sdk.sh \
--bottlerocket-dir ${BOTTLEROCKET_PROJECT_DIR} \
--alpha-registry ${ALPHA_SDK_REGISTRY} \
--alpha-version ${ALPHA_SDK_VERSION}
cd ..
```

# The Local Directory

This directory is for scripts involved with building and testing Twoliter.

0 comments on commit 66fc9f3

Please sign in to comment.