Skip to content

Commit

Permalink
move docker installation to INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jerryyiransun committed Aug 21, 2024
1 parent 09ebdf8 commit 83045ae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
12 changes: 12 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@ poetry run caribou setup_tables
Since AWS bucket names need to be unique, the currently configured bucket might already exist and be used by another version of the framework deployed somewhere else.
In this case, adapt the bucket name for the variable `DEPLOYMENT_RESOURCES_BUCKET` in the `caribou/common/constants.py` file.

## Docker

The Deployment Utility has an additional dependency on `docker`.
To install it, follow the instructions on the [docker website](https://docs.docker.com/engine/install/).
Ensure you have the docker daemon running before running the deployment utility.

To verify that Docker is installed correctly, you can try running:

```bash
docker --version
```

## Other dependencies

Since the AWS lambda environment restricts us from using Docker, we have to migrate the workflows using [crane](https://github.com/google/go-containerregistry/tree/main/cmd/crane). If you plan on running the framework locally instead of deploying it to the cloud, please install the crane as described in the [crane documentation](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md).
9 changes: 0 additions & 9 deletions QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,6 @@ You can then use the Caribou Python API to define and develop the workflow.

### Deployment Utility

The Deployment Utility has an additional dependency on `docker`.
To install it, follow the instructions on the [docker website](https://docs.docker.com/engine/install/).
Ensure you have the docker daemon running before running the deployment utility.

To verify that Docker is installed correctly, you can try running:

```bash
docker --version

The deployment utility can be found in `caribou/deployment/client` and can be run with:

```bash
Expand Down

0 comments on commit 83045ae

Please sign in to comment.