generator-micro-kube
v1.0.6
Published
Microservices scaffolding for Kubernetes and Ambassador
Downloads
17
Maintainers
Readme
generator-micro-kube
Microservices scaffolding for Kubernetes and Ambassador API Gateway.
Pre-requisites
You should be familiar with Kubernetes, Helm and Docker.
- docker
- kubectl
- helm
- access to push to a docker registry such as dockerhub
.. and a valid kubectl configuration for an active Kubernetes cluster with helm tiller installed.
Installation
First, install Yeoman, yarn, and generator-micro-kube using npm.
npm install -g yo yarn generator-micro-kube
Then generate your new lerna monorepo microservices project:
yo micro-kube
Once you have created a project, you can create packages using:
yarn generate-package
Testing
Use the following npm script to lint, test, build, and start your service in a local docker container:
yarn svc-docker
Deployment
A basic helm chart is generated for each package. To deploy to Kubernetes:
- build and publish the docker container using:
yarn publish
- install the helm chart:
yarn svc-deploy
- upgrade the helm chart when you have published new versions using:
yarn svc-upgrade
Performance testing
A starting point Artillery config is generated for each package:
artillery.yml
https://artillery.io/docs/
License
Apache-2.0 © wyvern8