CanSupportMe.Operator 1.0.0-nightly

CanSupportMe.Operator

Overview

What is this?

This package will allow you to create a simple Kubernetes Operator in .NET.
It can pick up changes to CRDs, ConfigMaps or Secrets and say if it was added, modified or deleted. It can check if a CRD exists as well as retrieve, create, replace and delete configmaps and secrets. It can also update the status of any manifest that supports it.

What isn't this?

It is not a full blown Kubernetes Operator SDK. These exist and, if desired, this package can be used in conjunction with them. It has been developed to do what the project required and nothing more however this will likely fit the requirements of many similar projects too.

Getting Started

Prerequisites

• .NET 8 or later
• A Kubernetes cluster (either local or remote)
• Sufficient access to the cluster to read and watch secrets (for the demo)
• The ability to create a service account and cluster role binding with access to the resources you will be watching or creating

Install the package

dotnet add package CanSupportMe.Operator

Create a simple operator

Where you are definting your services in Program.cs add the following:

services.AddOperator(options =>
{
	options.Group = "";
	options.Kind = "Secret";
	options.Version = "v1";
	options.Plural = "secrets";
	options.Scope = ResourceScope.Namespaced;

	options.OnAdded = async (kind, name, @namespace, item, dataObjectManager) =>
	{
		Log.Information("A secret called {Name} in {Namespace} of type {Type} with {ItemCount} item(s) was added", name, @namespace, item.Type, item.Data?.Count);
	};

	# This will normally work for most clusters including Azure Kubernetes Service (AKS)
	options.KubeConfigPath = Environment.GetEnvironmentVariable("KUBECONFIG");

	# This will work for most clusters including Azure Kubernetes Service (AKS)
	options.KubernetesServiceHost = Environment.GetEnvironmentVariable("KUBERNETES_SERVICE_HOST");
	options.FailoverToken = FAILOVER_TOKEN; # Note this is only required if pointing at a cluster/user that doesn't contain a token in KUBECONFIG
});

Retrieve service token

export SERVICEACCOUNT="cansupportme-operator"

kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
  name: ${SERVICEACCOUNT}-token
  namespace: seqapikey-system
  annotations:
    kubernetes.io/service-account.name: $SERVICEACCOUNT
type: kubernetes.io/service-account-token
EOF

export TOKEN=$(kubectl -n seqapikey-system get secret ${SERVICEACCOUNT}-token -o jsonpath='{.data.token}' | base64 --decode)
echo $TOKEN