Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uffizzicloud/github-actions-example

Create pull request environments from GitHub Actions
https://github.com/uffizzicloud/github-actions-example

Last synced: about 1 month ago
JSON representation

Create pull request environments from GitHub Actions

Awesome Lists containing this project

README 

        
# Uffizzi Quickstart for GitHub Actions (~ 1 minute)



Go from pull request to Uffizzi Ephemeral Environment in less than one minute. This quickstart will create a virtual Kubernetes cluster on Uffizzi Cloud and deploy a sample microservices application from this repository. Once created, you can connect to the cluster with the Uffizzi CLI, then manage the cluster via `kubectl`, `kustomize`, `helm`, and other tools. You can clean up the cluster by closing the pull request or manually deleting it via the Uffizzi CLI.



### 1. Fork this `quickstart-k8s` repo



[https://github.com/UffizziCloud/quickstart-k8s/fork](https://github.com/UffizziCloud/quickstart-k8s/fork)



⚠️ Be sure to **uncheck** the option **Copy the `main` branch only**.



This ensures that the `try-uffizzi` branch will be included in your fork.



### 2. Enable GitHub Actions workflows for your fork



Select **Actions**, then select **I understand my workflows, go ahead and enable them**.



### 3. Open a pull request for the `try-uffizzi` branch against `main` in your fork



⚠️ Be sure that you're opening a PR on the branches of _your fork_ (i.e. `your-account/tree/main` ← `your-account/tree/try-uffizzi`).



If you try to open a PR for `UffizziCloud/tree/main` ← `your-account/tree/try-uffizzi`, the Actions workflow will not run in this example.



### 4. View cluster details

Once the action is finished running, check the pull request comments section to find information on how to access the newly created cluster.






### 5. Access the `vote` and `result` HTTP services



Additionally, the app endpoints can be found on the action summary page. Under the Actions section of the forked repository, open up the latest completed action. Within the completed action, open up the summary section. Copy and paste the vote and result endpoints within the action summary






___

## What to expect



The PR will trigger a [GitHub Actions workflow](.github/workflows/uffizzi-cluster.yaml) that uses the Uffizzi CLI, and Kubernetes manifests to create a Uffizzi Ephemeral Environment for the [microservices application](#architecture-of-this-example-app) defined by this repo. When the workflow completes, the Ephemeral Environment URL will be posted as a comment in your PR issue.



## How it works



### Configuration



Ephemeral Environments are configured with [Kubernetes manifests](manifests/) that describe the application components and a [GitHub Actions workflow](.github/workflows/uffizzi-cluster.yaml) that includes a series of jobs triggered by a `pull_request` event and subsequent `push` events:



1. [Build and push the voting-app images](https://github.com/UffizziCloud/quickstart-k8s/blob/fc27d539d98fd602039a4259cafe9dd2ccf65dc5/.github/workflows/reusable.yml#L11C1-L90C28)

2. [Create the Uffizzi cluster using the uffizzi-cli](https://github.com/UffizziCloud/quickstart-k8s/blob/fc27d539d98fd602039a4259cafe9dd2ccf65dc5/.github/workflows/reusable.yml#L92C1-L102C22)

3. [Apply the Kubernetes manifests to deploy the application to the Uffizzi cluster](https://github.com/UffizziCloud/quickstart-k8s/blob/c6123e3510e69a9433398eeb59482d19b920fcee/.github/workflows/create-ucluster.yaml#L114C1-L125C73)

4. [Delete the Ephemeral Environment when the PR is merged/closed or after](https://github.com/UffizziCloud/quickstart-k8s/blob/fc27d539d98fd602039a4259cafe9dd2ccf65dc5/.github/workflows/uffizzi-cluster.yaml#L143C1-L153C54)



## Acceptable Use



We strive to keep Uffizzi Cloud free or inexpensive for individuals and small teams. Therefore, activities such as crypto mining, file sharing, bots, and similar uses that lead to increased costs and intermittent issues for other users are strictly prohibited per the [Acceptable Use Policy](https://www.uffizzi.com/legal/acceptable-use-policy). Violators of this policy are subject to permanent ban.



## Architecture of this Example App



The application defined by this repo allows users to vote for dogs or cats and see the results. It consists of the following microservices:






* `voting` - A frontend web app in [Python](/vote) that lets you vote between two options

* `redis` - A [Redis](https://hub.docker.com/_/redis/) queue that collects new votes

* `worker` - A [.NET Core](/worker/src/Worker) worker that consumes votes and stores them in...

* `db` - A [PostgreSQL](https://hub.docker.com/_/postgres/) database backed by a Docker volume

* `result` - A [Node.js](/result) web app that shows the results of the voting in real time