Skip to main content

kube-noob - Learn. Audit. Debug. Offline.

kube-noob

ci OpenSSF Scorecard PyPI License

Learn, audit and debug Kubernetes, OpenShift, ROSA HCP, Helm and RHACS/StackRox, offline by default. Use it as an MCP server, a Claude plugin, a CLI, or a sidecar/service on OpenShift.

  • Audit: 60 rules plus strict schemas (Kubernetes 1.35, Routes, SCCs, EgressFirewall, Gateway API, StackRox), removed-API checks, safe auto-fixes, 9 red-team scenarios, RHACS policy mapping.
  • Generate: hardened manifests and Helm charts for kubernetes, openshift, rosa-classic, rosa-hcp, re-audited before they are returned.
  • Debug: 33 offline playbooks; opt-in, read-only cluster evidence (Secrets are never read, values are redacted).
  • Learn: 5 tracks, 16 lessons, graded exercises and quizzes.
  • Cite: answers reference local knowledge as [kn:<doc>#<n>] with source and license.

Every design request runs a 7-step protocol: Clarify, Validate, Research, Audit, Calibrate, Generate, Red Team.

Quick start

pipx install kube-noob
kube-noob learn tracks
kube-noob audit -f k8s/ --platform openshift --version 4.22
kube-noob diagnose -f events.txt

Generate a hardened app for ROSA HCP from a blueprint:

name: orders-api
namespace: shop
image: quay.io/acme/orders@sha256:<digest>
platform: rosa-hcp
storage: {size: 20Gi, accessMode: ReadWriteMany}
exposure: {type: route, host: orders.apps.example.com}
kube-noob protocol "deploy orders-api with shared storage" --blueprint blueprint.yaml

Use with Claude or any MCP client

Claude Code plugin (skills + server):

/plugin marketplace add aashishmahajan/kube-noob
/plugin install kube-noob@kube-noob

Any MCP client:

{"mcpServers": {"kube-noob": {"command": "uvx", "args": ["--from", "kube-noob==0.1.1", "kube-noob", "mcp"]}}}

Tools are prefixed kubenoob_ (protocol, audit, fix, generate, diagnose, search, learn, grade). Cluster and web tools appear only when enabled.

Run on OpenShift

git clone https://github.com/aashishmahajan/kube-noob && cd kube-noob
oc new-project kube-noob
oc create secret generic kube-noob-token --from-literal=token="$(openssl rand -hex 32)"
helm install kube-noob deploy/helm/kube-noob --set auth.existingSecret=kube-noob-token

The service requires a bearer token, ships NetworkPolicies and runs under restricted-v2. For a loopback-only sidecar see deploy/sidecar.

Safe by default

Setting Default Enable with
Web lookups (allowlisted HTTPS docs only) off webEnabled: true / KUBE_NOOB_WEB_ENABLED=true
Live cluster (read-only, no Secrets) off cluster.enabled: true / --cluster-enabled
LLM agent (kube-noob ask) Anthropic claude-fable-5-1 llm.provider: openai-compatible + llm.baseUrl for local models

Config comes from --config, $KUBE_NOOB_CONFIG, ~/.config/kube-noob/config.yaml or /etc/kube-noob/config.yaml, never implicitly from the current directory. All keys: kube-noob.example.yaml.

Docs

Credits

Built on public, credited sources (Kubernetes docs CC BY 4.0, OpenShift docs, Red Hat Cloud Experts, HyperShift, StackRox, Helm docs and more): see THIRD_PARTY_NOTICES.md. Kubernetes, OpenShift, Helm, ROSA, RHACS and StackRox are trademarks of their owners; kube-noob is independent and not endorsed by them. Licensed under Apache-2.0.

Metadata

Release files for kube-noob 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kube-noob 0.1.1
File Size Uploaded Provenance
kube_noob-0.1.1.tar.gz 574.7 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for kube-noob 0.1.1
File Interpreter ABI Platform
kube_noob-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 829.1 kB

Release files / kube_noob-0.1.1.tar.gz

Download URL kube_noob-0.1.1.tar.gz
Size 574.7 kB
Tags Source
SHA-256 checksum
How to use checksums
446e73710acd757aa5c77e0dd5b58a1c18cfd811aad12ddc5a6c08c2ebb4e3e5
BLAKE2b-256 checksum
How to use checksums
fa1a7dd780f5a9a2c4db6fbaa387c02a4c76a70d5cf634d8354e94fd48afa511
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

Release files / kube_noob-0.1.1-py3-none-any.whl

Download URL kube_noob-0.1.1-py3-none-any.whl
Size 254.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
08c3df4d312d10b498fde2fa55d6dcfff8c2bbf26d043d2ee1d2b8cb3f513957
BLAKE2b-256 checksum
How to use checksums
4144fe06e352eccc38ad499d92f93127498bc263aa9b9f12f0027dd85b9dcabf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

Security for kube-noob 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for kube_noob-0.1.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 27, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page