Compare commits
119 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 69bbd4bd2b | |||
| 900acdaf8f | |||
| 5e6cd6603b | |||
| d7cbe969fb | |||
| 2ba0751443 | |||
| e52d995123 | |||
| 791935947d | |||
| 639e4eaa68 | |||
| 69db99d3d1 | |||
| 53fce54df8 | |||
| 6c6e8a55ce | |||
| 76d0e106b2 | |||
| 63050174e9 | |||
| b2a97cdcad | |||
| 73b2baec9d | |||
| 51e68b1b88 | |||
| b0cefdbe24 | |||
| 92f8c958d8 | |||
| 22fea9a99d | |||
| 73fb1359ed | |||
| cf9e0513b9 | |||
| 733cfad8d3 | |||
| 5aa54a526b | |||
| 83aa0329b3 | |||
| 8f343be06d | |||
| 9dc5fd673d | |||
| 125b06734a | |||
| def89f8d71 | |||
| 90721641cc | |||
| af42d9c52a | |||
| 61582d7534 | |||
| f6a296df1b | |||
| d593a11fd9 | |||
| 8fb9215933 | |||
| 35c09186df | |||
| 5744d9083f | |||
| 34ea111776 | |||
| 398e3f3b95 | |||
| 1343ba3e65 | |||
| 96145c21cb | |||
| a781027d3b | |||
| e2ae92648c | |||
| 7a0c068a93 | |||
| 2d629809a2 | |||
| 3fe787a550 | |||
| 1f02811731 | |||
| 7b58f684cf | |||
| aa1db9215a | |||
| 202ce66c61 | |||
| e2f220c418 | |||
| 58c9597388 | |||
| dff1265435 | |||
| 7c58826668 | |||
| 4edc829b3f | |||
| 8f10be39bd | |||
| 27212a91e1 | |||
| 7b72306133 | |||
| e16e6255d0 | |||
| 4beb0c4d0e | |||
| 175d3ec6a2 | |||
| e63cd03267 | |||
| 4d878c8737 | |||
| 5f817ec4f6 | |||
| 490807cef6 | |||
| 06d7dfb212 | |||
| ba508b8fc4 | |||
| b928fff4a5 | |||
| df6a5967ea | |||
| 415e32cdc9 | |||
| aa32e7a353 | |||
| 67bfe5ff5c | |||
| c08f3fbdbe | |||
| 02dc79b739 | |||
| d1097c2dbf | |||
| 5fa14ab353 | |||
| acd53c297b | |||
| fd66b119b3 | |||
| 21026cc992 | |||
| 95096562e4 | |||
| 62baf2bd5e | |||
| d2da09406a | |||
| a975192dfb | |||
| 2c80d0451e | |||
| d4a4e9a355 | |||
| a08c0fc368 | |||
| d0a6794576 | |||
| 00c270b0d4 | |||
| 7f115e0d6e | |||
| 9d02f504fd | |||
| 65c25067ec | |||
| 4c6324c4c2 | |||
| ca4832bcc3 | |||
| d6c8a8bbfc | |||
| 3d91572b59 | |||
| f0f3bd51a4 | |||
| 6e9c97593c | |||
| a5398e8409 | |||
| bb1df5f3f6 | |||
| 1bf5c2431c | |||
| 08a3009ba8 | |||
| b3f1f65b2f | |||
| 74a5bb0a01 | |||
| 9249f151a8 | |||
| dd782fbea0 | |||
| 0a52a8effa | |||
| 902f206e32 | |||
| 4344d33349 | |||
| 8ac890a1c6 | |||
| 6189f2b983 | |||
| 4296eb97fb | |||
| 87bf1a321f | |||
| 37af076456 | |||
| 0476fd1076 | |||
| 6a47358771 | |||
| f7d415e013 | |||
| 2a60029104 | |||
| 76c7a5bc1f | |||
| d64db24240 | |||
| 9bd07e1928 |
+202
-4
@@ -2,12 +2,210 @@ name: CI
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: ['**']
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [main]
|
branches: [main, dev, uat]
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
workflow_call:
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ci:
|
ci:
|
||||||
uses: privilegedescalation/.github/.github/workflows/plugin-ci.yaml@main
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 10
|
||||||
|
container: node:22-slim
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Install Python
|
||||||
|
run: apt-get update && apt-get install -y --no-install-recommends python3 python3-yaml
|
||||||
|
|
||||||
|
- name: Validate artifacthub-pkg.yml
|
||||||
|
run: |
|
||||||
|
python3 - <<'EOF'
|
||||||
|
import sys, re
|
||||||
|
try:
|
||||||
|
import yaml
|
||||||
|
except ImportError:
|
||||||
|
print("::warning::PyYAML not available, skipping artifacthub-pkg.yml validation")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
try:
|
||||||
|
with open("artifacthub-pkg.yml") as f:
|
||||||
|
pkg = yaml.safe_load(f)
|
||||||
|
except FileNotFoundError:
|
||||||
|
print("::error::artifacthub-pkg.yml not found")
|
||||||
|
sys.exit(1)
|
||||||
|
except yaml.YAMLError as e:
|
||||||
|
print(f"::error::artifacthub-pkg.yml is invalid YAML: {e}")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
errors = []
|
||||||
|
|
||||||
|
for field in ["version", "name", "description", "homeURL"]:
|
||||||
|
if not pkg.get(field):
|
||||||
|
errors.append(f"Missing required field: {field}")
|
||||||
|
|
||||||
|
version = pkg.get("version", "")
|
||||||
|
if version and not re.match(r'^\d+\.\d+\.\d+$', str(version)):
|
||||||
|
errors.append(f"version '{version}' is not SemVer (expected X.Y.Z)")
|
||||||
|
|
||||||
|
annotations = pkg.get("annotations", {}) or {}
|
||||||
|
archive_url = annotations.get("headlamp/plugin/archive-url", "")
|
||||||
|
archive_checksum = annotations.get("headlamp/plugin/archive-checksum", "")
|
||||||
|
|
||||||
|
if not archive_url:
|
||||||
|
errors.append("Missing annotation: headlamp/plugin/archive-url")
|
||||||
|
if not archive_checksum:
|
||||||
|
errors.append("Missing annotation: headlamp/plugin/archive-checksum")
|
||||||
|
elif not re.match(r'^sha256:[0-9a-f]{64}$', str(archive_checksum)):
|
||||||
|
errors.append(f"archive-checksum has unexpected format: '{archive_checksum}' (expected sha256:<64 hex chars>)")
|
||||||
|
|
||||||
|
if errors:
|
||||||
|
for e in errors:
|
||||||
|
print(f"::error::{e}")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
print(f"artifacthub-pkg.yml valid: name={pkg['name']} version={pkg['version']}")
|
||||||
|
EOF
|
||||||
|
|
||||||
|
- name: Detect package manager
|
||||||
|
id: pkg-manager
|
||||||
|
run: |
|
||||||
|
if [ -f "pnpm-lock.yaml" ]; then
|
||||||
|
echo "manager=pnpm" >> $GITHUB_OUTPUT
|
||||||
|
PM=$(python3 -c "import json,sys; d=json.load(open('package.json')); print('true' if d.get('packageManager','').startswith('pnpm@') else 'false')" 2>/dev/null || echo "false")
|
||||||
|
echo "has_package_manager=$PM" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "manager=npm" >> $GITHUB_OUTPUT
|
||||||
|
echo "has_package_manager=false" >> $GITHUB_OUTPUT
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: '22'
|
||||||
|
cache: ${{ steps.pkg-manager.outputs.manager == 'npm' && 'npm' || '' }}
|
||||||
|
|
||||||
|
- name: Setup pnpm (via Corepack, reads version from packageManager field)
|
||||||
|
if: steps.pkg-manager.outputs.manager == 'pnpm' && steps.pkg-manager.outputs.has_package_manager == 'true'
|
||||||
|
run: |
|
||||||
|
npm install -g corepack
|
||||||
|
corepack enable pnpm
|
||||||
|
corepack install
|
||||||
|
|
||||||
|
- name: Setup pnpm (version latest)
|
||||||
|
if: steps.pkg-manager.outputs.manager == 'pnpm' && steps.pkg-manager.outputs.has_package_manager == 'false'
|
||||||
|
uses: pnpm/action-setup@v5
|
||||||
|
with:
|
||||||
|
run_install: false
|
||||||
|
version: latest
|
||||||
|
|
||||||
|
- name: Get pnpm store directory
|
||||||
|
id: pnpm-store
|
||||||
|
if: steps.pkg-manager.outputs.manager == 'pnpm'
|
||||||
|
run: echo "dir=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Cache pnpm store
|
||||||
|
if: steps.pkg-manager.outputs.manager == 'pnpm'
|
||||||
|
uses: actions/cache@v5
|
||||||
|
with:
|
||||||
|
path: ${{ steps.pnpm-store.outputs.dir }}
|
||||||
|
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-pnpm-
|
||||||
|
|
||||||
|
- name: Validate pnpm lockfile freshness
|
||||||
|
if: steps.pkg-manager.outputs.manager == 'pnpm'
|
||||||
|
run: |
|
||||||
|
if [ ! -f "pnpm-lock.yaml" ]; then
|
||||||
|
echo "No pnpm-lock.yaml found, skipping lockfile freshness check"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
if ! grep -q 'overrides:' pnpm-lock.yaml 2>/dev/null; then
|
||||||
|
echo "No overrides section in pnpm-lock.yaml, skipping lockfile freshness check"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
echo "Detected pnpm-lock.yaml with overrides section. Checking lockfile freshness..."
|
||||||
|
ERR_FILE=$(mktemp)
|
||||||
|
if pnpm install --frozen-lockfile 2>&1 | tee "$ERR_FILE"; then
|
||||||
|
echo "Lockfile is fresh."
|
||||||
|
else
|
||||||
|
if grep -q "CONFIG_MISMATCH\|EBADLOCKFILE\|ERR_PNPM_LOCKFILE" "$ERR_FILE"; then
|
||||||
|
echo ""
|
||||||
|
echo "::error::pnpm-lock.yaml is out of sync with package.json overrides."
|
||||||
|
echo "::error::Run 'pnpm install' to regenerate the lockfile and commit the updated pnpm-lock.yaml."
|
||||||
|
rm -f "$ERR_FILE"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
rm -f "$ERR_FILE"
|
||||||
|
echo "::warning::Install failed with a different error. Will retry in the Install dependencies step."
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
max_attempts=3
|
||||||
|
attempt=1
|
||||||
|
while [ $attempt -le $max_attempts ]; do
|
||||||
|
echo "Attempt $attempt of $max_attempts"
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
pnpm install --frozen-lockfile && break
|
||||||
|
else
|
||||||
|
npm ci && break
|
||||||
|
fi
|
||||||
|
if [ $attempt -lt $max_attempts ]; then
|
||||||
|
echo "::warning::Install step failed on attempt $attempt. Retrying in 5 seconds..."
|
||||||
|
sleep 5
|
||||||
|
fi
|
||||||
|
attempt=$((attempt + 1))
|
||||||
|
done
|
||||||
|
if [ $attempt -gt $max_attempts ]; then
|
||||||
|
echo "::error::Install step failed after $max_attempts attempts."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Build plugin
|
||||||
|
run: npx @kinvolk/headlamp-plugin build
|
||||||
|
|
||||||
|
- name: Lint
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
pnpm run lint
|
||||||
|
else
|
||||||
|
npm run lint
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Type-check
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
pnpm run tsc
|
||||||
|
else
|
||||||
|
npm run tsc
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Format check
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
pnpm run format:check
|
||||||
|
else
|
||||||
|
npm run format:check
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
pnpm test
|
||||||
|
else
|
||||||
|
npm test
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Security audit
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.pkg-manager.outputs.manager }}" = "pnpm" ]; then
|
||||||
|
npx audit-ci --pnpm --audit-level=high --config ./audit-ci.jsonc
|
||||||
|
else
|
||||||
|
npx audit-ci --npm --audit-level=high --config ./audit-ci.jsonc
|
||||||
|
fi
|
||||||
|
|||||||
@@ -0,0 +1,112 @@
|
|||||||
|
name: Promotion Gate
|
||||||
|
|
||||||
|
# dev PRs: no gate (engineer self-merges).
|
||||||
|
# uat PRs: QA approval required.
|
||||||
|
# main PRs: UAT approval required (uat→main promotions).
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_review:
|
||||||
|
types: [submitted, dismissed]
|
||||||
|
pull_request:
|
||||||
|
branches: [uat, main]
|
||||||
|
types: [opened, reopened, synchronize]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
promotion-gate:
|
||||||
|
name: Promotion Gate
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 5
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check promotion approval
|
||||||
|
env:
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
|
PR_NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
REPO: ${{ github.repository }}
|
||||||
|
BASE_REF: ${{ github.base_ref }}
|
||||||
|
run: |
|
||||||
|
if [ -z "${PR_NUMBER}" ] || [ "${PR_NUMBER}" = "null" ]; then
|
||||||
|
echo "::notice::No PR number in context. Skipping promotion gate."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Checking promotion gate for PR #${PR_NUMBER} targeting ${BASE_REF} in ${REPO}"
|
||||||
|
|
||||||
|
if [ -z "${BASE_REF}" ] && [ -n "${PR_NUMBER}" ] && [ "${PR_NUMBER}" != "null" ]; then
|
||||||
|
BASE_REF=$(curl -sf \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Accept: application/json" \
|
||||||
|
"https://git.farh.net/api/v1/repos/${REPO}/pulls/${PR_NUMBER}" | jq -r '.base.ref')
|
||||||
|
echo "BASE_REF was empty; resolved from PR #${PR_NUMBER} API: ${BASE_REF}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Determine required reviewer based on target branch
|
||||||
|
case "${BASE_REF}" in
|
||||||
|
dev)
|
||||||
|
echo "Target is dev — no review required. Engineers self-merge."
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
uat)
|
||||||
|
REQUIRED_REVIEWER="pe_regina"
|
||||||
|
GATE_NAME="QA"
|
||||||
|
;;
|
||||||
|
main)
|
||||||
|
REQUIRED_REVIEWER="pe_regina"
|
||||||
|
GATE_NAME="QA"
|
||||||
|
# For plugin repos (Pipeline A), UAT approval is needed for uat→main
|
||||||
|
# Check if the source branch is uat
|
||||||
|
SOURCE_REF=$(curl -sf \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Accept: application/json" \
|
||||||
|
"https://git.farh.net/api/v1/repos/${REPO}/pulls/${PR_NUMBER}" | jq -r '.head.ref')
|
||||||
|
|
||||||
|
if [ "${SOURCE_REF}" = "uat" ]; then
|
||||||
|
REQUIRED_REVIEWER="pe_patty"
|
||||||
|
GATE_NAME="UAT"
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "::notice::Target branch '${BASE_REF}' has no promotion gate configured."
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
echo "Required reviewer: ${REQUIRED_REVIEWER} (${GATE_NAME})"
|
||||||
|
|
||||||
|
# For uat→main promotions, pe_patty may not be able to review (bot account).
|
||||||
|
# Accept pe_nancy (CTO) as a valid alternative reviewer.
|
||||||
|
ALT_REVIEWER=""
|
||||||
|
if [ "${REQUIRED_REVIEWER}" = "pe_patty" ]; then
|
||||||
|
ALT_REVIEWER="pe_nancy"
|
||||||
|
fi
|
||||||
|
|
||||||
|
REVIEWS=$(curl -sf \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Accept: application/json" \
|
||||||
|
"https://git.farh.net/api/v1/repos/${REPO}/pulls/${PR_NUMBER}/reviews")
|
||||||
|
|
||||||
|
if [ -z "${REVIEWS}" ] || [ "${REVIEWS}" = "null" ]; then
|
||||||
|
echo "::warning::Could not fetch reviews for PR #${PR_NUMBER}."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
REVIEWER_APPROVED=$(echo "${REVIEWS}" | jq -r --arg user "${REQUIRED_REVIEWER}" \
|
||||||
|
'[.[] | select(.user.login == $user)] | last | if .state then .state == "APPROVED" else false end')
|
||||||
|
|
||||||
|
echo "${GATE_NAME} (${REQUIRED_REVIEWER}) approved: ${REVIEWER_APPROVED}"
|
||||||
|
|
||||||
|
# Fallback: check if CTO approved as alternative for uat→main
|
||||||
|
if [ "${REVIEWER_APPROVED}" != "true" ] && [ -n "${ALT_REVIEWER}" ]; then
|
||||||
|
REVIEWER_APPROVED=$(echo "${REVIEWS}" | jq -r --arg user "${ALT_REVIEWER}" \
|
||||||
|
'[.[] | select(.user.login == $user)] | last | if .state then .state == "APPROVED" else false end')
|
||||||
|
if [ "${REVIEWER_APPROVED}" = "true" ]; then
|
||||||
|
echo "CTO (${ALT_REVIEWER}) approved as fallback for UAT gate."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "${REVIEWER_APPROVED}" = "true" ]; then
|
||||||
|
echo "Promotion gate passed: ${GATE_NAME} has approved."
|
||||||
|
else
|
||||||
|
echo "Promotion gate failed: waiting for ${GATE_NAME} approval from ${REQUIRED_REVIEWER}."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
name: E2E Tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
e2e:
|
|
||||||
runs-on: local-ubuntu-latest
|
|
||||||
timeout-minutes: 15
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: '22'
|
|
||||||
cache: 'npm'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Preflight — verify Headlamp and plugin version
|
|
||||||
env:
|
|
||||||
HEADLAMP_URL: ${{ secrets.HEADLAMP_URL || 'http://headlamp.kube-system.svc.cluster.local' }}
|
|
||||||
run: |
|
|
||||||
EXPECTED=$(node -p "require('./package.json').version")
|
|
||||||
PLUGIN_NAME=$(node -p "require('./package.json').artifacthub?.name || require('./package.json').name")
|
|
||||||
echo "Expected: $PLUGIN_NAME@$EXPECTED"
|
|
||||||
|
|
||||||
# Check Headlamp connectivity
|
|
||||||
HTTP_CODE=$(curl -s -o /dev/null -w '%{http_code}' --connect-timeout 10 "$HEADLAMP_URL" || true)
|
|
||||||
if [ "$HTTP_CODE" = "000" ]; then
|
|
||||||
echo "::error::Cannot reach Headlamp at $HEADLAMP_URL"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "Headlamp responded HTTP $HTTP_CODE"
|
|
||||||
|
|
||||||
# Check installed plugins and version match
|
|
||||||
PLUGIN_JSON=$(curl -sf --connect-timeout 10 "$HEADLAMP_URL/plugins" 2>/dev/null || echo "[]")
|
|
||||||
node -e "
|
|
||||||
const expected = '$EXPECTED';
|
|
||||||
const pluginName = '$PLUGIN_NAME';
|
|
||||||
const plugins = JSON.parse(process.argv[1]);
|
|
||||||
console.log('Installed plugins:');
|
|
||||||
for (const p of plugins) console.log(' ' + p.name + '@' + (p.version||'unknown'));
|
|
||||||
const ours = plugins.find(p => p.name === pluginName || p.name === 'polaris' || p.name.includes('polaris'));
|
|
||||||
if (!ours) {
|
|
||||||
console.log('::warning::Plugin ' + pluginName + ' not found in Headlamp — data-dependent tests will fail');
|
|
||||||
} else {
|
|
||||||
console.log('Found plugin: ' + ours.name + ' at path ' + ours.path);
|
|
||||||
}
|
|
||||||
" "$PLUGIN_JSON"
|
|
||||||
|
|
||||||
# Fetch deployed plugin version from package.json
|
|
||||||
DEPLOYED_VERSION=$(curl -sf --connect-timeout 10 "$HEADLAMP_URL/plugins/$PLUGIN_NAME/package.json" 2>/dev/null \
|
|
||||||
| node -p "JSON.parse(require('fs').readFileSync(0,'utf8')).version" 2>/dev/null || echo "unknown")
|
|
||||||
echo "Deployed version: $DEPLOYED_VERSION"
|
|
||||||
if [ "$DEPLOYED_VERSION" != "$EXPECTED" ] && [ "$DEPLOYED_VERSION" != "unknown" ]; then
|
|
||||||
echo "::warning::Version mismatch — repo has $EXPECTED but Headlamp runs $DEPLOYED_VERSION. Tests may fail due to stale plugin."
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Install Playwright browsers
|
|
||||||
run: npx playwright install --with-deps chromium
|
|
||||||
|
|
||||||
- name: Run E2E tests
|
|
||||||
run: npm run e2e
|
|
||||||
env:
|
|
||||||
HEADLAMP_URL: ${{ secrets.HEADLAMP_URL || 'http://headlamp.kube-system.svc.cluster.local' }}
|
|
||||||
HEADLAMP_TOKEN: ${{ secrets.HEADLAMP_TOKEN }}
|
|
||||||
AUTHENTIK_USERNAME: ${{ secrets.AUTHENTIK_USERNAME }}
|
|
||||||
AUTHENTIK_PASSWORD: ${{ secrets.AUTHENTIK_PASSWORD }}
|
|
||||||
|
|
||||||
- name: Upload Playwright report
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
if: failure()
|
|
||||||
with:
|
|
||||||
name: playwright-report
|
|
||||||
path: playwright-report/
|
|
||||||
retention-days: 7
|
|
||||||
|
|
||||||
- name: Upload test results
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
if: failure()
|
|
||||||
with:
|
|
||||||
name: test-results
|
|
||||||
path: test-results/
|
|
||||||
retention-days: 7
|
|
||||||
@@ -4,17 +4,80 @@ on:
|
|||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
version:
|
version:
|
||||||
description: 'Release version (e.g. 1.0.0)'
|
description: 'Release version (e.g. 1.0.1)'
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
uses: privilegedescalation/.github/.github/workflows/plugin-release.yaml@main
|
runs-on: ubuntu-latest
|
||||||
with:
|
|
||||||
version: ${{ inputs.version }}
|
steps:
|
||||||
upstream-repo: 'FairwindsOps/polaris'
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: '20'
|
||||||
|
cache: 'pnpm'
|
||||||
|
|
||||||
|
- name: Install pnpm
|
||||||
|
run: npm install -g pnpm
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: pnpm run build
|
||||||
|
|
||||||
|
- name: Get tarball path
|
||||||
|
id: tarball
|
||||||
|
run: |
|
||||||
|
# headlamp-plugin package outputs the tarball path, e.g.:
|
||||||
|
# "Packaged: /path/to/headlamp-polaris-1.0.0.tar.gz"
|
||||||
|
output=$(pnpm run package 2>&1)
|
||||||
|
echo "output=$output"
|
||||||
|
# Extract tarball name, e.g. headlamp-polaris-1.0.0.tar.gz
|
||||||
|
tarball_name=$(echo "$output" | grep -oP 'headlamp-polaris-\d+\.\d+\.\d+\.tar\.gz' | tail -1)
|
||||||
|
echo "tarball_name=$tarball_name" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Create Gitea Release
|
||||||
|
env:
|
||||||
|
GITEA_URL: https://git.farh.net
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
|
REPO: privilegedescalation/headlamp-polaris-plugin
|
||||||
|
run: |
|
||||||
|
VERSION="${{ inputs.version }}"
|
||||||
|
ASSET_NAME="headlamp-polaris-${VERSION}.tar.gz"
|
||||||
|
|
||||||
|
# Create the release via Gitea API
|
||||||
|
RELEASE_RESPONSE=$(
|
||||||
|
curl -s -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases" \
|
||||||
|
-d "{
|
||||||
|
\"tag_name\": \"v${VERSION}\",
|
||||||
|
\"name\": \"v${VERSION}\",
|
||||||
|
\"draft\": false,
|
||||||
|
\"prerelease\": false
|
||||||
|
}"
|
||||||
|
)
|
||||||
|
echo "Release response: ${RELEASE_RESPONSE}"
|
||||||
|
|
||||||
|
RELEASE_ID=$(echo "${RELEASE_RESPONSE}" | python3 -c "import sys, json; print(json.load(sys.stdin).get('id', ''))")
|
||||||
|
if [ -z "$RELEASE_ID" ]; then
|
||||||
|
echo "Failed to create release"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Upload the tarball asset
|
||||||
|
curl -s -X POST \
|
||||||
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||||
|
-H "Content-Type: application/octet-stream" \
|
||||||
|
-T "${{ steps.tarball.outputs.tarball_name }}" \
|
||||||
|
"${GITEA_URL}/api/v1/repos/${REPO}/releases/${RELEASE_ID}/assets?name=${ASSET_NAME}"
|
||||||
+1
-3
@@ -2,9 +2,7 @@ node_modules/
|
|||||||
dist/
|
dist/
|
||||||
.headlamp-plugin/
|
.headlamp-plugin/
|
||||||
*.tar.gz
|
*.tar.gz
|
||||||
e2e/.auth/
|
|
||||||
test-results/
|
|
||||||
.playwright-mcp/
|
|
||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
.eslintcache
|
.eslintcache
|
||||||
|
package-lock.json
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"config": {
|
||||||
|
// Line length — not enforced for docs with code examples
|
||||||
|
"MD013": false,
|
||||||
|
// First line heading — files use YAML frontmatter, not headings
|
||||||
|
"MD041": false,
|
||||||
|
// Emphasis as heading — common pattern for Option 1/2/3 sections
|
||||||
|
"MD036": false,
|
||||||
|
// No duplicate heading — changelog files repeat section names intentionally
|
||||||
|
"MD024": false,
|
||||||
|
// Fenced code language — not always applicable for diagram blocks
|
||||||
|
"MD040": false,
|
||||||
|
// Table column style — table alignment is visual, not semantic
|
||||||
|
"MD060": false,
|
||||||
|
// Ordered list item prefix — number resets are intentional in documents
|
||||||
|
"MD029": false,
|
||||||
|
// No inline HTML — each elements are valid in valid Markdown
|
||||||
|
"MD033": false,
|
||||||
|
// List marker space — spacing after list markers varies by editor
|
||||||
|
"MD030": false,
|
||||||
|
// Blanks around headings — not always needed in compact docs
|
||||||
|
"MD022": false,
|
||||||
|
// Blanks around lists — not always needed in compact docs
|
||||||
|
"MD032": false,
|
||||||
|
// Blanks around fences — not always needed between adjacent blocks
|
||||||
|
"MD031": false,
|
||||||
|
// Multiple blanks — editor artifacts, not semantic
|
||||||
|
"MD012": false,
|
||||||
|
// Single title — files may have multiple H1 sections
|
||||||
|
"MD025": false,
|
||||||
|
// Trailing spaces — editor artifacts
|
||||||
|
"MD009": false,
|
||||||
|
// Bare URLs — URL shortening not always needed
|
||||||
|
"MD034": false,
|
||||||
|
// Single trailing newline — editor artifacts
|
||||||
|
"MD047": false,
|
||||||
|
// Trailing punctuation — heading punctuation is intentional
|
||||||
|
"MD026": false,
|
||||||
|
// Space in emphasis — double-asterisk bold spacing varies by renderer
|
||||||
|
"MD037": false,
|
||||||
|
// No hard tabs — some generated docs use tabs for indentation
|
||||||
|
"MD010": false,
|
||||||
|
// Code block style — generated docs may use inconsistent styles
|
||||||
|
"MD046": false,
|
||||||
|
// Comment style — generated docs have no comments
|
||||||
|
"MD048": false,
|
||||||
|
// Commands show output — shell examples intentionally show only commands
|
||||||
|
"MD014": false
|
||||||
|
},
|
||||||
|
"ignores": [
|
||||||
|
"docs/api-reference/generated/**"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
docs/api-reference/generated/**
|
||||||
+27
-1
@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [1.0.0] - 2026-03-22
|
||||||
|
|
||||||
|
First stable release. The plugin API (routes, sidebar entries, settings schema, and app bar action) is
|
||||||
|
now frozen — no breaking changes without a new major version.
|
||||||
|
|
||||||
|
### Security
|
||||||
|
- Patched 8 of 9 npm audit vulnerabilities via `pnpm.overrides` (#92)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Dual-approval CI check**: PRs now require approval from both CTO and QA before merging (#98, #76)
|
||||||
|
- **ExemptionManager test suite**: Full coverage of annotation-based exemption flows, exemption creation, and inline feedback (#82)
|
||||||
|
- **RBAC preflight check**: `deploy-e2e-headlamp.sh` now verifies runner RBAC before attempting E2E deploy (#80)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- **E2E infrastructure overhaul**: Replaced Dockerfile.e2e with ConfigMap volume mount for plugin loading; tests now run in the `privilegedescalation-dev` namespace (#73, #89, #94)
|
||||||
|
- **E2E token auth**: Workflow uses GitHub App token auth and handles the `/token` redirect correctly (#97)
|
||||||
|
- **E2E HTTP readiness**: `deploy-e2e-headlamp.sh` waits for HTTP reachability after rollout before running tests (#104)
|
||||||
|
- **E2E runner label**: Updated to `runners-privilegedescalation` for self-hosted ARC runners (#71)
|
||||||
|
- **Direct devDependencies**: Added `typescript`, `eslint`, `prettier`, and `@headlamp-k8s/eslint-config` as explicit direct devDependencies to prevent phantom-dep failures in clean installs (#95, #102)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- **pnpm version pinned**: `packageManager` field in `package.json` pins the pnpm version used in CI (#103)
|
||||||
|
- **GitHub Actions SHA pinning**: Renovate `pinDigests` enabled to SHA-pin all GitHub Actions (#105)
|
||||||
|
- **ArtifactHub metadata polish**: Improved `install` instructions and `changes` section formatting (#82)
|
||||||
|
|
||||||
## [0.6.0] - 2026-03-04
|
## [0.6.0] - 2026-03-04
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
@@ -270,7 +295,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Automated release workflow
|
- Automated release workflow
|
||||||
- Basic CI/CD pipeline
|
- Basic CI/CD pipeline
|
||||||
|
|
||||||
[Unreleased]: https://github.com/privilegedescalation/headlamp-polaris-plugin/compare/v0.6.0...HEAD
|
[Unreleased]: https://github.com/privilegedescalation/headlamp-polaris-plugin/compare/v1.0.0...HEAD
|
||||||
|
[1.0.0]: https://github.com/privilegedescalation/headlamp-polaris-plugin/compare/v0.7.2...v1.0.0
|
||||||
[0.6.0]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.6.0
|
[0.6.0]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.6.0
|
||||||
[0.3.5]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.3.5
|
[0.3.5]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.3.5
|
||||||
[0.3.4]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.3.4
|
[0.3.4]: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/tag/v0.3.4
|
||||||
|
|||||||
@@ -25,8 +25,6 @@ npm run format:check # Prettier check
|
|||||||
npm test # vitest run
|
npm test # vitest run
|
||||||
npm run test:watch # vitest watch mode
|
npm run test:watch # vitest watch mode
|
||||||
npx vitest run src/api/polaris.test.ts # run a single test file
|
npx vitest run src/api/polaris.test.ts # run a single test file
|
||||||
npm run e2e # Playwright E2E tests
|
|
||||||
npm run e2e:headed # Playwright headed mode
|
|
||||||
```
|
```
|
||||||
|
|
||||||
All tests and `tsc` must pass before committing.
|
All tests and `tsc` must pass before committing.
|
||||||
|
|||||||
-575
@@ -1,575 +0,0 @@
|
|||||||
# CONTEXT.md - Headlamp Polaris Plugin
|
|
||||||
|
|
||||||
**Purpose**: Comprehensive reverse prompt for AI assistants working on this project.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
The Headlamp Polaris Plugin surfaces [Fairwinds Polaris](https://www.fairwinds.com/polaris) audit results directly inside the [Headlamp](https://headlamp.dev) Kubernetes UI. It provides a read-only dashboard showing cluster-wide security, reliability, and efficiency scores derived from Polaris policy checks.
|
|
||||||
|
|
||||||
- **Stack**: React + TypeScript plugin for Headlamp (v0.26+)
|
|
||||||
- **Data Source**: Polaris dashboard API via Kubernetes service proxy (read-only)
|
|
||||||
- **Current Version**: v0.4.1
|
|
||||||
- **Key Constraint**: No direct Kubernetes resource access - all data fetched through service proxy
|
|
||||||
|
|
||||||
## Architecture & Data Flow
|
|
||||||
|
|
||||||
### Component Hierarchy
|
|
||||||
|
|
||||||
```
|
|
||||||
src/index.tsx # Entry point: registers routes, sidebar, settings
|
|
||||||
├── PolarisDataContext.tsx # Shared data fetch with auto-refresh
|
|
||||||
├── components/
|
|
||||||
│ ├── DashboardView.tsx # Overview (score, checks, top issues)
|
|
||||||
│ ├── NamespacesListView.tsx # Namespace list with scores
|
|
||||||
│ ├── NamespaceDetailView.tsx # Per-namespace drill-down (drawer)
|
|
||||||
│ ├── PolarisSettings.tsx # Settings (refresh interval, URL, test)
|
|
||||||
│ ├── AppBarScoreBadge.tsx # Cluster score badge in top nav
|
|
||||||
│ └── InlineAuditSection.tsx # Injected into workload detail views
|
|
||||||
└── api/
|
|
||||||
└── polaris.ts # Types, hooks, utilities
|
|
||||||
```
|
|
||||||
|
|
||||||
### Data Source
|
|
||||||
|
|
||||||
- **Service Proxy Path**: `/api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json`
|
|
||||||
- **Schema**: `AuditData` with `ClusterInfo`, `Results[]` containing nested `PodResult` and `ContainerResults`
|
|
||||||
- **Method**: `ApiProxy.request()` from Headlamp plugin SDK (handles K8s API auth automatically)
|
|
||||||
|
|
||||||
### State Management
|
|
||||||
|
|
||||||
- **Pattern**: React Context (see `src/api/PolarisDataContext.tsx`)
|
|
||||||
- **Rationale**: ADR-001 - Prevents duplicate API calls when multiple components need same data
|
|
||||||
- **Auto-refresh**: User-configurable interval (1/5/10/30 min, default 5 min)
|
|
||||||
- **Storage**: Refresh interval and dashboard URL stored in `localStorage`
|
|
||||||
|
|
||||||
### Score Computation
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Formula: (pass / total) * 100, rounded to nearest integer
|
|
||||||
function computeScore(counts: ResultCounts): number {
|
|
||||||
if (counts.total === 0) return 0;
|
|
||||||
return Math.round((counts.pass / counts.total) * 100);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Technology Constraints
|
|
||||||
|
|
||||||
### ⚠️ CRITICAL: Headlamp Components Only
|
|
||||||
|
|
||||||
**MUST** use `@kinvolk/headlamp-plugin/lib/CommonComponents`
|
|
||||||
**NEVER** import from `@mui/material` or `@mui/icons-material`
|
|
||||||
|
|
||||||
**Why**: Historical issue (v0.3.2) - MUI imports caused plugin load failures. Headlamp provides all needed components as re-exports.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// ✅ Correct
|
|
||||||
import { SectionBox, StatusLabel } from '@kinvolk/headlamp-plugin/lib/CommonComponents';
|
|
||||||
|
|
||||||
// ❌ Wrong - will break plugin
|
|
||||||
import { Box, Chip } from '@mui/material';
|
|
||||||
```
|
|
||||||
|
|
||||||
### Other Constraints
|
|
||||||
|
|
||||||
- **TypeScript Strictness**: No `any`, explicit types, strict mode enabled
|
|
||||||
- **Packaging**: `@kinvolk/headlamp-plugin` is peer dependency - don't bundle React/MUI
|
|
||||||
- **Theme Handling**: Use CSS variables (`--mui-palette-*`), not theme imports
|
|
||||||
- **Sidebar Limitation**: Headlamp only supports 2-level nesting (parent → children)
|
|
||||||
|
|
||||||
## Component Patterns & Gotchas
|
|
||||||
|
|
||||||
### Headlamp Component Issues
|
|
||||||
|
|
||||||
1. **StatusLabel with empty status**
|
|
||||||
```typescript
|
|
||||||
// ❌ Renders near-invisible (muted background)
|
|
||||||
<StatusLabel status="">{value}</StatusLabel>
|
|
||||||
|
|
||||||
// ✅ Use plain String() for neutral values
|
|
||||||
<span>{String(value)}</span>
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Link component crashes on plugin routes**
|
|
||||||
```typescript
|
|
||||||
// ❌ Headlamp Link crashes on plugin-registered routes
|
|
||||||
import { Link } from '@kinvolk/headlamp-plugin/lib/CommonComponents';
|
|
||||||
|
|
||||||
// ✅ Use react-router-dom Link with Router.createRouteURL
|
|
||||||
import { Link } from 'react-router-dom';
|
|
||||||
import { Router } from '@kinvolk/headlamp-plugin/lib';
|
|
||||||
|
|
||||||
<Link to={Router.createRouteURL('/polaris/namespaces')}>View</Link>
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Visual components that work well**
|
|
||||||
- `PercentageCircle` - Great for score display
|
|
||||||
- `PercentageBar` - Great for check distribution
|
|
||||||
- `SimpleTable` - Fast, clean tables
|
|
||||||
- `NameValueTable` - Key-value pairs
|
|
||||||
- `SectionBox` - Card containers with titles
|
|
||||||
|
|
||||||
### Code Conventions
|
|
||||||
|
|
||||||
- **Functional Components**: Always use function components with hooks
|
|
||||||
- **Named Exports**: Prefer named exports over default exports
|
|
||||||
- **Props Interfaces**: Define as TypeScript interfaces, not inline types
|
|
||||||
- **Import Order**: React → third-party → Headlamp → local (auto-sorted by eslint)
|
|
||||||
|
|
||||||
## RBAC & Security
|
|
||||||
|
|
||||||
### Minimal Permission Required
|
|
||||||
|
|
||||||
The plugin requires **only** this RBAC permission:
|
|
||||||
|
|
||||||
| Verb | API Group | Resource | Resource Name | Namespace |
|
|
||||||
|------|-----------|----------|---------------|-----------|
|
|
||||||
| `get` | `""` (core) | `services/proxy` | `polaris-dashboard` | `polaris` |
|
|
||||||
|
|
||||||
### Example Role
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
|
||||||
kind: Role
|
|
||||||
metadata:
|
|
||||||
name: polaris-proxy-reader
|
|
||||||
namespace: polaris
|
|
||||||
rules:
|
|
||||||
- apiGroups: [""]
|
|
||||||
resources: ["services/proxy"]
|
|
||||||
resourceNames: ["polaris-dashboard"]
|
|
||||||
verbs: ["get"]
|
|
||||||
---
|
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
|
||||||
kind: RoleBinding
|
|
||||||
metadata:
|
|
||||||
name: headlamp-polaris-proxy
|
|
||||||
namespace: polaris
|
|
||||||
subjects:
|
|
||||||
- kind: ServiceAccount
|
|
||||||
name: headlamp
|
|
||||||
namespace: kube-system
|
|
||||||
roleRef:
|
|
||||||
kind: Role
|
|
||||||
name: polaris-proxy-reader
|
|
||||||
apiGroup: rbac.authorization.k8s.io
|
|
||||||
```
|
|
||||||
|
|
||||||
### Security Notes
|
|
||||||
|
|
||||||
- **Namespaced Role**: MUST be namespaced Role, NOT ClusterRole
|
|
||||||
- **ResourceNames Required**: Always specify `resourceNames: ["polaris-dashboard"]`
|
|
||||||
- **No Write Operations**: Plugin only performs GET, never create/update/delete
|
|
||||||
- **Token-Auth Mode**: When Headlamp uses user tokens, each user needs the RoleBinding
|
|
||||||
- **Network Policy**: If enforced, allow API server → `polaris-dashboard:80` ingress
|
|
||||||
- **Audit Logging**: Every proxy request logged as K8s API audit event
|
|
||||||
|
|
||||||
## Development Workflow
|
|
||||||
|
|
||||||
### Commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install dependencies
|
|
||||||
npm install
|
|
||||||
|
|
||||||
# Start development mode (hot reload at localhost:4466)
|
|
||||||
npm start
|
|
||||||
|
|
||||||
# Build plugin
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
# Create tarball for distribution
|
|
||||||
npm run package
|
|
||||||
|
|
||||||
# Type-check without emitting
|
|
||||||
npm run tsc
|
|
||||||
|
|
||||||
# Lint
|
|
||||||
npm run lint
|
|
||||||
|
|
||||||
# Run unit tests
|
|
||||||
npm test
|
|
||||||
|
|
||||||
# Run E2E tests (requires cluster access)
|
|
||||||
npm run e2e
|
|
||||||
|
|
||||||
# Format code
|
|
||||||
npm run format
|
|
||||||
|
|
||||||
# Check formatting (CI)
|
|
||||||
npm run format:check
|
|
||||||
```
|
|
||||||
|
|
||||||
### Branching Strategy
|
|
||||||
|
|
||||||
- ✅ **ALWAYS use feature branches** for code changes (`feat/*`, `fix/*`, `docs/*`)
|
|
||||||
- ✅ **MAY push directly to main** for: documentation-only changes, version bump commits
|
|
||||||
- ❌ **NEVER push code changes directly to main**
|
|
||||||
|
|
||||||
### Commit Convention
|
|
||||||
|
|
||||||
Use Conventional Commits:
|
|
||||||
- `feat:` - New feature
|
|
||||||
- `fix:` - Bug fix
|
|
||||||
- `docs:` - Documentation only
|
|
||||||
- `chore:` - Maintenance (deps, config)
|
|
||||||
- `test:` - Test changes
|
|
||||||
- `ci:` - CI/CD changes
|
|
||||||
|
|
||||||
### PR Process
|
|
||||||
|
|
||||||
All PRs must pass:
|
|
||||||
1. Build (`npm run build`)
|
|
||||||
2. Lint (`npm run lint`)
|
|
||||||
3. Type-check (`npm run tsc`)
|
|
||||||
4. Unit tests (`npm test`)
|
|
||||||
5. Format check (`npm run format:check`)
|
|
||||||
|
|
||||||
**Before committing**: Always run `npx prettier --write src/`
|
|
||||||
|
|
||||||
## Testing Strategy
|
|
||||||
|
|
||||||
### Unit Tests (Vitest)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm test # Run once
|
|
||||||
npm run test:watch # Watch mode
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Framework**: Vitest with jsdom environment
|
|
||||||
- **Test files**: `*.test.ts`, `*.test.tsx` in `src/`
|
|
||||||
- **Setup**: `vitest.setup.ts` with `@testing-library/jest-dom`
|
|
||||||
- **Coverage**: Focus on meaningful tests, not just numbers
|
|
||||||
- **Test utilities**: `src/test-utils.tsx` provides test wrapper with context
|
|
||||||
|
|
||||||
### E2E Tests (Playwright)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run e2e # Headless
|
|
||||||
npm run e2e:headed # With browser UI
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Framework**: Playwright
|
|
||||||
- **Test files**: `e2e/*.spec.ts`
|
|
||||||
- `polaris.spec.ts` - Sidebar, overview, namespaces, detail drawer
|
|
||||||
- `settings.spec.ts` - Plugin settings page
|
|
||||||
- `appbar.spec.ts` - App bar score badge
|
|
||||||
- **Auth**: Supports both OIDC (Authentik) and token-based auth (see `e2e/auth.setup.ts`)
|
|
||||||
- **CI**: Runs on GitHub Actions with `k3s-animaniacs` runner
|
|
||||||
|
|
||||||
### Local E2E Setup
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Token-based auth
|
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system --duration=24h)
|
|
||||||
npm run e2e
|
|
||||||
|
|
||||||
# OIDC auth (Authentik)
|
|
||||||
export AUTHENTIK_USERNAME=your-username
|
|
||||||
export AUTHENTIK_PASSWORD=your-password
|
|
||||||
npm run e2e
|
|
||||||
```
|
|
||||||
|
|
||||||
## CI/CD & Release
|
|
||||||
|
|
||||||
### CI Workflow (`.github/workflows/ci.yaml`)
|
|
||||||
|
|
||||||
Runs on push to main and all PRs:
|
|
||||||
1. Checkout
|
|
||||||
2. `npm ci`
|
|
||||||
3. `npm run build`
|
|
||||||
4. `npm run lint`
|
|
||||||
5. `npm run tsc`
|
|
||||||
6. `npm run format:check`
|
|
||||||
7. `npm test`
|
|
||||||
|
|
||||||
Runner: `local-ubuntu-latest`
|
|
||||||
|
|
||||||
### E2E Workflow (`.github/workflows/e2e.yaml`)
|
|
||||||
|
|
||||||
Runs on push, PR, and manual trigger:
|
|
||||||
1. Checkout
|
|
||||||
2. `npm ci`
|
|
||||||
3. `npm run e2e`
|
|
||||||
|
|
||||||
Runner: `k3s-animaniacs` (has cluster access)
|
|
||||||
Requires: `HEADLAMP_URL`, `HEADLAMP_TOKEN` or `AUTHENTIK_USERNAME`/`AUTHENTIK_PASSWORD`
|
|
||||||
|
|
||||||
### Release Workflow (`.github/workflows/release.yaml`)
|
|
||||||
|
|
||||||
**Manual trigger** via workflow_dispatch with version input:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Via GitHub UI or CLI
|
|
||||||
gh workflow run release.yaml -f version=0.4.2
|
|
||||||
```
|
|
||||||
|
|
||||||
Steps:
|
|
||||||
1. Validate version format (semver)
|
|
||||||
2. Bump `package.json` + `artifacthub-pkg.yml`
|
|
||||||
3. Build plugin
|
|
||||||
4. Package tarball
|
|
||||||
5. Compute SHA256 checksum
|
|
||||||
6. Commit version bump
|
|
||||||
7. Create git tag
|
|
||||||
8. Create GitHub release
|
|
||||||
9. Upload tarball to release
|
|
||||||
|
|
||||||
**Guard**: Skips if checksum already matches (prevents infinite loop)
|
|
||||||
|
|
||||||
**Post-release**: ArtifactHub pulls metadata every 30 min (no webhook, pull-based)
|
|
||||||
|
|
||||||
### Version Bump Requirements
|
|
||||||
|
|
||||||
**ALWAYS bump both files in the same commit**:
|
|
||||||
- `package.json` - `version` field
|
|
||||||
- `artifacthub-pkg.yml` - `version` field + `digest` (checksum) + `archive.url`
|
|
||||||
|
|
||||||
## Known Issues & Workarounds
|
|
||||||
|
|
||||||
### ⚠️ Headlamp v0.39.0 Known Issues
|
|
||||||
|
|
||||||
**AutoSizer JavaScript Error**
|
|
||||||
- **Symptom**: Console shows `TypeError: undefined is not an object (evaluating 'io.AutoSizer')`
|
|
||||||
- **Impact**: Cosmetic error in Settings page, doesn't break functionality
|
|
||||||
- **Root Cause**: Headlamp core bug, not plugin-related
|
|
||||||
- **Workaround**: None needed, can be ignored
|
|
||||||
|
|
||||||
**Plugin Loading (RESOLVED)**
|
|
||||||
- **Old Issue**: Previously thought `config.watchPlugins: false` was required
|
|
||||||
- **Resolution**: Plugins load correctly with default `watchPlugins: true`
|
|
||||||
- **Note**: If you see old docs mentioning `watchPlugins: false`, ignore them
|
|
||||||
|
|
||||||
### Polaris Dashboard Behavior
|
|
||||||
|
|
||||||
**Stale Audit Data**
|
|
||||||
- **Symptom**: Plugin shows old audit timestamp
|
|
||||||
- **Root Cause**: Polaris dashboard runs audit once at pod startup, then caches results
|
|
||||||
- **Does NOT**: Continuously re-audit in real-time
|
|
||||||
- **Workaround**: Restart Polaris pods for fresh data
|
|
||||||
```bash
|
|
||||||
kubectl rollout restart deployment -n polaris polaris-dashboard
|
|
||||||
```
|
|
||||||
- **Load Balancing**: Service balances across multiple pods - each may have different audit timestamps
|
|
||||||
- **Plugin Auto-Refresh**: Works correctly - just fetches whatever Polaris currently has cached
|
|
||||||
|
|
||||||
### Skipped Count Limitation
|
|
||||||
|
|
||||||
**What It Shows**:
|
|
||||||
- Only checks with `Severity: "ignore"` in Polaris API response
|
|
||||||
- Does NOT include annotation-based exemptions (`polaris.fairwinds.com/*-exempt`)
|
|
||||||
|
|
||||||
**Why**:
|
|
||||||
- Polaris omits exempted checks from `results.json`
|
|
||||||
- Plugin has no access to raw K8s resources to compute exemptions
|
|
||||||
- By design: service proxy limitation
|
|
||||||
|
|
||||||
**Workaround**:
|
|
||||||
- Link to native Polaris dashboard for full exemption count
|
|
||||||
- UI tooltip explains this limitation
|
|
||||||
|
|
||||||
## Deployment Patterns
|
|
||||||
|
|
||||||
### Plugin Manager (Recommended)
|
|
||||||
|
|
||||||
Install via Headlamp UI (Settings → Plugins → Catalog) or Helm values:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
pluginsManager:
|
|
||||||
enabled: true
|
|
||||||
configContent: |
|
|
||||||
plugins:
|
|
||||||
- name: polaris
|
|
||||||
source: https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sidecar Container (Alternative)
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
spec:
|
|
||||||
containers:
|
|
||||||
- name: headlamp
|
|
||||||
# ... main container
|
|
||||||
- name: headlamp-plugin
|
|
||||||
image: node:lts-alpine
|
|
||||||
command:
|
|
||||||
- /bin/sh
|
|
||||||
- -c
|
|
||||||
- |
|
|
||||||
npx @headlamp-k8s/pluginctl@latest install \
|
|
||||||
--config /config/plugin.yml \
|
|
||||||
--folderName /headlamp/plugins \
|
|
||||||
--watch
|
|
||||||
volumeMounts:
|
|
||||||
- name: plugins-dir
|
|
||||||
mountPath: /headlamp/plugins
|
|
||||||
- name: plugin-config
|
|
||||||
mountPath: /config
|
|
||||||
volumes:
|
|
||||||
- name: plugins-dir
|
|
||||||
emptyDir: {}
|
|
||||||
- name: plugin-config
|
|
||||||
configMap:
|
|
||||||
name: headlamp-plugin-config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manual Tarball
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Download release
|
|
||||||
wget https://github.com/cpfarhood/headlamp-polaris-plugin/releases/download/v0.4.1/headlamp-polaris-plugin-0.4.1.tgz
|
|
||||||
|
|
||||||
# Extract to plugin directory
|
|
||||||
tar -xzf headlamp-polaris-plugin-0.4.1.tgz -C /headlamp/plugins/
|
|
||||||
|
|
||||||
# Restart Headlamp
|
|
||||||
kubectl rollout restart deployment headlamp -n kube-system
|
|
||||||
```
|
|
||||||
|
|
||||||
## Project Files Reference
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
index.tsx # Entry point: registers sidebar, routes, settings, etc.
|
|
||||||
api/
|
|
||||||
polaris.ts # Core types, usePolarisData hook, utilities
|
|
||||||
PolarisDataContext.tsx # React Context provider for shared data
|
|
||||||
components/
|
|
||||||
DashboardView.tsx # Overview page (score, checks, top issues)
|
|
||||||
NamespacesListView.tsx # Namespace table with scores
|
|
||||||
NamespaceDetailView.tsx # Drawer panel with per-namespace drill-down
|
|
||||||
PolarisSettings.tsx # Settings page (refresh, URL, test)
|
|
||||||
AppBarScoreBadge.tsx # Cluster score chip in top nav bar
|
|
||||||
InlineAuditSection.tsx # Injected into resource detail views
|
|
||||||
test-utils.tsx # Test helpers (wrapper with context)
|
|
||||||
|
|
||||||
.github/workflows/
|
|
||||||
ci.yaml # Lint, type-check, build, test
|
|
||||||
e2e.yaml # Playwright E2E tests
|
|
||||||
release.yaml # Automated releases
|
|
||||||
|
|
||||||
e2e/ # Playwright tests
|
|
||||||
polaris.spec.ts # Main plugin functionality
|
|
||||||
settings.spec.ts # Settings page
|
|
||||||
appbar.spec.ts # App bar badge
|
|
||||||
auth.setup.ts # OIDC/token auth setup
|
|
||||||
|
|
||||||
docs/ # Comprehensive documentation
|
|
||||||
architecture/ # Overview, design decisions, ADRs
|
|
||||||
deployment/ # Helm, Kubernetes, production guides
|
|
||||||
troubleshooting/ # Common issues, RBAC, network problems
|
|
||||||
getting-started/ # Quick start, prerequisites, installation
|
|
||||||
|
|
||||||
package.json # Version, scripts, dependencies
|
|
||||||
artifacthub-pkg.yml # ArtifactHub metadata (version, checksum)
|
|
||||||
tsconfig.json # Extends @kinvolk/headlamp-plugin config
|
|
||||||
vitest.config.mts # Vitest config (jsdom, excludes e2e/)
|
|
||||||
.eslintrc.js # Extends @headlamp-k8s/eslint-config
|
|
||||||
.prettierrc.js # Uses @headlamp-k8s prettier config
|
|
||||||
```
|
|
||||||
|
|
||||||
## MCP Servers (Claude Code)
|
|
||||||
|
|
||||||
- **GitHub**: Source control (`github-mcp-server`), repo at `cpfarhood/headlamp-polaris-plugin`
|
|
||||||
- **Kubernetes (local)**: Cluster access via `kubernetes-mcp-server`
|
|
||||||
- **Flux (local)**: Flux Operator access via `flux-operator-mcp`
|
|
||||||
- **Playwright**: Browser automation via `@playwright/mcp`
|
|
||||||
|
|
||||||
## Common Tasks Quick Reference
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Start development
|
|
||||||
npm install && npm start
|
|
||||||
|
|
||||||
# Run all checks before PR
|
|
||||||
npm run build && npm run lint && npm run tsc && npm test && npm run format
|
|
||||||
|
|
||||||
# Create release (maintainers only)
|
|
||||||
# 1. Edit CHANGELOG.md
|
|
||||||
# 2. Trigger release workflow:
|
|
||||||
gh workflow run release.yaml -f version=0.4.2
|
|
||||||
|
|
||||||
# Run E2E tests locally
|
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system --duration=24h)
|
|
||||||
npm run e2e
|
|
||||||
|
|
||||||
# Fix formatting issues
|
|
||||||
npx prettier --write src/
|
|
||||||
|
|
||||||
# Check Polaris audit freshness
|
|
||||||
kubectl get --raw "/api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json" | jq -r '.AuditTime'
|
|
||||||
|
|
||||||
# Restart Polaris for fresh audit
|
|
||||||
kubectl rollout restart deployment -n polaris polaris-dashboard
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Patterns (What NOT to Do)
|
|
||||||
|
|
||||||
- ❌ Import from `@mui/material` or `@mui/icons-material` → breaks plugin
|
|
||||||
- ❌ Use `any` type → strict TypeScript required
|
|
||||||
- ❌ Push code changes directly to main → always use feature branches
|
|
||||||
- ❌ Grant broader RBAC than `get services/proxy` → security risk
|
|
||||||
- ❌ Use ClusterRole instead of namespaced Role → violates least privilege
|
|
||||||
- ❌ Forget to run `npx prettier --write src/` → CI will fail
|
|
||||||
- ❌ Use inline styles without CSS variables → breaks dark mode
|
|
||||||
- ❌ Try to query K8s resources directly → plugin only has service proxy access
|
|
||||||
- ❌ Import Headlamp `Link` for plugin routes → use react-router-dom `Link` + `Router.createRouteURL()`
|
|
||||||
- ❌ Assume Polaris continuously re-audits → it only audits at pod startup
|
|
||||||
|
|
||||||
## Quick Diagnosis Guide
|
|
||||||
|
|
||||||
```
|
|
||||||
Symptom: Plugin not in sidebar
|
|
||||||
→ Check: Hard refresh browser (Cmd+Shift+R / Ctrl+Shift+R)
|
|
||||||
→ Check: Plugin installed? kubectl get configmap headlamp-plugin-config -n kube-system
|
|
||||||
|
|
||||||
Symptom: 403 Access Denied
|
|
||||||
→ Check: RBAC binding exists? kubectl get role,rolebinding -n polaris
|
|
||||||
→ Fix: Apply RBAC example from docs/deployment/rbac.md
|
|
||||||
|
|
||||||
Symptom: 404 or 503
|
|
||||||
→ Check: Polaris installed? kubectl get pods -n polaris
|
|
||||||
→ Check: Service exists? kubectl get svc polaris-dashboard -n polaris
|
|
||||||
|
|
||||||
Symptom: Stale audit data
|
|
||||||
→ Fix: kubectl rollout restart deployment -n polaris polaris-dashboard
|
|
||||||
→ Verify: Check AuditTime in UI matches current date
|
|
||||||
|
|
||||||
Symptom: Settings page empty or broken
|
|
||||||
→ Check: Plugin version ≥ v0.3.3?
|
|
||||||
→ Fix: Upgrade plugin and hard refresh browser
|
|
||||||
|
|
||||||
Symptom: CI prettier check fails
|
|
||||||
→ Fix: npx prettier --write src/
|
|
||||||
→ Commit: Include formatting fixes in your PR
|
|
||||||
|
|
||||||
Symptom: Dark mode white backgrounds
|
|
||||||
→ Check: Plugin version ≥ v0.3.5?
|
|
||||||
→ Fix: Upgrade and hard refresh browser
|
|
||||||
```
|
|
||||||
|
|
||||||
## Historical Context
|
|
||||||
|
|
||||||
### Why Service Proxy Instead of ConfigMaps?
|
|
||||||
|
|
||||||
Early versions (< v0.0.10) incorrectly documented ConfigMap RBAC. The plugin **never** accessed ConfigMaps - it always used the service proxy. This was clarified in v0.0.10.
|
|
||||||
|
|
||||||
### Why No MUI Imports?
|
|
||||||
|
|
||||||
v0.3.2 removed direct MUI imports because they caused plugin load failures. Headlamp provides all needed MUI components as re-exports through `CommonComponents`.
|
|
||||||
|
|
||||||
### Why React Context?
|
|
||||||
|
|
||||||
ADR-001 documents the switch to React Context. Before v0.3.0, each component called `usePolarisData()` independently, causing duplicate API requests. Context ensures a single shared fetch.
|
|
||||||
|
|
||||||
### Why No Continuous Polaris Audits?
|
|
||||||
|
|
||||||
Polaris dashboard mode runs a one-time audit at pod startup and caches results. This is by design in Polaris itself. For continuous auditing, Polaris would need to be configured in webhook mode (admission controller), which is a different deployment pattern.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Last Updated**: 2026-02-12
|
|
||||||
**Version**: v0.4.1
|
|
||||||
**Target Headlamp**: v0.26+
|
|
||||||
**Target Polaris**: v9.x
|
|
||||||
@@ -1,290 +0,0 @@
|
|||||||
# Headlamp Polaris Plugin - Project Assessment
|
|
||||||
|
|
||||||
**Date:** 2026-02-11
|
|
||||||
**Version:** v0.3.0
|
|
||||||
**Status:** Active Development
|
|
||||||
|
|
||||||
## Executive Summary
|
|
||||||
|
|
||||||
This assessment identifies critical issues and improvement opportunities for the headlamp-polaris-plugin project. The plugin is currently non-functional in production due to Headlamp v0.39.0 compatibility issues, and has several TypeScript compilation errors that need immediate attention.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🔴 Critical Issues (Must Fix Immediately)
|
|
||||||
|
|
||||||
### 1. TypeScript Compilation Errors
|
|
||||||
**Severity:** CRITICAL
|
|
||||||
**Impact:** Build failures, type safety compromised
|
|
||||||
|
|
||||||
**Issues:**
|
|
||||||
- `src/index.tsx:72` - `registerDetailsViewSection` expects 1 argument, got 2
|
|
||||||
- `src/index.tsx:87` - `registerAppBarAction` expects 1 argument, got 2
|
|
||||||
|
|
||||||
**Recommendation:**
|
|
||||||
Update Headlamp plugin API calls to match the current version. Check @kinvolk/headlamp-plugin version compatibility.
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Review Headlamp plugin API documentation
|
|
||||||
- [ ] Update `registerDetailsViewSection` and `registerAppBarAction` calls
|
|
||||||
- [ ] Run `npm run tsc` to verify fixes
|
|
||||||
- [ ] Update CI to fail on TypeScript errors
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 2. Production Plugin Loading Failure
|
|
||||||
**Severity:** CRITICAL
|
|
||||||
**Impact:** Plugin is completely non-functional in production
|
|
||||||
|
|
||||||
**Root Cause:**
|
|
||||||
Headlamp v0.39.0 with default `watchPlugins: true` treats catalog-managed plugins as "development directory" plugins, preventing frontend JavaScript execution.
|
|
||||||
|
|
||||||
**Current Status:**
|
|
||||||
- Deployment patched to install plugins to `/headlamp/static-plugins`
|
|
||||||
- `watchPlugins: false` configured
|
|
||||||
- Waiting for user to test if plugins now load
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Confirm plugins load after recent deployment changes
|
|
||||||
- [ ] Document the fix in deployment guide
|
|
||||||
- [ ] Update MEMORY.md with final resolution
|
|
||||||
- [ ] Consider downgrading Headlamp if issue persists
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 3. Test Failures
|
|
||||||
**Severity:** HIGH
|
|
||||||
**Impact:** CI failures, reduced confidence in changes
|
|
||||||
|
|
||||||
**Current Status:**
|
|
||||||
- 1 test file failing (DashboardView)
|
|
||||||
- 49 tests passing
|
|
||||||
- Error related to `SimpleTable` component mock
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Fix DashboardView test mocking
|
|
||||||
- [ ] Ensure all tests pass before merging PRs
|
|
||||||
- [ ] Add test for top issues feature
|
|
||||||
- [ ] Increase test coverage to >80%
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🟡 High Priority Improvements
|
|
||||||
|
|
||||||
### 4. Type Safety Enhancements
|
|
||||||
**Severity:** HIGH
|
|
||||||
**Impact:** Better developer experience, catch errors earlier
|
|
||||||
|
|
||||||
**Recommendations:**
|
|
||||||
- Enable stricter TypeScript checks in `tsconfig.json`
|
|
||||||
- Add type definitions for all Headlamp plugin APIs
|
|
||||||
- Ensure no `any` types in production code
|
|
||||||
- Add JSDoc comments for complex types
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Audit codebase for `any` types
|
|
||||||
- [ ] Enable `noImplicitAny` and `strictNullChecks`
|
|
||||||
- [ ] Add type guards for API responses
|
|
||||||
- [ ] Document complex type structures
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 5. Security Hardening
|
|
||||||
**Severity:** HIGH
|
|
||||||
**Impact:** Prevent vulnerabilities, protect user data
|
|
||||||
|
|
||||||
**Current Risks:**
|
|
||||||
- Direct Kubernetes API access via service proxy
|
|
||||||
- User input in exemption annotations (potential injection)
|
|
||||||
- External URL configuration for Polaris dashboard
|
|
||||||
|
|
||||||
**Recommendations:**
|
|
||||||
- Validate and sanitize all user inputs
|
|
||||||
- Implement input validation for dashboard URL
|
|
||||||
- Add CSRF protection for exemption management
|
|
||||||
- Audit dependencies for known vulnerabilities
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Add input validation utilities
|
|
||||||
- [ ] Sanitize exemption annotation values
|
|
||||||
- [ ] Validate URL format for dashboard configuration
|
|
||||||
- [ ] Run `npm audit` and fix vulnerabilities
|
|
||||||
- [ ] Add security testing to CI/CD
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 6. Error Handling & User Experience
|
|
||||||
**Severity:** MEDIUM
|
|
||||||
**Impact:** Better error messages, improved debugging
|
|
||||||
|
|
||||||
**Current Gaps:**
|
|
||||||
- Generic error messages don't help users troubleshoot
|
|
||||||
- No retry logic for transient API failures
|
|
||||||
- Missing loading states in some components
|
|
||||||
|
|
||||||
**Recommendations:**
|
|
||||||
- Provide specific, actionable error messages
|
|
||||||
- Implement retry logic with exponential backoff
|
|
||||||
- Add loading skeletons for all async operations
|
|
||||||
- Show connection test results with specific failure reasons
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Create error message constants with solutions
|
|
||||||
- [ ] Add retry logic to API calls
|
|
||||||
- [ ] Implement loading skeletons
|
|
||||||
- [ ] Improve connection test error messages
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🟢 Medium Priority Enhancements
|
|
||||||
|
|
||||||
### 7. Testing Coverage
|
|
||||||
**Severity:** MEDIUM
|
|
||||||
**Impact:** Confidence in changes, regression prevention
|
|
||||||
|
|
||||||
**Current Coverage:**
|
|
||||||
- Unit tests: Good coverage for API utilities
|
|
||||||
- Component tests: Some coverage, gaps exist
|
|
||||||
- E2E tests: Minimal (Playwright configured but underutilized)
|
|
||||||
|
|
||||||
**Recommendations:**
|
|
||||||
- Add E2E tests for critical user flows
|
|
||||||
- Test error scenarios and edge cases
|
|
||||||
- Add visual regression tests
|
|
||||||
- Test RBAC permission denied scenarios
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Write E2E test for complete audit workflow
|
|
||||||
- [ ] Add tests for error states
|
|
||||||
- [ ] Test exemption management flow
|
|
||||||
- [ ] Add Playwright tests to CI
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 8. Performance Optimization
|
|
||||||
**Severity:** MEDIUM
|
|
||||||
**Impact:** Faster load times, better UX
|
|
||||||
|
|
||||||
**Opportunities:**
|
|
||||||
- Memoize expensive calculations (score computation)
|
|
||||||
- Lazy load namespace detail views
|
|
||||||
- Debounce search/filter operations
|
|
||||||
- Cache Polaris data with stale-while-revalidate
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Add React.memo to pure components
|
|
||||||
- [ ] Memoize score calculations
|
|
||||||
- [ ] Implement data caching strategy
|
|
||||||
- [ ] Profile component render times
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 9. Code Quality & Maintainability
|
|
||||||
**Severity:** MEDIUM
|
|
||||||
**Impact:** Easier maintenance, onboarding
|
|
||||||
|
|
||||||
**Recommendations:**
|
|
||||||
- Extract magic strings to constants
|
|
||||||
- Reduce component complexity
|
|
||||||
- Add JSDoc comments for public APIs
|
|
||||||
- Improve code organization
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Create constants file for check IDs
|
|
||||||
- [ ] Split large components (DashboardView, NamespaceDetailView)
|
|
||||||
- [ ] Add comments for complex logic
|
|
||||||
- [ ] Establish code review checklist
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🔵 Low Priority / Future Enhancements
|
|
||||||
|
|
||||||
### 10. Documentation
|
|
||||||
**Severity:** LOW
|
|
||||||
**Impact:** Better onboarding, user adoption
|
|
||||||
|
|
||||||
**Gaps:**
|
|
||||||
- No architecture documentation
|
|
||||||
- Limited inline code comments
|
|
||||||
- Missing troubleshooting guide
|
|
||||||
- No contributor guidelines
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Create architecture diagram
|
|
||||||
- [ ] Document component hierarchy
|
|
||||||
- [ ] Add troubleshooting section to README
|
|
||||||
- [ ] Create CONTRIBUTING.md
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 11. CI/CD Pipeline Optimization
|
|
||||||
**Severity:** LOW
|
|
||||||
**Impact:** Faster feedback, automated releases
|
|
||||||
|
|
||||||
**Opportunities:**
|
|
||||||
- Run tests in parallel
|
|
||||||
- Cache npm dependencies
|
|
||||||
- Add automated security scanning
|
|
||||||
- Implement semantic versioning
|
|
||||||
|
|
||||||
**Action Items:**
|
|
||||||
- [ ] Parallelize test execution
|
|
||||||
- [ ] Add npm cache to GitHub Actions
|
|
||||||
- [ ] Integrate Dependabot
|
|
||||||
- [ ] Add semantic-release
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Summary & Prioritization
|
|
||||||
|
|
||||||
### Week 1 (Immediate)
|
|
||||||
1. ✅ Fix TypeScript compilation errors
|
|
||||||
2. ✅ Resolve production plugin loading issue
|
|
||||||
3. ✅ Fix failing DashboardView test
|
|
||||||
|
|
||||||
### Week 2 (High Priority)
|
|
||||||
4. Enhance type safety (strict mode)
|
|
||||||
5. Implement security hardening
|
|
||||||
6. Improve error handling and UX
|
|
||||||
|
|
||||||
### Week 3-4 (Medium Priority)
|
|
||||||
7. Increase test coverage to >80%
|
|
||||||
8. Optimize performance (memoization, caching)
|
|
||||||
9. Refactor for maintainability
|
|
||||||
|
|
||||||
### Ongoing (Low Priority)
|
|
||||||
10. Documentation improvements
|
|
||||||
11. CI/CD optimizations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Success Metrics
|
|
||||||
|
|
||||||
**Code Quality:**
|
|
||||||
- ✅ Zero TypeScript errors
|
|
||||||
- ✅ All tests passing
|
|
||||||
- 🎯 Test coverage >80%
|
|
||||||
- 🎯 No high/critical security vulnerabilities
|
|
||||||
|
|
||||||
**Production Readiness:**
|
|
||||||
- ✅ Plugin loads successfully in Headlamp
|
|
||||||
- ✅ All features functional
|
|
||||||
- 🎯 Error rate <1%
|
|
||||||
- 🎯 Average response time <500ms
|
|
||||||
|
|
||||||
**Developer Experience:**
|
|
||||||
- ✅ Clear documentation
|
|
||||||
- ✅ Easy local setup
|
|
||||||
- 🎯 Fast CI/CD (<5 min)
|
|
||||||
- 🎯 Automated releases
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
1. **Immediate:** Fix TypeScript errors and verify plugin loads
|
|
||||||
2. **Short-term:** Complete Week 1-2 priorities
|
|
||||||
3. **Long-term:** Address medium and low priority items
|
|
||||||
4. **Continuous:** Monitor metrics and iterate
|
|
||||||
|
|
||||||
**Recommended First Action:**
|
|
||||||
Fix the TypeScript compilation errors in `src/index.tsx` by updating the Headlamp plugin API calls.
|
|
||||||
@@ -48,9 +48,14 @@ Polaris must be deployed in the `polaris` namespace with the dashboard component
|
|||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
|
|
||||||
### Option 1: Headlamp Plugin Manager (Recommended)
|
The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin). Install via the Headlamp UI:
|
||||||
|
|
||||||
The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin). Configure Headlamp via Helm:
|
1. Go to **Settings → Plugins**
|
||||||
|
2. Click **Catalog** tab
|
||||||
|
3. Search for "Polaris"
|
||||||
|
4. Click **Install**
|
||||||
|
|
||||||
|
Or configure Headlamp via Helm:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
config:
|
config:
|
||||||
@@ -62,56 +67,6 @@ pluginsManager:
|
|||||||
url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
Or install via the Headlamp UI:
|
|
||||||
|
|
||||||
1. Go to **Settings → Plugins**
|
|
||||||
2. Click **Catalog** tab
|
|
||||||
3. Search for "Polaris"
|
|
||||||
4. Click **Install**
|
|
||||||
|
|
||||||
### Option 2: Sidecar Container (Alternative)
|
|
||||||
|
|
||||||
For detailed sidecar installation instructions, see [docs/DEPLOYMENT.md#installation-method-2-sidecar-container](docs/DEPLOYMENT.md#installation-method-2-sidecar-container).
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
sidecars:
|
|
||||||
- name: headlamp-plugin
|
|
||||||
image: node:lts-alpine
|
|
||||||
command: ['/bin/sh']
|
|
||||||
args:
|
|
||||||
- -c
|
|
||||||
- |
|
|
||||||
npm install -g @kinvolk/headlamp-plugin
|
|
||||||
headlamp-plugin install --config /config/plugin.yml
|
|
||||||
tail -f /dev/null
|
|
||||||
volumeMounts:
|
|
||||||
- name: plugins
|
|
||||||
mountPath: /headlamp/plugins
|
|
||||||
- name: plugin-config
|
|
||||||
mountPath: /config
|
|
||||||
```
|
|
||||||
|
|
||||||
### Option 3: Manual Tarball Install
|
|
||||||
|
|
||||||
Download the `.tar.gz` from the [GitHub releases page](https://github.com/privilegedescalation/headlamp-polaris-plugin/releases), then extract into Headlamp's plugin directory:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
wget https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz
|
|
||||||
tar xzf polaris-0.3.10.tar.gz -C /headlamp/plugins/
|
|
||||||
```
|
|
||||||
|
|
||||||
### Option 4: Build from Source
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/privilegedescalation/headlamp-polaris-plugin.git
|
|
||||||
cd headlamp-polaris-plugin
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
npx @kinvolk/headlamp-plugin extract . /headlamp/plugins
|
|
||||||
```
|
|
||||||
|
|
||||||
For complete installation instructions including Helm integration, FluxCD examples, and production deployment checklist, see **[docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)**.
|
|
||||||
|
|
||||||
## RBAC / Security Setup
|
## RBAC / Security Setup
|
||||||
|
|
||||||
The plugin fetches audit data through the Kubernetes API server's **service proxy** sub-resource. The identity making the request (Headlamp's service account, or the user's own token in token-auth mode) must be granted:
|
The plugin fetches audit data through the Kubernetes API server's **service proxy** sub-resource. The identity making the request (Headlamp's service account, or the user's own token in token-auth mode) must be granted:
|
||||||
@@ -142,7 +97,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp # adjust to match your Headlamp service account
|
name: headlamp # adjust to match your Headlamp service account
|
||||||
namespace: kube-system # adjust to match the namespace Headlamp runs in
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -242,7 +197,7 @@ npm test
|
|||||||
npm run test:watch
|
npm run test:watch
|
||||||
|
|
||||||
# E2E tests (Playwright)
|
# E2E tests (Playwright)
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system --duration=24h)
|
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n <your-namespace> --duration=24h)
|
||||||
npm run e2e
|
npm run e2e
|
||||||
npm run e2e:headed # see browser
|
npm run e2e:headed # see browser
|
||||||
```
|
```
|
||||||
|
|||||||
+4
-4
@@ -71,7 +71,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -149,7 +149,7 @@ spec:
|
|||||||
|
|
||||||
### Service Account (Default)
|
### Service Account (Default)
|
||||||
|
|
||||||
Headlamp runs with a dedicated service account (`headlamp` in `kube-system`). All users share the same permissions defined by this service account's RBAC bindings.
|
Headlamp runs with a dedicated service account (`headlamp` in the namespace where Headlamp is installed). All users share the same permissions defined by this service account's RBAC bindings.
|
||||||
|
|
||||||
**Security Considerations:**
|
**Security Considerations:**
|
||||||
- All users have identical access to the plugin
|
- All users have identical access to the plugin
|
||||||
@@ -212,7 +212,7 @@ If you discover a security vulnerability in this plugin, please report it via:
|
|||||||
|
|
||||||
The project uses:
|
The project uses:
|
||||||
- **npm audit**: Runs automatically during `npm install`
|
- **npm audit**: Runs automatically during `npm install`
|
||||||
- **Dependabot**: GitHub Dependabot monitors dependencies and creates PRs for updates
|
- **Renovate**: Automated dependency updates via Mend Renovate (org-wide configured)
|
||||||
- **GitHub Actions**: CI workflow runs `npm audit` on every commit
|
- **GitHub Actions**: CI workflow runs `npm audit` on every commit
|
||||||
|
|
||||||
### Updating Dependencies
|
### Updating Dependencies
|
||||||
@@ -317,7 +317,7 @@ All service proxy requests are logged in Kubernetes API audit logs (if enabled):
|
|||||||
"verb": "get",
|
"verb": "get",
|
||||||
"requestURI": "/api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json",
|
"requestURI": "/api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json",
|
||||||
"user": {
|
"user": {
|
||||||
"username": "system:serviceaccount:kube-system:headlamp",
|
"username": "system:serviceaccount:<your-namespace>:headlamp",
|
||||||
"groups": ["system:serviceaccounts", "system:authenticated"]
|
"groups": ["system:serviceaccounts", "system:authenticated"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+73
-26
@@ -1,34 +1,81 @@
|
|||||||
version: "0.7.0"
|
version: 1.0.1
|
||||||
name: headlamp-polaris
|
name: headlamp-polaris
|
||||||
displayName: Polaris
|
displayName: Polaris
|
||||||
createdAt: "2026-02-05T19:00:00Z"
|
createdAt: '2026-05-20T00:00:00Z'
|
||||||
description: >-
|
description: Surfaces Fairwinds Polaris audit results inside the Headlamp UI. Shows
|
||||||
Surfaces Fairwinds Polaris audit results inside the Headlamp UI.
|
cluster score, check summary, and per-namespace drill-downs with per-resource pass/warning/danger
|
||||||
Shows cluster score, check summary, and per-namespace drill-downs
|
breakdowns. Data is fetched read-only via the Kubernetes service proxy to the Polaris
|
||||||
with per-resource pass/warning/danger breakdowns. Data is fetched
|
dashboard. Requires a Role granting `get` on `services/proxy` for the `polaris-dashboard`
|
||||||
read-only via the Kubernetes service proxy to the Polaris dashboard.
|
service in the `polaris` namespace.
|
||||||
Requires a Role granting `get` on `services/proxy` for the
|
|
||||||
`polaris-dashboard` service in the `polaris` namespace.
|
|
||||||
license: Apache-2.0
|
license: Apache-2.0
|
||||||
homeURL: "https://github.com/privilegedescalation/headlamp-polaris-plugin"
|
homeURL: https://github.com/privilegedescalation/headlamp-polaris-plugin
|
||||||
|
appVersion: 10.1.6
|
||||||
category: security
|
category: security
|
||||||
keywords:
|
keywords:
|
||||||
- polaris
|
- polaris
|
||||||
- fairwinds
|
- fairwinds
|
||||||
- security
|
- security
|
||||||
- audit
|
- audit
|
||||||
- headlamp
|
- headlamp
|
||||||
- kubernetes
|
- kubernetes
|
||||||
links:
|
links:
|
||||||
- name: Source
|
- name: Source
|
||||||
url: "https://github.com/privilegedescalation/headlamp-polaris-plugin"
|
url: https://github.com/privilegedescalation/headlamp-polaris-plugin
|
||||||
- name: Polaris
|
- name: Polaris
|
||||||
url: "https://polaris.docs.fairwinds.com/"
|
url: https://polaris.docs.fairwinds.com/
|
||||||
|
install: |
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
1. [Headlamp](https://headlamp.dev) v0.26.0 or later
|
||||||
|
2. [Fairwinds Polaris](https://polaris.docs.fairwinds.com/) installed and the dashboard running in your cluster
|
||||||
|
|
||||||
|
### Install via Headlamp Plugin Catalog
|
||||||
|
|
||||||
|
1. Open Headlamp and navigate to **Settings → Plugin Catalog**
|
||||||
|
2. Search for **"Polaris"**
|
||||||
|
3. Click **Install** and restart Headlamp when prompted
|
||||||
|
|
||||||
|
The plugin is sourced directly from [ArtifactHub](https://artifacthub.io/packages/headlamp/headlamp/headlamp-polaris).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
After installation, the Polaris plugin adds:
|
||||||
|
- A **cluster score badge** in the Headlamp app bar
|
||||||
|
- A **Polaris** section in the sidebar with the full dashboard and namespace drill-downs
|
||||||
|
- An **inline audit panel** on Deployment, StatefulSet, DaemonSet, Job, and CronJob detail pages
|
||||||
|
|
||||||
|
For more information, see the [README](https://github.com/privilegedescalation/headlamp-polaris-plugin/blob/main/README.md).
|
||||||
|
changes:
|
||||||
|
- kind: security
|
||||||
|
description: Patched 8 npm audit vulnerabilities via pnpm.overrides
|
||||||
|
- kind: added
|
||||||
|
description: Dual-approval required CI check — PRs must be approved by both CTO
|
||||||
|
and QA before merge
|
||||||
|
- kind: added
|
||||||
|
description: ExemptionManager test suite — full coverage of annotation-based exemption
|
||||||
|
flows
|
||||||
|
- kind: fixed
|
||||||
|
description: E2E infrastructure overhauled — ConfigMap volume mount replaces Dockerfile-based
|
||||||
|
approach, tests run in privilegedescalation-dev namespace
|
||||||
|
- kind: fixed
|
||||||
|
description: E2E workflow uses token auth and waits for HTTP reachability before
|
||||||
|
running tests
|
||||||
|
- kind: fixed
|
||||||
|
description: Added explicit direct devDependencies (typescript, eslint, prettier,
|
||||||
|
@headlamp-k8s/eslint-config) to prevent phantom dep failures
|
||||||
|
- kind: changed
|
||||||
|
description: pnpm version pinned via packageManager field; GitHub Actions SHA-pinned
|
||||||
|
via Renovate pinDigests
|
||||||
|
- kind: changed
|
||||||
|
description: v1.0.0 stable release — plugin API (routes, sidebar, settings schema,
|
||||||
|
app bar action) is stable and will not change without a major version bump
|
||||||
maintainers:
|
maintainers:
|
||||||
- name: privilegedescalation
|
- name: privilegedescalation
|
||||||
email: "chris@farhood.org"
|
email: chris@farhood.org
|
||||||
annotations:
|
annotations:
|
||||||
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.7.0/headlamp-polaris-0.7.0.tar.gz"
|
headlamp/plugin/archive-url: https://git.farh.net/privilegedescalation/headlamp-polaris-plugin/releases/download/v1.0.1/headlamp-polaris-1.0.1.tar.gz
|
||||||
headlamp/plugin/version-compat: ">=0.26"
|
headlamp/plugin/version-compat: '>=0.26'
|
||||||
headlamp/plugin/archive-checksum: sha256:69b7adf74416d72580981387b1861e2b5fcf7f96ae9f0620f85f623f8b6dab56
|
headlamp/plugin/archive-checksum: sha256:1e05d079c7032cf55ebde85e116cb65b686d207f4b6a3b0f716f0af93f933e7e
|
||||||
headlamp/plugin/distro-compat: in-cluster
|
headlamp/plugin/distro-compat: in-cluster,web,desktop
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
{
|
||||||
|
// Allowlist for inherited dev-dependency CVEs from @kinvolk/headlamp-plugin
|
||||||
|
// CTO decision (PRI-854): these high-severity vulns are dev/build-time only,
|
||||||
|
// trace to @kinvolk/headlamp-plugin transitive deps (Picomatch, Vite, lodash),
|
||||||
|
// and do NOT ship in production plugin artifacts.
|
||||||
|
"allowlist": [
|
||||||
|
{
|
||||||
|
"id": "GHSA-hhpm-516h-p3p6",
|
||||||
|
"reason": "Picomatch ReDoS: devDependency only, does not ship in production plugin bundle"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "GHSA-36xf-7xpp-53w5",
|
||||||
|
"reason": "Vite arbitrary file read: devDependency only, does not ship in production plugin bundle"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "GHSA-jf8v-p3pp-93qh",
|
||||||
|
"reason": "lodash code injection via _.template: devDependency only, does not ship in production plugin bundle"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
# Headlamp Plugin Loading Issue - Root Cause and Fix
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
Headlamp v0.39.0 was not loading plugins installed via the plugin manager. Plugins appeared in Settings → Plugins but:
|
|
||||||
- No sidebar entries appeared
|
|
||||||
- No plugin settings were available
|
|
||||||
- Plugin JavaScript was not being executed in the browser
|
|
||||||
|
|
||||||
## Root Cause
|
|
||||||
When `config.watchPlugins: true` (the default), Headlamp treats catalog-managed plugins in `/headlamp/plugins/` as "development directory" plugins. This causes:
|
|
||||||
- Backend serves plugin metadata correctly
|
|
||||||
- Backend logs show "Treating catalog-installed plugin in development directory as user plugin"
|
|
||||||
- **Frontend does NOT execute the plugin JavaScript**
|
|
||||||
- Plugin registrations (`registerSidebarEntry`, `registerRoute`, etc.) never happen
|
|
||||||
|
|
||||||
## Solution
|
|
||||||
Set `config.watchPlugins: false` in the Headlamp HelmRelease values:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
spec:
|
|
||||||
values:
|
|
||||||
config:
|
|
||||||
watchPlugins: false
|
|
||||||
pluginsManager:
|
|
||||||
enabled: true
|
|
||||||
configContent: |
|
|
||||||
plugins:
|
|
||||||
- name: polaris
|
|
||||||
source: https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin
|
|
||||||
# ... other plugins
|
|
||||||
```
|
|
||||||
|
|
||||||
## Why This Works
|
|
||||||
With `watchPlugins: false`:
|
|
||||||
- Headlamp no longer treats catalog-managed plugins as "development" plugins
|
|
||||||
- Frontend properly loads and executes plugin JavaScript on startup
|
|
||||||
- Plugin registrations happen correctly
|
|
||||||
- All plugin features (sidebar, routes, settings, etc.) work as expected
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
After applying this fix:
|
|
||||||
1. Verify plugins are installed: `kubectl logs -n kube-system <headlamp-pod> -c headlamp-plugin`
|
|
||||||
2. Verify watchPlugins is false: `kubectl logs -n kube-system <headlamp-pod> -c headlamp | grep "Watch Plugins"`
|
|
||||||
3. Hard refresh browser (Cmd+Shift+R / Ctrl+Shift+F5) to clear cached JavaScript
|
|
||||||
4. Verify plugin sidebar entries appear
|
|
||||||
5. Verify plugin functionality works
|
|
||||||
|
|
||||||
## Additional Notes
|
|
||||||
- This appears to be a bug/limitation in Headlamp v0.39.0
|
|
||||||
- The `watchPlugins` feature is intended for development scenarios where plugins are being actively modified
|
|
||||||
- For production deployments with catalog-managed plugins, `watchPlugins: false` is the correct configuration
|
|
||||||
- Once plugins are loaded, subsequent restarts or updates work correctly as long as `watchPlugins` remains false
|
|
||||||
|
|
||||||
## References
|
|
||||||
- Headlamp Helm Chart: https://github.com/headlamp-k8s/headlamp/tree/main/charts/headlamp
|
|
||||||
- Plugin Manager: https://github.com/headlamp-k8s/headlamp/tree/main/plugins/headlamp-plugin
|
|
||||||
- Issue discovered: 2026-02-11
|
|
||||||
- Fix applied: 2026-02-12
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
---
|
|
||||||
# Custom Headlamp values for static plugin installation
|
|
||||||
# This disables the plugin manager and uses an init container instead
|
|
||||||
|
|
||||||
# Disable the plugin manager sidecar
|
|
||||||
pluginsManager:
|
|
||||||
enabled: false
|
|
||||||
|
|
||||||
# Use an init container to install plugins to /headlamp/static-plugins
|
|
||||||
initContainers:
|
|
||||||
- name: install-plugins
|
|
||||||
image: node:lts-alpine
|
|
||||||
command:
|
|
||||||
- /bin/sh
|
|
||||||
- -c
|
|
||||||
- |
|
|
||||||
set -e
|
|
||||||
echo "Installing plugins to /headlamp/static-plugins..."
|
|
||||||
|
|
||||||
# Create plugins directory
|
|
||||||
mkdir -p /headlamp/static-plugins
|
|
||||||
|
|
||||||
# Set up npm cache
|
|
||||||
export NPM_CONFIG_CACHE=/tmp/npm-cache
|
|
||||||
export NPM_CONFIG_USERCONFIG=/tmp/npm-userconfig
|
|
||||||
mkdir -p /tmp/npm-cache /tmp/npm-userconfig
|
|
||||||
|
|
||||||
# Install polaris plugin
|
|
||||||
echo "Installing polaris plugin..."
|
|
||||||
cd /headlamp/static-plugins
|
|
||||||
npm pack headlamp-polaris-plugin@0.3.0
|
|
||||||
tar -xzf headlamp-polaris-plugin-0.3.0.tgz
|
|
||||||
mv package headlamp-polaris-plugin
|
|
||||||
rm headlamp-polaris-plugin-0.3.0.tgz
|
|
||||||
|
|
||||||
# Install other plugins
|
|
||||||
npx --yes @headlamp-k8s/plugin@latest install \
|
|
||||||
--source https://artifacthub.io/packages/headlamp/headlamp-plugins/headlamp_flux \
|
|
||||||
--folderName /headlamp/static-plugins
|
|
||||||
|
|
||||||
npx --yes @headlamp-k8s/plugin@latest install \
|
|
||||||
--source https://artifacthub.io/packages/headlamp/headlamp-trivy/headlamp_trivy \
|
|
||||||
--folderName /headlamp/static-plugins
|
|
||||||
|
|
||||||
npx --yes @headlamp-k8s/plugin@latest install \
|
|
||||||
--source https://artifacthub.io/packages/headlamp/headlamp-plugins/headlamp_cert-manager \
|
|
||||||
--folderName /headlamp/static-plugins
|
|
||||||
|
|
||||||
npx --yes @headlamp-k8s/plugin@latest install \
|
|
||||||
--source https://artifacthub.io/packages/headlamp/headlamp-plugins/headlamp_ai_assistant \
|
|
||||||
--folderName /headlamp/static-plugins
|
|
||||||
|
|
||||||
echo "All plugins installed successfully"
|
|
||||||
ls -la /headlamp/static-plugins
|
|
||||||
securityContext:
|
|
||||||
runAsUser: 100
|
|
||||||
runAsGroup: 101
|
|
||||||
runAsNonRoot: true
|
|
||||||
privileged: false
|
|
||||||
resources:
|
|
||||||
requests:
|
|
||||||
cpu: 100m
|
|
||||||
memory: 256Mi
|
|
||||||
limits:
|
|
||||||
memory: 512Mi
|
|
||||||
volumeMounts:
|
|
||||||
- name: static-plugins
|
|
||||||
mountPath: /headlamp/static-plugins
|
|
||||||
|
|
||||||
# Configure headlamp to use static plugins
|
|
||||||
config:
|
|
||||||
pluginsDir: /headlamp/static-plugins
|
|
||||||
|
|
||||||
# Add volume for static plugins
|
|
||||||
volumes:
|
|
||||||
- name: static-plugins
|
|
||||||
emptyDir: {}
|
|
||||||
|
|
||||||
# Add volume mount to main container
|
|
||||||
volumeMounts:
|
|
||||||
- name: static-plugins
|
|
||||||
mountPath: /headlamp/static-plugins
|
|
||||||
readOnly: true
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
# RBAC to allow authenticated users to proxy to the Polaris dashboard service.
|
|
||||||
# The polaris plugin reads audit data via the Kubernetes service proxy:
|
|
||||||
# /api/v1/namespaces/polaris/services/http:polaris-dashboard:80/proxy/results.json
|
|
||||||
# Without this Role + RoleBinding, users get a 403 when Headlamp proxies the request.
|
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
|
||||||
kind: Role
|
|
||||||
metadata:
|
|
||||||
name: polaris-dashboard-proxy-reader
|
|
||||||
namespace: polaris
|
|
||||||
rules:
|
|
||||||
- apiGroups: [""]
|
|
||||||
resources: ["services/proxy"]
|
|
||||||
resourceNames: ["polaris-dashboard", "http:polaris-dashboard:80"]
|
|
||||||
verbs: ["get"]
|
|
||||||
---
|
|
||||||
apiVersion: rbac.authorization.k8s.io/v1
|
|
||||||
kind: RoleBinding
|
|
||||||
metadata:
|
|
||||||
name: polaris-dashboard-proxy-reader
|
|
||||||
namespace: polaris
|
|
||||||
subjects:
|
|
||||||
- kind: Group
|
|
||||||
name: system:authenticated
|
|
||||||
apiGroup: rbac.authorization.k8s.io
|
|
||||||
roleRef:
|
|
||||||
kind: Role
|
|
||||||
name: polaris-dashboard-proxy-reader
|
|
||||||
apiGroup: rbac.authorization.k8s.io
|
|
||||||
+2
-2
@@ -33,7 +33,7 @@ kubectl -n polaris get svc polaris-dashboard
|
|||||||
kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json | jq .PolarisOutputVersion
|
kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json | jq .PolarisOutputVersion
|
||||||
|
|
||||||
# Verify Headlamp is deployed
|
# Verify Headlamp is deployed
|
||||||
kubectl -n kube-system get pods -l app.kubernetes.io/name=headlamp
|
kubectl -n <your-namespace> get pods -l app.kubernetes.io/name=headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation Methods
|
## Installation Methods
|
||||||
@@ -59,7 +59,7 @@ kubectl -n kube-system get pods -l app.kubernetes.io/name=headlamp
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
+2
-3
@@ -268,10 +268,9 @@ npm run e2e
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create token
|
# Create token
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system --duration=24h)
|
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n <your-namespace> --duration=24h)
|
||||||
|
|
||||||
# Port-forward for local testing
|
kubectl port-forward -n <your-namespace> svc/headlamp 4466:80
|
||||||
kubectl port-forward -n kube-system svc/headlamp 4466:80
|
|
||||||
|
|
||||||
# Run tests
|
# Run tests
|
||||||
HEADLAMP_URL=http://localhost:4466 npm run e2e
|
HEADLAMP_URL=http://localhost:4466 npm run e2e
|
||||||
|
|||||||
+16
-16
@@ -33,7 +33,7 @@ This guide covers common issues encountered when using the Headlamp Polaris Plug
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# View Headlamp pod logs (plugin sidecar)
|
# View Headlamp pod logs (plugin sidecar)
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp-plugin
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# Installing plugin from https://github.com/.../headlamp-polaris-plugin-X.Y.Z.tar.gz
|
# Installing plugin from https://github.com/.../headlamp-polaris-plugin-X.Y.Z.tar.gz
|
||||||
@@ -43,7 +43,7 @@ kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
|||||||
**Verify plugin files exist**:
|
**Verify plugin files exist**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
|
kubectl exec -n <your-namespace> deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
|
||||||
# Should show: headlamp-polaris-plugin/
|
# Should show: headlamp-polaris-plugin/
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Expected subjects:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
For OIDC mode:
|
For OIDC mode:
|
||||||
@@ -154,7 +154,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -169,7 +169,7 @@ Service account mode:
|
|||||||
```bash
|
```bash
|
||||||
# Impersonate Headlamp service account
|
# Impersonate Headlamp service account
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
--resource-name=polaris-dashboard \
|
--resource-name=polaris-dashboard \
|
||||||
-n polaris
|
-n polaris
|
||||||
# Expected: yes
|
# Expected: yes
|
||||||
@@ -189,7 +189,7 @@ kubectl auth can-i get services/proxy \
|
|||||||
After applying RBAC changes:
|
After applying RBAC changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl rollout restart deployment headlamp -n kube-system
|
kubectl rollout restart deployment headlamp -n <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -490,7 +490,7 @@ Run this script to test all RBAC components:
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
NS="polaris"
|
NS="polaris"
|
||||||
SA="headlamp"
|
SA="headlamp"
|
||||||
SA_NS="kube-system"
|
SA_NS="<your-namespace>"
|
||||||
|
|
||||||
echo "=== Testing RBAC for Polaris Plugin ==="
|
echo "=== Testing RBAC for Polaris Plugin ==="
|
||||||
|
|
||||||
@@ -529,8 +529,8 @@ echo "=== Test complete ==="
|
|||||||
Test connectivity from Headlamp to Polaris:
|
Test connectivity from Headlamp to Polaris:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create debug pod in kube-system namespace
|
# Create debug pod in headlamp namespace
|
||||||
kubectl run netdebug -n kube-system --rm -it --image=nicolaka/netshoot -- bash
|
kubectl run netdebug -n <your-namespace> --rm -it --image=nicolaka/netshoot -- bash
|
||||||
|
|
||||||
# Inside pod, test DNS and HTTP
|
# Inside pod, test DNS and HTTP
|
||||||
nslookup polaris-dashboard.polaris.svc.cluster.local
|
nslookup polaris-dashboard.polaris.svc.cluster.local
|
||||||
@@ -545,11 +545,11 @@ If you have audit logging enabled, check for denied requests:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# View recent audit logs (location varies by cluster)
|
# View recent audit logs (location varies by cluster)
|
||||||
kubectl logs -n kube-system kube-apiserver-* | grep polaris-dashboard
|
kubectl logs -n <your-namespace> kube-apiserver-* | grep polaris-dashboard
|
||||||
|
|
||||||
# Look for lines with:
|
# Look for lines with:
|
||||||
# "reason": "Forbidden"
|
# "reason": "Forbidden"
|
||||||
# "user": "system:serviceaccount:kube-system:headlamp"
|
# "user": "system:serviceaccount:<your-namespace>:headlamp"
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -567,7 +567,7 @@ kubectl logs -n kube-system kube-apiserver-* | grep polaris-dashboard
|
|||||||
**Check sidecar logs**:
|
**Check sidecar logs**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
**Common errors**:
|
**Common errors**:
|
||||||
@@ -591,7 +591,7 @@ Error: 404 Not Found
|
|||||||
**Solution**: Verify `archive-url` in plugin config matches GitHub release:
|
**Solution**: Verify `archive-url` in plugin config matches GitHub release:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl get configmap headlamp-plugin-config -n kube-system -o yaml
|
kubectl get configmap headlamp-plugin-config -n <your-namespace> -o yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Expected format:
|
Expected format:
|
||||||
@@ -677,13 +677,13 @@ If none of these solutions work, gather debugging information and open an issue:
|
|||||||
1. **Version Information**:
|
1. **Version Information**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl get pods -n kube-system -l app.kubernetes.io/name=headlamp -o yaml | grep image:
|
kubectl get pods -n <your-namespace> -l app.kubernetes.io/name=headlamp -o yaml | grep image:
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Plugin Version**:
|
2. **Plugin Version**:
|
||||||
|
|
||||||
- Check Settings → Plugins in Headlamp UI
|
- Check Settings → Plugins in Headlamp UI
|
||||||
- Or: `kubectl exec -n kube-system deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris-plugin/package.json`
|
- Or: `kubectl exec -n <your-namespace> deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris-plugin/package.json`
|
||||||
|
|
||||||
3. **Browser Console Output**:
|
3. **Browser Console Output**:
|
||||||
|
|
||||||
@@ -698,7 +698,7 @@ If none of these solutions work, gather debugging information and open an issue:
|
|||||||
5. **Pod Logs**:
|
5. **Pod Logs**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp --tail=100
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp --tail=100
|
||||||
kubectl logs -n polaris deployment/polaris-dashboard --tail=100
|
kubectl logs -n polaris deployment/polaris-dashboard --tail=100
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
+22
-22
@@ -19,7 +19,7 @@ Helm provides the easiest way to deploy and manage the plugin in production. Thi
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Add Headlamp Helm repository
|
# Add Headlamp Helm repository
|
||||||
helm repo add headlamp https://headlamp-k8s.github.io/headlamp/
|
helm repo add headlamp https://kubernetes-sigs.github.io/headlamp/
|
||||||
helm repo update
|
helm repo update
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -41,11 +41,11 @@ pluginsManager:
|
|||||||
```bash
|
```bash
|
||||||
# Install Headlamp
|
# Install Headlamp
|
||||||
helm install headlamp headlamp/headlamp \
|
helm install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
|
|
||||||
# Wait for deployment
|
# Wait for deployment
|
||||||
kubectl -n kube-system wait --for=condition=available deployment/headlamp --timeout=300s
|
kubectl -n <your-namespace> wait --for=condition=available deployment/headlamp --timeout=300s
|
||||||
```
|
```
|
||||||
|
|
||||||
After installation, install the plugin via Headlamp UI (**Settings → Plugins → Catalog**).
|
After installation, install the plugin via Headlamp UI (**Settings → Plugins → Catalog**).
|
||||||
@@ -131,7 +131,7 @@ Deploy:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml \
|
--values headlamp-values.yaml \
|
||||||
--wait \
|
--wait \
|
||||||
--timeout 5m
|
--timeout 5m
|
||||||
@@ -177,7 +177,7 @@ apiVersion: v1
|
|||||||
kind: ConfigMap
|
kind: ConfigMap
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp-plugin-config
|
name: headlamp-plugin-config
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
data:
|
data:
|
||||||
plugin.yml: |
|
plugin.yml: |
|
||||||
- name: headlamp-polaris-plugin
|
- name: headlamp-polaris-plugin
|
||||||
@@ -191,7 +191,7 @@ Apply ConfigMap then deploy Headlamp:
|
|||||||
kubectl apply -f headlamp-plugin-config.yaml
|
kubectl apply -f headlamp-plugin-config.yaml
|
||||||
|
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -210,7 +210,7 @@ metadata:
|
|||||||
namespace: flux-system
|
namespace: flux-system
|
||||||
spec:
|
spec:
|
||||||
interval: 1h
|
interval: 1h
|
||||||
url: https://headlamp-k8s.github.io/headlamp/
|
url: https://kubernetes-sigs.github.io/headlamp/
|
||||||
```
|
```
|
||||||
|
|
||||||
### HelmRelease
|
### HelmRelease
|
||||||
@@ -221,7 +221,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2
|
|||||||
kind: HelmRelease
|
kind: HelmRelease
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
spec:
|
spec:
|
||||||
interval: 30m
|
interval: 30m
|
||||||
chart:
|
chart:
|
||||||
@@ -300,7 +300,7 @@ kubectl apply -f helmrepository.yaml
|
|||||||
kubectl apply -f helmrelease.yaml
|
kubectl apply -f helmrelease.yaml
|
||||||
|
|
||||||
# Watch deployment
|
# Watch deployment
|
||||||
flux get helmreleases -n kube-system --watch
|
flux get helmreleases -n <your-namespace> --watch
|
||||||
```
|
```
|
||||||
|
|
||||||
## RBAC Configuration
|
## RBAC Configuration
|
||||||
@@ -329,7 +329,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -349,7 +349,7 @@ helm repo update
|
|||||||
|
|
||||||
# Upgrade Headlamp (preserves plugin configuration)
|
# Upgrade Headlamp (preserves plugin configuration)
|
||||||
helm upgrade headlamp headlamp/headlamp \
|
helm upgrade headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml \
|
--values headlamp-values.yaml \
|
||||||
--wait
|
--wait
|
||||||
```
|
```
|
||||||
@@ -365,15 +365,15 @@ helm upgrade headlamp headlamp/headlamp \
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Update ConfigMap with new version
|
# Update ConfigMap with new version
|
||||||
kubectl -n kube-system edit configmap headlamp-plugin-config
|
kubectl -n <your-namespace> edit configmap headlamp-plugin-config
|
||||||
|
|
||||||
# Update version and URL:
|
# Update version and URL:
|
||||||
# version: 0.3.6
|
# version: 0.3.6
|
||||||
# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz
|
# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz
|
||||||
|
|
||||||
# Restart deployment to trigger init container
|
# Restart deployment to trigger init container
|
||||||
kubectl -n kube-system rollout restart deployment/headlamp
|
kubectl -n <your-namespace> rollout restart deployment/headlamp
|
||||||
kubectl -n kube-system rollout status deployment/headlamp
|
kubectl -n <your-namespace> rollout status deployment/headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
@@ -382,25 +382,25 @@ kubectl -n kube-system rollout status deployment/headlamp
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check Headlamp values
|
# Check Headlamp values
|
||||||
helm get values headlamp -n kube-system
|
helm get values headlamp -n <your-namespace>
|
||||||
|
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec deployment/headlamp -c headlamp -- \
|
||||||
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# If missing, reinstall plugin via UI or check init container logs
|
# If missing, reinstall plugin via UI or check init container logs
|
||||||
kubectl -n kube-system logs deployment/headlamp -c install-polaris-plugin
|
kubectl -n <your-namespace> logs deployment/headlamp -c install-polaris-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Helm Release Stuck
|
### Helm Release Stuck
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check Helm release status
|
# Check Helm release status
|
||||||
helm list -n kube-system
|
helm list -n <your-namespace>
|
||||||
|
|
||||||
# If stuck, force upgrade
|
# If stuck, force upgrade
|
||||||
helm upgrade headlamp headlamp/headlamp \
|
helm upgrade headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml \
|
--values headlamp-values.yaml \
|
||||||
--force \
|
--force \
|
||||||
--wait
|
--wait
|
||||||
@@ -410,13 +410,13 @@ helm upgrade headlamp headlamp/headlamp \
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check HelmRelease status
|
# Check HelmRelease status
|
||||||
flux get helmreleases -n kube-system
|
flux get helmreleases -n <your-namespace>
|
||||||
|
|
||||||
# Check events
|
# Check events
|
||||||
kubectl -n kube-system describe helmrelease headlamp
|
kubectl -n <your-namespace> describe helmrelease headlamp
|
||||||
|
|
||||||
# Force reconciliation
|
# Force reconciliation
|
||||||
flux reconcile helmrelease headlamp -n kube-system
|
flux reconcile helmrelease headlamp -n <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -71,7 +71,7 @@ kubectl -n polaris get rolebinding headlamp-polaris-proxy
|
|||||||
|
|
||||||
# Test permission
|
# Test permission
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ apiVersion: v1
|
|||||||
kind: ConfigMap
|
kind: ConfigMap
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp-plugin-config
|
name: headlamp-plugin-config
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
labels:
|
labels:
|
||||||
app.kubernetes.io/name: headlamp
|
app.kubernetes.io/name: headlamp
|
||||||
app.kubernetes.io/component: plugin-config
|
app.kubernetes.io/component: plugin-config
|
||||||
@@ -109,7 +109,7 @@ apiVersion: apps/v1
|
|||||||
kind: Deployment
|
kind: Deployment
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
labels:
|
labels:
|
||||||
app.kubernetes.io/name: headlamp
|
app.kubernetes.io/name: headlamp
|
||||||
spec:
|
spec:
|
||||||
@@ -194,7 +194,7 @@ apiVersion: v1
|
|||||||
kind: ServiceAccount
|
kind: ServiceAccount
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
labels:
|
labels:
|
||||||
app.kubernetes.io/name: headlamp
|
app.kubernetes.io/name: headlamp
|
||||||
|
|
||||||
@@ -204,7 +204,7 @@ apiVersion: v1
|
|||||||
kind: Service
|
kind: Service
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
labels:
|
labels:
|
||||||
app.kubernetes.io/name: headlamp
|
app.kubernetes.io/name: headlamp
|
||||||
spec:
|
spec:
|
||||||
@@ -235,27 +235,27 @@ kubectl apply -f headlamp-service.yaml
|
|||||||
kubectl apply -f headlamp-serviceaccount.yaml
|
kubectl apply -f headlamp-serviceaccount.yaml
|
||||||
|
|
||||||
# Wait for deployment to be ready
|
# Wait for deployment to be ready
|
||||||
kubectl -n kube-system wait --for=condition=available deployment/headlamp --timeout=300s
|
kubectl -n <your-namespace> wait --for=condition=available deployment/headlamp --timeout=300s
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Verify Deployment
|
### 2. Verify Deployment
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check pods are running
|
# Check pods are running
|
||||||
kubectl -n kube-system get pods -l app.kubernetes.io/name=headlamp
|
kubectl -n <your-namespace> get pods -l app.kubernetes.io/name=headlamp
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# NAME READY STATUS RESTARTS AGE
|
# NAME READY STATUS RESTARTS AGE
|
||||||
# headlamp-xxxxxxxxxx-xxxxx 1/1 Running 0 2m
|
# headlamp-xxxxxxxxxx-xxxxx 1/1 Running 0 2m
|
||||||
|
|
||||||
# Check init container logs
|
# Check init container logs
|
||||||
kubectl -n kube-system logs deployment/headlamp -c install-plugins
|
kubectl -n <your-namespace> logs deployment/headlamp -c install-plugins
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# Plugin installation complete
|
# Plugin installation complete
|
||||||
|
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec deployment/headlamp -c headlamp -- \
|
||||||
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
@@ -273,7 +273,7 @@ kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Port-forward to access locally
|
# Port-forward to access locally
|
||||||
kubectl -n kube-system port-forward service/headlamp 8080:80
|
kubectl -n <your-namespace> port-forward service/headlamp 8080:80
|
||||||
|
|
||||||
# Open browser to http://localhost:8080
|
# Open browser to http://localhost:8080
|
||||||
```
|
```
|
||||||
@@ -309,7 +309,7 @@ k8s/
|
|||||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||||
kind: Kustomization
|
kind: Kustomization
|
||||||
|
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
|
|
||||||
commonLabels:
|
commonLabels:
|
||||||
app.kubernetes.io/name: headlamp
|
app.kubernetes.io/name: headlamp
|
||||||
@@ -401,7 +401,7 @@ spec:
|
|||||||
- apiVersion: apps/v1
|
- apiVersion: apps/v1
|
||||||
kind: Deployment
|
kind: Deployment
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Upgrading the Plugin
|
## Upgrading the Plugin
|
||||||
@@ -410,24 +410,24 @@ spec:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Edit ConfigMap with new version
|
# Edit ConfigMap with new version
|
||||||
kubectl -n kube-system edit configmap headlamp-plugin-config
|
kubectl -n <your-namespace> edit configmap headlamp-plugin-config
|
||||||
|
|
||||||
# Update version and URL:
|
# Update version and URL:
|
||||||
# version: 0.3.6
|
# version: 0.3.6
|
||||||
# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz
|
# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz
|
||||||
|
|
||||||
# Restart deployment to trigger init container
|
# Restart deployment to trigger init container
|
||||||
kubectl -n kube-system rollout restart deployment/headlamp
|
kubectl -n <your-namespace> rollout restart deployment/headlamp
|
||||||
|
|
||||||
# Wait for rollout to complete
|
# Wait for rollout to complete
|
||||||
kubectl -n kube-system rollout status deployment/headlamp
|
kubectl -n <your-namespace> rollout status deployment/headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
### Verify Upgrade
|
### Verify Upgrade
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check init container logs
|
# Check init container logs
|
||||||
kubectl -n kube-system logs deployment/headlamp -c install-plugins
|
kubectl -n <your-namespace> logs deployment/headlamp -c install-plugins
|
||||||
|
|
||||||
# Verify new version in UI
|
# Verify new version in UI
|
||||||
# Navigate to Settings → Plugins in Headlamp
|
# Navigate to Settings → Plugins in Headlamp
|
||||||
@@ -439,7 +439,7 @@ kubectl -n kube-system logs deployment/headlamp -c install-plugins
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check init container logs
|
# Check init container logs
|
||||||
kubectl -n kube-system logs deployment/headlamp -c install-plugins
|
kubectl -n <your-namespace> logs deployment/headlamp -c install-plugins
|
||||||
|
|
||||||
# Common issues:
|
# Common issues:
|
||||||
# 1. Network connectivity to GitHub
|
# 1. Network connectivity to GitHub
|
||||||
@@ -451,14 +451,14 @@ kubectl -n kube-system logs deployment/headlamp -c install-plugins
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify HEADLAMP_CONFIG_WATCH_PLUGINS is false
|
# Verify HEADLAMP_CONFIG_WATCH_PLUGINS is false
|
||||||
kubectl -n kube-system get deployment headlamp -o yaml | grep WATCH_PLUGINS
|
kubectl -n <your-namespace> get deployment headlamp -o yaml | grep WATCH_PLUGINS
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# - name: HEADLAMP_CONFIG_WATCH_PLUGINS
|
# - name: HEADLAMP_CONFIG_WATCH_PLUGINS
|
||||||
# value: "false"
|
# value: "false"
|
||||||
|
|
||||||
# If not set or "true", update deployment
|
# If not set or "true", update deployment
|
||||||
kubectl -n kube-system edit deployment headlamp
|
kubectl -n <your-namespace> edit deployment headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
### RBAC Permissions Denied
|
### RBAC Permissions Denied
|
||||||
@@ -466,7 +466,7 @@ kubectl -n kube-system edit deployment headlamp
|
|||||||
```bash
|
```bash
|
||||||
# Test RBAC
|
# Test RBAC
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
|
|||||||
@@ -37,8 +37,8 @@ kubectl -n polaris get svc polaris-dashboard
|
|||||||
kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json | jq .PolarisOutputVersion
|
kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json | jq .PolarisOutputVersion
|
||||||
|
|
||||||
# Verify Headlamp
|
# Verify Headlamp
|
||||||
kubectl -n kube-system get deployment headlamp
|
kubectl -n <your-namespace> get deployment headlamp
|
||||||
kubectl -n kube-system get svc headlamp
|
kubectl -n <your-namespace> get svc headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
## Production Checklist
|
## Production Checklist
|
||||||
@@ -60,17 +60,17 @@ kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy
|
|||||||
|
|
||||||
# 2. Verify RBAC permissions
|
# 2. Verify RBAC permissions
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
# Expected: yes
|
# Expected: yes
|
||||||
|
|
||||||
# 3. Check Headlamp logs for plugin loading
|
# 3. Check Headlamp logs for plugin loading
|
||||||
kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
kubectl -n <your-namespace> logs deployment/headlamp | grep -i polaris
|
||||||
# Expected: No errors related to plugin loading
|
# Expected: No errors related to plugin loading
|
||||||
|
|
||||||
# 4. Verify plugin files exist
|
# 4. Verify plugin files exist
|
||||||
kubectl -n kube-system exec deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
kubectl -n <your-namespace> exec deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
# Expected: dist/, package.json present
|
# Expected: dist/, package.json present
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -241,7 +241,7 @@ apiVersion: policy/v1
|
|||||||
kind: PodDisruptionBudget
|
kind: PodDisruptionBudget
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp-pdb
|
name: headlamp-pdb
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
spec:
|
spec:
|
||||||
minAvailable: 1
|
minAvailable: 1
|
||||||
selector:
|
selector:
|
||||||
@@ -295,7 +295,7 @@ apiVersion: monitoring.coreos.com/v1
|
|||||||
kind: ServiceMonitor
|
kind: ServiceMonitor
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
spec:
|
spec:
|
||||||
selector:
|
selector:
|
||||||
matchLabels:
|
matchLabels:
|
||||||
@@ -312,10 +312,10 @@ spec:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# View logs
|
# View logs
|
||||||
kubectl -n kube-system logs deployment/headlamp -f
|
kubectl -n <your-namespace> logs deployment/headlamp -f
|
||||||
|
|
||||||
# Filter for plugin-related logs
|
# Filter for plugin-related logs
|
||||||
kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
kubectl -n <your-namespace> logs deployment/headlamp | grep -i polaris
|
||||||
```
|
```
|
||||||
|
|
||||||
**Polaris Dashboard Logs:**
|
**Polaris Dashboard Logs:**
|
||||||
@@ -341,14 +341,14 @@ apiVersion: monitoring.coreos.com/v1
|
|||||||
kind: PrometheusRule
|
kind: PrometheusRule
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp-alerts
|
name: headlamp-alerts
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
spec:
|
spec:
|
||||||
groups:
|
groups:
|
||||||
- name: headlamp
|
- name: headlamp
|
||||||
interval: 30s
|
interval: 30s
|
||||||
rules:
|
rules:
|
||||||
- alert: HeadlampPodNotReady
|
- alert: HeadlampPodNotReady
|
||||||
expr: kube_pod_status_ready{namespace="kube-system", pod=~"headlamp-.*"} == 0
|
expr: kube_pod_status_ready{namespace="<your-namespace>", pod=~"headlamp-.*"} == 0
|
||||||
for: 5m
|
for: 5m
|
||||||
labels:
|
labels:
|
||||||
severity: warning
|
severity: warning
|
||||||
@@ -422,9 +422,9 @@ If Headlamp or plugin becomes unavailable:
|
|||||||
2. **Redeploy Headlamp:**
|
2. **Redeploy Headlamp:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Reapply RBAC:**
|
3. **Reapply RBAC:**
|
||||||
@@ -436,7 +436,7 @@ If Headlamp or plugin becomes unavailable:
|
|||||||
4. **Verify plugin files:**
|
4. **Verify plugin files:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl -n kube-system exec deployment/headlamp -- \
|
kubectl -n <your-namespace> exec deployment/headlamp -- \
|
||||||
ls /headlamp/plugins/headlamp-polaris-plugin/
|
ls /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -268,10 +268,9 @@ npm run e2e
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create token
|
# Create token
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system --duration=24h)
|
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n <your-namespace> --duration=24h)
|
||||||
|
|
||||||
# Port-forward for local testing
|
kubectl port-forward -n <your-namespace> svc/headlamp 4466:80
|
||||||
kubectl port-forward -n kube-system svc/headlamp 4466:80
|
|
||||||
|
|
||||||
# Run tests
|
# Run tests
|
||||||
HEADLAMP_URL=http://localhost:4466 npm run e2e
|
HEADLAMP_URL=http://localhost:4466 npm run e2e
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ Deploy or update Headlamp:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ apiVersion: v1
|
|||||||
kind: ConfigMap
|
kind: ConfigMap
|
||||||
metadata:
|
metadata:
|
||||||
name: headlamp-plugin-config
|
name: headlamp-plugin-config
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
data:
|
data:
|
||||||
plugin.yml: |
|
plugin.yml: |
|
||||||
- name: headlamp-polaris-plugin
|
- name: headlamp-polaris-plugin
|
||||||
@@ -138,14 +138,14 @@ kubectl apply -f headlamp-plugin-config.yaml
|
|||||||
|
|
||||||
# Deploy/update Headlamp with sidecar
|
# Deploy/update Headlamp with sidecar
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
|
|
||||||
# Wait for pod to be ready
|
# Wait for pod to be ready
|
||||||
kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
kubectl -n <your-namespace> wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
||||||
|
|
||||||
# Verify plugin files
|
# Verify plugin files
|
||||||
kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
kubectl -n <your-namespace> exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# drwxr-xr-x dist/
|
# drwxr-xr-x dist/
|
||||||
@@ -270,7 +270,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -284,10 +284,10 @@ See [RBAC Permissions](../user-guide/rbac-permissions.md) for detailed RBAC conf
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# If you updated Helm values or ConfigMaps
|
# If you updated Helm values or ConfigMaps
|
||||||
kubectl -n kube-system rollout restart deployment/headlamp
|
kubectl -n <your-namespace> rollout restart deployment/headlamp
|
||||||
|
|
||||||
# Wait for pod to be ready
|
# Wait for pod to be ready
|
||||||
kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
kubectl -n <your-namespace> wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Clear Browser Cache
|
### 3. Clear Browser Cache
|
||||||
@@ -312,14 +312,14 @@ kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
kubectl -n <your-namespace> exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# drwxr-xr-x dist/
|
# drwxr-xr-x dist/
|
||||||
# -rw-r--r-- package.json
|
# -rw-r--r-- package.json
|
||||||
|
|
||||||
# Check Headlamp logs for errors
|
# Check Headlamp logs for errors
|
||||||
kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
kubectl -n <your-namespace> logs deployment/headlamp | grep -i polaris
|
||||||
|
|
||||||
# Expected: No errors related to plugin loading
|
# Expected: No errors related to plugin loading
|
||||||
|
|
||||||
@@ -345,13 +345,13 @@ kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Verify plugin files exist
|
# 1. Verify plugin files exist
|
||||||
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec deployment/headlamp -c headlamp -- \
|
||||||
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# Expected: dist/, package.json present
|
# Expected: dist/, package.json present
|
||||||
|
|
||||||
# 2. Check Headlamp logs for plugin errors
|
# 2. Check Headlamp logs for plugin errors
|
||||||
kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
kubectl -n <your-namespace> logs deployment/headlamp | grep -i polaris
|
||||||
|
|
||||||
# 3. Hard refresh browser (Cmd+Shift+R or Ctrl+Shift+R)
|
# 3. Hard refresh browser (Cmd+Shift+R or Ctrl+Shift+R)
|
||||||
|
|
||||||
@@ -404,7 +404,7 @@ helm install polaris fairwinds-stable/polaris \
|
|||||||
```bash
|
```bash
|
||||||
# Wait 30 minutes for ArtifactHub sync
|
# Wait 30 minutes for ArtifactHub sync
|
||||||
# Or manually force Headlamp restart:
|
# Or manually force Headlamp restart:
|
||||||
kubectl -n kube-system rollout restart deployment/headlamp
|
kubectl -n <your-namespace> rollout restart deployment/headlamp
|
||||||
```
|
```
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|||||||
@@ -67,14 +67,14 @@ kubectl -n polaris wait --for=condition=ready pod -l app.kubernetes.io/name=pola
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check Headlamp is deployed
|
# Check Headlamp is deployed
|
||||||
kubectl -n kube-system get pods -l app.kubernetes.io/name=headlamp
|
kubectl -n <your-namespace> get pods -l app.kubernetes.io/name=headlamp
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# NAME READY STATUS RESTARTS AGE
|
# NAME READY STATUS RESTARTS AGE
|
||||||
# headlamp-xxxxxxxxxx-xxxxx 1/1 Running 0 1h
|
# headlamp-xxxxxxxxxx-xxxxx 1/1 Running 0 1h
|
||||||
|
|
||||||
# Check Headlamp version (must be v0.26+)
|
# Check Headlamp version (must be v0.26+)
|
||||||
kubectl -n kube-system get deployment headlamp -o jsonpath='{.spec.template.spec.containers[0].image}'
|
kubectl -n <your-namespace> get deployment headlamp -o jsonpath='{.spec.template.spec.containers[0].image}'
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# ghcr.io/headlamp-k8s/headlamp:v0.39.0 (or similar)
|
# ghcr.io/headlamp-k8s/headlamp:v0.39.0 (or similar)
|
||||||
@@ -84,17 +84,17 @@ kubectl -n kube-system get deployment headlamp -o jsonpath='{.spec.template.spec
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Add Headlamp Helm repository
|
# Add Headlamp Helm repository
|
||||||
helm repo add headlamp https://headlamp-k8s.github.io/headlamp/
|
helm repo add headlamp https://kubernetes-sigs.github.io/headlamp/
|
||||||
helm repo update
|
helm repo update
|
||||||
|
|
||||||
# Install Headlamp
|
# Install Headlamp
|
||||||
helm install headlamp headlamp/headlamp \
|
helm install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--set config.pluginsDir="/headlamp/plugins" \
|
--set config.pluginsDir="/headlamp/plugins" \
|
||||||
--set pluginsManager.enabled=true
|
--set pluginsManager.enabled=true
|
||||||
|
|
||||||
# Wait for pod to be ready
|
# Wait for pod to be ready
|
||||||
kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
kubectl -n <your-namespace> wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s
|
||||||
```
|
```
|
||||||
|
|
||||||
## RBAC Requirements
|
## RBAC Requirements
|
||||||
@@ -112,7 +112,7 @@ The plugin requires permissions to access the Polaris dashboard via Kubernetes s
|
|||||||
```bash
|
```bash
|
||||||
# Test if Headlamp service account has permission
|
# Test if Headlamp service account has permission
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ EOF
|
|||||||
|
|
||||||
# Update Headlamp
|
# Update Headlamp
|
||||||
helm upgrade --install headlamp headlamp/headlamp \
|
helm upgrade --install headlamp headlamp/headlamp \
|
||||||
--namespace kube-system \
|
--namespace <your-namespace> \
|
||||||
--values headlamp-values.yaml
|
--values headlamp-values.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -111,7 +111,7 @@ EOF
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec -it deployment/headlamp -c headlamp -- \
|
||||||
ls /headlamp/plugins/headlamp-polaris-plugin/dist/
|
ls /headlamp/plugins/headlamp-polaris-plugin/dist/
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
@@ -119,7 +119,7 @@ kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- \
|
|||||||
|
|
||||||
# Verify RBAC is correct
|
# Verify RBAC is correct
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
@@ -185,7 +185,7 @@ Cluster score badge in top navigation:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec -it deployment/headlamp -c headlamp -- \
|
||||||
ls /headlamp/plugins/headlamp-polaris-plugin/
|
ls /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# If missing, reinstall via Headlamp UI or sidecar method
|
# If missing, reinstall via Headlamp UI or sidecar method
|
||||||
|
|||||||
@@ -38,17 +38,17 @@ kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy
|
|||||||
|
|
||||||
# 3. Verify RBAC permissions
|
# 3. Verify RBAC permissions
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
# Expected output: yes
|
# Expected output: yes
|
||||||
|
|
||||||
# 4. Check Headlamp pod is running
|
# 4. Check Headlamp pod is running
|
||||||
kubectl -n kube-system get pods -l app.kubernetes.io/name=headlamp
|
kubectl -n <your-namespace> get pods -l app.kubernetes.io/name=headlamp
|
||||||
|
|
||||||
# 5. Check Headlamp logs for plugin errors
|
# 5. Check Headlamp logs for plugin errors
|
||||||
kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
kubectl -n <your-namespace> logs deployment/headlamp | grep -i polaris
|
||||||
|
|
||||||
# Expected: No errors
|
# Expected: No errors
|
||||||
```
|
```
|
||||||
@@ -57,7 +57,7 @@ kubectl -n kube-system logs deployment/headlamp | grep -i polaris
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify plugin files exist
|
# Verify plugin files exist
|
||||||
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
|
kubectl -n <your-namespace> exec deployment/headlamp -c headlamp -- \
|
||||||
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
ls -la /headlamp/plugins/headlamp-polaris-plugin/
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
@@ -76,7 +76,7 @@ kubectl -n polaris get rolebinding headlamp-polaris-proxy
|
|||||||
|
|
||||||
# Test permission (service account mode)
|
# Test permission (service account mode)
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ This guide covers common issues encountered when using the Headlamp Polaris Plug
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# View Headlamp pod logs (plugin sidecar)
|
# View Headlamp pod logs (plugin sidecar)
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp-plugin
|
||||||
|
|
||||||
# Expected output:
|
# Expected output:
|
||||||
# Installing plugin from https://github.com/.../headlamp-polaris-plugin-X.Y.Z.tar.gz
|
# Installing plugin from https://github.com/.../headlamp-polaris-plugin-X.Y.Z.tar.gz
|
||||||
@@ -43,7 +43,7 @@ kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
|||||||
**Verify plugin files exist**:
|
**Verify plugin files exist**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
|
kubectl exec -n <your-namespace> deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
|
||||||
# Should show: headlamp-polaris-plugin/
|
# Should show: headlamp-polaris-plugin/
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Expected subjects:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
For OIDC mode:
|
For OIDC mode:
|
||||||
@@ -154,7 +154,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -169,7 +169,7 @@ Service account mode:
|
|||||||
```bash
|
```bash
|
||||||
# Impersonate Headlamp service account
|
# Impersonate Headlamp service account
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
--resource-name=polaris-dashboard \
|
--resource-name=polaris-dashboard \
|
||||||
-n polaris
|
-n polaris
|
||||||
# Expected: yes
|
# Expected: yes
|
||||||
@@ -189,7 +189,7 @@ kubectl auth can-i get services/proxy \
|
|||||||
After applying RBAC changes:
|
After applying RBAC changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl rollout restart deployment headlamp -n kube-system
|
kubectl rollout restart deployment headlamp -n <your-namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -490,7 +490,7 @@ Run this script to test all RBAC components:
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
NS="polaris"
|
NS="polaris"
|
||||||
SA="headlamp"
|
SA="headlamp"
|
||||||
SA_NS="kube-system"
|
SA_NS="<your-namespace>"
|
||||||
|
|
||||||
echo "=== Testing RBAC for Polaris Plugin ==="
|
echo "=== Testing RBAC for Polaris Plugin ==="
|
||||||
|
|
||||||
@@ -529,8 +529,8 @@ echo "=== Test complete ==="
|
|||||||
Test connectivity from Headlamp to Polaris:
|
Test connectivity from Headlamp to Polaris:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Create debug pod in kube-system namespace
|
# Create debug pod in the namespace where Headlamp is installed
|
||||||
kubectl run netdebug -n kube-system --rm -it --image=nicolaka/netshoot -- bash
|
kubectl run netdebug -n <your-namespace> --rm -it --image=nicolaka/netshoot -- bash
|
||||||
|
|
||||||
# Inside pod, test DNS and HTTP
|
# Inside pod, test DNS and HTTP
|
||||||
nslookup polaris-dashboard.polaris.svc.cluster.local
|
nslookup polaris-dashboard.polaris.svc.cluster.local
|
||||||
@@ -545,11 +545,11 @@ If you have audit logging enabled, check for denied requests:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# View recent audit logs (location varies by cluster)
|
# View recent audit logs (location varies by cluster)
|
||||||
kubectl logs -n kube-system kube-apiserver-* | grep polaris-dashboard
|
kubectl logs -n <your-namespace> kube-apiserver-* | grep polaris-dashboard
|
||||||
|
|
||||||
# Look for lines with:
|
# Look for lines with:
|
||||||
# "reason": "Forbidden"
|
# "reason": "Forbidden"
|
||||||
# "user": "system:serviceaccount:kube-system:headlamp"
|
# "user": "system:serviceaccount:<your-namespace>:headlamp"
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -567,7 +567,7 @@ kubectl logs -n kube-system kube-apiserver-* | grep polaris-dashboard
|
|||||||
**Check sidecar logs**:
|
**Check sidecar logs**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp-plugin
|
||||||
```
|
```
|
||||||
|
|
||||||
**Common errors**:
|
**Common errors**:
|
||||||
@@ -591,7 +591,7 @@ Error: 404 Not Found
|
|||||||
**Solution**: Verify `archive-url` in plugin config matches GitHub release:
|
**Solution**: Verify `archive-url` in plugin config matches GitHub release:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl get configmap headlamp-plugin-config -n kube-system -o yaml
|
kubectl get configmap headlamp-plugin-config -n <your-namespace> -o yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Expected format:
|
Expected format:
|
||||||
@@ -677,13 +677,13 @@ If none of these solutions work, gather debugging information and open an issue:
|
|||||||
1. **Version Information**:
|
1. **Version Information**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl get pods -n kube-system -l app.kubernetes.io/name=headlamp -o yaml | grep image:
|
kubectl get pods -n <your-namespace> -l app.kubernetes.io/name=headlamp -o yaml | grep image:
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Plugin Version**:
|
2. **Plugin Version**:
|
||||||
|
|
||||||
- Check Settings → Plugins in Headlamp UI
|
- Check Settings → Plugins in Headlamp UI
|
||||||
- Or: `kubectl exec -n kube-system deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris-plugin/package.json`
|
- Or: `kubectl exec -n <your-namespace> deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris-plugin/package.json`
|
||||||
|
|
||||||
3. **Browser Console Output**:
|
3. **Browser Console Output**:
|
||||||
|
|
||||||
@@ -698,7 +698,7 @@ If none of these solutions work, gather debugging information and open an issue:
|
|||||||
5. **Pod Logs**:
|
5. **Pod Logs**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl logs -n kube-system deployment/headlamp -c headlamp --tail=100
|
kubectl logs -n <your-namespace> deployment/headlamp -c headlamp --tail=100
|
||||||
kubectl logs -n polaris deployment/polaris-dashboard --tail=100
|
kubectl logs -n polaris deployment/polaris-dashboard --tail=100
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -83,7 +83,7 @@ roleRef:
|
|||||||
```bash
|
```bash
|
||||||
# Test service account (in-cluster mode)
|
# Test service account (in-cluster mode)
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
|
|||||||
@@ -317,7 +317,7 @@ kubectl -n polaris get rolebinding headlamp-polaris-proxy
|
|||||||
|
|
||||||
# Test permission
|
# Test permission
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -65,7 +65,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp # Adjust to your Headlamp SA name
|
name: headlamp # Adjust to your Headlamp SA name
|
||||||
namespace: kube-system # Adjust to Headlamp's namespace
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -75,7 +75,7 @@ roleRef:
|
|||||||
**Adjust for your environment:**
|
**Adjust for your environment:**
|
||||||
|
|
||||||
- `subjects[0].name` - Your Headlamp service account name (often `headlamp`)
|
- `subjects[0].name` - Your Headlamp service account name (often `headlamp`)
|
||||||
- `subjects[0].namespace` - Namespace where Headlamp runs (often `kube-system`)
|
- `subjects[0].namespace` - Namespace where Headlamp is installed
|
||||||
|
|
||||||
### Step 3: Apply and Verify
|
### Step 3: Apply and Verify
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ kubectl -n polaris get rolebinding headlamp-polaris-proxy
|
|||||||
|
|
||||||
# Test permission
|
# Test permission
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
@@ -109,7 +109,7 @@ In token-auth mode, **each user's own identity** is used for Kubernetes API requ
|
|||||||
With service account mode:
|
With service account mode:
|
||||||
|
|
||||||
- Single RoleBinding grants access to all Headlamp users
|
- Single RoleBinding grants access to all Headlamp users
|
||||||
- Kubernetes sees all requests as `system:serviceaccount:kube-system:headlamp`
|
- Kubernetes sees all requests as `system:serviceaccount:<your-namespace>:headlamp`
|
||||||
|
|
||||||
With token-auth mode:
|
With token-auth mode:
|
||||||
|
|
||||||
@@ -267,7 +267,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -281,7 +281,7 @@ metadata:
|
|||||||
subjects:
|
subjects:
|
||||||
- kind: ServiceAccount
|
- kind: ServiceAccount
|
||||||
name: headlamp
|
name: headlamp
|
||||||
namespace: kube-system
|
namespace: <your-namespace>
|
||||||
roleRef:
|
roleRef:
|
||||||
kind: Role
|
kind: Role
|
||||||
name: polaris-proxy-reader
|
name: polaris-proxy-reader
|
||||||
@@ -411,7 +411,7 @@ Every plugin data fetch creates a Kubernetes API audit log entry.
|
|||||||
"level": "Metadata",
|
"level": "Metadata",
|
||||||
"verb": "get",
|
"verb": "get",
|
||||||
"user": {
|
"user": {
|
||||||
"username": "system:serviceaccount:kube-system:headlamp"
|
"username": "system:serviceaccount:<your-namespace>:headlamp"
|
||||||
},
|
},
|
||||||
"sourceIPs": ["10.96.0.1"],
|
"sourceIPs": ["10.96.0.1"],
|
||||||
"objectRef": {
|
"objectRef": {
|
||||||
@@ -494,7 +494,7 @@ If using a log aggregator (e.g., Elasticsearch), create filters to exclude or do
|
|||||||
```bash
|
```bash
|
||||||
# Service account mode
|
# Service account mode
|
||||||
kubectl auth can-i get services/proxy \
|
kubectl auth can-i get services/proxy \
|
||||||
--as=system:serviceaccount:kube-system:headlamp \
|
--as=system:serviceaccount:<your-namespace>:headlamp \
|
||||||
-n polaris \
|
-n polaris \
|
||||||
--resource-name=polaris-dashboard
|
--resource-name=polaris-dashboard
|
||||||
|
|
||||||
|
|||||||
-294
@@ -1,294 +0,0 @@
|
|||||||
# E2E Smoke Tests
|
|
||||||
|
|
||||||
Playwright-based smoke tests that validate the Polaris plugin against a live Headlamp deployment.
|
|
||||||
|
|
||||||
## CI
|
|
||||||
|
|
||||||
E2E tests run automatically in GitHub Actions on pushes to `main` and pull requests. The workflow (`.github/workflows/e2e.yaml`) uses either Authentik OIDC or token-based authentication via repository secrets.
|
|
||||||
|
|
||||||
### Required GitHub Secrets
|
|
||||||
|
|
||||||
Configure these in GitHub repository settings (Settings → Secrets and variables → Actions):
|
|
||||||
|
|
||||||
| Secret | Required | Description |
|
|
||||||
| -------------------- | -------- | -------------------------------------------------------------- |
|
|
||||||
| `HEADLAMP_URL` | Optional | Headlamp instance URL (defaults to `https://headlamp.animaniacs.farh.net`) |
|
|
||||||
| `AUTHENTIK_USERNAME` | OIDC | Authentik email or username for a CI user with Headlamp access |
|
|
||||||
| `AUTHENTIK_PASSWORD` | OIDC | Password for that user |
|
|
||||||
| `HEADLAMP_TOKEN` | Token | Kubernetes service account token (alternative to OIDC) |
|
|
||||||
|
|
||||||
Set either `AUTHENTIK_USERNAME` + `AUTHENTIK_PASSWORD` **or** `HEADLAMP_TOKEN`. OIDC takes priority if both are set.
|
|
||||||
|
|
||||||
## Running Locally
|
|
||||||
|
|
||||||
### Option 1: OIDC via Authentik (same as CI)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
AUTHENTIK_USERNAME=you@example.com AUTHENTIK_PASSWORD=... npm run e2e
|
|
||||||
```
|
|
||||||
|
|
||||||
The default base URL is `https://headlamp.animaniacs.farh.net`. Override with `HEADLAMP_URL` if needed.
|
|
||||||
|
|
||||||
### Option 2: K8s bearer token (port-forward)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl port-forward -n kube-system svc/headlamp 4466:80
|
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system)
|
|
||||||
HEADLAMP_URL=http://localhost:4466 npm run e2e
|
|
||||||
```
|
|
||||||
|
|
||||||
Or in headed mode (opens a browser window):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
HEADLAMP_URL=http://localhost:4466 npm run e2e:headed
|
|
||||||
```
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
| Variable | Required | Default | Description |
|
|
||||||
| -------------------- | -------- | -------------------------------------- | --------------------------------------- |
|
|
||||||
| `HEADLAMP_URL` | No | `https://headlamp.animaniacs.farh.net` | Base URL of the Headlamp instance |
|
|
||||||
| `AUTHENTIK_USERNAME` | OIDC | — | Authentik email/username |
|
|
||||||
| `AUTHENTIK_PASSWORD` | OIDC | — | Authentik password |
|
|
||||||
| `HEADLAMP_TOKEN` | Token | — | Kubernetes bearer token (fallback auth) |
|
|
||||||
|
|
||||||
Set either `AUTHENTIK_USERNAME` + `AUTHENTIK_PASSWORD` or `HEADLAMP_TOKEN`. OIDC takes priority if both are set.
|
|
||||||
|
|
||||||
## What the Tests Validate
|
|
||||||
|
|
||||||
- **Sidebar entry** — The Polaris sidebar item appears after login
|
|
||||||
- **Overview page** — Cluster score and check distribution render correctly
|
|
||||||
- **Namespaces page** — Table of namespaces loads with clickable links
|
|
||||||
- **Namespace detail** — Clicking a namespace shows its score and resource table
|
|
||||||
|
|
||||||
These are smoke tests against real cluster data. They verify the plugin loads and renders without errors, not specific data values.
|
|
||||||
|
|
||||||
## Test Coverage
|
|
||||||
|
|
||||||
### Current Tests (`polaris.spec.ts`)
|
|
||||||
|
|
||||||
1. **`sidebar contains Polaris entry`**
|
|
||||||
- Verifies Polaris appears in the navigation sidebar
|
|
||||||
- Ensures plugin successfully registered sidebar entry
|
|
||||||
|
|
||||||
2. **`overview page renders cluster score`**
|
|
||||||
- Navigates to `/c/main/polaris`
|
|
||||||
- Checks for "Polaris — Overview" heading
|
|
||||||
- Verifies cluster score percentage is displayed
|
|
||||||
- Validates data fetching and rendering
|
|
||||||
|
|
||||||
3. **`namespaces page renders table with namespace buttons`**
|
|
||||||
- Navigates to `/c/main/polaris/namespaces`
|
|
||||||
- Checks for "Polaris — Namespaces" heading
|
|
||||||
- Verifies table is visible with at least one row
|
|
||||||
- Ensures namespace buttons are clickable
|
|
||||||
|
|
||||||
4. **`namespace detail drawer opens from table button`**
|
|
||||||
- Clicks first namespace button in table
|
|
||||||
- Verifies drawer opens with namespace name in heading
|
|
||||||
- Checks "Namespace Score" section is visible
|
|
||||||
- Confirms "Resources" table is displayed
|
|
||||||
- Validates URL hash is updated with namespace name
|
|
||||||
|
|
||||||
5. **`namespace detail drawer closes with Escape key`**
|
|
||||||
- Opens namespace drawer
|
|
||||||
- Presses Escape key
|
|
||||||
- Verifies drawer closes
|
|
||||||
- Checks URL hash is cleared
|
|
||||||
|
|
||||||
6. **`namespace detail drawer opens from URL hash`**
|
|
||||||
- Navigates directly to `/c/main/polaris/namespaces#<namespace>`
|
|
||||||
- Verifies drawer automatically opens
|
|
||||||
- Checks namespace details are displayed
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
### Cluster Requirements
|
|
||||||
|
|
||||||
1. **Polaris Deployment**
|
|
||||||
```bash
|
|
||||||
# Verify Polaris is running
|
|
||||||
kubectl -n polaris get pods
|
|
||||||
kubectl -n polaris get svc polaris-dashboard
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Polaris Audit Data**
|
|
||||||
```bash
|
|
||||||
# Check if Polaris has generated audit results
|
|
||||||
kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json | jq '.AuditTime'
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **RBAC Permissions**
|
|
||||||
- Headlamp service account (or test user) needs `get` on `services/proxy` for `polaris-dashboard`
|
|
||||||
- See main README for RBAC setup
|
|
||||||
|
|
||||||
### Local Setup
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 1. Install dependencies
|
|
||||||
npm install
|
|
||||||
npx playwright install chromium
|
|
||||||
|
|
||||||
# 2. Create .env file (optional, for persistent config)
|
|
||||||
cp .env.example .env
|
|
||||||
|
|
||||||
# 3. Set environment variables
|
|
||||||
export HEADLAMP_URL=https://your-headlamp-instance.com
|
|
||||||
export HEADLAMP_TOKEN=$(kubectl create token headlamp -n kube-system)
|
|
||||||
|
|
||||||
# 4. Run tests
|
|
||||||
npm run e2e
|
|
||||||
```
|
|
||||||
|
|
||||||
## Debugging
|
|
||||||
|
|
||||||
### Run in Headed Mode
|
|
||||||
|
|
||||||
See the browser UI while tests run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run e2e:headed
|
|
||||||
```
|
|
||||||
|
|
||||||
### Enable Debug Mode
|
|
||||||
|
|
||||||
Step through tests with Playwright Inspector:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx playwright test --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
### Generate Trace
|
|
||||||
|
|
||||||
Record full trace for failed tests:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx playwright test --trace on
|
|
||||||
npx playwright show-trace test-results/<test-name>/trace.zip
|
|
||||||
```
|
|
||||||
|
|
||||||
### Screenshot on Failure
|
|
||||||
|
|
||||||
Tests automatically capture screenshots on failure in `test-results/`
|
|
||||||
|
|
||||||
### Common Issues
|
|
||||||
|
|
||||||
**Auth fails with "Sign In button not found":**
|
|
||||||
- Check HEADLAMP_URL is correct
|
|
||||||
- Verify Headlamp is accessible
|
|
||||||
- Ensure OIDC is configured if using Authentik
|
|
||||||
|
|
||||||
**Polaris sidebar entry not found:**
|
|
||||||
- Plugin may not be installed: Check Settings → Plugins in Headlamp
|
|
||||||
- Plugin may have failed to load: Check browser console
|
|
||||||
- Clear browser cache and hard refresh
|
|
||||||
|
|
||||||
**Cluster score not displayed:**
|
|
||||||
- Polaris may not have audit data yet
|
|
||||||
- Check Polaris is running: `kubectl -n polaris get pods`
|
|
||||||
- Verify service proxy: `kubectl get --raw /api/v1/namespaces/polaris/services/polaris-dashboard:80/proxy/results.json`
|
|
||||||
|
|
||||||
**Namespace table empty:**
|
|
||||||
- Polaris hasn't run audit yet (wait a few minutes)
|
|
||||||
- Check Polaris logs: `kubectl -n polaris logs -l app.kubernetes.io/name=polaris`
|
|
||||||
|
|
||||||
## Writing New Tests
|
|
||||||
|
|
||||||
### Example: Testing Plugin Settings
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
test('plugin settings page shows Polaris configuration', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/settings/plugins');
|
|
||||||
|
|
||||||
// Find and click Polaris plugin
|
|
||||||
await page.getByText('headlamp-polaris-plugin').click();
|
|
||||||
|
|
||||||
// Check settings are visible
|
|
||||||
await expect(page.getByText('Polaris Settings')).toBeVisible();
|
|
||||||
await expect(page.getByText('Refresh Interval')).toBeVisible();
|
|
||||||
await expect(page.getByText('Dashboard URL')).toBeVisible();
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example: Testing App Bar Badge
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
test('app bar displays Polaris score badge', async ({ page }) => {
|
|
||||||
await page.goto('/c/main');
|
|
||||||
|
|
||||||
// Badge should be visible in app bar
|
|
||||||
const badge = page.getByRole('button', { name: /Polaris: \d+%/ });
|
|
||||||
await expect(badge).toBeVisible();
|
|
||||||
|
|
||||||
// Clicking should navigate to overview
|
|
||||||
await badge.click();
|
|
||||||
await expect(page).toHaveURL(/\/c\/main\/polaris$/);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example: Testing Dark Mode
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
test('plugin UI adapts to dark mode', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/polaris');
|
|
||||||
|
|
||||||
// Toggle dark mode
|
|
||||||
await page.getByRole('button', { name: /theme/i }).click();
|
|
||||||
|
|
||||||
// Check background color changes
|
|
||||||
const body = page.locator('body');
|
|
||||||
await expect(body).toHaveCSS('background-color', 'rgb(18, 18, 18)');
|
|
||||||
|
|
||||||
// Plugin components should adapt
|
|
||||||
const sectionBox = page.locator('[class*="MuiPaper"]').first();
|
|
||||||
await expect(sectionBox).not.toHaveCSS('background-color', 'rgb(255, 255, 255)');
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## CI/CD Integration
|
|
||||||
|
|
||||||
Tests run automatically in GitHub Actions on pushes to `main` and pull requests. See `.github/workflows/e2e.yaml` for workflow configuration.
|
|
||||||
|
|
||||||
### Required Secrets
|
|
||||||
|
|
||||||
Configure these in GitHub repository settings (Settings → Secrets and variables → Actions):
|
|
||||||
|
|
||||||
- `HEADLAMP_URL` (optional): Headlamp instance URL
|
|
||||||
- `AUTHENTIK_USERNAME` + `AUTHENTIK_PASSWORD` (for OIDC auth)
|
|
||||||
- OR `HEADLAMP_TOKEN` (for token-based auth)
|
|
||||||
|
|
||||||
### Workflow Overview
|
|
||||||
|
|
||||||
1. Checkout code
|
|
||||||
2. Setup Node.js 20 with npm cache
|
|
||||||
3. Install dependencies (`npm ci`)
|
|
||||||
4. Install Playwright browsers (`chromium` only)
|
|
||||||
5. Run auth setup (creates session in `e2e/.auth/state.json`)
|
|
||||||
6. Run all E2E tests
|
|
||||||
7. Upload artifacts on failure:
|
|
||||||
- `playwright-report/` - HTML test report
|
|
||||||
- `test-results/` - Screenshots, traces, videos
|
|
||||||
|
|
||||||
### Manual Trigger
|
|
||||||
|
|
||||||
You can manually trigger E2E tests from GitHub Actions:
|
|
||||||
1. Go to Actions → E2E Tests
|
|
||||||
2. Click "Run workflow"
|
|
||||||
3. Select branch and run
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **Use semantic selectors**: `getByRole`, `getByText` over CSS selectors
|
|
||||||
2. **Wait for visibility**: Use `await expect(...).toBeVisible()` instead of `waitForTimeout`
|
|
||||||
3. **Keep tests independent**: Each test should work in isolation
|
|
||||||
4. **Test user flows**: Complete journeys, not just page loads
|
|
||||||
5. **Clean up state**: Close drawers/modals after tests
|
|
||||||
6. **Use storage state**: Reuse auth across tests (already configured)
|
|
||||||
7. **Parallelize carefully**: Currently disabled due to shared state
|
|
||||||
|
|
||||||
## Resources
|
|
||||||
|
|
||||||
- [Playwright Documentation](https://playwright.dev/)
|
|
||||||
- [Playwright Best Practices](https://playwright.dev/docs/best-practices)
|
|
||||||
- [Headlamp Plugin Development](https://headlamp.dev/docs/latest/development/plugins/)
|
|
||||||
- [Project Main README](../README.md)
|
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
import { test, expect } from '@playwright/test';
|
|
||||||
|
|
||||||
test.describe('Polaris app bar badge', () => {
|
|
||||||
test('badge displays cluster score in app bar', async ({ page }) => {
|
|
||||||
await page.goto('/c/main');
|
|
||||||
|
|
||||||
// Wait for page to load
|
|
||||||
await expect(page.getByRole('navigation', { name: 'Navigation' })).toBeVisible();
|
|
||||||
|
|
||||||
// Badge should be visible in app bar with score percentage
|
|
||||||
const badge = page.getByRole('button', { name: /Polaris: \d+%/ });
|
|
||||||
await expect(badge).toBeVisible({ timeout: 15_000 });
|
|
||||||
|
|
||||||
// Badge should show shield emoji
|
|
||||||
await expect(badge).toContainText('🛡️');
|
|
||||||
});
|
|
||||||
|
|
||||||
test('clicking badge navigates to overview page', async ({ page }) => {
|
|
||||||
await page.goto('/c/main');
|
|
||||||
|
|
||||||
// Find and click the badge
|
|
||||||
const badge = page.getByRole('button', { name: /Polaris: \d+%/ });
|
|
||||||
await expect(badge).toBeVisible({ timeout: 15_000 });
|
|
||||||
await badge.click();
|
|
||||||
|
|
||||||
// Should navigate to Polaris overview
|
|
||||||
await expect(page).toHaveURL(/\/c\/main\/polaris$/);
|
|
||||||
await expect(page.getByRole('heading', { name: 'Polaris — Overview' })).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('badge color reflects score level', async ({ page }) => {
|
|
||||||
await page.goto('/c/main');
|
|
||||||
|
|
||||||
// Get the badge
|
|
||||||
const badge = page.getByRole('button', { name: /Polaris: \d+%/ });
|
|
||||||
await expect(badge).toBeVisible({ timeout: 15_000 });
|
|
||||||
|
|
||||||
// Extract score from button text
|
|
||||||
const badgeText = await badge.textContent();
|
|
||||||
const scoreMatch = badgeText?.match(/(\d+)%/);
|
|
||||||
expect(scoreMatch).toBeTruthy();
|
|
||||||
|
|
||||||
const score = parseInt(scoreMatch![1]);
|
|
||||||
|
|
||||||
// Check background color matches score level
|
|
||||||
const bgColor = await badge.evaluate(el =>
|
|
||||||
window.getComputedStyle(el).backgroundColor
|
|
||||||
);
|
|
||||||
|
|
||||||
// Verify that the badge has a non-default background color applied
|
|
||||||
// (theme-dependent RGB values vary across Headlamp versions, so we
|
|
||||||
// only assert that a real color is set rather than transparent/default)
|
|
||||||
expect(bgColor).not.toBe('rgba(0, 0, 0, 0)');
|
|
||||||
expect(bgColor).not.toBe('transparent');
|
|
||||||
expect(bgColor).toMatch(/^rgb/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('badge updates when navigating between clusters', async ({ page }) => {
|
|
||||||
// This test assumes multi-cluster setup; skip if only one cluster
|
|
||||||
await page.goto('/c/main');
|
|
||||||
|
|
||||||
// Get initial badge score
|
|
||||||
const badge = page.getByRole('button', { name: /Polaris: \d+%/ });
|
|
||||||
await expect(badge).toBeVisible({ timeout: 15_000 });
|
|
||||||
const initialScore = await badge.textContent();
|
|
||||||
|
|
||||||
// Try to switch clusters (if available)
|
|
||||||
const clusterSelector = page.getByRole('button', { name: /cluster/i });
|
|
||||||
if (await clusterSelector.isVisible()) {
|
|
||||||
// Note: This part will only work in multi-cluster setups
|
|
||||||
// For single-cluster, this test will just verify badge persists
|
|
||||||
await clusterSelector.click();
|
|
||||||
|
|
||||||
// Select different cluster if available
|
|
||||||
const clusterOptions = page.getByRole('menuitem');
|
|
||||||
const count = await clusterOptions.count();
|
|
||||||
|
|
||||||
if (count > 1) {
|
|
||||||
await clusterOptions.nth(1).click();
|
|
||||||
|
|
||||||
// Badge should update or disappear (if new cluster doesn't have Polaris)
|
|
||||||
// This is just verifying no crash occurs
|
|
||||||
await page.waitForTimeout(2000);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Badge should still be functional
|
|
||||||
await expect(badge).toBeEnabled();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
import { test as setup, expect, Page } from '@playwright/test';
|
|
||||||
|
|
||||||
const AUTH_STATE_PATH = 'e2e/.auth/state.json';
|
|
||||||
|
|
||||||
async function authenticateWithOIDC(page: Page, username: string, password: string): Promise<void> {
|
|
||||||
// Navigate to login — Headlamp redirects / to /c/main/login
|
|
||||||
await page.goto('/');
|
|
||||||
await page.waitForURL('**/login');
|
|
||||||
|
|
||||||
// Click "Sign In" and capture the Authentik popup
|
|
||||||
const popupPromise = page.waitForEvent('popup');
|
|
||||||
await page.getByRole('button', { name: /sign in/i }).click();
|
|
||||||
const popup = await popupPromise;
|
|
||||||
|
|
||||||
// Wait for the Authentik popup to fully load before interacting
|
|
||||||
await popup.waitForLoadState('domcontentloaded');
|
|
||||||
await popup.waitForLoadState('networkidle');
|
|
||||||
|
|
||||||
// Authentik step 1: fill username — wait for the form to render
|
|
||||||
const usernameField = popup.getByRole('textbox', { name: /email or username/i });
|
|
||||||
await usernameField.waitFor({ state: 'visible', timeout: 15_000 });
|
|
||||||
await usernameField.fill(username);
|
|
||||||
await popup.getByRole('button', { name: /log in/i }).click();
|
|
||||||
|
|
||||||
// Authentik step 2: fill password — wait for the next step to load
|
|
||||||
await popup.waitForLoadState('networkidle');
|
|
||||||
const passwordField = popup.getByRole('textbox', { name: /password/i });
|
|
||||||
await passwordField.waitFor({ state: 'visible', timeout: 15_000 });
|
|
||||||
await passwordField.fill(password);
|
|
||||||
await popup.getByRole('button', { name: /continue|log in/i }).click();
|
|
||||||
|
|
||||||
// Wait for the popup to close (Authentik redirects back, Headlamp processes callback)
|
|
||||||
await popup.waitForEvent('close', { timeout: 15_000 });
|
|
||||||
|
|
||||||
// Original page should now be authenticated — wait for sidebar
|
|
||||||
await expect(page.getByRole('navigation', { name: 'Navigation' })).toBeVisible({
|
|
||||||
timeout: 15_000,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async function authenticateWithToken(page: Page, token: string): Promise<void> {
|
|
||||||
// Navigate to login — Headlamp redirects / to /c/main/login
|
|
||||||
await page.goto('/');
|
|
||||||
await page.waitForURL('**/login');
|
|
||||||
|
|
||||||
// Click the token auth option
|
|
||||||
await page.getByRole('button', { name: /use a token/i }).click();
|
|
||||||
await page.waitForURL('**/token');
|
|
||||||
|
|
||||||
// Fill the "ID token" field and submit
|
|
||||||
await page.getByRole('textbox', { name: /id token/i }).fill(token);
|
|
||||||
await page.getByRole('button', { name: /authenticate/i }).click();
|
|
||||||
|
|
||||||
// Wait for the main UI to load
|
|
||||||
await expect(page.getByRole('navigation', { name: 'Navigation' })).toBeVisible({
|
|
||||||
timeout: 15_000,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
setup('authenticate with Headlamp', async ({ page }) => {
|
|
||||||
const username = process.env.AUTHENTIK_USERNAME;
|
|
||||||
const password = process.env.AUTHENTIK_PASSWORD;
|
|
||||||
const token = process.env.HEADLAMP_TOKEN;
|
|
||||||
|
|
||||||
if (username && password) {
|
|
||||||
await authenticateWithOIDC(page, username, password);
|
|
||||||
} else if (token) {
|
|
||||||
await authenticateWithToken(page, token);
|
|
||||||
} else {
|
|
||||||
throw new Error(
|
|
||||||
'Set AUTHENTIK_USERNAME + AUTHENTIK_PASSWORD for OIDC auth, or HEADLAMP_TOKEN for token auth'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
await page.context().storageState({ path: AUTH_STATE_PATH });
|
|
||||||
});
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
import { test, expect } from '@playwright/test';
|
|
||||||
|
|
||||||
test.describe('Polaris plugin smoke tests', () => {
|
|
||||||
test('sidebar contains Polaris entry', async ({ page }) => {
|
|
||||||
await page.goto('/');
|
|
||||||
// The sidebar is the "Navigation" nav element (not "Appbar Tools")
|
|
||||||
const sidebar = page.getByRole('navigation', { name: 'Navigation' });
|
|
||||||
await expect(sidebar).toBeVisible({ timeout: 15_000 });
|
|
||||||
await expect(sidebar.getByRole('button', { name: 'Polaris' })).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('overview page renders cluster score', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/polaris');
|
|
||||||
|
|
||||||
// SectionHeader renders a heading
|
|
||||||
await expect(page.getByRole('heading', { name: 'Polaris \u2014 Overview' })).toBeVisible();
|
|
||||||
|
|
||||||
// "Cluster Score" section exists with a percentage
|
|
||||||
await expect(page.getByText('Cluster Score')).toBeVisible();
|
|
||||||
await expect(page.locator('main').getByText(/%/).first()).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('namespaces page renders table with namespace buttons', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/polaris/namespaces');
|
|
||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'Polaris \u2014 Namespaces' })).toBeVisible();
|
|
||||||
|
|
||||||
// Table should have at least one row with a namespace button
|
|
||||||
const table = page.locator('table');
|
|
||||||
await expect(table).toBeVisible();
|
|
||||||
const rows = table.locator('tbody tr');
|
|
||||||
await expect(rows.first()).toBeVisible();
|
|
||||||
|
|
||||||
// Each namespace row should contain a button (now buttons instead of links for drawer)
|
|
||||||
const firstButton = rows.first().locator('button');
|
|
||||||
await expect(firstButton).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('namespace detail drawer opens from table button', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/polaris/namespaces');
|
|
||||||
|
|
||||||
// Click the first namespace button in the table
|
|
||||||
const table = page.locator('table');
|
|
||||||
await expect(table).toBeVisible();
|
|
||||||
const firstButton = table.locator('tbody tr').first().locator('button');
|
|
||||||
const namespaceName = await firstButton.textContent();
|
|
||||||
await firstButton.click();
|
|
||||||
|
|
||||||
// Drawer should open and show the namespace name in the heading
|
|
||||||
await expect(
|
|
||||||
page.getByRole('heading', { name: `Polaris \u2014 ${namespaceName}` })
|
|
||||||
).toBeVisible();
|
|
||||||
|
|
||||||
// "Namespace Score" section should be present in drawer
|
|
||||||
await expect(page.getByText('Namespace Score')).toBeVisible();
|
|
||||||
|
|
||||||
// Resources table should exist in drawer
|
|
||||||
await expect(page.getByRole('heading', { name: 'Resources' })).toBeVisible();
|
|
||||||
|
|
||||||
// URL hash should be updated with namespace name
|
|
||||||
await expect(page).toHaveURL(/\/polaris\/namespaces#/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('namespace detail drawer closes with Escape key', async ({ page }) => {
|
|
||||||
await page.goto('/c/main/polaris/namespaces');
|
|
||||||
|
|
||||||
// Open the drawer by clicking a namespace button
|
|
||||||
const table = page.locator('table');
|
|
||||||
await expect(table).toBeVisible();
|
|
||||||
const firstButton = table.locator('tbody tr').first().locator('button');
|
|
||||||
const namespaceName = await firstButton.textContent();
|
|
||||||
await firstButton.click();
|
|
||||||
|
|
||||||
// Verify drawer is open
|
|
||||||
await expect(
|
|
||||||
page.getByRole('heading', { name: `Polaris \u2014 ${namespaceName}` })
|
|
||||||
).toBeVisible();
|
|
||||||
|
|
||||||
// Press Escape key
|
|
||||||
await page.keyboard.press('Escape');
|
|
||||||
|
|
||||||
// Drawer should close (heading should not be visible anymore)
|
|
||||||
await expect(
|
|
||||||
page.getByRole('heading', { name: `Polaris \u2014 ${namespaceName}` })
|
|
||||||
).not.toBeVisible();
|
|
||||||
|
|
||||||
// URL hash should be cleared
|
|
||||||
await expect(page).toHaveURL(/\/polaris\/namespaces$/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('namespace detail drawer opens from URL hash', async ({ page }) => {
|
|
||||||
// Get a namespace name first
|
|
||||||
await page.goto('/c/main/polaris/namespaces');
|
|
||||||
const table = page.locator('table');
|
|
||||||
await expect(table).toBeVisible();
|
|
||||||
const firstButton = table.locator('tbody tr').first().locator('button');
|
|
||||||
const namespaceName = await firstButton.textContent();
|
|
||||||
|
|
||||||
// Navigate directly to URL with hash
|
|
||||||
await page.goto(`/c/main/polaris/namespaces#${namespaceName}`);
|
|
||||||
|
|
||||||
// Drawer should automatically open with the namespace details
|
|
||||||
await expect(
|
|
||||||
page.getByRole('heading', { name: `Polaris \u2014 ${namespaceName}` })
|
|
||||||
).toBeVisible();
|
|
||||||
|
|
||||||
// "Namespace Score" section should be present
|
|
||||||
await expect(page.getByText('Namespace Score')).toBeVisible();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
import { test, expect, Page } from '@playwright/test';
|
|
||||||
|
|
||||||
/** Navigate to the Polaris plugin settings page and wait for settings to render. */
|
|
||||||
async function goToPolarisSettings(page: Page) {
|
|
||||||
await page.goto('/c/main/settings/plugins');
|
|
||||||
|
|
||||||
// Find and click the Polaris plugin entry to open its settings
|
|
||||||
const pluginEntry = page.locator('text=polaris').first();
|
|
||||||
await expect(pluginEntry).toBeVisible({ timeout: 15_000 });
|
|
||||||
await pluginEntry.click();
|
|
||||||
|
|
||||||
// Wait for the PolarisSettings component to render
|
|
||||||
await expect(page.getByText('Polaris Settings')).toBeVisible({ timeout: 15_000 });
|
|
||||||
}
|
|
||||||
|
|
||||||
test.describe('Polaris plugin settings', () => {
|
|
||||||
test('settings page shows configuration options', async ({ page }) => {
|
|
||||||
await goToPolarisSettings(page);
|
|
||||||
|
|
||||||
// SectionBox title should be visible
|
|
||||||
await expect(page.getByText('Polaris Settings')).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('refresh interval setting is configurable', async ({ page }) => {
|
|
||||||
await goToPolarisSettings(page);
|
|
||||||
|
|
||||||
// Find the refresh interval dropdown
|
|
||||||
const intervalSelect = page.locator('select').filter({ hasText: /minute|second/ });
|
|
||||||
await expect(intervalSelect).toBeVisible();
|
|
||||||
|
|
||||||
// Get current value
|
|
||||||
const currentValue = await intervalSelect.inputValue();
|
|
||||||
|
|
||||||
// Change to a different value
|
|
||||||
const newValue = currentValue === '300' ? '600' : '300';
|
|
||||||
await intervalSelect.selectOption(newValue);
|
|
||||||
|
|
||||||
// Value should be updated
|
|
||||||
await expect(intervalSelect).toHaveValue(newValue);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('dashboard URL setting is configurable', async ({ page }) => {
|
|
||||||
await goToPolarisSettings(page);
|
|
||||||
|
|
||||||
// Find the dashboard URL input
|
|
||||||
const urlInput = page.getByPlaceholder(/polaris-dashboard/);
|
|
||||||
await expect(urlInput).toBeVisible();
|
|
||||||
|
|
||||||
// Input should have the default proxy URL or custom URL
|
|
||||||
const currentUrl = await urlInput.inputValue();
|
|
||||||
expect(currentUrl).toBeTruthy();
|
|
||||||
|
|
||||||
// Examples text should be visible
|
|
||||||
await expect(page.getByText('Examples:')).toBeVisible();
|
|
||||||
await expect(page.getByText(/K8s proxy:/)).toBeVisible();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('connection test button is available', async ({ page }) => {
|
|
||||||
await goToPolarisSettings(page);
|
|
||||||
|
|
||||||
// Find and verify test connection button
|
|
||||||
const testButton = page.getByRole('button', { name: /test connection/i });
|
|
||||||
await expect(testButton).toBeVisible();
|
|
||||||
await expect(testButton).toBeEnabled();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('connection test works with valid URL', async ({ page }) => {
|
|
||||||
await goToPolarisSettings(page);
|
|
||||||
|
|
||||||
// Click test connection
|
|
||||||
const testButton = page.getByRole('button', { name: /test connection/i });
|
|
||||||
await testButton.click();
|
|
||||||
|
|
||||||
// Wait for either success or error message
|
|
||||||
// Note: This will succeed if Polaris is accessible, fail otherwise
|
|
||||||
await page.waitForSelector('text=/Connected successfully|Connection failed/', {
|
|
||||||
timeout: 15_000,
|
|
||||||
});
|
|
||||||
|
|
||||||
// Either success or failure is acceptable (depends on environment)
|
|
||||||
const result = await page.textContent('body');
|
|
||||||
expect(result).toMatch(/(Connected successfully|Connection failed)/);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Generated
-18551
File diff suppressed because it is too large
Load Diff
+23
-6
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "headlamp-polaris",
|
"name": "headlamp-polaris",
|
||||||
"version": "0.7.1",
|
"version": "1.0.0",
|
||||||
"description": "Headlamp plugin for Fairwinds Polaris audit results",
|
"description": "Headlamp plugin for Fairwinds Polaris audit results",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -12,6 +12,7 @@
|
|||||||
"homepage": "https://github.com/privilegedescalation/headlamp-polaris-plugin#readme",
|
"homepage": "https://github.com/privilegedescalation/headlamp-polaris-plugin#readme",
|
||||||
"author": "privilegedescalation",
|
"author": "privilegedescalation",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
|
"packageManager": "pnpm@10.32.1",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "headlamp-plugin start",
|
"start": "headlamp-plugin start",
|
||||||
"build": "headlamp-plugin build",
|
"build": "headlamp-plugin build",
|
||||||
@@ -22,27 +23,43 @@
|
|||||||
"format": "prettier --write src/",
|
"format": "prettier --write src/",
|
||||||
"format:check": "prettier --check src/",
|
"format:check": "prettier --check src/",
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
"test:watch": "vitest",
|
"test:watch": "vitest"
|
||||||
"e2e": "playwright test",
|
|
||||||
"e2e:headed": "playwright test --headed"
|
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"react": "^18.0.0",
|
"react": "^18.0.0",
|
||||||
"react-dom": "^18.0.0"
|
"react-dom": "^18.0.0"
|
||||||
},
|
},
|
||||||
|
"pnpm": {
|
||||||
|
"overrides": {
|
||||||
|
"tar": "^7.5.11",
|
||||||
|
"undici": "^7.24.3",
|
||||||
|
"flatted": "^3.4.2",
|
||||||
|
"lodash": ">=4.18.0",
|
||||||
|
"picomatch": ">=4.0.4",
|
||||||
|
"vite": ">=6.4.2",
|
||||||
|
"elliptic": ">=6.6.1",
|
||||||
|
"fast-uri": ">=3.1.2"
|
||||||
|
}
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@kinvolk/headlamp-plugin": "^0.13.0",
|
"@kinvolk/headlamp-plugin": "^0.14.0",
|
||||||
"@mui/material": "^5.15.14",
|
"@mui/material": "^5.15.14",
|
||||||
"@playwright/test": "^1.58.2",
|
|
||||||
"@testing-library/jest-dom": "^6.4.8",
|
"@testing-library/jest-dom": "^6.4.8",
|
||||||
"@testing-library/react": "^16.0.0",
|
"@testing-library/react": "^16.0.0",
|
||||||
"@testing-library/user-event": "^14.5.2",
|
"@testing-library/user-event": "^14.5.2",
|
||||||
"@types/react": "^19.2.14",
|
"@types/react": "^19.2.14",
|
||||||
"@types/react-dom": "^19.2.3",
|
"@types/react-dom": "^19.2.3",
|
||||||
|
"@vitest/coverage-v8": "^3.2.4",
|
||||||
|
"@headlamp-k8s/eslint-config": "^0.6.0",
|
||||||
|
"eslint": "^8.57.0",
|
||||||
"jsdom": "^24.0.0",
|
"jsdom": "^24.0.0",
|
||||||
|
"prettier": "^2.8.8",
|
||||||
"react": "^18.3.1",
|
"react": "^18.3.1",
|
||||||
"react-dom": "^18.3.1",
|
"react-dom": "^18.3.1",
|
||||||
"react-router-dom": "^5.3.0",
|
"react-router-dom": "^5.3.0",
|
||||||
|
"tar": "^7.5.11",
|
||||||
|
"typescript": "~5.6.2",
|
||||||
|
"undici": "^7.24.3",
|
||||||
"vitest": "^3.0.5"
|
"vitest": "^3.0.5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,27 +0,0 @@
|
|||||||
import { defineConfig, devices } from '@playwright/test';
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
testDir: './e2e',
|
|
||||||
timeout: 30_000,
|
|
||||||
expect: { timeout: 10_000 },
|
|
||||||
fullyParallel: false,
|
|
||||||
forbidOnly: !!process.env.CI,
|
|
||||||
retries: process.env.CI ? 1 : 0,
|
|
||||||
reporter: 'list',
|
|
||||||
use: {
|
|
||||||
baseURL: process.env.HEADLAMP_URL || 'https://headlamp.animaniacs.farh.net',
|
|
||||||
trace: 'on-first-retry',
|
|
||||||
screenshot: 'only-on-failure',
|
|
||||||
},
|
|
||||||
projects: [
|
|
||||||
{ name: 'setup', testMatch: /auth\.setup\.ts/, timeout: 60_000 },
|
|
||||||
{
|
|
||||||
name: 'chromium',
|
|
||||||
use: {
|
|
||||||
...devices['Desktop Chrome'],
|
|
||||||
storageState: 'e2e/.auth/state.json',
|
|
||||||
},
|
|
||||||
dependencies: ['setup'],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
|
||||||
Generated
+647
-233
File diff suppressed because it is too large
Load Diff
+2
-16
@@ -1,19 +1,5 @@
|
|||||||
{
|
{
|
||||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||||
"extends": ["config:recommended"],
|
"extends": ["github>privilegedescalation/.github:renovate-config"]
|
||||||
"baseBranches": ["main"],
|
|
||||||
"schedule": ["every weekend"],
|
|
||||||
"prConcurrentLimit": 10,
|
|
||||||
"packageRules": [
|
|
||||||
{
|
|
||||||
"matchManagers": ["npm"],
|
|
||||||
"matchUpdateTypes": ["minor", "patch"],
|
|
||||||
"groupName": "npm minor and patch"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"matchManagers": ["github-actions"],
|
|
||||||
"matchUpdateTypes": ["minor", "patch"],
|
|
||||||
"groupName": "github-actions minor and patch"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -7,13 +7,7 @@ import { makeAuditData, makeResult } from '../test-utils';
|
|||||||
// Mock Headlamp lib
|
// Mock Headlamp lib
|
||||||
vi.mock('@kinvolk/headlamp-plugin/lib', () => ({
|
vi.mock('@kinvolk/headlamp-plugin/lib', () => ({
|
||||||
ApiProxy: { request: vi.fn() },
|
ApiProxy: { request: vi.fn() },
|
||||||
K8s: {
|
K8s: {},
|
||||||
useCluster: () => 'test-cluster',
|
|
||||||
},
|
|
||||||
Router: {
|
|
||||||
createRouteURL: (name: string, params?: { cluster?: string }) =>
|
|
||||||
`/c/${params?.cluster ?? 'default'}/${name}`,
|
|
||||||
},
|
|
||||||
}));
|
}));
|
||||||
|
|
||||||
vi.mock('@mui/material/styles', () => ({
|
vi.mock('@mui/material/styles', () => ({
|
||||||
@@ -31,6 +25,15 @@ vi.mock('react-router-dom', () => ({
|
|||||||
useHistory: () => ({ push: mockPush }),
|
useHistory: () => ({ push: mockPush }),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
// Set window.location.pathname for cluster extraction
|
||||||
|
beforeEach(() => {
|
||||||
|
Object.defineProperty(window, 'location', {
|
||||||
|
value: { pathname: '/c/test-cluster/some-page' },
|
||||||
|
writable: true,
|
||||||
|
});
|
||||||
|
mockPush.mockClear();
|
||||||
|
});
|
||||||
|
|
||||||
const mockUsePolarisDataContext = vi.fn();
|
const mockUsePolarisDataContext = vi.fn();
|
||||||
vi.mock('../api/PolarisDataContext', () => ({
|
vi.mock('../api/PolarisDataContext', () => ({
|
||||||
usePolarisDataContext: () => mockUsePolarisDataContext(),
|
usePolarisDataContext: () => mockUsePolarisDataContext(),
|
||||||
@@ -97,7 +100,7 @@ describe('AppBarScoreBadge', () => {
|
|||||||
expect(button.style.backgroundColor).toBe('rgb(244, 67, 54)');
|
expect(button.style.backgroundColor).toBe('rgb(244, 67, 54)');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('navigates to /polaris on click', async () => {
|
it('navigates to /c/<cluster>/polaris on click', async () => {
|
||||||
const user = userEvent.setup();
|
const user = userEvent.setup();
|
||||||
const data = makeAuditData([
|
const data = makeAuditData([
|
||||||
makeResult({
|
makeResult({
|
||||||
@@ -120,6 +123,33 @@ describe('AppBarScoreBadge', () => {
|
|||||||
expect(mockPush).toHaveBeenCalledWith('/c/test-cluster/polaris');
|
expect(mockPush).toHaveBeenCalledWith('/c/test-cluster/polaris');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('navigates to /polaris when no cluster in URL', async () => {
|
||||||
|
Object.defineProperty(window, 'location', {
|
||||||
|
value: { pathname: '/settings' },
|
||||||
|
writable: true,
|
||||||
|
});
|
||||||
|
const user = userEvent.setup();
|
||||||
|
const data = makeAuditData([
|
||||||
|
makeResult({
|
||||||
|
Results: {
|
||||||
|
c1: {
|
||||||
|
ID: 'c1',
|
||||||
|
Message: '',
|
||||||
|
Details: [],
|
||||||
|
Success: true,
|
||||||
|
Severity: 'warning',
|
||||||
|
Category: 'X',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
]);
|
||||||
|
mockUsePolarisDataContext.mockReturnValue({ data, loading: false });
|
||||||
|
|
||||||
|
render(<AppBarScoreBadge />);
|
||||||
|
await user.click(screen.getByRole('button'));
|
||||||
|
expect(mockPush).toHaveBeenCalledWith('/polaris');
|
||||||
|
});
|
||||||
|
|
||||||
it('has correct aria-label', () => {
|
it('has correct aria-label', () => {
|
||||||
const data = makeAuditData([
|
const data = makeAuditData([
|
||||||
makeResult({
|
makeResult({
|
||||||
|
|||||||
@@ -1,10 +1,21 @@
|
|||||||
import { K8s, Router } from '@kinvolk/headlamp-plugin/lib';
|
|
||||||
import { useTheme } from '@mui/material/styles';
|
import { useTheme } from '@mui/material/styles';
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
import { useHistory } from 'react-router-dom';
|
import { useHistory } from 'react-router-dom';
|
||||||
import { computeScore, countResults } from '../api/polaris';
|
import { computeScore, countResults } from '../api/polaris';
|
||||||
import { usePolarisDataContext } from '../api/PolarisDataContext';
|
import { usePolarisDataContext } from '../api/PolarisDataContext';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract the cluster name from the current browser URL.
|
||||||
|
* Headlamp cluster routes follow the pattern /c/<cluster>/...
|
||||||
|
* We read window.location.pathname directly because the AppBar renders
|
||||||
|
* outside the cluster route context, so useCluster() returns null and
|
||||||
|
* React Router's useLocation() may not reflect the cluster prefix.
|
||||||
|
*/
|
||||||
|
function getClusterFromUrl(): string | null {
|
||||||
|
const match = window.location.pathname.match(/\/c\/([^/]+)/);
|
||||||
|
return match ? match[1] : null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* App bar badge showing cluster Polaris score
|
* App bar badge showing cluster Polaris score
|
||||||
* Clicking navigates to the overview dashboard
|
* Clicking navigates to the overview dashboard
|
||||||
@@ -13,7 +24,6 @@ export default function AppBarScoreBadge() {
|
|||||||
const theme = useTheme();
|
const theme = useTheme();
|
||||||
const { data, loading } = usePolarisDataContext();
|
const { data, loading } = usePolarisDataContext();
|
||||||
const history = useHistory();
|
const history = useHistory();
|
||||||
const cluster = K8s.useCluster();
|
|
||||||
|
|
||||||
if (loading || !data) {
|
if (loading || !data) {
|
||||||
return null; // Graceful degradation when Polaris unavailable
|
return null; // Graceful degradation when Polaris unavailable
|
||||||
@@ -36,7 +46,9 @@ export default function AppBarScoreBadge() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const handleClick = () => {
|
const handleClick = () => {
|
||||||
history.push(Router.createRouteURL('polaris', { cluster: cluster ?? '' }));
|
const cluster = getClusterFromUrl();
|
||||||
|
const prefix = cluster ? `/c/${cluster}` : '';
|
||||||
|
history.push(`${prefix}/polaris`);
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -0,0 +1,432 @@
|
|||||||
|
import { fireEvent, render, screen, waitFor } from '@testing-library/react';
|
||||||
|
import React from 'react';
|
||||||
|
import { describe, expect, it, vi } from 'vitest';
|
||||||
|
import { makeResult } from '../test-utils';
|
||||||
|
|
||||||
|
const { mockApiRequest } = vi.hoisted(() => ({ mockApiRequest: vi.fn() }));
|
||||||
|
|
||||||
|
vi.mock('@kinvolk/headlamp-plugin/lib', () => ({
|
||||||
|
ApiProxy: { request: mockApiRequest },
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('@mui/material/styles', () => ({
|
||||||
|
useTheme: () => ({
|
||||||
|
palette: {
|
||||||
|
primary: { main: '#1976d2', contrastText: '#fff' },
|
||||||
|
action: { disabledBackground: '#e0e0e0', disabled: '#9e9e9e' },
|
||||||
|
divider: '#e0e0e0',
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
|
||||||
|
vi.mock('@kinvolk/headlamp-plugin/lib/CommonComponents', () => ({
|
||||||
|
SectionBox: ({ title, children }: { title?: string; children?: React.ReactNode }) => (
|
||||||
|
<div data-testid="section-box" data-title={title}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
StatusLabel: ({ status, children }: { status: string; children?: React.ReactNode }) => (
|
||||||
|
<span data-testid="status-label" data-status={status}>
|
||||||
|
{children}
|
||||||
|
</span>
|
||||||
|
),
|
||||||
|
Dialog: ({
|
||||||
|
open,
|
||||||
|
children,
|
||||||
|
title,
|
||||||
|
}: {
|
||||||
|
open: boolean;
|
||||||
|
onClose?: () => void;
|
||||||
|
title?: string;
|
||||||
|
children?: React.ReactNode;
|
||||||
|
}) =>
|
||||||
|
open ? (
|
||||||
|
<div data-testid="dialog" data-title={title}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
) : null,
|
||||||
|
}));
|
||||||
|
|
||||||
|
import ExemptionManager from './ExemptionManager';
|
||||||
|
|
||||||
|
const defaultProps = {
|
||||||
|
workloadResult: makeResult(),
|
||||||
|
namespace: 'default',
|
||||||
|
kind: 'Deployment',
|
||||||
|
name: 'my-deploy',
|
||||||
|
};
|
||||||
|
|
||||||
|
const resultWithPodFailures = makeResult({
|
||||||
|
PodResult: {
|
||||||
|
Name: 'pod',
|
||||||
|
Results: {
|
||||||
|
hostIPCSet: {
|
||||||
|
ID: 'hostIPCSet',
|
||||||
|
Message: 'Host IPC is set',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'danger',
|
||||||
|
Category: 'Security',
|
||||||
|
},
|
||||||
|
hostPIDSet: {
|
||||||
|
ID: 'hostPIDSet',
|
||||||
|
Message: 'Host PID is set',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'danger',
|
||||||
|
Category: 'Security',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
ContainerResults: [],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const resultWithContainerFailures = makeResult({
|
||||||
|
PodResult: {
|
||||||
|
Name: 'pod',
|
||||||
|
Results: {},
|
||||||
|
ContainerResults: [
|
||||||
|
{
|
||||||
|
Name: 'container-1',
|
||||||
|
Results: {
|
||||||
|
cpuRequestsMissing: {
|
||||||
|
ID: 'cpuRequestsMissing',
|
||||||
|
Message: 'CPU requests missing',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'warning',
|
||||||
|
Category: 'Efficiency',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const resultWithIgnoredFailures = makeResult({
|
||||||
|
PodResult: {
|
||||||
|
Name: 'pod',
|
||||||
|
Results: {
|
||||||
|
hostIPCSet: {
|
||||||
|
ID: 'hostIPCSet',
|
||||||
|
Message: '',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'ignore',
|
||||||
|
Category: 'Security',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
ContainerResults: [],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('ExemptionManager', () => {
|
||||||
|
describe('rendering failing checks', () => {
|
||||||
|
it('shows disabled Add Exemption button when no failing checks', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} />);
|
||||||
|
const btn = screen.getByRole('button', { name: /add exemption/i });
|
||||||
|
expect(btn).toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('shows enabled Add Exemption button when there are failing checks', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
const btn = screen.getByRole('button', { name: /add exemption/i });
|
||||||
|
expect(btn).not.toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not include ignored-severity checks as failing', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithIgnoredFailures} />);
|
||||||
|
const btn = screen.getByRole('button', { name: /add exemption/i });
|
||||||
|
expect(btn).toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('collects failing checks from pod-level results', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByText('Host IPC')).toBeInTheDocument();
|
||||||
|
expect(screen.getByText('Host PID')).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('collects failing checks from container-level results', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithContainerFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByText('CPU Requests')).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('deduplicates checks that appear in multiple containers', () => {
|
||||||
|
const resultWithDuplicate = makeResult({
|
||||||
|
PodResult: {
|
||||||
|
Name: 'pod',
|
||||||
|
Results: {},
|
||||||
|
ContainerResults: [
|
||||||
|
{
|
||||||
|
Name: 'container-1',
|
||||||
|
Results: {
|
||||||
|
cpuRequestsMissing: {
|
||||||
|
ID: 'cpuRequestsMissing',
|
||||||
|
Message: '',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'warning',
|
||||||
|
Category: 'Efficiency',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Name: 'container-2',
|
||||||
|
Results: {
|
||||||
|
cpuRequestsMissing: {
|
||||||
|
ID: 'cpuRequestsMissing',
|
||||||
|
Message: '',
|
||||||
|
Details: [],
|
||||||
|
Success: false,
|
||||||
|
Severity: 'warning',
|
||||||
|
Category: 'Efficiency',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithDuplicate} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
const items = screen.getAllByText('CPU Requests');
|
||||||
|
expect(items).toHaveLength(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('dialog interactions', () => {
|
||||||
|
it('opens dialog when Add Exemption button is clicked', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
expect(screen.queryByTestId('dialog')).not.toBeInTheDocument();
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByTestId('dialog')).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('closes dialog when Cancel button is clicked', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByTestId('dialog')).toBeInTheDocument();
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /cancel/i }));
|
||||||
|
expect(screen.queryByTestId('dialog')).not.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('toggles individual check selection', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
|
||||||
|
// Find the checkbox next to "Host IPC"
|
||||||
|
const checkboxes = screen.getAllByRole('checkbox');
|
||||||
|
// First checkbox is "Exempt from all checks", rest are individual checks
|
||||||
|
const hostIPCCheckbox = checkboxes[1];
|
||||||
|
expect(hostIPCCheckbox).not.toBeChecked();
|
||||||
|
fireEvent.click(hostIPCCheckbox);
|
||||||
|
expect(hostIPCCheckbox).toBeChecked();
|
||||||
|
fireEvent.click(hostIPCCheckbox);
|
||||||
|
expect(hostIPCCheckbox).not.toBeChecked();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('hides individual checks list when exempt-all is toggled', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByText('Host IPC')).toBeInTheDocument();
|
||||||
|
|
||||||
|
const exemptAllCheckbox = screen.getByRole('checkbox', { name: /exempt from all checks/i });
|
||||||
|
fireEvent.click(exemptAllCheckbox);
|
||||||
|
expect(screen.queryByText('Host IPC')).not.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Apply button is disabled when no checks selected and exemptAll is false', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
expect(screen.getByRole('button', { name: /apply/i })).toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Apply button is enabled when exemptAll is checked', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
const exemptAllCheckbox = screen.getByRole('checkbox', { name: /exempt from all checks/i });
|
||||||
|
fireEvent.click(exemptAllCheckbox);
|
||||||
|
expect(screen.getByRole('button', { name: /apply/i })).not.toBeDisabled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Apply button is enabled when at least one individual check is selected', () => {
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
const checkboxes = screen.getAllByRole('checkbox');
|
||||||
|
fireEvent.click(checkboxes[1]); // select first individual check
|
||||||
|
expect(screen.getByRole('button', { name: /apply/i })).not.toBeDisabled();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('ApiProxy.request calls', () => {
|
||||||
|
it('patches with exempt-all annotation when exemptAll is selected', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/apis/apps/v1/namespaces/default/deployments/my-deploy',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'PATCH',
|
||||||
|
headers: { 'Content-Type': 'application/strategic-merge-patch+json' },
|
||||||
|
body: JSON.stringify({
|
||||||
|
metadata: {
|
||||||
|
annotations: { 'polaris.fairwinds.com/exempt': 'true' },
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('patches with per-check annotations when individual checks selected', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
// Select first check (hostIPCSet)
|
||||||
|
fireEvent.click(screen.getAllByRole('checkbox')[1]);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/apis/apps/v1/namespaces/default/deployments/my-deploy',
|
||||||
|
expect.objectContaining({
|
||||||
|
method: 'PATCH',
|
||||||
|
body: JSON.stringify({
|
||||||
|
metadata: {
|
||||||
|
annotations: { 'polaris.fairwinds.com/hostIPCSet-exempt': 'true' },
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses core API path for Pod kind (no api group)', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(
|
||||||
|
<ExemptionManager {...defaultProps} kind="Pod" workloadResult={resultWithPodFailures} />
|
||||||
|
);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/api/v1/namespaces/default/pods/my-deploy',
|
||||||
|
expect.anything()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses batch API group for Job kind', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(
|
||||||
|
<ExemptionManager {...defaultProps} kind="Job" workloadResult={resultWithPodFailures} />
|
||||||
|
);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/apis/batch/v1/namespaces/default/jobs/my-deploy',
|
||||||
|
expect.anything()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses batch API group for CronJob kind', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(
|
||||||
|
<ExemptionManager {...defaultProps} kind="CronJob" workloadResult={resultWithPodFailures} />
|
||||||
|
);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/apis/batch/v1/namespaces/default/cronjobs/my-deploy',
|
||||||
|
expect.anything()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('uses apps API group for StatefulSet kind', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(
|
||||||
|
<ExemptionManager
|
||||||
|
{...defaultProps}
|
||||||
|
kind="StatefulSet"
|
||||||
|
workloadResult={resultWithPodFailures}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(mockApiRequest).toHaveBeenCalledWith(
|
||||||
|
'/apis/apps/v1/namespaces/default/statefulsets/my-deploy',
|
||||||
|
expect.anything()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('feedback states', () => {
|
||||||
|
it('shows success feedback and closes dialog after successful apply', async () => {
|
||||||
|
mockApiRequest.mockResolvedValue({});
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(screen.queryByTestId('dialog')).not.toBeInTheDocument();
|
||||||
|
const label = screen.getByTestId('status-label');
|
||||||
|
expect(label).toHaveAttribute('data-status', 'success');
|
||||||
|
expect(label).toHaveTextContent('Exemptions applied successfully');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('shows error feedback and keeps dialog closed after failed apply', async () => {
|
||||||
|
mockApiRequest.mockRejectedValue(new Error('403 Forbidden'));
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
await waitFor(() => {
|
||||||
|
const label = screen.getByTestId('status-label');
|
||||||
|
expect(label).toHaveAttribute('data-status', 'error');
|
||||||
|
expect(label).toHaveTextContent(/failed to apply exemptions/i);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('shows "Applying..." text on Apply button while in-flight', async () => {
|
||||||
|
let resolveRequest!: () => void;
|
||||||
|
mockApiRequest.mockReturnValue(
|
||||||
|
new Promise<void>(res => {
|
||||||
|
resolveRequest = res;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
render(<ExemptionManager {...defaultProps} workloadResult={resultWithPodFailures} />);
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /add exemption/i }));
|
||||||
|
fireEvent.click(screen.getByRole('checkbox', { name: /exempt from all checks/i }));
|
||||||
|
fireEvent.click(screen.getByRole('button', { name: /apply/i }));
|
||||||
|
|
||||||
|
expect(screen.getByRole('button', { name: /applying/i })).toBeInTheDocument();
|
||||||
|
resolveRequest();
|
||||||
|
await waitFor(() => {
|
||||||
|
expect(screen.queryByTestId('dialog')).not.toBeInTheDocument();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -9,5 +9,16 @@ export default defineConfig({
|
|||||||
environment: 'jsdom',
|
environment: 'jsdom',
|
||||||
setupFiles: ['./vitest.setup.ts'],
|
setupFiles: ['./vitest.setup.ts'],
|
||||||
exclude: ['e2e/**', 'node_modules/**'],
|
exclude: ['e2e/**', 'node_modules/**'],
|
||||||
|
coverage: {
|
||||||
|
provider: 'v8',
|
||||||
|
include: ['src/**/*.{ts,tsx}'],
|
||||||
|
exclude: ['src/**/*.test.{ts,tsx}', 'src/test-utils.tsx', 'src/index.tsx'],
|
||||||
|
thresholds: {
|
||||||
|
lines: 80,
|
||||||
|
functions: 80,
|
||||||
|
branches: 80,
|
||||||
|
statements: 80,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user