Pripod

Pripod enables you to easily access Pod information from the .NET Core app inside a Pod.

Access information related to pods such as Deployment and ReplicaSet using the Kubernetes API.

Features

No configuration
- If the Kubernetes cluster enables RBAC enabled, you need to assign service account to a Pod.
Minimal API surface (Pod.Current.)
- Pod: Name, Namespace, HostIP, PodIP, Labels, Annotations, NodeName
  - Deployment,ReplicaSet,DaemonSet,StatefulSet,Job,CronJob: Name, Namespace, Labels, Annotations
No dependencies. No need to install KubernetesClient, Json.NET, etc...

Usage

Just docker is enough?

docker build -t pripodsampleapp:debug -f samples/Pripod.SampleApp/Dockerfile .

Or try on kubernetes? To try pripod on your k8s, build docker image then deploy pod.

build docker image and push it.

docker build -t YOUR_USERNAME:debug -f samples/Pripod.SampleApp/Dockerfile .

ADDITONAL: if your cluster is remote, push image to docker hub or any registry.

docker push -t YOUR_USERNAME:debug

Create k8s manifest for pod and appropriate role.

# pripod.yaml
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: pripod-role
  annotations:
    app.kubernetes.io/type: role
rules:
  - apiGroups: [""]
    resources: ["pods"]
    verbs: ["get", "list", "watch"]
  - apiGroups: ["extensions", "apps"]
    resources: ["replicasets"]
    verbs: ["get", "list", "watch"]
  - apiGroups: ["extensions", "apps"]
    resources: ["daemonsets"]
    verbs: ["get", "list", "watch"]
  - apiGroups: ["extensions", "apps"]
    resources: ["deployments"]
    verbs: ["get", "list", "watch"]
  - apiGroups: ["apps"]
    resources: ["statefulsets"]
    verbs: ["get", "list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: pripod-rolebinding
  annotations:
    app.kubernetes.io/type: rolebinding
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: pripod-role
subjects:
  - kind: ServiceAccount
    name: pripod-serviceaccount
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: pripod-serviceaccount
---
apiVersion: v1
kind: Pod
metadata:
  name: pripod
spec:
  serviceAccountName: pripod-serviceaccount
  containers:
    - name: pripod
      image: YOUR_USERNAME:debug
      command: ["sleep", "86400"]

Deploy to your k8s cluster.

kubectl apply -f pripod.yaml

Now you can check your role is correct and pripod can read kubernetes meta.

kubectl exec -it pripod -- dotnet Pripod.SampleApp.dll

Code sample and outputs

using Pripod;

// Optional: Explicitly initialize to improve performance on first-time access.
// Pod.Initialize();

// Determines whether this process is running on the Kubernetes cluster.
Console.WriteLine($"IsRunningOnKubernetes: {Pod.Current.IsRunningOnKubernetes}");

// Show Pod information
Console.WriteLine($"Pod: {Pod.Current.Namespace}/{Pod.Current.Name} @ {Pod.Current.NodeName}");
Console.WriteLine("Labels:");
foreach (var keyValue in Pod.Current.Labels)
{
    Console.WriteLine($"  - {keyValue.Key}: {keyValue.Value}");
}
Console.WriteLine($"HostIP: {Pod.Current.HostIP}");
Console.WriteLine($"PodIP: {Pod.Current.PodIP}");

// Show Deployment information
Console.WriteLine($"Deployment: {Pod.Current.Deployment?.Namespace}/{Pod.Current.Deployment?.Name}");

IsRunningOnKubernetes: True
Pod: default/consoleapp1-595b95b5f7-xsdjc @ docker-for-desktop
Labels:
 - pod-template-hash: 1516516193
 - run: consoleapp1
HostIP: 192.168.0.1
PodIP: 10.1.0.14
Deployment: default/consoleapp1