https://github.com/heliumedu/deploy

Configuration for remote deployment infrastructure and local development environment
https://github.com/heliumedu/deploy

aws django docker education heliumcli python terraform ubuntu

Last synced: 6 days ago
JSON representation

Configuration for remote deployment infrastructure and local development environment

• Host: GitHub
• URL: https://github.com/heliumedu/deploy
• Owner: HeliumEdu
• License: mit
• Created: 2017-11-20T01:03:37.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-26T18:32:37.000Z (20 days ago)
• Last Synced: 2024-10-27T11:13:29.469Z (19 days ago)
• Topics: aws, django, docker, education, heliumcli, python, terraform, ubuntu
• Language: HCL
• Homepage: https://www.heliumedu.com
• Size: 438 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


![Python Versions](https://img.shields.io/badge/python-%203.12%20-blue)

[![Build](https://img.shields.io/github/actions/workflow/status/HeliumEdu/deploy/build.yml)](https://github.com/HeliumEdu/deploy/actions/workflows/build.yml)

![GitHub License](https://img.shields.io/github/license/heliumedu/deploy)

# Helium Deployment

This repository contains everything that is necessary to get a development environment setup on a local machine using

[Docker](https://docs.docker.com/), as well as the [Terraform](https://app.terraform.io/app) code necessary to provision deployment environments.

## Development

### Docker Setup

Here is a minimal set of commands that will get a Docker environment setup locally.

```sh

git clone https://github.com/HeliumEdu/deploy.git ~/Developer/helium

cd ~/Developer/helium

make

```

Done! Now that your environment has been initialized, to quickly bring up Docker in the future, simply run `make start`.

## Deployment

Use [the Release action](https://github.com/HeliumEdu/deploy/actions/workflows/release.yml) to cut a release and publish container images to

[AWS ECR](https://aws.amazon.com/ecr/). If a [Terraform Workspace](https://developer.hashicorp.com/terraform/cli/workspaces) has been provisioned

and [hooks to this repo are setup](https://developer.hashicorp.com/terraform/cloud-docs/vcs), then bumping the

[Image URI version variable in Terraform](https://github.com/HeliumEdu/deploy/blob/main/terraform/environments/prod/variables.tf#L1) will trigger a new deployment to this version when the Terraform applies.

### Initializing a New Environment

For more information on initializing infrastructure in a new environment for the first time, see

[the `prod` Terraform Workspace](https://github.com/HeliumEdu/deploy/tree/main/terraform/environments/prod#readme).