Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a05c42afd9 |
+4
-202
@@ -2,210 +2,12 @@ name: CI
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: ['**']
|
branches: [main]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [main, dev, uat]
|
branches: [main]
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
workflow_call:
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ci:
|
ci:
|
||||||
runs-on: ubuntu-latest
|
uses: privilegedescalation/.github/.github/workflows/plugin-ci.yaml@main
|
||||||
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
|
|
||||||
|
|||||||
@@ -1,116 +1,18 @@
|
|||||||
name: Promotion Gate
|
name: Dual Approval (CTO + QA)
|
||||||
|
|
||||||
# dev PRs: no gate (engineer self-merges).
|
# Calls the shared dual-approval-check workflow.
|
||||||
# uat PRs: QA approval required.
|
# Passes when both privilegedescalation-cto and privilegedescalation-qa
|
||||||
# main PRs: UAT approval required (uat→main promotions).
|
# have approved the PR. Add "Dual Approval (CTO + QA)" to required_status_checks
|
||||||
|
# in branch protection to enforce this gate.
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request_review:
|
pull_request_review:
|
||||||
types: [submitted, dismissed]
|
types: [submitted, dismissed]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [uat, main]
|
branches: [main]
|
||||||
types: [opened, reopened, synchronize]
|
types: [opened, reopened, synchronize]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
promotion-gate:
|
dual-approval:
|
||||||
name: Promotion Gate
|
uses: privilegedescalation/.github/.github/workflows/dual-approval-check.yaml@main
|
||||||
runs-on: ubuntu-latest
|
secrets: inherit
|
||||||
container: ubuntu:latest
|
|
||||||
timeout-minutes: 5
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Install dependencies
|
|
||||||
run: apt-get update -qq && apt-get install -y --no-install-recommends ca-certificates curl jq
|
|
||||||
|
|
||||||
- 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
|
|
||||||
|
|||||||
@@ -0,0 +1,103 @@
|
|||||||
|
name: E2E Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
# Only one E2E run at a time: the shared E2E_RELEASE (headlamp-e2e) in
|
||||||
|
# privilegedescalation-dev cannot be shared across concurrent runs.
|
||||||
|
# cancel-in-progress: false (queue, don't cancel) — cancelling in-flight
|
||||||
|
# runs may skip the if: always() teardown, leaving dangling cluster resources.
|
||||||
|
concurrency:
|
||||||
|
group: e2e-${{ github.repository }}
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
env:
|
||||||
|
E2E_NAMESPACE: privilegedescalation-dev
|
||||||
|
E2E_RELEASE: headlamp-e2e
|
||||||
|
# Pin to a known-good Headlamp version. Using :latest is risky because
|
||||||
|
# the tag can change between CI runs, causing flaky failures when a newer
|
||||||
|
# image is pulled on some nodes but not others (IfNotPresent pull policy).
|
||||||
|
# Update this when Headlamp is upgraded in production (kube-system).
|
||||||
|
HEADLAMP_VERSION: v0.40.1
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
e2e:
|
||||||
|
runs-on: runners-privilegedescalation
|
||||||
|
timeout-minutes: 15
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: '22'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Setup kubectl
|
||||||
|
uses: azure/setup-kubectl@v4
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build plugin
|
||||||
|
run: npx @kinvolk/headlamp-plugin build
|
||||||
|
|
||||||
|
- name: Deploy E2E Headlamp instance
|
||||||
|
run: scripts/deploy-e2e-headlamp.sh
|
||||||
|
|
||||||
|
- name: Load E2E environment
|
||||||
|
run: |
|
||||||
|
if [ -f .env.e2e ]; then
|
||||||
|
cat .env.e2e >> "$GITHUB_ENV"
|
||||||
|
else
|
||||||
|
echo "::error::deploy-e2e-headlamp.sh did not produce .env.e2e"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Install Playwright browsers
|
||||||
|
run: npx playwright install --with-deps chromium
|
||||||
|
|
||||||
|
- name: Run E2E tests
|
||||||
|
run: npm run e2e
|
||||||
|
env:
|
||||||
|
HEADLAMP_URL: ${{ env.HEADLAMP_URL }}
|
||||||
|
HEADLAMP_TOKEN: ${{ env.HEADLAMP_TOKEN }}
|
||||||
|
|
||||||
|
- name: Collect deployment diagnostics on failure
|
||||||
|
if: failure()
|
||||||
|
run: |
|
||||||
|
echo "=== Pod state ==="
|
||||||
|
kubectl get pods -n "$E2E_NAMESPACE" -l "app.kubernetes.io/instance=$E2E_RELEASE" 2>&1 || true
|
||||||
|
echo "=== Pod describe ==="
|
||||||
|
kubectl describe pods -n "$E2E_NAMESPACE" -l "app.kubernetes.io/instance=$E2E_RELEASE" 2>&1 || true
|
||||||
|
echo "=== Recent namespace events ==="
|
||||||
|
kubectl get events -n "$E2E_NAMESPACE" --sort-by='.lastTimestamp' 2>&1 | tail -20 || true
|
||||||
|
|
||||||
|
- name: Teardown E2E instance
|
||||||
|
if: always()
|
||||||
|
run: scripts/teardown-e2e-headlamp.sh
|
||||||
|
|
||||||
|
- name: Upload Playwright report
|
||||||
|
uses: actions/upload-artifact@v7
|
||||||
|
if: failure()
|
||||||
|
with:
|
||||||
|
name: playwright-report
|
||||||
|
path: playwright-report/
|
||||||
|
retention-days: 7
|
||||||
|
|
||||||
|
- name: Upload test results
|
||||||
|
uses: actions/upload-artifact@v7
|
||||||
|
if: failure()
|
||||||
|
with:
|
||||||
|
name: test-results
|
||||||
|
path: test-results/
|
||||||
|
retention-days: 7
|
||||||
@@ -1,3 +1,8 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
dist/
|
dist/
|
||||||
*.tar.gz
|
*.tar.gz
|
||||||
|
.playwright-mcp/
|
||||||
|
e2e/.auth/state.json
|
||||||
|
.env.e2e
|
||||||
|
test-results/
|
||||||
|
playwright-report/
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# Installation Policy
|
||||||
|
|
||||||
|
## Approved Installation Method
|
||||||
|
|
||||||
|
**The ONLY approved method for installing this plugin is via [Artifact Hub](https://artifacthub.io/) using the Headlamp plugin installer.**
|
||||||
|
|
||||||
|
No other installation method is acceptable. This includes but is not limited to:
|
||||||
|
|
||||||
|
- Direct installation from GitHub release assets
|
||||||
|
- Manual npm pack / tarball extraction
|
||||||
|
- initContainer workarounds that bypass Artifact Hub
|
||||||
|
- Direct file copy or sidecar injection
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
All deployment configurations, CI/CD pipelines, and documentation MUST reference Artifact Hub as the sole plugin distribution channel. Any pull request that introduces an alternative installation method will be rejected.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
Artifact Hub provides verified checksums, consistent versioning, and a standard discovery mechanism for the CNCF ecosystem. Bypassing it introduces security and integrity risks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This policy is set by the CTO and approved by the CEO of Privileged Escalation.*
|
||||||
@@ -20,9 +20,6 @@ A [Headlamp](https://headlamp.dev/) plugin providing visibility into [Intel GPU
|
|||||||
|
|
||||||
Search for `headlamp-intel-gpu` in the Headlamp Plugin Manager (Settings → Plugins → Catalog).
|
Search for `headlamp-intel-gpu` in the Headlamp Plugin Manager (Settings → Plugins → Catalog).
|
||||||
|
|
||||||
> See [Plugin Installation Policy](https://git.farh.net/privilegedescalation/privilegedescalation.com/wiki/Plugin-Installation-Policy) for approved installation methods.
|
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Headlamp >= v0.20.0
|
- Headlamp >= v0.20.0
|
||||||
|
|||||||
+3
-3
@@ -1,4 +1,4 @@
|
|||||||
version: "1.1.0"
|
version: "1.0.0"
|
||||||
name: headlamp-intel-gpu
|
name: headlamp-intel-gpu
|
||||||
displayName: Intel GPU
|
displayName: Intel GPU
|
||||||
description: >-
|
description: >-
|
||||||
@@ -99,7 +99,7 @@ screenshots:
|
|||||||
url: https://raw.githubusercontent.com/privilegedescalation/headlamp-intel-gpu-plugin/main/docs/screenshots/03-metrics.svg
|
url: https://raw.githubusercontent.com/privilegedescalation/headlamp-intel-gpu-plugin/main/docs/screenshots/03-metrics.svg
|
||||||
|
|
||||||
annotations:
|
annotations:
|
||||||
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-intel-gpu-plugin/releases/download/v1.1.0/intel-gpu-1.1.0.tar.gz"
|
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-intel-gpu-plugin/releases/download/v1.0.0/intel-gpu-1.0.0.tar.gz"
|
||||||
headlamp/plugin/archive-checksum: sha256:e212381f38c331383604b06f6552997fcba5c8b42a3bd828e3b43ed3e5028448
|
headlamp/plugin/archive-checksum: sha256:93d6c531e7c12440c9625138f0645fc0c3521b574d0089492759699b324943f0
|
||||||
headlamp/plugin/version-compat: ">=0.20.0"
|
headlamp/plugin/version-compat: ">=0.20.0"
|
||||||
headlamp/plugin/distro-compat: "in-cluster,web,app"
|
headlamp/plugin/distro-compat: "in-cluster,web,app"
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
{
|
|
||||||
// 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"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
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> {
|
||||||
|
await page.goto('/');
|
||||||
|
// Headlamp goes to /token directly when no OIDC is configured,
|
||||||
|
// or through /login when OIDC is configured
|
||||||
|
await page.waitForURL(/\/(login|token)$/);
|
||||||
|
|
||||||
|
if (page.url().includes('/login')) {
|
||||||
|
// OIDC login page — click "use a token" to reach token auth.
|
||||||
|
// Wait explicitly before clicking so failures surface at 15 s
|
||||||
|
// with a clear message rather than silently timing out at 60 s.
|
||||||
|
const useTokenBtn = page.getByRole('button', { name: /use a token/i });
|
||||||
|
await useTokenBtn.waitFor({ state: 'visible', timeout: 15_000 });
|
||||||
|
await useTokenBtn.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 });
|
||||||
|
});
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
import { test, expect } from '@playwright/test';
|
||||||
|
|
||||||
|
test.describe('Intel GPU plugin smoke tests', () => {
|
||||||
|
test('sidebar contains intel-gpu entry', async ({ page }) => {
|
||||||
|
await page.goto('/');
|
||||||
|
const sidebar = page.getByRole('navigation', { name: 'Navigation' });
|
||||||
|
await expect(sidebar).toBeVisible({ timeout: 15_000 });
|
||||||
|
await expect(sidebar.getByRole('button', { name: 'intel-gpu' })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('sidebar intel-gpu entry is clickable and navigates to overview', async ({ page }) => {
|
||||||
|
await page.goto('/');
|
||||||
|
const sidebar = page.getByRole('navigation', { name: 'Navigation' });
|
||||||
|
await expect(sidebar).toBeVisible({ timeout: 15_000 });
|
||||||
|
|
||||||
|
const gpuEntry = sidebar.getByRole('button', { name: 'intel-gpu' });
|
||||||
|
await expect(gpuEntry).toBeVisible();
|
||||||
|
await gpuEntry.click();
|
||||||
|
|
||||||
|
// Should navigate to the overview route
|
||||||
|
await expect(page).toHaveURL(/\/intel-gpu$/);
|
||||||
|
await expect(page.getByRole('heading', { name: /intel.gpu/i })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('overview page renders GPU device list or empty state', async ({ page }) => {
|
||||||
|
await page.goto('/c/main/intel-gpu');
|
||||||
|
|
||||||
|
// Overview heading should be present
|
||||||
|
await expect(page.getByRole('heading', { name: /intel.gpu/i })).toBeVisible({
|
||||||
|
timeout: 15_000,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Either a populated table/list or an empty-state indicator must be visible
|
||||||
|
const hasTable = await page.locator('table').first().isVisible().catch(() => false);
|
||||||
|
const hasEmptyState = await page
|
||||||
|
.locator('text=/no.*gpu|no.*device|0 node|empty/i')
|
||||||
|
.first()
|
||||||
|
.isVisible()
|
||||||
|
.catch(() => false);
|
||||||
|
expect(hasTable || hasEmptyState).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('device plugins page renders or shows empty state', async ({ page }) => {
|
||||||
|
await page.goto('/c/main/intel-gpu/device-plugins');
|
||||||
|
|
||||||
|
await expect(page.getByRole('heading', { name: /device plugin/i })).toBeVisible({
|
||||||
|
timeout: 15_000,
|
||||||
|
});
|
||||||
|
|
||||||
|
const hasTable = await page.locator('table').first().isVisible().catch(() => false);
|
||||||
|
const hasEmptyState = await page
|
||||||
|
.locator('text=/no.*plugin|no.*device|empty/i')
|
||||||
|
.first()
|
||||||
|
.isVisible()
|
||||||
|
.catch(() => false);
|
||||||
|
expect(hasTable || hasEmptyState).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('navigation between plugin views works', async ({ page }) => {
|
||||||
|
await page.goto('/c/main/intel-gpu');
|
||||||
|
await expect(page.getByRole('heading', { name: /intel.gpu/i })).toBeVisible({
|
||||||
|
timeout: 15_000,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Navigate to GPU Nodes
|
||||||
|
const sidebar = page.getByRole('navigation', { name: 'Navigation' });
|
||||||
|
const nodesLink = sidebar.getByRole('link', { name: /gpu nodes/i });
|
||||||
|
await expect(nodesLink).toBeVisible();
|
||||||
|
await nodesLink.click();
|
||||||
|
await expect(page).toHaveURL(/\/intel-gpu\/nodes$/);
|
||||||
|
await expect(page.getByRole('heading', { name: /node/i })).toBeVisible();
|
||||||
|
|
||||||
|
// Navigate to GPU Pods
|
||||||
|
const podsLink = sidebar.getByRole('link', { name: /gpu pods/i });
|
||||||
|
await expect(podsLink).toBeVisible();
|
||||||
|
await podsLink.click();
|
||||||
|
await expect(page).toHaveURL(/\/intel-gpu\/pods$/);
|
||||||
|
await expect(page.getByRole('heading', { name: /pod/i })).toBeVisible();
|
||||||
|
|
||||||
|
// Navigate to Metrics
|
||||||
|
const metricsLink = sidebar.getByRole('link', { name: /metrics/i });
|
||||||
|
await expect(metricsLink).toBeVisible();
|
||||||
|
await metricsLink.click();
|
||||||
|
await expect(page).toHaveURL(/\/intel-gpu\/metrics$/);
|
||||||
|
await expect(page.getByRole('heading', { name: /metric/i })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('plugin settings page shows intel-gpu plugin entry', async ({ page }) => {
|
||||||
|
await page.goto('/settings/plugins');
|
||||||
|
|
||||||
|
// Wait for plugin list to load — plugin scripts load asynchronously
|
||||||
|
const pluginEntry = page.locator('text=intel-gpu').first();
|
||||||
|
await expect(pluginEntry).toBeVisible({ timeout: 30_000 });
|
||||||
|
});
|
||||||
|
});
|
||||||
Generated
+5
-5
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "intel-gpu",
|
"name": "intel-gpu",
|
||||||
"version": "1.1.0",
|
"version": "1.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "intel-gpu",
|
"name": "intel-gpu",
|
||||||
"version": "1.1.0",
|
"version": "1.0.0",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@kinvolk/headlamp-plugin": "^0.13.0",
|
"@kinvolk/headlamp-plugin": "^0.13.0",
|
||||||
@@ -11600,9 +11600,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/lodash": {
|
"node_modules/lodash": {
|
||||||
"version": "4.18.1",
|
"version": "4.17.23",
|
||||||
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz",
|
"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz",
|
||||||
"integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==",
|
"integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
},
|
},
|
||||||
|
|||||||
+6
-5
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "intel-gpu",
|
"name": "intel-gpu",
|
||||||
"version": "1.1.0",
|
"version": "1.0.0",
|
||||||
"description": "Headlamp plugin for Intel GPU device plugin visibility and monitoring",
|
"description": "Headlamp plugin for Intel GPU device plugin visibility and monitoring",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -22,7 +22,9 @@
|
|||||||
"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",
|
||||||
@@ -30,6 +32,7 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@kinvolk/headlamp-plugin": "^0.13.0",
|
"@kinvolk/headlamp-plugin": "^0.13.0",
|
||||||
|
"@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",
|
||||||
@@ -41,8 +44,6 @@
|
|||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"tar": "^7.5.11",
|
"tar": "^7.5.11",
|
||||||
"undici": "^7.24.3",
|
"undici": "^7.24.3"
|
||||||
"lodash": ">=4.18.0",
|
|
||||||
"elliptic": ">=6.6.1"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
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 || (() => { throw new Error('HEADLAMP_URL is required — run scripts/deploy-e2e-headlamp.sh first'); })(),
|
||||||
|
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'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
Executable
+204
@@ -0,0 +1,204 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# deploy-e2e-headlamp.sh
|
||||||
|
#
|
||||||
|
# Deploys a stock Headlamp instance with the intel-gpu plugin loaded via
|
||||||
|
# a ConfigMap volume mount. No custom Docker images — the plugin is built
|
||||||
|
# in CI and injected as a ConfigMap.
|
||||||
|
#
|
||||||
|
# E2E resources are deployed to the `privilegedescalation-dev` namespace. Nothing
|
||||||
|
# persists beyond the test run — teardown cleans up all created resources.
|
||||||
|
#
|
||||||
|
# Prerequisites:
|
||||||
|
# - Plugin built (dist/ exists with plugin-main.js + package.json)
|
||||||
|
# - kubectl configured with cluster access
|
||||||
|
# - RBAC applied: kubectl apply -f deployment/e2e-ci-runner-rbac.yaml
|
||||||
|
#
|
||||||
|
# Environment:
|
||||||
|
# E2E_NAMESPACE — namespace for E2E Headlamp (default: privilegedescalation-dev)
|
||||||
|
# E2E_RELEASE — release/resource name prefix (default: headlamp-e2e)
|
||||||
|
# HEADLAMP_VERSION — Headlamp image tag (default: latest)
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||||||
|
DIST_DIR="$REPO_ROOT/dist"
|
||||||
|
|
||||||
|
E2E_NAMESPACE="${E2E_NAMESPACE:-privilegedescalation-dev}"
|
||||||
|
E2E_RELEASE="${E2E_RELEASE:-headlamp-e2e}"
|
||||||
|
HEADLAMP_VERSION="${HEADLAMP_VERSION:-latest}"
|
||||||
|
|
||||||
|
if [ ! -d "$DIST_DIR" ]; then
|
||||||
|
echo "ERROR: dist/ not found. Run 'npm run build' first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --- Preflight: verify RBAC before touching the cluster ---
|
||||||
|
echo "Checking RBAC permissions in namespace '${E2E_NAMESPACE}'..."
|
||||||
|
if ! kubectl auth can-i delete configmaps -n "$E2E_NAMESPACE" --quiet 2>/dev/null; then
|
||||||
|
echo "ERROR: Missing RBAC — cannot delete configmaps in namespace '${E2E_NAMESPACE}'." >&2
|
||||||
|
echo " Apply RBAC first: kubectl apply -f deployment/e2e-ci-runner-rbac.yaml" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "=== E2E Headlamp Deployment ==="
|
||||||
|
echo " Image: ghcr.io/headlamp-k8s/headlamp:${HEADLAMP_VERSION}"
|
||||||
|
echo " Namespace: $E2E_NAMESPACE"
|
||||||
|
echo " Release: $E2E_RELEASE"
|
||||||
|
|
||||||
|
# --- Create ConfigMap from built plugin ---
|
||||||
|
echo ""
|
||||||
|
echo "Creating ConfigMap with plugin files..."
|
||||||
|
|
||||||
|
# Delete existing ConfigMap if present (idempotent redeploy)
|
||||||
|
kubectl delete configmap headlamp-intel-gpu-plugin \
|
||||||
|
-n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
|
||||||
|
# Create ConfigMap from dist/ contents and package.json
|
||||||
|
kubectl create configmap headlamp-intel-gpu-plugin \
|
||||||
|
-n "$E2E_NAMESPACE" \
|
||||||
|
--from-file="$DIST_DIR" \
|
||||||
|
--from-file=package.json="$REPO_ROOT/package.json"
|
||||||
|
|
||||||
|
# --- Tear down any existing E2E deployment for a clean start ---
|
||||||
|
echo ""
|
||||||
|
echo "Removing any existing E2E deployment (clean-start)..."
|
||||||
|
kubectl delete deployment "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found --wait
|
||||||
|
kubectl delete service "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found --wait
|
||||||
|
kubectl delete serviceaccount "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found --wait
|
||||||
|
|
||||||
|
# --- Deploy Headlamp via kubectl apply ---
|
||||||
|
echo ""
|
||||||
|
echo "Deploying Headlamp E2E instance..."
|
||||||
|
|
||||||
|
kubectl apply -f - <<EOF
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ServiceAccount
|
||||||
|
metadata:
|
||||||
|
name: ${E2E_RELEASE}
|
||||||
|
namespace: ${E2E_NAMESPACE}
|
||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: ${E2E_RELEASE}
|
||||||
|
namespace: ${E2E_NAMESPACE}
|
||||||
|
labels:
|
||||||
|
app.kubernetes.io/name: headlamp
|
||||||
|
app.kubernetes.io/instance: ${E2E_RELEASE}
|
||||||
|
spec:
|
||||||
|
replicas: 1
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app.kubernetes.io/name: headlamp
|
||||||
|
app.kubernetes.io/instance: ${E2E_RELEASE}
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app.kubernetes.io/name: headlamp
|
||||||
|
app.kubernetes.io/instance: ${E2E_RELEASE}
|
||||||
|
spec:
|
||||||
|
serviceAccountName: ${E2E_RELEASE}
|
||||||
|
automountServiceAccountToken: true
|
||||||
|
securityContext: {}
|
||||||
|
containers:
|
||||||
|
- name: headlamp
|
||||||
|
image: ghcr.io/headlamp-k8s/headlamp:${HEADLAMP_VERSION}
|
||||||
|
imagePullPolicy: IfNotPresent
|
||||||
|
securityContext:
|
||||||
|
runAsNonRoot: true
|
||||||
|
privileged: false
|
||||||
|
runAsUser: 100
|
||||||
|
runAsGroup: 101
|
||||||
|
args:
|
||||||
|
- "-in-cluster"
|
||||||
|
- "-in-cluster-context-name=main"
|
||||||
|
- "-plugins-dir=/headlamp/plugins"
|
||||||
|
ports:
|
||||||
|
- name: http
|
||||||
|
containerPort: 4466
|
||||||
|
protocol: TCP
|
||||||
|
readinessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /
|
||||||
|
port: http
|
||||||
|
initialDelaySeconds: 5
|
||||||
|
periodSeconds: 5
|
||||||
|
failureThreshold: 6
|
||||||
|
livenessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /
|
||||||
|
port: http
|
||||||
|
initialDelaySeconds: 10
|
||||||
|
periodSeconds: 10
|
||||||
|
volumeMounts:
|
||||||
|
- name: intel-gpu-plugin
|
||||||
|
mountPath: /headlamp/plugins/headlamp-intel-gpu
|
||||||
|
readOnly: true
|
||||||
|
volumes:
|
||||||
|
- name: intel-gpu-plugin
|
||||||
|
configMap:
|
||||||
|
name: headlamp-intel-gpu-plugin
|
||||||
|
---
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: ${E2E_RELEASE}
|
||||||
|
namespace: ${E2E_NAMESPACE}
|
||||||
|
labels:
|
||||||
|
app.kubernetes.io/name: headlamp
|
||||||
|
app.kubernetes.io/instance: ${E2E_RELEASE}
|
||||||
|
spec:
|
||||||
|
type: ClusterIP
|
||||||
|
selector:
|
||||||
|
app.kubernetes.io/name: headlamp
|
||||||
|
app.kubernetes.io/instance: ${E2E_RELEASE}
|
||||||
|
ports:
|
||||||
|
- name: http
|
||||||
|
port: 80
|
||||||
|
targetPort: http
|
||||||
|
protocol: TCP
|
||||||
|
EOF
|
||||||
|
|
||||||
|
echo "Waiting for rollout..."
|
||||||
|
kubectl rollout status "deployment/${E2E_RELEASE}" \
|
||||||
|
-n "$E2E_NAMESPACE" --timeout=120s
|
||||||
|
|
||||||
|
# --- Generate a service URL for tests ---
|
||||||
|
SVC_URL="http://${E2E_RELEASE}.${E2E_NAMESPACE}.svc.cluster.local"
|
||||||
|
|
||||||
|
# --- Wait for DNS and HTTP reachability ---
|
||||||
|
echo ""
|
||||||
|
echo "Waiting for ${SVC_URL} to be reachable..."
|
||||||
|
ATTEMPTS=0
|
||||||
|
MAX_ATTEMPTS=24 # 24 × 5s = 120s max
|
||||||
|
until curl -sf --max-time 5 "${SVC_URL}" -o /dev/null 2>/dev/null; do
|
||||||
|
ATTEMPTS=$((ATTEMPTS + 1))
|
||||||
|
if [ "$ATTEMPTS" -ge "$MAX_ATTEMPTS" ]; then
|
||||||
|
echo "ERROR: ${SVC_URL} not reachable after $((MAX_ATTEMPTS * 5))s" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo " [${ATTEMPTS}/${MAX_ATTEMPTS}] not yet reachable, retrying in 5s..."
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
echo ""
|
||||||
|
echo "E2E Headlamp is ready at: ${SVC_URL}"
|
||||||
|
echo " export HEADLAMP_URL=${SVC_URL}"
|
||||||
|
|
||||||
|
# --- Generate a token for test auth ---
|
||||||
|
echo ""
|
||||||
|
echo "Creating service account token for E2E auth..."
|
||||||
|
kubectl create serviceaccount headlamp-e2e-test \
|
||||||
|
-n "$E2E_NAMESPACE" --dry-run=client -o yaml | kubectl apply -f -
|
||||||
|
|
||||||
|
TOKEN=$(kubectl create token headlamp-e2e-test -n "$E2E_NAMESPACE" --duration=1h 2>/dev/null || echo "")
|
||||||
|
if [ -n "$TOKEN" ]; then
|
||||||
|
echo " export HEADLAMP_TOKEN=<generated>"
|
||||||
|
echo ""
|
||||||
|
echo "HEADLAMP_URL=${SVC_URL}" > "$REPO_ROOT/.env.e2e"
|
||||||
|
echo "HEADLAMP_TOKEN=${TOKEN}" >> "$REPO_ROOT/.env.e2e"
|
||||||
|
echo "Wrote .env.e2e with HEADLAMP_URL and HEADLAMP_TOKEN"
|
||||||
|
else
|
||||||
|
echo " WARNING: Could not generate token. Set HEADLAMP_TOKEN manually or use OIDC."
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "E2E deployment complete."
|
||||||
Executable
+38
@@ -0,0 +1,38 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# teardown-e2e-headlamp.sh
|
||||||
|
#
|
||||||
|
# Tears down the dedicated E2E Headlamp instance deployed by deploy-e2e-headlamp.sh.
|
||||||
|
#
|
||||||
|
# Environment:
|
||||||
|
# E2E_NAMESPACE — namespace to clean up (default: privilegedescalation-dev)
|
||||||
|
# E2E_RELEASE — release/resource name prefix (default: headlamp-e2e)
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||||||
|
|
||||||
|
E2E_NAMESPACE="${E2E_NAMESPACE:-privilegedescalation-dev}"
|
||||||
|
E2E_RELEASE="${E2E_RELEASE:-headlamp-e2e}"
|
||||||
|
|
||||||
|
echo "=== E2E Headlamp Teardown ==="
|
||||||
|
echo " Namespace: $E2E_NAMESPACE"
|
||||||
|
echo " Release: $E2E_RELEASE"
|
||||||
|
|
||||||
|
echo "Removing Headlamp Deployment, Service, and ServiceAccount..."
|
||||||
|
kubectl delete deployment "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
kubectl delete service "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
kubectl delete serviceaccount "${E2E_RELEASE}" -n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
|
||||||
|
echo "Cleaning up ConfigMap..."
|
||||||
|
kubectl delete configmap headlamp-intel-gpu-plugin -n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
|
||||||
|
echo "Cleaning up test service account..."
|
||||||
|
kubectl delete serviceaccount headlamp-e2e-test -n "$E2E_NAMESPACE" --ignore-not-found
|
||||||
|
|
||||||
|
# Clean up .env.e2e if present
|
||||||
|
if [ -f "$REPO_ROOT/.env.e2e" ]; then
|
||||||
|
rm "$REPO_ROOT/.env.e2e"
|
||||||
|
echo "Removed .env.e2e"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "E2E teardown complete."
|
||||||
@@ -151,27 +151,4 @@ describe('IntelGpuDataProvider', () => {
|
|||||||
expect(callCountAfter).toBeGreaterThan(callCountBefore);
|
expect(callCountAfter).toBeGreaterThan(callCountBefore);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it('treats a hanging CRD request as unavailable after 2s timeout', async () => {
|
|
||||||
vi.useFakeTimers();
|
|
||||||
const nodeWrapper = { jsonData: {} };
|
|
||||||
vi.mocked(K8s.ResourceClasses.Node.useList).mockReturnValue([[nodeWrapper], null] as any);
|
|
||||||
vi.mocked(K8s.ResourceClasses.Pod.useList).mockReturnValue([[nodeWrapper], null] as any);
|
|
||||||
vi.mocked(ApiProxy.request)
|
|
||||||
.mockReturnValueOnce(new Promise(() => {}))
|
|
||||||
.mockResolvedValueOnce({ items: [] })
|
|
||||||
.mockResolvedValueOnce({ items: [] })
|
|
||||||
.mockResolvedValueOnce({ items: [] });
|
|
||||||
|
|
||||||
const { result } = renderHook(() => useIntelGpuContext(), { wrapper: Wrapper });
|
|
||||||
|
|
||||||
expect(result.current.loading).toBe(true);
|
|
||||||
|
|
||||||
vi.advanceTimersByTime(2000);
|
|
||||||
await act(async () => {});
|
|
||||||
expect(result.current.crdAvailable).toBe(false);
|
|
||||||
expect(result.current.loading).toBe(false);
|
|
||||||
|
|
||||||
vi.useRealTimers();
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -69,18 +69,6 @@ export function useIntelGpuContext(): IntelGpuContextValue {
|
|||||||
// Helpers
|
// Helpers
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
const DEFAULT_REQUEST_TIMEOUT_MS = 2_000;
|
|
||||||
|
|
||||||
/** Wraps a promise with a timeout, rejecting if it doesn't settle within ms. */
|
|
||||||
function withTimeout<T>(promise: Promise<T>, ms: number): Promise<T> {
|
|
||||||
return Promise.race([
|
|
||||||
promise,
|
|
||||||
new Promise<T>((_, reject) =>
|
|
||||||
setTimeout(() => reject(new Error(`Request timed out after ${ms}ms`)), ms)
|
|
||||||
),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Extract raw Kubernetes JSON from Headlamp KubeObject wrappers. */
|
/** Extract raw Kubernetes JSON from Headlamp KubeObject wrappers. */
|
||||||
const extractJsonData = (items: unknown[]): unknown[] =>
|
const extractJsonData = (items: unknown[]): unknown[] =>
|
||||||
items.map(item =>
|
items.map(item =>
|
||||||
@@ -120,11 +108,8 @@ export function IntelGpuDataProvider({ children }: { children: React.ReactNode }
|
|||||||
try {
|
try {
|
||||||
// GpuDevicePlugin CRDs — graceful degradation if CRD not installed
|
// GpuDevicePlugin CRDs — graceful degradation if CRD not installed
|
||||||
try {
|
try {
|
||||||
const pluginList = await withTimeout(
|
const pluginList = await ApiProxy.request(
|
||||||
ApiProxy.request(
|
`/apis/${INTEL_DEVICE_PLUGIN_API_GROUP}/${INTEL_DEVICE_PLUGIN_API_VERSION}/gpudeviceplugins`
|
||||||
`/apis/${INTEL_DEVICE_PLUGIN_API_GROUP}/${INTEL_DEVICE_PLUGIN_API_VERSION}/gpudeviceplugins`
|
|
||||||
),
|
|
||||||
DEFAULT_REQUEST_TIMEOUT_MS
|
|
||||||
);
|
);
|
||||||
if (!cancelled && isKubeList(pluginList)) {
|
if (!cancelled && isKubeList(pluginList)) {
|
||||||
setCrdAvailable(true);
|
setCrdAvailable(true);
|
||||||
@@ -154,7 +139,7 @@ export function IntelGpuDataProvider({ children }: { children: React.ReactNode }
|
|||||||
|
|
||||||
for (const url of pluginPodSelectors) {
|
for (const url of pluginPodSelectors) {
|
||||||
try {
|
try {
|
||||||
const list = await withTimeout(ApiProxy.request(url), DEFAULT_REQUEST_TIMEOUT_MS);
|
const list = await ApiProxy.request(url);
|
||||||
if (!cancelled && isKubeList(list)) {
|
if (!cancelled && isKubeList(list)) {
|
||||||
const gpuPluginPods = filterIntelGpuPluginPods(list.items);
|
const gpuPluginPods = filterIntelGpuPluginPods(list.items);
|
||||||
foundPluginPods.push(...gpuPluginPods);
|
foundPluginPods.push(...gpuPluginPods);
|
||||||
|
|||||||
@@ -106,13 +106,11 @@ describe('MetricsPage', () => {
|
|||||||
vi.clearAllMocks();
|
vi.clearAllMocks();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('shows loader when ctxLoading=true but heading is visible immediately', () => {
|
it('shows loader when ctxLoading=true', () => {
|
||||||
vi.mocked(useIntelGpuContext).mockReturnValue(makeContext({ loading: true }));
|
vi.mocked(useIntelGpuContext).mockReturnValue(makeContext({ loading: true }));
|
||||||
// fetchGpuMetrics should never be called in loading state
|
// fetchGpuMetrics should never be called in loading state
|
||||||
vi.mocked(fetchGpuMetrics).mockResolvedValue(null);
|
vi.mocked(fetchGpuMetrics).mockResolvedValue(null);
|
||||||
render(<MetricsPage />);
|
render(<MetricsPage />);
|
||||||
// Heading renders immediately, loader appears below it while waiting for context
|
|
||||||
expect(screen.getByText('Intel GPU — Metrics')).toBeInTheDocument();
|
|
||||||
expect(screen.getByTestId('loader')).toHaveTextContent('Loading Intel GPU data...');
|
expect(screen.getByTestId('loader')).toHaveTextContent('Loading Intel GPU data...');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -230,6 +230,10 @@ export default function MetricsPage() {
|
|||||||
};
|
};
|
||||||
}, [ctxLoading, fetchSeq]);
|
}, [ctxLoading, fetchSeq]);
|
||||||
|
|
||||||
|
if (ctxLoading) {
|
||||||
|
return <Loader title="Loading Intel GPU data..." />;
|
||||||
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<div
|
<div
|
||||||
@@ -243,7 +247,7 @@ export default function MetricsPage() {
|
|||||||
<SectionHeader title="Intel GPU — Metrics" />
|
<SectionHeader title="Intel GPU — Metrics" />
|
||||||
<button
|
<button
|
||||||
onClick={() => void doFetch()}
|
onClick={() => void doFetch()}
|
||||||
disabled={fetching || ctxLoading}
|
disabled={fetching}
|
||||||
aria-label="Refresh metrics"
|
aria-label="Refresh metrics"
|
||||||
style={{
|
style={{
|
||||||
padding: '6px 16px',
|
padding: '6px 16px',
|
||||||
@@ -251,18 +255,15 @@ export default function MetricsPage() {
|
|||||||
color: 'var(--mui-palette-primary-main, #0071c5)',
|
color: 'var(--mui-palette-primary-main, #0071c5)',
|
||||||
border: '1px solid var(--mui-palette-primary-main, #0071c5)',
|
border: '1px solid var(--mui-palette-primary-main, #0071c5)',
|
||||||
borderRadius: '4px',
|
borderRadius: '4px',
|
||||||
cursor: fetching || ctxLoading ? 'not-allowed' : 'pointer',
|
cursor: 'pointer',
|
||||||
fontSize: '13px',
|
fontSize: '13px',
|
||||||
fontWeight: 500,
|
fontWeight: 500,
|
||||||
opacity: fetching || ctxLoading ? 0.6 : 1,
|
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
{fetching ? 'Refreshing…' : 'Refresh'}
|
{fetching ? 'Refreshing…' : 'Refresh'}
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{ctxLoading && <Loader title="Loading Intel GPU data..." />}
|
|
||||||
|
|
||||||
<MetricRequirements />
|
<MetricRequirements />
|
||||||
|
|
||||||
{fetching && !metrics && <Loader title="Querying Prometheus for GPU metrics..." />}
|
{fetching && !metrics && <Loader title="Querying Prometheus for GPU metrics..." />}
|
||||||
|
|||||||
Reference in New Issue
Block a user