kubesift 2.0.0__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.
- kubesift-2.0.0/.dockerignore +12 -0
- kubesift-2.0.0/.gitattributes +2 -0
- kubesift-2.0.0/.github/workflows/ci.yml +167 -0
- kubesift-2.0.0/.github/workflows/pages.yml +31 -0
- kubesift-2.0.0/.github/workflows/release.yml +108 -0
- kubesift-2.0.0/.gitignore +30 -0
- kubesift-2.0.0/.pre-commit-hooks.yaml +7 -0
- kubesift-2.0.0/CONTRIBUTING.md +41 -0
- kubesift-2.0.0/Dockerfile +20 -0
- kubesift-2.0.0/LICENSE +202 -0
- kubesift-2.0.0/PKG-INFO +192 -0
- kubesift-2.0.0/README.md +140 -0
- kubesift-2.0.0/SECURITY.md +30 -0
- kubesift-2.0.0/action.yml +38 -0
- kubesift-2.0.0/deploy/helm/kubesift/Chart.yaml +8 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/NOTES.txt +20 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/_helpers.tpl +25 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/deployment.yaml +147 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/rbac.yaml +139 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/secret.yaml +25 -0
- kubesift-2.0.0/deploy/helm/kubesift/templates/service.yaml +88 -0
- kubesift-2.0.0/deploy/helm/kubesift/values.yaml +85 -0
- kubesift-2.0.0/docs/architecture.md +40 -0
- kubesift-2.0.0/docs/checks.md +457 -0
- kubesift-2.0.0/docs/configuration.md +91 -0
- kubesift-2.0.0/docs/mcp.md +82 -0
- kubesift-2.0.0/docs/preflight.md +50 -0
- kubesift-2.0.0/docs/production.md +68 -0
- kubesift-2.0.0/docs/releasing.md +48 -0
- kubesift-2.0.0/docs/slack.md +38 -0
- kubesift-2.0.0/pyproject.toml +67 -0
- kubesift-2.0.0/scripts/e2e.sh +39 -0
- kubesift-2.0.0/scripts/e2e_check.py +36 -0
- kubesift-2.0.0/scripts/gen_check_docs.py +23 -0
- kubesift-2.0.0/src/kubesift/__init__.py +3 -0
- kubesift-2.0.0/src/kubesift/analysis/__init__.py +3 -0
- kubesift-2.0.0/src/kubesift/analysis/changes.py +165 -0
- kubesift-2.0.0/src/kubesift/analysis/correlate.py +160 -0
- kubesift-2.0.0/src/kubesift/analysis/describe.py +83 -0
- kubesift-2.0.0/src/kubesift/analysis/engine.py +362 -0
- kubesift-2.0.0/src/kubesift/analysis/llm.py +152 -0
- kubesift-2.0.0/src/kubesift/checks/__init__.py +17 -0
- kubesift-2.0.0/src/kubesift/checks/base.py +150 -0
- kubesift-2.0.0/src/kubesift/checks/config_refs.py +84 -0
- kubesift-2.0.0/src/kubesift/checks/events.py +77 -0
- kubesift-2.0.0/src/kubesift/checks/hygiene.py +264 -0
- kubesift-2.0.0/src/kubesift/checks/lifecycle.py +202 -0
- kubesift-2.0.0/src/kubesift/checks/network.py +325 -0
- kubesift-2.0.0/src/kubesift/checks/nodes.py +183 -0
- kubesift-2.0.0/src/kubesift/checks/operations.py +319 -0
- kubesift-2.0.0/src/kubesift/checks/pods.py +485 -0
- kubesift-2.0.0/src/kubesift/checks/storage.py +72 -0
- kubesift-2.0.0/src/kubesift/checks/workloads.py +201 -0
- kubesift-2.0.0/src/kubesift/cli.py +874 -0
- kubesift-2.0.0/src/kubesift/cluster/__init__.py +4 -0
- kubesift-2.0.0/src/kubesift/cluster/client.py +141 -0
- kubesift-2.0.0/src/kubesift/cluster/snapshot.py +513 -0
- kubesift-2.0.0/src/kubesift/config.py +134 -0
- kubesift-2.0.0/src/kubesift/cost.py +150 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/01-crashloop-missing-env.yaml +24 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/02-imagepull-wrong-tag.yaml +23 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/03-oomkilled-low-memory.yaml +24 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/04-service-selector-mismatch.yaml +34 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/05-missing-probe-crashloop.yaml +24 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/06-pending-insufficient-resources.yaml +26 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/07-missing-secret.yaml +28 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/08-pvc-missing-storageclass.yaml +38 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/09-netpol-blocks-dns.yaml +14 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/10a-rollout-good.yaml +27 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/10b-rollout-bad.yaml +25 -0
- kubesift-2.0.0/src/kubesift/drill_scenarios/__init__.py +1 -0
- kubesift-2.0.0/src/kubesift/drills.py +122 -0
- kubesift-2.0.0/src/kubesift/knowledge.py +51 -0
- kubesift-2.0.0/src/kubesift/leader.py +145 -0
- kubesift-2.0.0/src/kubesift/lint.py +89 -0
- kubesift-2.0.0/src/kubesift/mcp_server.py +193 -0
- kubesift-2.0.0/src/kubesift/models.py +144 -0
- kubesift-2.0.0/src/kubesift/notify.py +71 -0
- kubesift-2.0.0/src/kubesift/postmortem.py +152 -0
- kubesift-2.0.0/src/kubesift/preflight.py +435 -0
- kubesift-2.0.0/src/kubesift/redact.py +38 -0
- kubesift-2.0.0/src/kubesift/remediate.py +99 -0
- kubesift-2.0.0/src/kubesift/report.py +193 -0
- kubesift-2.0.0/src/kubesift/runbooks.py +58 -0
- kubesift-2.0.0/src/kubesift/server/__init__.py +0 -0
- kubesift-2.0.0/src/kubesift/server/app.py +480 -0
- kubesift-2.0.0/src/kubesift/server/static/index.html +152 -0
- kubesift-2.0.0/src/kubesift/slack.py +106 -0
- kubesift-2.0.0/src/kubesift/store.py +219 -0
- kubesift-2.0.0/src/kubesift/timetravel.py +156 -0
- kubesift-2.0.0/src/kubesift/upgrade.py +51 -0
- kubesift-2.0.0/src/kubesift/util.py +174 -0
- kubesift-2.0.0/test-scenarios/01-crashloop-missing-env.yaml +25 -0
- kubesift-2.0.0/test-scenarios/02-imagepull-wrong-tag.yaml +24 -0
- kubesift-2.0.0/test-scenarios/03-oomkilled-low-memory.yaml +25 -0
- kubesift-2.0.0/test-scenarios/04-service-selector-mismatch.yaml +36 -0
- kubesift-2.0.0/test-scenarios/05-missing-probe-crashloop.yaml +25 -0
- kubesift-2.0.0/test-scenarios/06-pending-insufficient-resources.yaml +27 -0
- kubesift-2.0.0/test-scenarios/07-missing-secret.yaml +29 -0
- kubesift-2.0.0/test-scenarios/08-pvc-missing-storageclass.yaml +40 -0
- kubesift-2.0.0/test-scenarios/09-netpol-blocks-dns.yaml +15 -0
- kubesift-2.0.0/test-scenarios/10a-rollout-good.yaml +28 -0
- kubesift-2.0.0/test-scenarios/10b-rollout-bad.yaml +26 -0
- kubesift-2.0.0/test-scenarios/apply-scenario.sh +26 -0
- kubesift-2.0.0/test-scenarios/cleanup.sh +5 -0
- kubesift-2.0.0/test-scenarios/expected.json +12 -0
- kubesift-2.0.0/tests/conftest.py +28 -0
- kubesift-2.0.0/tests/fixtures.py +224 -0
- kubesift-2.0.0/tests/test_analysis.py +115 -0
- kubesift-2.0.0/tests/test_checks.py +114 -0
- kubesift-2.0.0/tests/test_client.py +118 -0
- kubesift-2.0.0/tests/test_features.py +424 -0
- kubesift-2.0.0/tests/test_ha.py +188 -0
- kubesift-2.0.0/tests/test_hardening.py +186 -0
- kubesift-2.0.0/tests/test_interfaces.py +135 -0
- kubesift-2.0.0/tests/test_lint_redact.py +106 -0
- kubesift-2.0.0/tests/test_llm.py +103 -0
- kubesift-2.0.0/tests/test_more_checks.py +136 -0
- kubesift-2.0.0/tests/test_production.py +80 -0
- kubesift-2.0.0/website/README.md +13 -0
- kubesift-2.0.0/website/favicon.svg +12 -0
- kubesift-2.0.0/website/index.html +342 -0
- kubesift-2.0.0/website/main.js +139 -0
- kubesift-2.0.0/website/styles.css +258 -0
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
test:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
services:
|
|
15
|
+
postgres:
|
|
16
|
+
image: postgres:16-alpine
|
|
17
|
+
env:
|
|
18
|
+
POSTGRES_PASSWORD: kubesift
|
|
19
|
+
POSTGRES_DB: kubesift
|
|
20
|
+
ports: ["5432:5432"]
|
|
21
|
+
options: >-
|
|
22
|
+
--health-cmd "pg_isready -U postgres" --health-interval 5s --health-timeout 5s --health-retries 10
|
|
23
|
+
env:
|
|
24
|
+
KUBESIFT_TEST_DATABASE_URL: postgresql://postgres:kubesift@localhost:5432/kubesift
|
|
25
|
+
strategy:
|
|
26
|
+
fail-fast: false
|
|
27
|
+
matrix:
|
|
28
|
+
python: ["3.10", "3.11", "3.12", "3.13"]
|
|
29
|
+
steps:
|
|
30
|
+
- uses: actions/checkout@v4
|
|
31
|
+
- uses: actions/setup-python@v5
|
|
32
|
+
with:
|
|
33
|
+
python-version: ${{ matrix.python }}
|
|
34
|
+
cache: pip
|
|
35
|
+
- run: pip install -e ".[dev]"
|
|
36
|
+
- run: ruff check src tests
|
|
37
|
+
- run: pytest --cov=kubesift --cov-report=term-missing
|
|
38
|
+
|
|
39
|
+
workflows:
|
|
40
|
+
# A broken workflow file is only noticed when it runs; for the release workflow that is too late.
|
|
41
|
+
runs-on: ubuntu-latest
|
|
42
|
+
steps:
|
|
43
|
+
- uses: actions/checkout@v4
|
|
44
|
+
- name: actionlint
|
|
45
|
+
run: |
|
|
46
|
+
bash <(curl -sSfL https://raw.githubusercontent.com/rhysd/actionlint/v1.7.7/scripts/download-actionlint.bash) 1.7.7
|
|
47
|
+
./actionlint -color
|
|
48
|
+
|
|
49
|
+
oldest-deps:
|
|
50
|
+
# The Kubernetes client changed its low-level API in v37; keep supporting older releases.
|
|
51
|
+
runs-on: ubuntu-latest
|
|
52
|
+
steps:
|
|
53
|
+
- uses: actions/checkout@v4
|
|
54
|
+
- uses: actions/setup-python@v5
|
|
55
|
+
with:
|
|
56
|
+
python-version: "3.10"
|
|
57
|
+
- run: pip install -e ".[dev]" "kubernetes==31.0.0"
|
|
58
|
+
- run: pytest -q
|
|
59
|
+
|
|
60
|
+
chart:
|
|
61
|
+
runs-on: ubuntu-latest
|
|
62
|
+
steps:
|
|
63
|
+
- uses: actions/checkout@v4
|
|
64
|
+
- uses: azure/setup-helm@v4
|
|
65
|
+
- uses: actions/setup-python@v5
|
|
66
|
+
with:
|
|
67
|
+
python-version: "3.12"
|
|
68
|
+
- run: pip install -e .
|
|
69
|
+
- run: helm lint deploy/helm/kubesift
|
|
70
|
+
# Dogfooding: the chart must pass KubeSift's own checks, in both modes.
|
|
71
|
+
- run: helm template ko deploy/helm/kubesift | kubesift lint - --fail-on medium
|
|
72
|
+
- run: |
|
|
73
|
+
helm template ko deploy/helm/kubesift --set replicaCount=2 --set database.url=postgresql://u:p@db/k | kubesift lint - --fail-on medium
|
|
74
|
+
- name: Two replicas without a shared database must be rejected
|
|
75
|
+
run: |
|
|
76
|
+
if helm template ko deploy/helm/kubesift --set replicaCount=2 >/dev/null 2>&1; then
|
|
77
|
+
echo "expected a validation error"; exit 1
|
|
78
|
+
fi
|
|
79
|
+
|
|
80
|
+
docker:
|
|
81
|
+
runs-on: ubuntu-latest
|
|
82
|
+
steps:
|
|
83
|
+
- uses: actions/checkout@v4
|
|
84
|
+
- uses: docker/setup-buildx-action@v3
|
|
85
|
+
- uses: docker/build-push-action@v6
|
|
86
|
+
with:
|
|
87
|
+
context: .
|
|
88
|
+
push: false
|
|
89
|
+
tags: kubesift:ci
|
|
90
|
+
load: true
|
|
91
|
+
- run: docker run --rm kubesift:ci version
|
|
92
|
+
|
|
93
|
+
e2e:
|
|
94
|
+
runs-on: ubuntu-latest
|
|
95
|
+
needs: test
|
|
96
|
+
steps:
|
|
97
|
+
- uses: actions/checkout@v4
|
|
98
|
+
- uses: actions/setup-python@v5
|
|
99
|
+
with:
|
|
100
|
+
python-version: "3.12"
|
|
101
|
+
- run: pip install -e .
|
|
102
|
+
- uses: helm/kind-action@v1
|
|
103
|
+
with:
|
|
104
|
+
cluster_name: kubesift-e2e
|
|
105
|
+
- name: Break the cluster on purpose and check every failure is explained
|
|
106
|
+
run: CLUSTER=kubesift-e2e ./scripts/e2e.sh
|
|
107
|
+
- uses: actions/upload-artifact@v4
|
|
108
|
+
if: always()
|
|
109
|
+
with:
|
|
110
|
+
name: e2e-report
|
|
111
|
+
path: e2e-report.json
|
|
112
|
+
|
|
113
|
+
deploy:
|
|
114
|
+
# Install the Helm chart on a real cluster: single replica, then HA with PostgreSQL and leader election.
|
|
115
|
+
runs-on: ubuntu-latest
|
|
116
|
+
needs: [test, docker]
|
|
117
|
+
steps:
|
|
118
|
+
- uses: actions/checkout@v4
|
|
119
|
+
- uses: azure/setup-helm@v4
|
|
120
|
+
- uses: helm/kind-action@v1
|
|
121
|
+
with:
|
|
122
|
+
cluster_name: kubesift-deploy
|
|
123
|
+
- name: Build the image and load it into kind
|
|
124
|
+
run: |
|
|
125
|
+
docker build -t ghcr.io/opeyemiadeniji/kubesift:ci .
|
|
126
|
+
kind load docker-image ghcr.io/opeyemiadeniji/kubesift:ci --name kubesift-deploy
|
|
127
|
+
- name: Single replica
|
|
128
|
+
run: |
|
|
129
|
+
helm install ko deploy/helm/kubesift -n kubesift --create-namespace --set image.tag=ci --set image.pullPolicy=Never --set scan.interval=30 --wait --timeout 3m
|
|
130
|
+
kubectl -n kubesift port-forward svc/ko-kubesift 8080:80 & sleep 5
|
|
131
|
+
TOKEN=$(kubectl -n kubesift get secret ko-kubesift -o jsonpath='{.data.api-token}' | base64 -d)
|
|
132
|
+
curl -fsS localhost:8080/healthz
|
|
133
|
+
curl -fsS -H "Authorization: Bearer $TOKEN" localhost:8080/api/v1/info
|
|
134
|
+
code=$(curl -s -o /dev/null -w '%{http_code}' -X POST localhost:8080/mcp -H 'Content-Type: application/json' -d '{}')
|
|
135
|
+
test "$code" = 401
|
|
136
|
+
curl -fsS -X POST -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' localhost:8080/api/v1/diagnose -d '{"llm": false}' | python3 -c 'import json,sys; r=json.load(sys.stdin); print(r["cluster"], len(r["findings"]), "findings")'
|
|
137
|
+
kill %1
|
|
138
|
+
helm uninstall ko -n kubesift --wait
|
|
139
|
+
- name: Two replicas with PostgreSQL and leader election
|
|
140
|
+
run: |
|
|
141
|
+
kubectl -n kubesift create deployment pg --image=postgres:16-alpine --port=5432
|
|
142
|
+
kubectl -n kubesift set env deployment/pg POSTGRES_PASSWORD=pw POSTGRES_DB=kubesift
|
|
143
|
+
kubectl -n kubesift expose deployment pg --port=5432
|
|
144
|
+
kubectl -n kubesift rollout status deployment/pg --timeout=120s
|
|
145
|
+
helm install ko deploy/helm/kubesift -n kubesift --set image.tag=ci --set image.pullPolicy=Never --set replicaCount=2 --set database.url=postgresql://postgres:pw@pg:5432/kubesift --set scan.interval=30 --wait --timeout 4m
|
|
146
|
+
kubectl -n kubesift get pods -o wide
|
|
147
|
+
# The lease must end up held by one of the running replicas (a previous holder may need to expire).
|
|
148
|
+
pods=$(kubectl -n kubesift get pods -l app.kubernetes.io/name=kubesift -o jsonpath='{.items[*].metadata.name}')
|
|
149
|
+
for _ in $(seq 1 30); do
|
|
150
|
+
holder=$(kubectl -n kubesift get lease kubesift-scanner -o jsonpath='{.spec.holderIdentity}' 2>/dev/null || true)
|
|
151
|
+
if [ -n "$holder" ] && echo " $pods " | grep -q " $holder "; then break; fi
|
|
152
|
+
sleep 3
|
|
153
|
+
done
|
|
154
|
+
echo "replicas: $pods"; echo "leader: $holder"
|
|
155
|
+
echo " $pods " | grep -q " $holder "
|
|
156
|
+
- name: Killing the leader hands over to the other replica
|
|
157
|
+
run: |
|
|
158
|
+
old=$(kubectl -n kubesift get lease kubesift-scanner -o jsonpath='{.spec.holderIdentity}')
|
|
159
|
+
kubectl -n kubesift delete pod "$old" --wait=false
|
|
160
|
+
for i in $(seq 1 30); do
|
|
161
|
+
holder=$(kubectl -n kubesift get lease kubesift-scanner -o jsonpath='{.spec.holderIdentity}')
|
|
162
|
+
if [ -n "$holder" ] && [ "$holder" != "$old" ]; then echo "failover: $old -> $holder after ~$((i*2))s"; exit 0; fi
|
|
163
|
+
sleep 2
|
|
164
|
+
done
|
|
165
|
+
echo "no failover"; exit 1
|
|
166
|
+
- if: failure()
|
|
167
|
+
run: kubectl -n kubesift logs -l app.kubernetes.io/name=kubesift --tail=100 --prefix || true
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: Website
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
paths: ["website/**", ".github/workflows/pages.yml"]
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
permissions:
|
|
10
|
+
contents: read
|
|
11
|
+
pages: write
|
|
12
|
+
id-token: write
|
|
13
|
+
|
|
14
|
+
concurrency:
|
|
15
|
+
group: pages
|
|
16
|
+
cancel-in-progress: false
|
|
17
|
+
|
|
18
|
+
jobs:
|
|
19
|
+
deploy:
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
environment:
|
|
22
|
+
name: github-pages
|
|
23
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
24
|
+
steps:
|
|
25
|
+
- uses: actions/checkout@v4
|
|
26
|
+
- uses: actions/configure-pages@v5
|
|
27
|
+
- uses: actions/upload-pages-artifact@v3
|
|
28
|
+
with:
|
|
29
|
+
path: website
|
|
30
|
+
- id: deployment
|
|
31
|
+
uses: actions/deploy-pages@v4
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags: ["v*"]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
pypi:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
environment: pypi
|
|
14
|
+
permissions:
|
|
15
|
+
id-token: write # PyPI trusted publishing: no stored token
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
- uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: "3.12"
|
|
21
|
+
- name: Check the tag matches the package version
|
|
22
|
+
run: |
|
|
23
|
+
v=$(python -c "import re;print(re.search(r'__version__ = \"(.+)\"', open('src/kubesift/__init__.py').read())[1])")
|
|
24
|
+
test "v$v" = "$GITHUB_REF_NAME" || { echo "tag $GITHUB_REF_NAME != version $v"; exit 1; }
|
|
25
|
+
- run: pip install build && python -m build
|
|
26
|
+
# Publishes with PEP 740 attestations (signed provenance) automatically.
|
|
27
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
28
|
+
|
|
29
|
+
image:
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
permissions:
|
|
32
|
+
contents: read
|
|
33
|
+
packages: write
|
|
34
|
+
id-token: write # keyless cosign signing
|
|
35
|
+
outputs:
|
|
36
|
+
digest: ${{ steps.build.outputs.digest }}
|
|
37
|
+
steps:
|
|
38
|
+
- uses: actions/checkout@v4
|
|
39
|
+
- uses: docker/setup-qemu-action@v3
|
|
40
|
+
- uses: docker/setup-buildx-action@v3
|
|
41
|
+
- uses: sigstore/cosign-installer@v3
|
|
42
|
+
- uses: docker/login-action@v3
|
|
43
|
+
with:
|
|
44
|
+
registry: ghcr.io
|
|
45
|
+
username: ${{ github.actor }}
|
|
46
|
+
password: ${{ secrets.GITHUB_TOKEN }}
|
|
47
|
+
- id: meta
|
|
48
|
+
uses: docker/metadata-action@v5
|
|
49
|
+
with:
|
|
50
|
+
images: ghcr.io/${{ github.repository_owner }}/kubesift # metadata-action lowercases this
|
|
51
|
+
tags: |
|
|
52
|
+
type=semver,pattern={{version}}
|
|
53
|
+
type=semver,pattern={{major}}.{{minor}}
|
|
54
|
+
- id: build
|
|
55
|
+
uses: docker/build-push-action@v6
|
|
56
|
+
with:
|
|
57
|
+
context: .
|
|
58
|
+
platforms: linux/amd64,linux/arm64
|
|
59
|
+
push: true
|
|
60
|
+
tags: ${{ steps.meta.outputs.tags }}
|
|
61
|
+
labels: ${{ steps.meta.outputs.labels }}
|
|
62
|
+
sbom: true # SPDX software bill of materials attached to the image
|
|
63
|
+
provenance: mode=max # SLSA build provenance
|
|
64
|
+
- name: Sign the image (keyless, GitHub OIDC identity)
|
|
65
|
+
run: |
|
|
66
|
+
echo "${{ steps.meta.outputs.tags }}" | while read -r tag; do
|
|
67
|
+
cosign sign --yes "${tag}@${{ steps.build.outputs.digest }}"
|
|
68
|
+
done
|
|
69
|
+
|
|
70
|
+
chart:
|
|
71
|
+
runs-on: ubuntu-latest
|
|
72
|
+
permissions:
|
|
73
|
+
contents: read
|
|
74
|
+
packages: write
|
|
75
|
+
id-token: write
|
|
76
|
+
steps:
|
|
77
|
+
- uses: actions/checkout@v4
|
|
78
|
+
- uses: azure/setup-helm@v4
|
|
79
|
+
- uses: sigstore/cosign-installer@v3
|
|
80
|
+
- name: Package, push and sign the chart (OCI)
|
|
81
|
+
run: |
|
|
82
|
+
owner=$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]') # OCI names must be lowercase
|
|
83
|
+
echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login ghcr.io -u "${{ github.actor }}" --password-stdin
|
|
84
|
+
echo "${{ secrets.GITHUB_TOKEN }}" | cosign login ghcr.io -u "${{ github.actor }}" --password-stdin
|
|
85
|
+
helm package deploy/helm/kubesift
|
|
86
|
+
out=$(helm push kubesift-*.tgz "oci://ghcr.io/${owner}/charts" 2>&1)
|
|
87
|
+
echo "$out"
|
|
88
|
+
digest=$(echo "$out" | awk '/Digest:/ {print $2}')
|
|
89
|
+
test -n "$digest"
|
|
90
|
+
cosign sign --yes "ghcr.io/${owner}/charts/kubesift@${digest}"
|
|
91
|
+
|
|
92
|
+
github-release:
|
|
93
|
+
runs-on: ubuntu-latest
|
|
94
|
+
needs: [pypi, image, chart]
|
|
95
|
+
permissions:
|
|
96
|
+
contents: write
|
|
97
|
+
steps:
|
|
98
|
+
- uses: actions/checkout@v4
|
|
99
|
+
with:
|
|
100
|
+
fetch-depth: 0
|
|
101
|
+
- run: gh release create "$GITHUB_REF_NAME" --generate-notes --verify-tag
|
|
102
|
+
env:
|
|
103
|
+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
104
|
+
- name: "Move the major tag (v2) so the GitHub Action reference @v2 gets this release"
|
|
105
|
+
run: |
|
|
106
|
+
major="${GITHUB_REF_NAME%%.*}"
|
|
107
|
+
git tag -f "$major" "$GITHUB_REF_NAME"
|
|
108
|
+
git push -f origin "refs/tags/$major"
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
backend/.env
|
|
2
|
+
frontend/.env.local
|
|
3
|
+
__pycache__/
|
|
4
|
+
*.pyc
|
|
5
|
+
*.pyo
|
|
6
|
+
.pytest_cache/
|
|
7
|
+
node_modules/
|
|
8
|
+
.next/
|
|
9
|
+
*.log
|
|
10
|
+
.DS_Store
|
|
11
|
+
.kube/
|
|
12
|
+
|
|
13
|
+
# Local MCP client config (may contain API keys)
|
|
14
|
+
.mcp.json
|
|
15
|
+
.env
|
|
16
|
+
.env.*
|
|
17
|
+
!.env.example
|
|
18
|
+
!.env.*.example
|
|
19
|
+
|
|
20
|
+
# Python / tooling
|
|
21
|
+
.venv/
|
|
22
|
+
dist/
|
|
23
|
+
.ruff_cache/
|
|
24
|
+
.coverage
|
|
25
|
+
*.egg-info/
|
|
26
|
+
|
|
27
|
+
# KubeSift outputs
|
|
28
|
+
e2e-report.json
|
|
29
|
+
kubesift-snapshot.json
|
|
30
|
+
kubesift.sarif
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for helping. The most valuable contributions are **new checks for failures you have actually seen**.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install -e ".[dev]"
|
|
9
|
+
pytest
|
|
10
|
+
ruff check src tests
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Adding a check
|
|
14
|
+
|
|
15
|
+
1. Pick the module in `src/kubesift/checks/` that matches the area (pods, workloads, network, nodes,
|
|
16
|
+
storage, events, hygiene, lifecycle, config_refs, operations).
|
|
17
|
+
2. Write a function decorated with `@check(...)`:
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
@check("pod-something", "Short title", Category.WORKLOAD, Severity.HIGH)
|
|
21
|
+
def something(ctx: Context) -> Iterator[Finding]:
|
|
22
|
+
"""One sentence: what this detects and why it matters."""
|
|
23
|
+
for pod in ctx.snap.all("pods"):
|
|
24
|
+
if ...:
|
|
25
|
+
yield ctx.finding("pod-something", pod, "What is wrong, in plain words.",
|
|
26
|
+
evidence=["facts copied from the object or its events"],
|
|
27
|
+
remediation="What to do.", commands=["kubectl ..."])
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
- `live_only=False` if it only needs specs (it will then also run in `kubesift lint`).
|
|
31
|
+
- `risk=True` if it describes something that will hurt later rather than something broken now.
|
|
32
|
+
3. Add a case to `tests/fixtures.py` and a test in `tests/test_checks.py`.
|
|
33
|
+
4. Run `python scripts/gen_check_docs.py` to update `docs/checks.md`.
|
|
34
|
+
|
|
35
|
+
Guidelines: messages say what is wrong and why it matters; evidence is copied from the cluster, never guessed;
|
|
36
|
+
no check may read Secret values; a check that raises is logged and skipped, but please don't rely on that.
|
|
37
|
+
|
|
38
|
+
## Scenarios
|
|
39
|
+
|
|
40
|
+
`test-scenarios/` holds manifests that break a cluster in specific ways, and `expected.json` lists the check
|
|
41
|
+
that must catch each one. Add a scenario for every new live check you can reproduce on kind.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# syntax=docker/dockerfile:1
|
|
2
|
+
FROM python:3.12-slim AS build
|
|
3
|
+
WORKDIR /src
|
|
4
|
+
COPY pyproject.toml README.md LICENSE ./
|
|
5
|
+
COPY src ./src
|
|
6
|
+
RUN pip install --no-cache-dir build && python -m build --wheel --outdir /dist
|
|
7
|
+
|
|
8
|
+
FROM python:3.12-slim
|
|
9
|
+
LABEL org.opencontainers.image.source="https://github.com/OpeyemiAdeniji/KubeSift" \
|
|
10
|
+
org.opencontainers.image.description="Evidence-based Kubernetes troubleshooting" \
|
|
11
|
+
org.opencontainers.image.licenses="Apache-2.0"
|
|
12
|
+
ENV PYTHONUNBUFFERED=1 PYTHONDONTWRITEBYTECODE=1 KUBESIFT_DATA_DIR=/data
|
|
13
|
+
COPY --from=build /dist/*.whl /tmp/
|
|
14
|
+
RUN pip install --no-cache-dir "$(ls /tmp/*.whl)[all]" && rm /tmp/*.whl \
|
|
15
|
+
&& useradd --uid 10001 --create-home kubesift && mkdir /data && chown 10001 /data
|
|
16
|
+
USER 10001
|
|
17
|
+
VOLUME /data
|
|
18
|
+
EXPOSE 8080
|
|
19
|
+
ENTRYPOINT ["kubesift"]
|
|
20
|
+
CMD ["serve", "--host", "0.0.0.0", "--port", "8080"]
|
kubesift-2.0.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|