microkubes's Introduction

microkubes

Microkubes is a ground-up scalable microservice framework

Getting started guide

For more information and how to set up your first microservice with Microkubes, visit our Getting started page.

Deployment guide for Kubernetes

These instructions will let you deploy the Microkubes on Kubernetes

Preparing

Run a single-node Kubernetes cluster via Minikube tool

minikube --memory 8192 --cpus 2 start

Create keys for authorization servers:

./keys/create.sh

Create a default microkubes namespace and service account

kubectl create -f kubernetes/manifests/namespace.yaml
kubectl create -f kubernetes/manifests/serviceaccount.yaml

Create a secret from keys generated in Step 2

kubectl -n microkubes create secret generic microkubes-secrets \
	--from-file=keys/default \
	--from-file=keys/default.pub \
	--from-file=keys/private.pem \
	--from-file=keys/public.pub \
	--from-file=keys/service.cert \
	--from-file=keys/service.key \
	--from-file=keys/system \
	--from-file=keys/system.pub

Create a secret for the mongo objects creation

kubectl -n microkubes create secret generic mongo-init-db \
        --from-file=./kubernetes/manifests/mongo/create_microkubes_db_objects.sh

Create microkubes configmap

kubectl -n microkubes create -f kubernetes/manifests/microkubes-configmap.yaml

Deploy Microkubes

Run the following commands:

cd kubernetes/manifests
kubectl create -f consul.yaml
kubectl create -f kube-consul-register.yaml
kubectl create -f kong.yaml
kubectl create -f mongo.yaml
kubectl create -f rabbitmq.yaml
kubectl create -f fakesmtp.yaml
kubectl create -f microkubes.yaml

The platform takes about 5 minutes to bring up and you can follow the progress using kubectl -n microkubes get pods -w. Once all services are running, you can start using microkubes.

Check that microkubes is up and running

The API gateway is exposed as a nodePort in kubernetes, you can get the URL and do an http GET request to check that microkubes is responding.

MICROKUBES_URL=`minikube service -n microkubes kong --url`
curl $MICROKUBES_URL/users

Contributing

For contributing to this repository or its documentation, see the Contributing guidelines.

microkubes's People

Contributors

Stargazers

Watchers

microkubes's Issues

Implement deploy order and Health Check inside the Helm chart

We need to solve the dependency between the microservices, there are too many errors during the helm install process, we can solve this by setting up health checks (Liveness and Readiness probes) in Kubernetes.

Allow sending mail to unencrypted connection when deploying the example configuration

Currently we're getting errors in the log of microservice-mail:

microkubes_microservice-mail.1.uchrwz32tex9@pavle-lx    | 2018/12/07 13:08:03 Failed to send mail to [email protected]: unencrypted connection

The example setup of Microkubes ships with integrated dummy mail server (Mailhog). Mailhog is configured to listen on plain HTTP (unencypted connection), but microservice-mail is not configured to send to unencrypted servers. This ENV variable should be configured:
export ALLOW_UNENCRYPTED_CONNECTION=true

to allow sending the emails over plain text for the dummy mail server.

Consul URL is hard coded in kong migrations

Scripts:

Creation of mongo-init-db secret is missing from the documentation

The mongo deployment needs the mongo-init-db secret to be created. So, running kubectl create secret generic mongo-init-db --from-file=./kubernetes/mongo/create_microkubes_db_objects.sh does the trick. However this is not an ideal design. We should rather move the creation of databse objects within the actual microservices rather than outside.

Recommend Projects

microkubes / microkubes Goto Github PK