Emmie assists with creating unique and isolated environments for each feature being worked on within an application. This allows for easier testing since the entire application is stood up and doesn't rely on brittle mocks or fake components.
- Working Kubernetes cluster
- Build docker images and tag with branchName (e.g.
stevesloka/web:US1234_AddLogging) - Note: All branchNames need to be consistent across repos
- Deploy all replication controllers and services to a template namespace. This can be a new namespace or configured to be "develop" branch
- listen-port: Port Emmie will listen on to take requests (NOTE: Only listents on HTTPS)
- docker-registry: Set to url of private docker registry
- template-namespace: Namespace to 'clone from when creating new deployments'
- path-to-tokens: Full path including file name to tokens file for authorization, setting to empty string will disable.
Emmie integrates into the k8s api via the supported go client. Setup your CI server to build all Docker images and tag with branch name. Then send POST request and Emmie will look at all the services and replication controllers in the configured template namespace, and deploy to a new namespace. You can repeat this as many times as your cluster has resources.
By default Emmie will tag all the images in the k8s cluster with the branch name requested, however, this means that a tag for the branchname MUST exist in the Docker registry. This can be cubersome since not all images will need to be build (e.g. default to develop) in addition, there is a large overhead of time involved.
Providing Emmie with the account credentials for the ECR repository you want to access, can now check if an image exists first, and if so, will use that tag, otherwise will default to your template image tag.
- POST /deploy/{namespace}/{branchName} : Deploy a new branch
- DELETE /deploy/{branchName} : Delete an environment
- PUT /deploy/{branchName} : Update an existing environment
- GET /deploy : Get list of current deployments
NOTE: Include a token query string to end of all requests for simple auth.
- Create auth tokens file
- Generate certs
- Deploy Emmie to your cluster (See samples)
- Deploy Router to your cluster (
kubectl create -f k8s/router.yml) - Create template namespace
- Deploy template services / replication controllers
- NOTE: Make sure your templates have correct Annotations on them for what to deploy (See Annotations section below).
- Configure CI to build feature branch images
- Configure CI to curl Emmie and deploy new namespace
- Bask in the glory of how your team will produce better well tested code
Since a pod can be made up of many containers, an annotation is required to tell Emmie how to update that pod when deploying new code. In the example below, Emmie looks for the key emmie-update and uses the value to find the container name to replace. In this case the container named web in the pod will be updated with the feature branch deploy.
annotations:
emmie-update: web
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365 -nodes
cd k8s/router
openssl req -newkey rsa:2048 -nodes -keyout tls.key -x509 -days 365 -out tls.crt
Watch a demo here:
http://www.youtube.com/watch?v=w7rshjxsojA
- Do not have network mounts or host mounts, for now this proves difficult to manage via the template system
- If multiple containers are used in a single pod, make sure annotate
Built by UPMC Enterprises in Pittsburgh, PA. http://enterprises.upmc.com/