Repository files navigation

Stream Kubernetes Pod events to the Coder startup logs.

• Easily determine the reason for a pod provision failure, or why a pod is stuck in a pending state.
• Visibility into when pods are OOMKilled, or when they are evicted.
• Filter by namespace, field selector, and label selector to reduce Kubernetes API load.

Apply the Helm chart to start streaming logs into your Coder instance:

helm repo add coder-logstream-kube https://helm.coder.com/logstream-kubehelm install coder-logstream-kube coder-logstream-kube/coder-logstream-kube \    --namespace coder \    --set url=<your-coder-url-including-http-or-https>

Multi-Namespace support

By default, coder-logstream-kube will watch all namespaces in the cluster. To limit which namespaces are monitored, you can specify them in thevalues.yaml file:

# Watch specific namespaces onlynamespaces:["default", "kube-system"]# Watch all namespaces (default)namespaces:[]

Whennamespaces is empty or not specified, the service will monitor all namespaces in the cluster.

NoteFor additional customization (such as customizing the image, pull secrets, annotations, etc.), you can use thevalues.yaml file directly.

Your Coder template should be using akubernetes_deployment resource withwait_for_rollout set tofalse.

resource"kubernetes_deployment""hello_world" {count=data.coder_workspace.me.start_countwait_for_rollout=false...}

This ensures all pod events will be sent during initialization and startup.

Kubernetes provides aninformers API that streams pod and event data from the API server.

coder-logstream-kube listens for pod creation events with containers that have theCODER_AGENT_TOKEN environment variable set. All pod events are streamed as logs to the Coder API using the agent token for authentication.

• SSL_CERT_FILE: Specifies the path to an SSL certificate.
• SSL_CERT_DIR: Identifies which directory to check for SSL certificate files.

Unit tests can be run with:

go test ./... -race

Integration tests run against a real Kubernetes cluster usingKinD (Kubernetes in Docker).

Prerequisites:

• Docker
• KinD
• kubectl

Setup and run:

#Create a KinD cluster./scripts/kind-setup.sh create#Run integration testsgo test -tags=integration -v ./...#Clean up whendone./scripts/kind-setup.sh delete

The integration tests validate:

• Pod event streaming with real Kubernetes informers
• ReplicaSet event handling
• Multi-namespace support
• Label selector filtering