TypeScript Node Express Google Kubernetes Engine (GKE)
A reference project to build, and deploy a TypeScript Node Express service to Google Kubernetes Engine (GKE)
Pre-requisite
- Please ensure you have installed Terraform, and Google Cloud SDK
- Install Redis by follow official documentations here and start Redis:
redis-server # then in a new terminal run redis-cli ping
Development
- Create a
.envfile at project root directory, and populate with following:
JWT_KEY=<A-SECRET-JWT-TOKEN>
MONGO_DB_CONNECTION_STRING=<YOUR-MONGO-DB-CONNECTION-STRING>
- Then, run the following commands:
npm i # installs Node dependencies
npm run dev # app listening at http://localhost:8080
Create GCP resources
cd deploy # change to deploy directory
terraform init # initialises Terraform
terraform apply # deploys GCP stack
terraform destroy # destroys GCP stack
Deploy
- Encode the GCP service account key in base64 by running the following command. Then, create a Github action secret called
GCP_SERVICE_ACCOUNT_KEY:
cat key.json | base64
-
Run
scripts/apply-k8s.shto apply various Kubernetes configurations -
Merge into
masterbranch to trigger Github Action workflow to deploy to GKE
Usage
- Using Postman, make a
GETrequest at<EXTERNAL-STATIC-IP>for health check end-point - Note, you may need to disable SSL certificate verification on Postman. See tutorial here
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
