Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/evanshortiss/neon-kube-previews


https://github.com/evanshortiss/neon-kube-previews

Last synced: 21 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Kube Preview Environments with Neon Database



This sample project demonstrates how to create continuous integration pipeline

that creates a Neon branch and preview environment for every pull request.

These preview environments are deployed into a Kubernetes cluster and are

kept in sync with the pull request using Argo CD.



![Architecture Overview](/images/architecture.png)



## Prerequisites



* Kubernetes cluster with Argo CD installed and exposed via an HTTPS ingress.

* A [Neon account](https://console.neon.tech/sign_in) and project.



_Note: If you'd like help setting up a lightweight Kubernetes on your development machine using [Kind](https://kind.sigs.k8s.io/), visit [_kind-cluster/README.md_](/kind-cluster/README.md)._



## Usage



Click the **Use this template** button in the top-right corner of this

repository. Create a new repository using the following options:



* Repository name: `neon-kube-previews`

* Vsibility: Public



Set these secrets in the *Secrets and variables > Actions* screen from

your new repository's settings screen:



* `DOCKERHUB_USERNAME` - Your Docker Hub username.

* `DOCKERHUB_TOKEN` - A token generated [Account Settings](https://hub.docker.com/settings/security) on Docker Hub.

* `NEON_API_KEY` - Found in the [Developer Settings](https://console.neon.tech/app/settings/api-keys) screen on the Neon console.

* `NEON_PROJECT_ID` - Found in *Settings > General* on the Neon project dashboard.

* `ARGOCD_HOSTNAME` - Strictly the hostname, e.g `argocd.foo.bar` without `https`.

* `ARGOCD_USERNAME` - A valid Argo CD username. You can could use `admin` if you're prototyping.

* `ARGOCD_PASSWORD` - The password associated with the given `ARGOCD_USERNAME`.



The following secret is optional. It's used to generate a preview URL

provided by [ngrok](https://ngrok.io), and assumes you've installed the 

[ngrok ingress controller](https://ngrok.com/blog-post/ngrok-k8s) on the

cluster where Argo CD is deploying your application. Remember, if you're using

the ngrok free tier you only have access to a single subdomain which limits

your preview environment count.



*Note: If you have an alternative ingress solution configured on your Kubernetes cluster do not set this secret. Instead edit the Helm Chart and GitHub Actions Workflow to use your chosen ingress solution.*



* `NGROK_SUBDOMAIN` - Used to generate a preview URL with the format `pr-$NUMBER.$NGROK_SUBDOMAIN`, e.g `pr-1.evanshortiss.ngrok.app`



## Production Deployment



Configure a production deployment by applying the provided `application.yaml`:



```bash

# Set the database URL

export DATABASE_URL='REPLACE_THIS'



# Inject database URL into yaml and apply in argocd namespace

envsubst < ./application.yaml | kubectl apply -n argocd -f -

```



_Note: This `application.yaml` passes the `DATABASE_URL` environment variable as a value to a Secret. In a production environment, consider using a solution such as [Sealed Secret](https://github.com/bitnami-labs/sealed-secrets#sealed-secrets-for-kubernetes)._