#enrober

This project consists of a an API server that functions as a wrapper around the kubernetes client library. The server can be deployed both locally and as a docker container within a kubernetes cluster.

###Local Deployment

go build
./enrober

The server will be accesible at localhost:9000/

For the server to be able to communicate with your kubernetes cluster you must run:

kubectl proxy --port=8080 &

Please note that this allows for insecure communication with your kubernetes cluster and should only be used for testing.

###Kubernetes Deployment

A prebuilt docker image is available with:

docker pull thirtyx/enrober:v0.5.0

To deploy the server as a docker container on a kubernetes cluster you should use the provided deploy.yaml file. Running kubectl create -f deploy-base.yaml will pull the image from dockerhub and deploy it to the default namespace.

The server will be accesible at it's <pod-ip>

Additionally you can expose the server using a kubernetes service. Refer to the docs here.

###Privileged Containers

By default enrober doesn't allow privileged containers to be deployed and will modify the containers security context at deploy time so that Priveleged = false. If you have a need for privileged containers set the ALLOW_PRIV_CONTAINERS environment variable to "true" in enrobers deployment yaml file.

##API Design

An OpenAPI.yaml file is provided that documents the API per the OpenAPI specification.

##Key Components

####Environments

An environment consists of a kubernetes namespace and our specific secrets associated with it. Each environment comes with a routing secret that contains two key-value pairs, a public-api-key and a private-api-key. These are for use with the k8s-router to allow for secure communication with pods from inside and outside of the kubernetes cluster.

When created environments can accept an array of valid host names to accept traffic from. This array is represented on the namespace object as a space delimited annotation. The individual values must be either a valid IP address or valid host name.

####Deployments

When created deployments can accept a publicHosts value, a privateHosts value or both. These values are for use with the k8s-router and are the host name where the deployment can be reached. These values are stored as annotations on the deployed pods.

####Pod Template Specs

Enrober only accepts Pod Template Specs(PTS) through a URL. For testing it is easiest to host your PTS as JSON objects on a site like myjson.com.

Additionally Enrober only supports single container pods at this time!

An example Pod Template Spec might look like:

{
  "metadata": {
    "name": "django",
    "labels": {
      "component": "webapp"
    }
  },
  "spec": {
    "containers": [
      {
        "name": "frontend",
        "image": "django",
        "ports": [
          {
            "containerPort": 8000
          }
        ]
      }
    ]
  }
}

##Usage

This assumes you are running the server locally, it is accessible at localhost:9000, and your kubernetes cluster is exposed with kubectl proxy --port=8080

Note: When running in production mode all API calls require a valid Apigee SSO JWT to be passed into an authorization header.

####Create a new environment:

curl -X POST -d '{
	"environmentName": "org1:env1",
	"hostNames": ["host1"]
	}' \
"localhost:9000/environments"

This will create a org1-env1 namespace and a secret named routing with two key-value pairs:

• public-api-key
• private-api-key

The value of each of these keys-value pairs will a 256-bit base64 encoded randomized string. These secrets are for use with 30x/k8s-pods-ingress

###Update the environment

curl -X PATCH -d '{
	"hostNames": ["host1", "host2"]
	}' \
"localhost:9000/environments/org1:env1"

This will modify the previously created environment's hostNames array to equal:

["host1", "host2"]

###Create deployment

curl -X POST -d '{
	"deploymentName": "dep1",
	"publicHosts": "",
	"privateHosts": "",
	"replicas": 1,
	"ptsURL": "https://api.myjson.com/bins/3f781"
}' \
"localhost:9000/environments/org1:env1/deployments"

Update deployment

curl -X PATCH  -d '{
	"replicas": 3,
}' \
"localhost:9000/environments/org1:env1/deployments/dep1"

This will modify the previous deployment to now guarantee 3 replicas of the pod.

###Delete deployment

curl -X DELETE  \
"localhost:9000/environments/org1:env1/deployments/dep1"

This will delete the previously created deployment and all related resources such as replica sets and pods.

###Delete environment

curl -X DELETE \
"localhost:9000/environments/org1:env1"

This will delete the previously created environment.