server-controller

Server controller

CRD controller installation is extending the Kubernetes API definition to additional CRD record type called ‘inference-endpoints.ai.intel.com’. Its definition is included in crd.yaml The controller is monitoring the status of ‘inference-endpoints.ai.intel.com’ CRD records and applies required changes in linked Kubernetes deployments, services and ingress resources.

This way managing all aspects of serving inference endpoints can be delegated to a single Kubernetes record. It makes the management much simpler and allows delegating for the users permissions to manage the inference endpoint without exposing other operations and resources in Kubernetes like pods, secrets and config maps.

Inference Endpoint configuration files

How to create new templates is mentioned here.

Docker image building

make docker_build

While the docker image is built it should be pushed to a docker registry accessible by the K8S cluster.

Deployment in Kubernetes cluster

Refer to the helm chart documentation. There is mentioned how to handle with Serving templates.

Deployment using Docker

To launch Server-controller using Docker you must mount volume with Serving templates.

docker run --rm -d -v <Your directory with Serving templates>/:serving-templates server-controller-prod:latest

Development guide

Prerequisites

It is golang project so you need to prepare workspace in order to easily develop it. In order to re-generate deep copy operations for CRD structures you will need deepcopy package.

go get github.com/kubernetes/gengo/examples/deepcopy-gen

All project dependencies are managed by dep tool.

curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
cd server-controller/
dep ensure -v

Local building

In order to build server-controller locally please use following command

go build -v -i .

Continuous integration build

For production usage Dockerfile.prod shall be built and deployed. To do so please use following make command:

make circleci

Local execution

Due to the fact that there is no need to keep two identical codes, before local launching Server-controller please copy Inference Endpoint configuration files from serving-templates to resources directory(Please create empty directory if you dont have one). Server controller requires $PLATFORM_DOMAIN environment variable to be set. It shall contain domain name for the system, controller will operate in. Endpoints created by the controller will include the domain name (e.g. endpointName-namespace.PLATFORM_DOMAIN)

# Assumes you have a working kubeconfig. Not required if operating in-cluster.
export PLATFORM_DOMAIN=some-domain.com
./server-controller -kubeconfig=$HOME/.kube/config

Testing

Creation of new inference endpoint.

In order to create new Inference Endpoint you need to provide description of it in a yaml file. There is one resource file with example called example-inference-endpoint.yaml. In order to add it to existing kubernetes just type: kubectl create -f example-inference-endpoint.yaml

Server-controller will spin new deployment, service and ingress record for you.

Resources removal

In order to remove all resources that sums up to your Inference Endpoint just remove CRD resource you introduced: kubectl delete inference-endpoint example-endpoint