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, read-only steps first; opt-in, read-only cluster evidence (Secrets are never read, values are redacted).
  • Learn: 5 tracks, 16 lessons, graded exercises and quizzes; remembers confirmed team fixes locally.
  • 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 demo --list
kube-noob audit -f k8s/ --platform openshift --version 4.22
kube-noob diagnose -f events.txt
kube-noob doctor
kube-noob selftest

Pick your role in use cases; every demo runs offline.

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.2.0", "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 Change with
Web lookups (HTTPS GET, allowlisted docs, text only) off webEnabled: true / KUBE_NOOB_WEB_ENABLED=true
Admin offline lock (overrides web, local models only) off offline: true / KUBE_NOOB_OFFLINE=1 / chart config.offline
Live cluster (read-only, no Secrets) off cluster.enabled: true / --cluster-enabled
Local learning file (profile, confirmed notes) on learningEnabled: false
LLM agent (kube-noob ask) Anthropic claude-fable-5-1 llm.provider: openai-compatible + llm.baseUrl for local models

kube-noob doctor prints what the process can reach and exits 1 when the configuration contradicts the lock.

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.2.0

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.2.0
File Size Uploaded Provenance
kube_noob-0.2.0.tar.gz 634.3 kB With provenance Details

Built distribution (wheel)

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

Total release size: 932.7 kB

Release files / kube_noob-0.2.0.tar.gz

Download URL kube_noob-0.2.0.tar.gz
Size 634.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0be728c7ebb57e225473dc7570914755ce52eace22f89b47325d813f753c45cc
BLAKE2b-256 checksum
How to use checksums
db376aed6c77cc61b13fd08d6ee9aa748a5bceccdb28527424999bd710c09af6
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.2.0-py3-none-any.whl

Download URL kube_noob-0.2.0-py3-none-any.whl
Size 298.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8fa198596181f4fbe3544c3f1085e416e054135023d276c1904c4c688bef9715
BLAKE2b-256 checksum
How to use checksums
493ec18e02b416fcd54a0a5ad945ef085a8f37fa2ab5ea263393e78f6b42f095
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.2.0

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.2.0.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