kube-noob 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- kube_noob-0.1.1/.claude-plugin/marketplace.json +20 -0
- kube_noob-0.1.1/.gitignore +17 -0
- kube_noob-0.1.1/CHANGELOG.md +23 -0
- kube_noob-0.1.1/Containerfile +55 -0
- kube_noob-0.1.1/LICENSE +201 -0
- kube_noob-0.1.1/NOTICE +12 -0
- kube_noob-0.1.1/PKG-INFO +154 -0
- kube_noob-0.1.1/README.md +105 -0
- kube_noob-0.1.1/SECURITY.md +41 -0
- kube_noob-0.1.1/THIRD_PARTY_NOTICES.md +37 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/Chart.yaml +14 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/NOTES.txt +7 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/_helpers.tpl +19 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/configmap.yaml +33 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/deployment.yaml +110 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/exposure.yaml +40 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/networkpolicy.yaml +57 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/pdb.yaml +11 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/pvc.yaml +15 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/rbac.yaml +63 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/service.yaml +10 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/serviceaccount.yaml +6 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/templates/tests/test-health.yaml +38 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/values.schema.json +21 -0
- kube_noob-0.1.1/deploy/helm/kube-noob/values.yaml +69 -0
- kube_noob-0.1.1/deploy/sidecar/app-with-kube-noob-sidecar.yaml +91 -0
- kube_noob-0.1.1/plugin/kube-noob/.claude-plugin/icon.png +0 -0
- kube_noob-0.1.1/plugin/kube-noob/.claude-plugin/plugin.json +13 -0
- kube_noob-0.1.1/plugin/kube-noob/.mcp.json +17 -0
- kube_noob-0.1.1/plugin/kube-noob/LICENSE +201 -0
- kube_noob-0.1.1/plugin/kube-noob/README.md +30 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/helm-charts/SKILL.md +17 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/kube-debugging/SKILL.md +18 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/kube-master-controller/SKILL.md +41 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/kubernetes-core/SKILL.md +21 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/openshift-platform/SKILL.md +19 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/rhacs-stackrox/SKILL.md +19 -0
- kube_noob-0.1.1/plugin/kube-noob/skills/rosa-hcp/SKILL.md +19 -0
- kube_noob-0.1.1/pyproject.toml +137 -0
- kube_noob-0.1.1/requirements.lock +827 -0
- kube_noob-0.1.1/scripts/bump_version.py +84 -0
- kube_noob-0.1.1/scripts/check_publishable.sh +30 -0
- kube_noob-0.1.1/scripts/e2e_mcp_http.py +113 -0
- kube_noob-0.1.1/scripts/risk_baseline.json +9 -0
- kube_noob-0.1.1/scripts/risk_review.py +238 -0
- kube_noob-0.1.1/scripts/vendor_schemas.py +217 -0
- kube_noob-0.1.1/server.json +43 -0
- kube_noob-0.1.1/src/kube_noob/__init__.py +15 -0
- kube_noob-0.1.1/src/kube_noob/__main__.py +3 -0
- kube_noob-0.1.1/src/kube_noob/agent/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/agent/loop.py +139 -0
- kube_noob-0.1.1/src/kube_noob/agent/providers.py +250 -0
- kube_noob-0.1.1/src/kube_noob/audit/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/audit/engine.py +72 -0
- kube_noob-0.1.1/src/kube_noob/audit/fixer.py +539 -0
- kube_noob-0.1.1/src/kube_noob/audit/model.py +142 -0
- kube_noob-0.1.1/src/kube_noob/audit/podspec.py +149 -0
- kube_noob-0.1.1/src/kube_noob/audit/protocol.py +193 -0
- kube_noob-0.1.1/src/kube_noob/audit/quantity.py +45 -0
- kube_noob-0.1.1/src/kube_noob/audit/redteam.py +316 -0
- kube_noob-0.1.1/src/kube_noob/audit/rules.py +1851 -0
- kube_noob-0.1.1/src/kube_noob/catalog.py +600 -0
- kube_noob-0.1.1/src/kube_noob/cli.py +641 -0
- kube_noob-0.1.1/src/kube_noob/config.py +282 -0
- kube_noob-0.1.1/src/kube_noob/data/brand/kube-noob-icon.svg +69 -0
- kube_noob-0.1.1/src/kube_noob/data/curriculum.yaml +449 -0
- kube_noob-0.1.1/src/kube_noob/data/evals/tasks.yaml +212 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/helm-troubleshooting.md +33 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/helm.md +44 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-debug-pods.md +26 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-deprecations.md +98 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-images.md +21 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-networkpolicy.md +42 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-pdb.md +20 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-probes.md +26 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-pss.md +42 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-rbac.md +22 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-resources.md +26 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-services.md +23 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/k8s-topology-spread.md +27 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/kubernetes.md +47 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/learning-paths.md +51 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/master-controller.md +68 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/ocp-arbitrary-uid.md +28 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/ocp-egressfirewall.md +32 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/ocp-operators.md +21 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/ocp-routes.md +40 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/ocp-scc.md +37 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/openshift.md +48 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/rosa-efs.md +29 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/rosa-hcp.md +61 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/stackrox-admission.md +39 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/stackrox.md +49 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/storage-access-modes.md +41 -0
- kube_noob-0.1.1/src/kube_noob/data/knowledge/version-history.md +38 -0
- kube_noob-0.1.1/src/kube_noob/debug/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/debug/cluster.py +412 -0
- kube_noob-0.1.1/src/kube_noob/debug/diagnose.py +274 -0
- kube_noob-0.1.1/src/kube_noob/debug/playbooks.py +908 -0
- kube_noob-0.1.1/src/kube_noob/errors.py +54 -0
- kube_noob-0.1.1/src/kube_noob/evals/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/evals/checks.py +262 -0
- kube_noob-0.1.1/src/kube_noob/evals/export.py +215 -0
- kube_noob-0.1.1/src/kube_noob/evals/judge.py +74 -0
- kube_noob-0.1.1/src/kube_noob/evals/reward.py +275 -0
- kube_noob-0.1.1/src/kube_noob/evals/runner.py +53 -0
- kube_noob-0.1.1/src/kube_noob/generate/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/generate/blueprint.py +253 -0
- kube_noob-0.1.1/src/kube_noob/generate/helm.py +271 -0
- kube_noob-0.1.1/src/kube_noob/generate/manifests.py +503 -0
- kube_noob-0.1.1/src/kube_noob/knowledge/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/knowledge/store.py +389 -0
- kube_noob-0.1.1/src/kube_noob/learn/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/learn/tutor.py +258 -0
- kube_noob-0.1.1/src/kube_noob/net.py +86 -0
- kube_noob-0.1.1/src/kube_noob/py.typed +0 -0
- kube_noob-0.1.1/src/kube_noob/schemas/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/PROVENANCE.json +74 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/gateway.networking.k8s.io_v1_Gateway.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/gateway.networking.k8s.io_v1_HTTPRoute.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/k8s.ovn.org_v1_EgressFirewall.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/platform.stackrox.io_v1alpha1_Central.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/platform.stackrox.io_v1alpha1_SecuredCluster.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/route.openshift.io_v1_Route.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/crds/security.openshift.io_v1_SecurityContextConstraints.json +1 -0
- kube_noob-0.1.1/src/kube_noob/schemas/data/kubernetes-v1.35.0-definitions.json.gz +0 -0
- kube_noob-0.1.1/src/kube_noob/schemas/validate.py +124 -0
- kube_noob-0.1.1/src/kube_noob/server/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/server/mcp_app.py +353 -0
- kube_noob-0.1.1/src/kube_noob/sources/__init__.py +1 -0
- kube_noob-0.1.1/src/kube_noob/sources/corpus.py +140 -0
- kube_noob-0.1.1/src/kube_noob/sources/git_ingest.py +163 -0
- kube_noob-0.1.1/src/kube_noob/sources/history.py +95 -0
- kube_noob-0.1.1/src/kube_noob/sources/jira.py +459 -0
- kube_noob-0.1.1/src/kube_noob/sources/registry.py +217 -0
- kube_noob-0.1.1/src/kube_noob/toolkit.py +620 -0
- kube_noob-0.1.1/src/kube_noob/yamlio.py +194 -0
- kube_noob-0.1.1/tests/__init__.py +0 -0
- kube_noob-0.1.1/tests/conftest.py +36 -0
- kube_noob-0.1.1/tests/fixtures/bad-bundle.yaml +82 -0
- kube_noob-0.1.1/tests/fixtures/legacy-bundle.yaml +80 -0
- kube_noob-0.1.1/tests/test_audit.py +166 -0
- kube_noob-0.1.1/tests/test_bump_version.py +83 -0
- kube_noob-0.1.1/tests/test_config_net.py +61 -0
- kube_noob-0.1.1/tests/test_coverage_paths.py +313 -0
- kube_noob-0.1.1/tests/test_debug.py +158 -0
- kube_noob-0.1.1/tests/test_distribution.py +47 -0
- kube_noob-0.1.1/tests/test_evals_jira.py +300 -0
- kube_noob-0.1.1/tests/test_generate.py +100 -0
- kube_noob-0.1.1/tests/test_knowledge_learn.py +79 -0
- kube_noob-0.1.1/tests/test_redteam_regressions.py +170 -0
- kube_noob-0.1.1/tests/test_reward_hardening.py +166 -0
- kube_noob-0.1.1/tests/test_risk_review.py +86 -0
- kube_noob-0.1.1/tests/test_security_hardening.py +175 -0
- kube_noob-0.1.1/tests/test_server_agent_cli.py +312 -0
- kube_noob-0.1.1/tests/test_yamlio_catalog.py +62 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "kube-noob",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "kube-noob maintainers",
|
|
5
|
+
"url": "https://github.com/aashishmahajan/kube-noob"
|
|
6
|
+
},
|
|
7
|
+
"metadata": {
|
|
8
|
+
"description": "kube-noob plugin marketplace"
|
|
9
|
+
},
|
|
10
|
+
"plugins": [
|
|
11
|
+
{
|
|
12
|
+
"name": "kube-noob",
|
|
13
|
+
"source": "./plugin/kube-noob",
|
|
14
|
+
"description": "Offline-first Kubernetes / OpenShift / ROSA HCP / Helm / RHACS learning, audit and debugging (MCP server + skills).",
|
|
15
|
+
"version": "0.1.1",
|
|
16
|
+
"license": "Apache-2.0",
|
|
17
|
+
"keywords": ["kubernetes", "openshift", "rosa", "helm", "stackrox", "mcp"]
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.1 - 2026-10-27
|
|
4
|
+
|
|
5
|
+
- First PyPI release. 0.1.0 was tagged but never reached PyPI: the pinned pypa/gh-action-pypi-publish v1.13.0 bundles twine 6.1.0, which rejects Metadata-Version 2.5 from current hatchling. Publish action bumped to v1.14.3 (twine 7.0.0) and scorecard-action to v2.5.0; CI and release now check dists with the exact twine the pinned publish action uses (scripts/check_publishable.sh).
|
|
6
|
+
|
|
7
|
+
## 0.1.0 - 2026-10-27
|
|
8
|
+
|
|
9
|
+
First release.
|
|
10
|
+
- MCP server (stdio + authenticated streamable HTTP), CLI, Claude plugin with 7 skills, Helm chart and sidecar example.
|
|
11
|
+
- 7-step protocol (Clarify, Validate, Research, Audit, Calibrate, Generate, Red Team).
|
|
12
|
+
- 60 deterministic audit rules plus strict schema validation (Kubernetes 1.35, Route, SCC, EgressFirewall, Gateway
|
|
13
|
+
API, StackRox CRDs), 9 red-team scenarios, safe auto-fix, RHACS policy mapping.
|
|
14
|
+
- Generator for kubernetes / openshift / rosa-classic / rosa-hcp manifests and Helm charts.
|
|
15
|
+
- 33 debugging playbooks and read-only live cluster evidence (kubectl/oc or in-cluster ServiceAccount).
|
|
16
|
+
- 28 fact-checked knowledge docs (OCP 4.22 = Kubernetes 1.35, Helm 4, RHACS 4.11 -> 5.0, ROSA HCP architecture).
|
|
17
|
+
- Learning tracks with graded exercises, quizzes and credits.
|
|
18
|
+
- Corpus builder (Git docs with license provenance, release history, jittered Jira pulls), deterministic reward with
|
|
19
|
+
TRL adapter, held-out benchmark, SFT/GRPO export.
|
|
20
|
+
- Hardened before release after an independent red-team review: assertion-gated, negation-aware reward with citation
|
|
21
|
+
relevance; config never read implicitly from the working directory; LLM key/endpoint restrictions; redaction of
|
|
22
|
+
credentials in every cluster string; duplicate-key and nesting-depth checks; fixer output that the API server
|
|
23
|
+
accepts (privileged containers, root containers, null securityContexts, duplicate EgressFirewalls).
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# kube-noob container image (OpenShift restricted-v2 compatible: non-root, arbitrary UID, group 0 writable dirs).
|
|
2
|
+
# Build: docker build -f Containerfile -t kube-noob:dev .
|
|
3
|
+
# CI resolves BASE_IMAGE to an immutable digest at build time and records it in the SLSA provenance.
|
|
4
|
+
ARG BASE_IMAGE=registry.access.redhat.com/ubi9/python-312:latest
|
|
5
|
+
|
|
6
|
+
FROM ${BASE_IMAGE} AS build
|
|
7
|
+
USER 0
|
|
8
|
+
WORKDIR /src
|
|
9
|
+
COPY pyproject.toml README.md LICENSE NOTICE requirements.lock ./
|
|
10
|
+
COPY src ./src
|
|
11
|
+
RUN python3 -m pip install --no-cache-dir --upgrade "pip>=24.3" "build>=1.2" \
|
|
12
|
+
&& python3 -m build --wheel --outdir /wheels . \
|
|
13
|
+
&& python3 -m venv /opt/kube-noob \
|
|
14
|
+
&& /opt/kube-noob/bin/pip install --no-cache-dir --require-hashes --only-binary=:all: -r requirements.lock \
|
|
15
|
+
&& /opt/kube-noob/bin/pip install --no-cache-dir --no-deps /wheels/*.whl \
|
|
16
|
+
&& /opt/kube-noob/bin/kube-noob --version
|
|
17
|
+
|
|
18
|
+
FROM ${BASE_IMAGE}
|
|
19
|
+
ARG VERSION=0.1.1
|
|
20
|
+
# Red Hat container certification (preflight HasRequiredLabel) needs name, vendor, version, release, summary,
|
|
21
|
+
# description and maintainer; the MCP Registry verifies ownership of OCI images through io.modelcontextprotocol.*.
|
|
22
|
+
LABEL name="kube-noob" \
|
|
23
|
+
vendor="kube-noob project" \
|
|
24
|
+
version="${VERSION}" \
|
|
25
|
+
release="1" \
|
|
26
|
+
summary="Offline-first Kubernetes/OpenShift/ROSA learning, audit and debugging MCP server" \
|
|
27
|
+
description="kube-noob audits, generates and debugs Kubernetes, OpenShift, ROSA HCP, Helm and RHACS configuration with a deterministic engine and local knowledge; web and cluster access are opt-in and read-only." \
|
|
28
|
+
maintainer="kube-noob maintainers (https://github.com/aashishmahajan/kube-noob)" \
|
|
29
|
+
io.modelcontextprotocol.server.name="io.github.aashishmahajan/kube-noob" \
|
|
30
|
+
org.opencontainers.image.version="${VERSION}" \
|
|
31
|
+
org.opencontainers.image.title="kube-noob" \
|
|
32
|
+
org.opencontainers.image.description="Offline-first Kubernetes/OpenShift/ROSA/Helm/RHACS learning, audit and debugging MCP server" \
|
|
33
|
+
org.opencontainers.image.source="https://github.com/aashishmahajan/kube-noob" \
|
|
34
|
+
org.opencontainers.image.licenses="Apache-2.0" \
|
|
35
|
+
io.k8s.display-name="kube-noob" \
|
|
36
|
+
io.openshift.tags="kubernetes,openshift,mcp,security"
|
|
37
|
+
USER 0
|
|
38
|
+
COPY --from=build /opt/kube-noob /opt/kube-noob
|
|
39
|
+
COPY LICENSE NOTICE THIRD_PARTY_NOTICES.md /licenses/
|
|
40
|
+
RUN mkdir -p /var/lib/kube-noob /etc/kube-noob \
|
|
41
|
+
&& chgrp -R 0 /var/lib/kube-noob /etc/kube-noob \
|
|
42
|
+
&& chmod -R g=u /var/lib/kube-noob /etc/kube-noob
|
|
43
|
+
# webEnabled / cluster.enabled are deliberately not baked in as env vars: env overrides the config file, so an image
|
|
44
|
+
# default would silently ignore `webEnabled: true` in a mounted config. Both default to false in code.
|
|
45
|
+
ENV PATH="/opt/kube-noob/bin:${PATH}" \
|
|
46
|
+
KUBE_NOOB_DATA_DIR=/var/lib/kube-noob \
|
|
47
|
+
PYTHONDONTWRITEBYTECODE=1 \
|
|
48
|
+
PYTHONUNBUFFERED=1 \
|
|
49
|
+
HOME=/tmp
|
|
50
|
+
# Numeric non-root user; OpenShift replaces it with a namespace-range UID in group 0, which still works.
|
|
51
|
+
USER 1001
|
|
52
|
+
WORKDIR /var/lib/kube-noob
|
|
53
|
+
EXPOSE 8080
|
|
54
|
+
ENTRYPOINT ["kube-noob"]
|
|
55
|
+
CMD ["serve", "--host", "0.0.0.0", "--port", "8080"]
|
kube_noob-0.1.1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
kube_noob-0.1.1/NOTICE
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
kube-noob
|
|
2
|
+
Copyright 2026 The kube-noob Authors
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
This product bundles third-party material; see THIRD_PARTY_NOTICES.md and
|
|
7
|
+
src/kube_noob/schemas/data/PROVENANCE.json for sources, licenses and attribution.
|
|
8
|
+
|
|
9
|
+
Kubernetes, Helm, OpenShift, Red Hat OpenShift Service on AWS (ROSA), Red Hat Advanced
|
|
10
|
+
Cluster Security (RHACS) and StackRox are trademarks of their respective owners. kube-noob
|
|
11
|
+
is an independent project and is not affiliated with or endorsed by the Linux Foundation,
|
|
12
|
+
the Cloud Native Computing Foundation, Red Hat, Inc. or Amazon Web Services.
|
kube_noob-0.1.1/PKG-INFO
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: kube-noob
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Offline-first learning, manifest-audit and debugging agent for Kubernetes, Helm, OpenShift, ROSA HCP and StackRox (RHACS). Runs as an MCP server, a CLI, or an OpenShift sidecar.
|
|
5
|
+
Project-URL: Homepage, https://github.com/aashishmahajan/kube-noob
|
|
6
|
+
Project-URL: Source, https://github.com/aashishmahajan/kube-noob
|
|
7
|
+
Project-URL: Issues, https://github.com/aashishmahajan/kube-noob/issues
|
|
8
|
+
Project-URL: Security, https://github.com/aashishmahajan/kube-noob/security/policy
|
|
9
|
+
Project-URL: Documentation, https://github.com/aashishmahajan/kube-noob/tree/main/docs
|
|
10
|
+
Project-URL: Changelog, https://github.com/aashishmahajan/kube-noob/blob/main/CHANGELOG.md
|
|
11
|
+
Author: kube-noob maintainers
|
|
12
|
+
License-Expression: Apache-2.0
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
License-File: NOTICE
|
|
15
|
+
License-File: THIRD_PARTY_NOTICES.md
|
|
16
|
+
Keywords: helm,hypershift,kubernetes,learning,manifest-audit,mcp,model-context-protocol,openshift,rhacs,rosa,security,sre,stackrox
|
|
17
|
+
Classifier: Development Status :: 4 - Beta
|
|
18
|
+
Classifier: Environment :: Console
|
|
19
|
+
Classifier: Intended Audience :: Developers
|
|
20
|
+
Classifier: Intended Audience :: Education
|
|
21
|
+
Classifier: Intended Audience :: System Administrators
|
|
22
|
+
Classifier: Operating System :: OS Independent
|
|
23
|
+
Classifier: Programming Language :: Python :: 3
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
27
|
+
Classifier: Topic :: Security
|
|
28
|
+
Classifier: Topic :: System :: Clustering
|
|
29
|
+
Classifier: Topic :: System :: Systems Administration
|
|
30
|
+
Classifier: Typing :: Typed
|
|
31
|
+
Requires-Python: >=3.11.4
|
|
32
|
+
Requires-Dist: anthropic<3,>=2.0
|
|
33
|
+
Requires-Dist: httpx<1,>=0.27
|
|
34
|
+
Requires-Dist: jsonschema<5,>=4.23
|
|
35
|
+
Requires-Dist: mcp<3,>=2.3
|
|
36
|
+
Requires-Dist: pydantic<3,>=2.12
|
|
37
|
+
Requires-Dist: pyyaml<7,>=6.0.2
|
|
38
|
+
Requires-Dist: starlette>=0.40
|
|
39
|
+
Requires-Dist: uvicorn<1,>=0.31
|
|
40
|
+
Provides-Extra: dev
|
|
41
|
+
Requires-Dist: build>=1.2; extra == 'dev'
|
|
42
|
+
Requires-Dist: mypy>=1.13; extra == 'dev'
|
|
43
|
+
Requires-Dist: pip-audit>=2.7; extra == 'dev'
|
|
44
|
+
Requires-Dist: pytest-cov>=5; extra == 'dev'
|
|
45
|
+
Requires-Dist: pytest>=8.3; extra == 'dev'
|
|
46
|
+
Requires-Dist: ruff>=0.8; extra == 'dev'
|
|
47
|
+
Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
|
|
48
|
+
Description-Content-Type: text/markdown
|
|
49
|
+
|
|
50
|
+
<p align="center">
|
|
51
|
+
<img src="https://raw.githubusercontent.com/aashishmahajan/kube-noob/main/docs/brand/social-preview.png" alt="kube-noob - Learn. Audit. Debug. Offline." width="720">
|
|
52
|
+
</p>
|
|
53
|
+
|
|
54
|
+
# kube-noob
|
|
55
|
+
|
|
56
|
+
<!-- mcp-name: io.github.aashishmahajan/kube-noob -->
|
|
57
|
+
|
|
58
|
+
[](https://github.com/aashishmahajan/kube-noob/actions/workflows/ci.yml)
|
|
59
|
+
[](https://securityscorecards.dev/viewer/?uri=github.com/aashishmahajan/kube-noob)
|
|
60
|
+
[](https://pypi.org/project/kube-noob/)
|
|
61
|
+
[](https://github.com/aashishmahajan/kube-noob/blob/main/LICENSE)
|
|
62
|
+
|
|
63
|
+
Learn, audit and debug Kubernetes, OpenShift, ROSA HCP, Helm and RHACS/StackRox, offline by default.
|
|
64
|
+
Use it as an MCP server, a Claude plugin, a CLI, or a sidecar/service on OpenShift.
|
|
65
|
+
|
|
66
|
+
- **Audit**: 60 rules plus strict schemas (Kubernetes 1.35, Routes, SCCs, EgressFirewall, Gateway API, StackRox),
|
|
67
|
+
removed-API checks, safe auto-fixes, 9 red-team scenarios, RHACS policy mapping.
|
|
68
|
+
- **Generate**: hardened manifests and Helm charts for `kubernetes`, `openshift`, `rosa-classic`, `rosa-hcp`, re-audited
|
|
69
|
+
before they are returned.
|
|
70
|
+
- **Debug**: 33 offline playbooks; opt-in, read-only cluster evidence (Secrets are never read, values are redacted).
|
|
71
|
+
- **Learn**: 5 tracks, 16 lessons, graded exercises and quizzes.
|
|
72
|
+
- **Cite**: answers reference local knowledge as `[kn:<doc>#<n>]` with source and license.
|
|
73
|
+
|
|
74
|
+
Every design request runs a 7-step protocol: Clarify, Validate, Research, Audit, Calibrate, Generate, Red Team.
|
|
75
|
+
|
|
76
|
+
## Quick start
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
pipx install kube-noob
|
|
80
|
+
kube-noob learn tracks
|
|
81
|
+
kube-noob audit -f k8s/ --platform openshift --version 4.22
|
|
82
|
+
kube-noob diagnose -f events.txt
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Generate a hardened app for ROSA HCP from a blueprint:
|
|
86
|
+
|
|
87
|
+
```yaml
|
|
88
|
+
name: orders-api
|
|
89
|
+
namespace: shop
|
|
90
|
+
image: quay.io/acme/orders@sha256:<digest>
|
|
91
|
+
platform: rosa-hcp
|
|
92
|
+
storage: {size: 20Gi, accessMode: ReadWriteMany}
|
|
93
|
+
exposure: {type: route, host: orders.apps.example.com}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
kube-noob protocol "deploy orders-api with shared storage" --blueprint blueprint.yaml
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Use with Claude or any MCP client
|
|
101
|
+
|
|
102
|
+
Claude Code plugin (skills + server):
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
/plugin marketplace add aashishmahajan/kube-noob
|
|
106
|
+
/plugin install kube-noob@kube-noob
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Any MCP client:
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{"mcpServers": {"kube-noob": {"command": "uvx", "args": ["--from", "kube-noob==0.1.1", "kube-noob", "mcp"]}}}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Tools are prefixed `kubenoob_` (protocol, audit, fix, generate, diagnose, search, learn, grade). Cluster and web
|
|
116
|
+
tools appear only when enabled.
|
|
117
|
+
|
|
118
|
+
## Run on OpenShift
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
git clone https://github.com/aashishmahajan/kube-noob && cd kube-noob
|
|
122
|
+
oc new-project kube-noob
|
|
123
|
+
oc create secret generic kube-noob-token --from-literal=token="$(openssl rand -hex 32)"
|
|
124
|
+
helm install kube-noob deploy/helm/kube-noob --set auth.existingSecret=kube-noob-token
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
The service requires a bearer token, ships NetworkPolicies and runs under `restricted-v2`. For a loopback-only sidecar
|
|
128
|
+
see [deploy/sidecar](https://github.com/aashishmahajan/kube-noob/blob/main/deploy/sidecar/app-with-kube-noob-sidecar.yaml).
|
|
129
|
+
|
|
130
|
+
## Safe by default
|
|
131
|
+
|
|
132
|
+
| Setting | Default | Enable with |
|
|
133
|
+
|---|---|---|
|
|
134
|
+
| Web lookups (allowlisted HTTPS docs only) | off | `webEnabled: true` / `KUBE_NOOB_WEB_ENABLED=true` |
|
|
135
|
+
| Live cluster (read-only, no Secrets) | off | `cluster.enabled: true` / `--cluster-enabled` |
|
|
136
|
+
| LLM agent (`kube-noob ask`) | Anthropic `claude-fable-5-1` | `llm.provider: openai-compatible` + `llm.baseUrl` for local models |
|
|
137
|
+
|
|
138
|
+
Config comes from `--config`, `$KUBE_NOOB_CONFIG`, `~/.config/kube-noob/config.yaml` or `/etc/kube-noob/config.yaml`,
|
|
139
|
+
never implicitly from the current directory. All keys: [kube-noob.example.yaml](https://github.com/aashishmahajan/kube-noob/blob/main/kube-noob.example.yaml).
|
|
140
|
+
|
|
141
|
+
## Docs
|
|
142
|
+
|
|
143
|
+
- [Architecture and trust boundaries](https://github.com/aashishmahajan/kube-noob/blob/main/docs/architecture.md)
|
|
144
|
+
- [Corpus, training and the reward](https://github.com/aashishmahajan/kube-noob/blob/main/docs/training.md)
|
|
145
|
+
- [Operations: weekly risk review and releases](https://github.com/aashishmahajan/kube-noob/blob/main/docs/operations.md)
|
|
146
|
+
- [Release readiness assessment](https://github.com/aashishmahajan/kube-noob/blob/main/docs/release-readiness.md) and [0.2.0 scope](https://github.com/aashishmahajan/kube-noob/blob/main/docs/roadmap-0.2.md)
|
|
147
|
+
- [Security policy](https://github.com/aashishmahajan/kube-noob/blob/main/SECURITY.md) and [Contributing](https://github.com/aashishmahajan/kube-noob/blob/main/CONTRIBUTING.md)
|
|
148
|
+
|
|
149
|
+
## Credits
|
|
150
|
+
|
|
151
|
+
Built on public, credited sources (Kubernetes docs CC BY 4.0, OpenShift docs, Red Hat Cloud Experts, HyperShift,
|
|
152
|
+
StackRox, Helm docs and more): see [THIRD_PARTY_NOTICES.md](https://github.com/aashishmahajan/kube-noob/blob/main/THIRD_PARTY_NOTICES.md). Kubernetes, OpenShift, Helm,
|
|
153
|
+
ROSA, RHACS and StackRox are trademarks of their owners; kube-noob is independent and not endorsed by them.
|
|
154
|
+
Licensed under [Apache-2.0](https://github.com/aashishmahajan/kube-noob/blob/main/LICENSE).
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/aashishmahajan/kube-noob/main/docs/brand/social-preview.png" alt="kube-noob - Learn. Audit. Debug. Offline." width="720">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# kube-noob
|
|
6
|
+
|
|
7
|
+
<!-- mcp-name: io.github.aashishmahajan/kube-noob -->
|
|
8
|
+
|
|
9
|
+
[](https://github.com/aashishmahajan/kube-noob/actions/workflows/ci.yml)
|
|
10
|
+
[](https://securityscorecards.dev/viewer/?uri=github.com/aashishmahajan/kube-noob)
|
|
11
|
+
[](https://pypi.org/project/kube-noob/)
|
|
12
|
+
[](https://github.com/aashishmahajan/kube-noob/blob/main/LICENSE)
|
|
13
|
+
|
|
14
|
+
Learn, audit and debug Kubernetes, OpenShift, ROSA HCP, Helm and RHACS/StackRox, offline by default.
|
|
15
|
+
Use it as an MCP server, a Claude plugin, a CLI, or a sidecar/service on OpenShift.
|
|
16
|
+
|
|
17
|
+
- **Audit**: 60 rules plus strict schemas (Kubernetes 1.35, Routes, SCCs, EgressFirewall, Gateway API, StackRox),
|
|
18
|
+
removed-API checks, safe auto-fixes, 9 red-team scenarios, RHACS policy mapping.
|
|
19
|
+
- **Generate**: hardened manifests and Helm charts for `kubernetes`, `openshift`, `rosa-classic`, `rosa-hcp`, re-audited
|
|
20
|
+
before they are returned.
|
|
21
|
+
- **Debug**: 33 offline playbooks; opt-in, read-only cluster evidence (Secrets are never read, values are redacted).
|
|
22
|
+
- **Learn**: 5 tracks, 16 lessons, graded exercises and quizzes.
|
|
23
|
+
- **Cite**: answers reference local knowledge as `[kn:<doc>#<n>]` with source and license.
|
|
24
|
+
|
|
25
|
+
Every design request runs a 7-step protocol: Clarify, Validate, Research, Audit, Calibrate, Generate, Red Team.
|
|
26
|
+
|
|
27
|
+
## Quick start
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pipx install kube-noob
|
|
31
|
+
kube-noob learn tracks
|
|
32
|
+
kube-noob audit -f k8s/ --platform openshift --version 4.22
|
|
33
|
+
kube-noob diagnose -f events.txt
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Generate a hardened app for ROSA HCP from a blueprint:
|
|
37
|
+
|
|
38
|
+
```yaml
|
|
39
|
+
name: orders-api
|
|
40
|
+
namespace: shop
|
|
41
|
+
image: quay.io/acme/orders@sha256:<digest>
|
|
42
|
+
platform: rosa-hcp
|
|
43
|
+
storage: {size: 20Gi, accessMode: ReadWriteMany}
|
|
44
|
+
exposure: {type: route, host: orders.apps.example.com}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
kube-noob protocol "deploy orders-api with shared storage" --blueprint blueprint.yaml
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Use with Claude or any MCP client
|
|
52
|
+
|
|
53
|
+
Claude Code plugin (skills + server):
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
/plugin marketplace add aashishmahajan/kube-noob
|
|
57
|
+
/plugin install kube-noob@kube-noob
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Any MCP client:
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{"mcpServers": {"kube-noob": {"command": "uvx", "args": ["--from", "kube-noob==0.1.1", "kube-noob", "mcp"]}}}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Tools are prefixed `kubenoob_` (protocol, audit, fix, generate, diagnose, search, learn, grade). Cluster and web
|
|
67
|
+
tools appear only when enabled.
|
|
68
|
+
|
|
69
|
+
## Run on OpenShift
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
git clone https://github.com/aashishmahajan/kube-noob && cd kube-noob
|
|
73
|
+
oc new-project kube-noob
|
|
74
|
+
oc create secret generic kube-noob-token --from-literal=token="$(openssl rand -hex 32)"
|
|
75
|
+
helm install kube-noob deploy/helm/kube-noob --set auth.existingSecret=kube-noob-token
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The service requires a bearer token, ships NetworkPolicies and runs under `restricted-v2`. For a loopback-only sidecar
|
|
79
|
+
see [deploy/sidecar](https://github.com/aashishmahajan/kube-noob/blob/main/deploy/sidecar/app-with-kube-noob-sidecar.yaml).
|
|
80
|
+
|
|
81
|
+
## Safe by default
|
|
82
|
+
|
|
83
|
+
| Setting | Default | Enable with |
|
|
84
|
+
|---|---|---|
|
|
85
|
+
| Web lookups (allowlisted HTTPS docs only) | off | `webEnabled: true` / `KUBE_NOOB_WEB_ENABLED=true` |
|
|
86
|
+
| Live cluster (read-only, no Secrets) | off | `cluster.enabled: true` / `--cluster-enabled` |
|
|
87
|
+
| LLM agent (`kube-noob ask`) | Anthropic `claude-fable-5-1` | `llm.provider: openai-compatible` + `llm.baseUrl` for local models |
|
|
88
|
+
|
|
89
|
+
Config comes from `--config`, `$KUBE_NOOB_CONFIG`, `~/.config/kube-noob/config.yaml` or `/etc/kube-noob/config.yaml`,
|
|
90
|
+
never implicitly from the current directory. All keys: [kube-noob.example.yaml](https://github.com/aashishmahajan/kube-noob/blob/main/kube-noob.example.yaml).
|
|
91
|
+
|
|
92
|
+
## Docs
|
|
93
|
+
|
|
94
|
+
- [Architecture and trust boundaries](https://github.com/aashishmahajan/kube-noob/blob/main/docs/architecture.md)
|
|
95
|
+
- [Corpus, training and the reward](https://github.com/aashishmahajan/kube-noob/blob/main/docs/training.md)
|
|
96
|
+
- [Operations: weekly risk review and releases](https://github.com/aashishmahajan/kube-noob/blob/main/docs/operations.md)
|
|
97
|
+
- [Release readiness assessment](https://github.com/aashishmahajan/kube-noob/blob/main/docs/release-readiness.md) and [0.2.0 scope](https://github.com/aashishmahajan/kube-noob/blob/main/docs/roadmap-0.2.md)
|
|
98
|
+
- [Security policy](https://github.com/aashishmahajan/kube-noob/blob/main/SECURITY.md) and [Contributing](https://github.com/aashishmahajan/kube-noob/blob/main/CONTRIBUTING.md)
|
|
99
|
+
|
|
100
|
+
## Credits
|
|
101
|
+
|
|
102
|
+
Built on public, credited sources (Kubernetes docs CC BY 4.0, OpenShift docs, Red Hat Cloud Experts, HyperShift,
|
|
103
|
+
StackRox, Helm docs and more): see [THIRD_PARTY_NOTICES.md](https://github.com/aashishmahajan/kube-noob/blob/main/THIRD_PARTY_NOTICES.md). Kubernetes, OpenShift, Helm,
|
|
104
|
+
ROSA, RHACS and StackRox are trademarks of their owners; kube-noob is independent and not endorsed by them.
|
|
105
|
+
Licensed under [Apache-2.0](https://github.com/aashishmahajan/kube-noob/blob/main/LICENSE).
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Reporting a vulnerability
|
|
4
|
+
|
|
5
|
+
Please report vulnerabilities privately through GitHub's **"Report a vulnerability"** button on the repository's
|
|
6
|
+
Security tab (private vulnerability reporting). Do not open a public issue. Expect an acknowledgement within 3 business
|
|
7
|
+
days and a fix or mitigation plan within 30 days for confirmed issues.
|
|
8
|
+
|
|
9
|
+
## Supported versions
|
|
10
|
+
|
|
11
|
+
The latest minor release receives security fixes.
|
|
12
|
+
|
|
13
|
+
## Default posture
|
|
14
|
+
|
|
15
|
+
kube-noob makes no outbound connections and touches no cluster unless you enable it. This is tested in CI and was
|
|
16
|
+
verified end to end inside a network namespace with no route (docs/release-readiness.md). With web access enabled it
|
|
17
|
+
only performs HTTPS GETs to allowlisted documentation domains, streams at most `web.maxBytes`, never writes the content
|
|
18
|
+
to disk and never executes it. The MCP server's only subprocesses are read-only `oc`/`kubectl` calls (argv, no shell)
|
|
19
|
+
when cluster access is enabled; the maintainer CLI commands `corpus build --online` and `helm-audit` run `git` and
|
|
20
|
+
`helm template` locally.
|
|
21
|
+
|
|
22
|
+
## Security design
|
|
23
|
+
|
|
24
|
+
| Area | Control |
|
|
25
|
+
|---|---|
|
|
26
|
+
| Network | `webEnabled: false` by default; all outbound HTTP goes through one guarded client; web requests (and every redirect) must be HTTPS to an allowlisted domain. |
|
|
27
|
+
| Cluster access | Opt-in (`cluster.enabled`), read-only verbs on an allowlist of resources, Secrets never readable, ConfigMap values / sensitive env values / token-like log content redacted, strict argument validation, no shell. |
|
|
28
|
+
| HTTP server | Refuses to bind non-loopback without a bearer token (constant-time compare) unless explicitly overridden; DNS-rebinding protection with a Host allowlist; health endpoints are the only unauthenticated paths. |
|
|
29
|
+
| Input parsing | YAML SafeLoader only, 5 MB / 1000-document caps, alias-expansion budget against billion-laughs. |
|
|
30
|
+
| Container | UBI 9, non-root numeric UID, works with OpenShift arbitrary UIDs, read-only root filesystem in the chart, all capabilities dropped, RuntimeDefault seccomp. |
|
|
31
|
+
| Supply chain | Hash-pinned dependencies (`requirements.lock`), SHA-pinned Actions, CodeQL, OpenSSF Scorecard, Dependabot, `pip-audit` in CI, PyPI Trusted Publishing, SLSA provenance attestations, SBOM, keyless cosign signatures. |
|
|
32
|
+
| Data | Corpus records carry license and redistributability; Jira identities and emails are scrubbed; non-redistributable content is never published unencrypted by CI. |
|
|
33
|
+
|
|
34
|
+
## Verifying releases
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
gh attestation verify dist/kube_noob-*.whl --repo aashishmahajan/kube-noob
|
|
38
|
+
cosign verify ghcr.io/aashishmahajan/kube-noob:<version> \
|
|
39
|
+
--certificate-identity-regexp 'https://github.com/aashishmahajan/kube-noob/.github/workflows/release.yml@.*' \
|
|
40
|
+
--certificate-oidc-issuer https://token.actions.githubusercontent.com
|
|
41
|
+
```
|