Skip to content

NorthScope

CI Artifact Hub License

Read-only Kubernetes traffic topology debugger. Pick a host and see its configured path from the load balancer and ingress controller through Ingress or Gateway API routes, Services, and endpoints to Pods.

NorthScope showing the route for shop.demo.localhost from the load balancer to its Pods

Features

  • Search hosts, paths, and Services across namespaces; switch between Simple and Expanded views.
  • Ingress, Gateway API, and F5 CIS resources, discovered when their APIs are installed.
  • Diagnostics for missing Services, wrong backend ports, unready Pods or endpoints, and stale watches.
  • Read-only RBAC, built-in sign-in, and Kubernetes 1.20 or newer.

NorthScope reads Kubernetes configuration only. It does not capture traffic or probe connectivity.

Install

Requirements: Kubernetes 1.20+, Helm 3, and an ingress controller.

The chart exposes NorthScope through an Ingress by default. Set the host in a values file:

# values.yaml
ingress:
  hosts:
    - host: northscope.your-domain.com
  # Recommended: a TLS Secret from cert-manager or your own certificate.
  tls:
    - secretName: northscope-tls
      hosts:
        - northscope.your-domain.com
helm repo add northscope https://emircanagac.github.io/northscope
helm repo update
helm upgrade --install northscope northscope/northscope \
  --namespace northscope --create-namespace -f values.yaml

Open the host in a browser and sign in as admin with the generated password:

kubectl -n northscope get secret northscope-auth -o jsonpath='{.data.password}' | base64 -d; echo

Set ingress.className if the cluster has no default IngressClass. Without an ingress controller, set ingress.enabled=false and run kubectl -n northscope port-forward svc/northscope 18080:80.

See the chart values and production access guide for your own password, GitOps with auth.existingSecret, SSO at the edge, NetworkPolicy, and namespace-scoped installs.

Demo

Load sample healthy and broken routes into a test cluster after installing NorthScope:

kubectl apply -f https://raw.githubusercontent.com/emircanagac/northscope/main/examples/demo-topology.yaml

Security

NorthScope only uses get, list, and watch, and never reads Secrets or Pod logs through the Kubernetes API. The UI requires a sign-in by default because topology data includes internal hostnames and IPs. Report vulnerabilities as described in the security policy.

Status

NorthScope is an early preview. Real-cluster feedback and bug reports are welcome.

Documentation

License

Apache 2.0

Releases

Packages

Used by

Contributors

Languages