https://github.com/coldbrewcloud/coldbrew-cli
AWS Docker container deploy automation
https://github.com/coldbrewcloud/coldbrew-cli
Last synced: 5 months ago
JSON representation
AWS Docker container deploy automation
- Host: GitHub
- URL: https://github.com/coldbrewcloud/coldbrew-cli
- Owner: coldbrewcloud
- License: mit
- Created: 2016-10-14T02:26:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T08:25:54.000Z (over 1 year ago)
- Last Synced: 2024-08-03T22:19:13.296Z (8 months ago)
- Language: Go
- Homepage:
- Size: 199 KB
- Stars: 249
- Watchers: 11
- Forks: 17
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - coldbrewcloud/coldbrew-cli - AWS Docker container deploy automation (Go)
README
# coldbrew-cli
**NOTE: Unfortunately, coldbrew-cli is not actively maintained at the moment. [ecs-cli](https://github.com/aws/amazon-ecs-cli) could be an option instead.**
### Objectives
**coldbrew-cli** can provide
* faster access to ECS _(jumpstart with little knowledge on AWS specifics)_
* lower maintenance costs _(most cases you don't even need AWS console or SDK)_
* lessen mistakes by removing boring repetitions
* easier integration with CI
### Features
- ECS cluster with EC2 Auto Scaling Group configured
- Support ELB Application Load Balance _(multiple app instances on a single EC2 instance)_
- Logging: most of Docker logging drivers and AWS CloudWatch Logs
## Getting Started
### Install and Configure CLI
- [Download](https://github.com/coldbrewcloud/coldbrew-cli/wiki/Downloads) CLI executable (`coldbrew` or `coldbrew.exe`) and put it in your `$PATH`.
- Configure AWS credentials, region, and VPC through [environment variables](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Environment-Variables) or [CLI Flags](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Global-Flags).
- Make sure you have [docker](https://docs.docker.com/engine/installation/) installed in your system. You will also need [Dockerfile](https://docs.docker.com/engine/reference/builder/) for your application if you want to build Docker image using **coldbrew-cli**.
### Core Concepts
**coldbrew-cli** operates on two simple concepts: applications _(apps)_ and clusters.
- An **app** is the minimum deployment unit.
- One or more apps can run in a **cluster**, and, they share the computing resources.
This is what a typical deployment workflow might look like:
1. Create new cluster _(See: [cluster-create](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-create))_
2. Create app configuration _(See: [init](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-init))_
3. Development iteration:
- Make code/configuration changes
- Deploy app to cluster _(See [deploy](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-deploy))_
- Check app/cluster status _(See: [status](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-status) and [cluster-status](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-status))_ and adjust cluster capacity as needed _(See: [cluster-scale](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-scale))_
4. Delete app and its resources _(See: [delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-delete) )_
5. Delete cluster and its resources _(See: [cluster-delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-delete))_
See [Concepts](https://github.com/coldbrewcloud/coldbrew-cli/wiki/Concepts) for more details.
### Tutorials
Check out tutorials:
- [Running a Node.JS application on AWS](https://github.com/coldbrewcloud/tutorial-nodejs)
- [Running a Slack bot on AWS](https://github.com/coldbrewcloud/tutorial-echo-slack-bot)
- [Running a Meteor application on AWS](https://github.com/coldbrewcloud/tutorial-meteor)
- [Running a Go application on AWS](https://github.com/coldbrewcloud/tutorial-echo)
- [Running a scalable WordPress website on AWS](https://github.com/coldbrewcloud/tutorial-wordpress)
## Core Functions
### Create Cluster
To start deploying your applications, you need to have at least one cluster set up.
```bash
coldbrew cluster-create {cluster-name}
```
[cluster-create](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-create) command will look into your current AWS environment, and, will perform all necessary changes to build the cluster. Note that it can take several minutes until all Docker hosts (EC2 instances) become fully available in your cluster. Use [cluster-status](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-status) command to check the status. You can also adjust the cluster's computing capacity using [cluster-scale](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-scale) command.
### Configure App
The next step is prepare the app [configuration file](https://github.com/coldbrewcloud/coldbrew-cli/wiki/Configuration-File).
```bash
coldbrew init --default
```
You can manually create/edit your configuration file, or, you can use [init](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-init) command to generate a proper default configuraiton.
### Deploy App
Once the configuration file is ready, now you can deploy your app in the cluster.
```bash
coldbrew deploy
```
Basically [deploy](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-deploy) command does:
- build Docker image using your `Dockerfile` _(but this is completely optional if provide your own local Docker image; see [--docker-image](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-deploy#--docker-image) flag)_
- push Docker image to a remote repository (ECR)
- analyze the current AWS environment and setup, and, perform all necessary changes to initiate ECS deployments
Then, within a couple minutes _(mostly less than a minute)_, you will see your new application units up and running.
### Check Status
You can use [status](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-status) and [cluster-status](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-status) commands to check the running status of your app and cluster respectively.
```bash
coldbrew status
```
```bash
coldbrew cluster-status {cluster-name}
```
### Delete App
When you no longer need your app, you can remove your app from the cluster using [delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-delete) command.
```bash
coldbrew delete
```
[delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-delete) command gathers a list of AWS resources that need to be deleted, and, if you confirm, it will start cleaning them up. It can take several minutes for the full process.
### Delete Cluster
You can use a cluster for more than one apps, but, when you no longer need the cluster, you use [cluster-delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-delete) command to clean up all the resources.
```bash
coldbrew cluster-delete
```
Similar to [delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-delete) command, [cluster-delete](https://github.com/coldbrewcloud/coldbrew-cli/wiki/CLI-Command:-cluster-delete) will delete all AWS resources that are no longer needed. It can take several minutes for the full process.
## Documentations
- [Documentations Home](https://github.com/coldbrewcloud/coldbrew-cli/wiki)
- [Managed AWS Resources](https://github.com/coldbrewcloud/coldbrew-cli/wiki/Managed-AWS-Resources)
- [FAQ](https://github.com/coldbrewcloud/coldbrew-cli/wiki/FAQ)