Kepler Installation

Requirements

Kernel 4.18+
Access to a Kubernetes cluster
kubectl v1.21.0+

Deployments

Deploy using Helm Chart

The Kepler Helm Chart is available on GitHub and ArtifactHub

For Installation Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

The chart is accessible using the following commands:

Add the helm repo

helm repo add kepler https://sustainable-computing-io.github.io/kepler-helm-chart

You can see the latest version by using the folllowing command:

helm search repo kepler

If you would like to test and look at the manifest files before deploying you can run:

helm install kepler kepler/kepler --namespace kepler --create-namespace --dry-run --devel

Then to install run the following:

helm install kepler kepler/kepler --namespace kepler --create-namespace

You may want to override values.yaml file use the following command.

helm install kepler kepler/kepler --values values.yaml --namespace kepler --create-namespace

The following table lists the configurable parameters for this chart and their default values.

Parameter	Description	Default
global.namespace	Kubernete namespace for kepler	kepler
image.repository	Repository for Kepler Image	quay.io/sustainable_computing_io/kepler
image.pullPolicy	Pull policy for Kepler	Always
image.tag	Image tag for Kepler Image	latest
serviceAccount.name	Service acccount name for Kepler	kepler-sa
service.type	Kepler service type	ClusterIP
service.port	Kepler service exposed port	9102

Uninstall the kepler

To uninstall this chart, use the following steps

helm delete --purge kepler --tiller-namespace <namespace>

Deploy from source code

Follow the steps below to deploy the Kepler exporter as a Daemonset to run on all Nodes. The following deployment will also create a service listening on port 9102.

First, fork the kepler repository and clone it.

Then, build the manifests file that suit your environment and deploy it with the following steps:

Build manifests

make build-manifest OPTS="<deployment options>"
# minimum deployment: 
# > make build-manifest
# deployment with sidecar on openshift: 
# > make build-manifest OPTS="ESTIMATOR_SIDECAR_DEPLOY OPENSHIFT_DEPLOY"

Manifests will be generated in _output/manifests/kubernetes/generated/ by default.

Deployment Option	Description	Dependency
BM_DEPLOY	baremetal deployment patched with node selector feature.node.kubernetes.io/cpu-cpuid.HYPERVISOR to not exist	-
OPENSHIFT_DEPLOY	patch openshift-specific attribute to kepler daemonset and deploy SecurityContextConstraints	-
PROMETHEUS_DEPLOY	patch prometheus-related resource (ServiceMonitor, RBAC role, rolebinding)	require prometheus deployment which can be OpenShift integrated or custom deploy
CLUSTER_PREREQ_DEPLOY	deploy prerequisites for kepler on openshift cluster	OPENSHIFT_DEPLOY option set
CI_DEPLOY	update proc path for kind cluster using in CI	-
ESTIMATOR_SIDECAR_DEPLOY	patch estimator sidecar and corresponding configmap to kepler daemonset	-
MODEL_SERVER_DEPLOY	deploy model server and corresponding configmap to kepler daemonset	-
TRAIN_DEPLOY	patch online-trainer sidecar to model server	MODEL_SERVER_DEPLOY option set
- build-manifest requirements:
- kubectl v1.21+
- make
- go
- manifest sources and outputs will be in `_output/generated-manifest` by default

Deploy using Kubectl

# kubectl apply -f _output/generated-manifest/deployment.yaml

Deploy the Prometheus operator and the whole monitoring stack

If Prometheus is already installed in the cluster, skip this step. Otherwise, follow these steps to install it.

Clone the kube-prometheus project to your local folder.

git clone https://github.com/prometheus-operator/kube-prometheus

Deploy the whole monitoring stack using the config in the manifests directory. Create the namespace and CRDs, and then wait for them to be available before creating the remaining resources. During the until loop, a response of No resources found is to be expected. This statement checks whether the resource API is created but doesn't expect the resources to be there.

cd kube-prometheus
kubectl apply --server-side -f manifests/setup
until kubectl get servicemonitors --all-namespaces ; do date; sleep 1; echo ""; done
kubectl apply -f manifests/