Compare commits
33 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 45d5bf96a4 | |||
| 786f5b7398 | |||
| e4e08f236a | |||
| 0352f6cf39 | |||
| 3996b1e029 | |||
| 27d7bbf9a5 | |||
| d03c4f7b4d | |||
| 201c46c41b | |||
| 718a11f016 | |||
| d14f442893 | |||
| 110b4e6398 | |||
| 9b9c503521 | |||
| 1ba1a67f01 | |||
| 22b4bdeba0 | |||
| a10d274e71 | |||
| 8c256f9dc5 | |||
| 98e0cf7ea1 | |||
| cbf5ba4a2a | |||
| 1c5e50ce8c | |||
| b4e6cb9367 | |||
| 6459913304 | |||
| d9fec8b93c | |||
| dd2d942d39 | |||
| 8e9b2c2645 | |||
| ac3d9e87ca | |||
| ad99689f47 | |||
| 90623e32c7 | |||
| aeb762ff85 | |||
| a86fb9f596 | |||
| 079a96f7d2 | |||
| f6abc14a95 | |||
| 8f32bb3545 | |||
| f5fd03fe75 |
+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_call:
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
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
|
||||||
|
|||||||
@@ -1,18 +1,116 @@
|
|||||||
name: Dual Approval (CTO + QA)
|
name: Promotion Gate
|
||||||
|
|
||||||
# Calls the shared dual-approval-check workflow.
|
# dev PRs: no gate (engineer self-merges).
|
||||||
# Passes when both privilegedescalation-cto and privilegedescalation-qa
|
# uat PRs: QA approval required.
|
||||||
# have approved the PR. Add "Dual Approval (CTO + QA)" to required_status_checks
|
# main PRs: UAT approval required (uat→main promotions).
|
||||||
# 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: [main]
|
branches: [uat, main]
|
||||||
types: [opened, reopened, synchronize]
|
types: [opened, reopened, synchronize]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
dual-approval:
|
promotion-gate:
|
||||||
uses: privilegedescalation/.github/.github/workflows/dual-approval-check.yaml@main
|
name: Promotion Gate
|
||||||
secrets: inherit
|
runs-on: ubuntu-latest
|
||||||
|
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
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ on:
|
|||||||
description: 'Release version (e.g. 1.0.0)'
|
description: 'Release version (e.g. 1.0.0)'
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
repository_dispatch:
|
||||||
|
types: [release]
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
@@ -19,5 +21,6 @@ jobs:
|
|||||||
RELEASE_APP_ID: ${{ secrets.RELEASE_APP_ID }}
|
RELEASE_APP_ID: ${{ secrets.RELEASE_APP_ID }}
|
||||||
RELEASE_APP_PRIVATE_KEY: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
|
RELEASE_APP_PRIVATE_KEY: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
|
||||||
with:
|
with:
|
||||||
version: ${{ inputs.version }}
|
version: ${{ inputs.version || github.event.client_payload.version }}
|
||||||
upstream-repo: 'kube-vip/kube-vip'
|
upstream-repo: 'kube-vip/kube-vip'
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
name: Mend Renovate GitHub App Token
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
outputs:
|
||||||
|
token:
|
||||||
|
description: "Short-lived GitHub App installation token"
|
||||||
|
value: ${{ jobs.app-token.outputs.token }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
app-token:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
token: ${{ steps.app-token.outputs.token }}
|
||||||
|
steps:
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
id: app-token
|
||||||
|
uses: actions/create-github-app-token@v3
|
||||||
|
with:
|
||||||
|
app-id: ${{ secrets.RELEASE_APP_ID }}
|
||||||
|
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
name: Renovate
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 3 * * 0'
|
||||||
|
workflow_dispatch:
|
||||||
|
jobs:
|
||||||
|
renovate:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
id: app-token
|
||||||
|
uses: actions/create-github-app-token@v3
|
||||||
|
with:
|
||||||
|
app-id: ${{ secrets.RELEASE_APP_ID }}
|
||||||
|
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
|
||||||
|
- uses: renovatebot/github-action@v40.3.0
|
||||||
|
with:
|
||||||
|
token: ${{ steps.app-token.outputs.token }}
|
||||||
|
configurationFile: renovate.json
|
||||||
@@ -5,3 +5,9 @@ dist/
|
|||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
.eslintcache
|
.eslintcache
|
||||||
|
|
||||||
|
# E2E
|
||||||
|
e2e/.auth/
|
||||||
|
.env.e2e
|
||||||
|
playwright-report/
|
||||||
|
test-results/
|
||||||
|
|||||||
@@ -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/**
|
||||||
@@ -8,7 +8,7 @@ Headlamp plugin for kube-vip virtual IP and load balancer visibility. Read-only
|
|||||||
|
|
||||||
- **Plugin name**: `kube-vip`
|
- **Plugin name**: `kube-vip`
|
||||||
- **Target**: Headlamp >= v0.26
|
- **Target**: Headlamp >= v0.26
|
||||||
- **Data sources**: kube-vip DaemonSet/pods in `kube-system`, Services (type:LoadBalancer), Nodes, Leases, `kubevip` ConfigMap
|
- **Data sources**: kube-vip DaemonSet/pods in `headlamp`, Services (type:LoadBalancer), Nodes, Leases, `kubevip` ConfigMap
|
||||||
- **Reference plugin**: `../headlamp-polaris-plugin`
|
- **Reference plugin**: `../headlamp-polaris-plugin`
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
@@ -58,7 +58,7 @@ kube-vip uses **no CRDs**. All state comes from standard Kubernetes resources an
|
|||||||
|
|
||||||
## Key constants (src/api/k8s.ts)
|
## Key constants (src/api/k8s.ts)
|
||||||
|
|
||||||
- Namespace: `kube-system`
|
- Namespace: `headlamp`
|
||||||
- DaemonSet name: `kube-vip-ds`
|
- DaemonSet name: `kube-vip-ds`
|
||||||
- Cloud provider name: `kube-vip-cloud-provider`
|
- Cloud provider name: `kube-vip-cloud-provider`
|
||||||
- ConfigMap name: `kubevip`
|
- ConfigMap name: `kubevip`
|
||||||
|
|||||||
@@ -1,24 +0,0 @@
|
|||||||
# 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.*
|
|
||||||
@@ -17,10 +17,13 @@ A [Headlamp](https://headlamp.dev/) plugin providing visibility into [kube-vip](
|
|||||||
|
|
||||||
Search for `kube-vip` in the Headlamp Plugin Manager (Settings → Plugins → Catalog).
|
Search for `kube-vip` 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.26
|
- Headlamp >= v0.26
|
||||||
- kube-vip deployed in `kube-system` (DaemonSet or static pod)
|
- kube-vip deployed in `headlamp` (DaemonSet or static pod)
|
||||||
- Optional: kube-vip-cloud-provider for IP pool management
|
- Optional: kube-vip-cloud-provider for IP pool management
|
||||||
|
|
||||||
## RBAC
|
## RBAC
|
||||||
@@ -66,7 +69,7 @@ npm run lint # ESLint
|
|||||||
|
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
| "kube-vip Not Detected" | No kube-vip pods in kube-system | Install kube-vip per https://kube-vip.io/docs/installation/ |
|
| "kube-vip Not Detected" | No kube-vip pods in headlamp namespace | Install kube-vip per https://kube-vip.io/docs/installation/ |
|
||||||
| No IP pools shown | kubevip ConfigMap not found | Install kube-vip-cloud-provider |
|
| No IP pools shown | kubevip ConfigMap not found | Install kube-vip-cloud-provider |
|
||||||
| Services show "Pending" VIP | No IP pool configured or pool exhausted | Add IP ranges to kubevip ConfigMap |
|
| Services show "Pending" VIP | No IP pool configured or pool exhausted | Add IP ranges to kubevip ConfigMap |
|
||||||
| Leader shows "—" | No kube-vip leases found | Verify leader election is enabled (`vip_leaderelection=true`) |
|
| Leader shows "—" | No kube-vip leases found | Verify leader election is enabled (`vip_leaderelection=true`) |
|
||||||
|
|||||||
+29
-4
@@ -12,13 +12,38 @@ This plugin is **read-only**. It does not perform any write operations against t
|
|||||||
|
|
||||||
- Services (type: LoadBalancer)
|
- Services (type: LoadBalancer)
|
||||||
- Nodes
|
- Nodes
|
||||||
- Pods in `kube-system`
|
- Pods in `headlamp`
|
||||||
- DaemonSets in `kube-system`
|
- DaemonSets in `headlamp`
|
||||||
- Leases in `kube-system`
|
- Leases in `headlamp`
|
||||||
- ConfigMaps in `kube-system`
|
- ConfigMaps in `headlamp`
|
||||||
|
|
||||||
All data is fetched through Headlamp's built-in API proxy, which respects the user's existing RBAC permissions.
|
All data is fetched through Headlamp's built-in API proxy, which respects the user's existing RBAC permissions.
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
Please report security vulnerabilities by opening a private issue or emailing the maintainers directly.
|
Please report security vulnerabilities by opening a private issue or emailing the maintainers directly.
|
||||||
|
|
||||||
|
## Known Low-Severity Vulnerabilities
|
||||||
|
|
||||||
|
### GHSA-848j-6mx2-7j84 (elliptic)
|
||||||
|
|
||||||
|
**Severity:** High (but not exploitable in this plugin's context)
|
||||||
|
|
||||||
|
**Affected component:** `elliptic` (transitive, via `vite-plugin-node-polyfills` → `node-stdlib-browser` → `crypto-browserify` → `browserify-sign`)
|
||||||
|
|
||||||
|
**Description:** The elliptic library used in this plugin's development dependencies contains a prototype pollution vulnerability. This plugin is a **read-only** Headlamp plugin that never executes any cryptographic operations at runtime. The vulnerable code path requires:
|
||||||
|
- Use of `elliptic` curve operations on untrusted input, AND
|
||||||
|
- Ability for an attacker to influence the `elliptic` curve key generation input
|
||||||
|
|
||||||
|
Neither condition is met in this plugin's runtime context.
|
||||||
|
|
||||||
|
**Remediation:** No patched version of `elliptic` exists on npm. The current override in `package.json` (`"elliptic": ">=6.6.1"`) is a placeholder — no resolvable version satisfies this constraint.
|
||||||
|
|
||||||
|
**Risk acceptance rationale:**
|
||||||
|
1. Plugin has no write operations against the cluster
|
||||||
|
2. All data flows through Headlamp's API proxy with standard RBAC enforcement
|
||||||
|
3. The vulnerable dependency is only in the development/build toolchain, not runtime
|
||||||
|
4. No untrusted input can reach `elliptic` curve operations through this plugin
|
||||||
|
|
||||||
|
**Review date:** 2026-05-05
|
||||||
|
**Reviewed by:** Hugh Hackman (VP Engineering Operations)
|
||||||
|
|||||||
+5
-3
@@ -1,4 +1,4 @@
|
|||||||
version: "1.0.0"
|
version: "1.0.2"
|
||||||
name: headlamp-kube-vip
|
name: headlamp-kube-vip
|
||||||
displayName: kube-vip
|
displayName: kube-vip
|
||||||
createdAt: "2026-03-04T00:00:00Z"
|
createdAt: "2026-03-04T00:00:00Z"
|
||||||
@@ -25,11 +25,13 @@ maintainers:
|
|||||||
provider:
|
provider:
|
||||||
name: privilegedescalation
|
name: privilegedescalation
|
||||||
annotations:
|
annotations:
|
||||||
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-kube-vip-plugin/releases/download/v1.0.0/kube-vip-1.0.0.tar.gz"
|
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-kube-vip-plugin/releases/download/v1.0.2/kube-vip-1.0.2.tar.gz"
|
||||||
headlamp/plugin/archive-checksum: sha256:495288275f39ddcaeb9c5a9e5d870b4bdf83e27cfe1672fcd9aebcbda627722a
|
headlamp/plugin/archive-checksum: sha256:cb6b8b6d93a41c129304c57ed705cdafbcb4d6e7511ce5bad0aa05d5762c3fbf
|
||||||
headlamp/plugin/version-compat: ">=0.26"
|
headlamp/plugin/version-compat: ">=0.26"
|
||||||
headlamp/plugin/distro-compat: "in-cluster"
|
headlamp/plugin/distro-compat: "in-cluster"
|
||||||
changes:
|
changes:
|
||||||
|
- kind: changed
|
||||||
|
description: "Fix ArtifactHub checksum for v1.0.0 release tarball"
|
||||||
- kind: added
|
- kind: added
|
||||||
description: "v1.0.0 stable release"
|
description: "v1.0.0 stable release"
|
||||||
- kind: changed
|
- kind: changed
|
||||||
|
|||||||
@@ -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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
+6
-2
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "kube-vip",
|
"name": "kube-vip",
|
||||||
"version": "1.0.0",
|
"version": "1.0.2",
|
||||||
"description": "Headlamp plugin for kube-vip virtual IP and load balancer visibility",
|
"description": "Headlamp plugin for kube-vip virtual IP and load balancer visibility",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -12,6 +12,7 @@
|
|||||||
"homepage": "https://github.com/privilegedescalation/headlamp-kube-vip-plugin#readme",
|
"homepage": "https://github.com/privilegedescalation/headlamp-kube-vip-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",
|
||||||
@@ -30,7 +31,10 @@
|
|||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"tar": "^7.5.11",
|
"tar": "^7.5.11",
|
||||||
"undici": "^7.24.3"
|
"undici": "^7.24.3",
|
||||||
|
"lodash": ">=4.18.0",
|
||||||
|
"vite": ">=6.4.2",
|
||||||
|
"elliptic": ">=6.6.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@headlamp-k8s/eslint-config": "^0.6.0",
|
"@headlamp-k8s/eslint-config": "^0.6.0",
|
||||||
|
|||||||
Generated
+934
-851
File diff suppressed because it is too large
Load Diff
@@ -21,6 +21,7 @@ import {
|
|||||||
isEgressEnabled,
|
isEgressEnabled,
|
||||||
isKubeVipService,
|
isKubeVipService,
|
||||||
isPodReady,
|
isPodReady,
|
||||||
|
KUBE_VIP_NAMESPACE,
|
||||||
phaseToStatus,
|
phaseToStatus,
|
||||||
} from '../api/k8s';
|
} from '../api/k8s';
|
||||||
import { useKubeVipContext } from '../api/KubeVipDataContext';
|
import { useKubeVipContext } from '../api/KubeVipDataContext';
|
||||||
@@ -105,7 +106,9 @@ export default function OverviewPage() {
|
|||||||
{
|
{
|
||||||
name: 'Status',
|
name: 'Status',
|
||||||
value: (
|
value: (
|
||||||
<StatusLabel status="error">No kube-vip pods found in kube-system</StatusLabel>
|
<StatusLabel status="error">
|
||||||
|
No kube-vip pods found in {KUBE_VIP_NAMESPACE}
|
||||||
|
</StatusLabel>
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user