Skip to content

Cello - The engine for cloud deployments

Quick Start

Quickstart¶

Note: this is a quick guide for getting something up and running. This is configured for local setups and not meant to be run in production

Pre-reqs¶

The quickstart currently only supports macOS.

Clone the Cello GitHub repository.
Install Docker Desktop, ensure Kubernetes is running.
Install AWS CLI
Install Argo CLI brew install argo
Install jq for json parsing.

Deploy Sample App Locally¶

You will need two windows

Vault & Cello Service
Client commands, etc

Start Vault & Cello Service¶

In window #1, ensure you have AWS credentials for the target account configured and access to your kubernetes cluster. For the AWS credentials, export the AWS_PROFILE that is to be used.
Set CELLO_ADMIN_SECRET env var to abcd1234abcd1234.

export CELLO_ADMIN_SECRET=abcd1234abcd1234

Start the Cello Service (includes workflows, vault, and postgres). Note: this will copy your current AWS credentials to the vault containers.

bash scripts/quickstart_run.sh

Create Cello Project And Target (One Time Setup)¶

In window #2, ensure you have the CELLO_ADMIN_SECRET env var set to abcd1234abcd1234.
```
export CELLO_ADMIN_SECRET=abcd1234abcd1234
```
Ensure your AWS credentials are set for the target account and create your first project and target. The output contains an export command for the CELLO_USER_TOKEN for the new project.

bash scripts/create_project.sh https://github.com/cello-proj/cello.git

Run Workflow¶

In window #2, ensure the CELLO_USER_TOKEN for the project is specified (the output of create_project.sh should have output a bash command to export it).
CDK Example

# CDK Example
CDK_WORKFLOW_NAME=`bash scripts/run_gitops_example.sh manifests/kube_cdk_manifest.yaml e3a419e69a5ae762862dc7cf382304a4e6cc2547`

# Get the status/follow the logs
./quickstart/cello get $CDK_WORKFLOW_NAME
./quickstart/cello logs -f $CDK_WORKFLOW_NAME

TERRAFORM Example

# Terraform Example
TERRAFORM_WORKFLOW_NAME=`bash scripts/run_gitops_example.sh manifests/kube_terraform_manifest.yaml e3a419e69a5ae762862dc7cf382304a4e6cc2547`

# Get the status/follow the logs
./quickstart/cello get $TERRAFORM_WORKFLOW_NAME
./quickstart/cello logs -f $TERRAFORM_WORKFLOW_NAME