mdai-operator

MDAI K8s Operator

manages MDAI Hubs

Description

MDAI k8s operator:

• Monitors OTEL collectors with labels matching the hub name.
• Creates alerting rules for the Prometheus operator.
• Reads variables from ValKey.
• Requires environment variables with the ValKey endpoint and password to be provided.
• Supports two types of variables: set and string.
• Converts to uppercase MDAI environment variables when injecting them into the OTEL collector if env variable name is not specified explicitly. Injects environment variables into OTEL collectors through a ConfigMap with labels matching the hub name. The OTEL collector must be configured to use the ConfigMap. Operator is not responsible for removing this ConfigMap.
• The ConfigMap name is the MDAI hub name plus -variables

  envFrom:
    - configMapRef:
      name: mdaihub-sample-variables

• For now assuming hub names are unique across all namespaces
• valkey key name has a structure: variable/some_hub_name/some_variable_name
• Updates to variables are applied by triggering the collector’s restart
• Supports the built-in ValKey storage type for variables
• Creates immutable meta variables that have references to other variables

Getting Started

Prerequisites

• go version v1.22.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.
• MDAI OTEL operator CRD installed into cluster.
• Prometheus operator CRD installed into cluster.
• valkey secret created (see below)
• valkey is installed

To Deploy on the local cluster

Create cluster & Deploy Cert manager

kind create cluster -n mdai
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.1/cert-manager.yaml
kubectl wait --for=condition=available --timeout=600s deployment --all -n cert-manager

Other prerequisites operator

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml
helm install valkey oci://registry-1.docker.io/bitnamicharts/valkey --set auth.password=abc \
  --set image.registry="" \
  --set image.repository=public.ecr.aws/decisiveai/valkey \
  --set image.tag=latest \
  -f test/test-samples/valkey-values.yaml
helm install prometheus prometheus-community/kube-prometheus-stack
helm upgrade prometheus prometheus-community/kube-prometheus-stack -f test/test-samples/prometheus-custom-values.yaml
kubectl create namespace otel
kubectl create namespace mdai
kubectl create configmap mdai-operator-release-info \
  --from-literal=RELEASE_NAME=mdai \
  --namespace=mdai
kubectl create secret generic valkey-secret \
  --from-literal=VALKEY_ENDPOINT=valkey-primary.default.svc.cluster.local:6379 \
  --from-literal=VALKEY_PASSWORD=abc \
  --namespace=mdai \
  --dry-run=client -o yaml | kubectl apply -f -

Build and deploy to the local kind cluster: Make sure you have the right k8s context selected, run:

make local-deploy

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

Testing

Deploy test OTEL collectors:

kubectl apply -k test/test-samples/

Run E2E test locally

clear ; kind delete cluster ; kind create cluster ; sleep 30 ; IMG=mdai-operator:v0.0.1 make test-e2e

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete test OTEL collectors:

kubectl delete -k test/test-samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

Undeploy the controller from the cluster:

make undeploy

Helm

Install helm plugin

make helm-values-schema-json-plugin

Regenerate from the latest manifests:

Update VERSION number in make file and run:

make helm-update

• update chart and app version in deployment/Chart.yaml
• update image version in deployment/values.yaml
• update newTag in config/manager/kustomization.yaml
• update README.md in deployment
• update values.schema.json in deployment

Package chart

make helm-package

Publish chart

make helm-publish

Project Distribution

Following the options to release and provide this solution to the users.

By providing a bundle with all YAML files

1. Build the installer for the image built and published in the registry:

make build-installer IMG=mdai-operator:v0.0.1

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

1. Using the installer

Users can just run 'kubectl apply -f ' to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/mdai-operator/<tag or branch>/dist/install.yaml