GETTING-STARTED.md

Getting Started with epehemeral.run

This repo has a sample implementation for ephemeral environments using the demo microservices application sock-shop.

For the sample implementation, the front-end repo has been forked at https://github.com/OpenGov/front-end.

The main implementation and configuration is maintained in this repo (OpenGov/ephemeral.run).

The sample minimum setup for the EKS Cluster is in ephemeral.run/platform-setup.

The configuration for the ephemeral environments is described in ephemeral.run/ephemeral-env.

Run the sample

Follow the steps below to run the sample:

1. Fork the front-end repo
2. Fork the ephemeral.run repo
3. Create and configure the EKS Cluster on your AWS Account. Refer to ephemeral.run/platform-setup
4. Set the following secrets on your fork:
   • DOCKERHUB_REPOSITORY
   • DOCKERHUB_USERNAME
   • DOCKERHUB_PASSWORD
   • GIT_HUB_ACCESS_TOKEN
   • AWS_CLUSTER_NAME
   • IAM_CLUSTER_USER
   • IAM_CLUSTER_PASSWORD
5. Make some change to the front-end codebase in a branch
6. Create a PR to the main branch of your fork.
7. A build will be triggered through Github Actions. The build will push the image to your Docker Hub repository.
8. Once the build is completed, add a ephemeral-deploy label to the PR.