Source code

The source code for deployment can be found in scripts/deployment. Its README has been copied below.

Deployment¶

Deploying our software to our autonomous sailboat's main computer.

Scripts¶

`start_container.sh`¶

Runs the base image. A new container is created every time this is run. The default container name is sailbot_deployment_container. Container names are unique, so if you want to use multiple deployment containers (e.g., from different branches) you will have to update the variable CONTAINER_NAME in the script.

Usage:

Runs the base image used by the Dev Container by default: ./start_container.sh
Run a specific version of the base image by specifying its ID: ./start_container.sh <IMAGE_ID>

`setup_boot.sh`¶

Configures programs and scripts that need to run when the main computer boots. Only needs to be run once unless the script is updated. Does not need to be rerun if any scripts or programs it targets are updated, with the exception of renaming or moving the file.

Usage:

Must be run as root
sudo ./setup_boot.sh

Deployment container commands¶

Exit out of a container: exit
Start an existing container: docker start -ia <container name>
Delete an existing container: docker rm <container name>
Find the container ID of a container: docker ps -a

Deploy software¶

These commands are run in the in the root directory of this repository

Run the setup script: ./scripts/setup.sh
Run the build script with the quick build flag: ./scripts/build.sh -q

Develop software¶

The deployment container isn't intended for development, but if you discover a bug and want to quickly push a fix:

Fix the issue in a terminal outside the deployment container
Run the software to verify your fix in a terminal inside the deployment container
Commit and push your fix in a terminal outside the deployment container