privilegedescalation/headlamp-polaris-plugin
Archived
12
0
Fork 0
Code Issues 4 Pull Requests 3 Actions Packages Projects Releases 50 Wiki Activity

release: v0.7.2 #44

Closed
ghost wants to merge 2 commits from release/v0.7.2 into main
pull from: release/v0.7.2
merge into: privilegedescalation:main
Conversation 1 Commits 2 Files Changed 17
+73 -70
17 changed files with 73 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacthub-pkg.yml
+2 -2
View File
@@ -1,4 +1,4 @@
version: "0.7.0" version: "0.7.2"
name: headlamp-polaris name: headlamp-polaris
displayName: Polaris displayName: Polaris
createdAt: "2026-02-05T19:00:00Z" createdAt: "2026-02-05T19:00:00Z"
@@ -28,7 +28,7 @@ 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://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.7.2/headlamp-polaris-0.7.0.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:69b7adf74416d72580981387b1861e2b5fcf7f96ae9f0620f85f623f8b6dab56
headlamp/plugin/distro-compat: in-cluster headlamp/plugin/distro-compat: in-cluster
deployment/headlamp-static-plugin-values.yaml
+3 -3
View File
@@ -28,10 +28,10 @@ initContainers:
# Install polaris plugin # Install polaris plugin
echo "Installing polaris plugin..." echo "Installing polaris plugin..."
cd /headlamp/static-plugins cd /headlamp/static-plugins
npm pack headlamp-polaris-plugin@0.3.0 npm pack headlamp-polaris-plugin@0.7.2
tar -xzf headlamp-polaris-plugin-0.3.0.tgz tar -xzf headlamp-polaris-plugin-0.7.2.tgz
mv package headlamp-polaris-plugin mv package headlamp-polaris-plugin
rm headlamp-polaris-plugin-0.3.0.tgz rm headlamp-polaris-plugin-0.7.2.tgz
# Install other plugins # Install other plugins
npx --yes @headlamp-k8s/plugin@latest install \ npx --yes @headlamp-k8s/plugin@latest install \
deployment/polaris-rbac.yaml
+3
View File
@@ -22,6 +22,9 @@ subjects:
- kind: Group - kind: Group
name: system:authenticated name: system:authenticated
apiGroup: rbac.authorization.k8s.io apiGroup: rbac.authorization.k8s.io
- kind: ServiceAccount
name: headlamp
namespace: kube-system
roleRef: roleRef:
kind: Role kind: Role
name: polaris-dashboard-proxy-reader name: polaris-dashboard-proxy-reader
docs/DEPLOYMENT.md
+10 -10
View File
@@ -110,9 +110,9 @@ metadata:
namespace: kube-system namespace: kube-system
data: data:
plugin.yml: | plugin.yml: |
- name: headlamp-polaris-plugin - name: headlamp-polaris
version: 0.3.4 version: 0.3.4
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/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
### Method 3: Volume Mount (Development) ### Method 3: Volume Mount (Development)
@@ -136,7 +136,7 @@ volumeMounts:
readOnly: true readOnly: true
``` ```
Then manually place `headlamp-polaris-plugin/` in the host path. Then manually place `headlamp-polaris/` in the host path.
## Helm Integration ## Helm Integration
@@ -344,7 +344,7 @@ metadata:
name: polaris-proxy-reader name: polaris-proxy-reader
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
rules: rules:
- apiGroups: [''] - apiGroups: ['']
@@ -360,7 +360,7 @@ metadata:
name: headlamp-polaris-proxy name: headlamp-polaris-proxy
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
@@ -430,7 +430,7 @@ spec:
kubectl -n kube-system exec -it deployment/headlamp -- ls -la /headlamp/plugins/ kubectl -n kube-system exec -it deployment/headlamp -- ls -la /headlamp/plugins/
# Expected output: # Expected output:
# drwxr-xr-x headlamp-polaris-plugin/ # drwxr-xr-x headlamp-polaris/
``` ```
## Production Checklist ## Production Checklist
@@ -467,7 +467,7 @@ kubectl -n kube-system 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 -it deployment/headlamp -- ls -la /headlamp/plugins/headlamp-polaris-plugin/ kubectl -n kube-system exec -it deployment/headlamp -- ls -la /headlamp/plugins/headlamp-polaris/
# Expected: dist/, package.json present # Expected: dist/, package.json present
``` ```
@@ -475,7 +475,7 @@ kubectl -n kube-system exec -it deployment/headlamp -- ls -la /headlamp/plugins/
### UI Verification ### UI Verification
- [ ] Navigate to Headlamp → Settings → Plugins - [ ] Navigate to Headlamp → Settings → Plugins
- [ ] Plugin "headlamp-polaris-plugin" listed - [ ] Plugin "headlamp-polaris" listed
- [ ] Sidebar shows "Polaris" entry - [ ] Sidebar shows "Polaris" entry
- [ ] Click "Polaris" → Overview page loads - [ ] Click "Polaris" → Overview page loads
- [ ] Cluster score displays correctly - [ ] Cluster score displays correctly
@@ -498,7 +498,7 @@ kubectl -n kube-system exec -it deployment/headlamp -- ls -la /headlamp/plugins/
```bash ```bash
# Verify plugin files exist # Verify plugin files exist
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \ kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# Restart Headlamp # Restart Headlamp
kubectl -n kube-system rollout restart deployment/headlamp kubectl -n kube-system rollout restart deployment/headlamp
@@ -646,7 +646,7 @@ Polaris audit data may contain:
### Plugin Upgrade via Plugin Manager ### Plugin Upgrade via Plugin Manager
1. Navigate to Settings → Plugins 1. Navigate to Settings → Plugins
2. Find "headlamp-polaris-plugin" 2. Find "headlamp-polaris"
3. Click "Update" if new version available 3. Click "Update" if new version available
4. Refresh browser (Cmd+Shift+R / Ctrl+Shift+R) 4. Refresh browser (Cmd+Shift+R / Ctrl+Shift+R)
docs/DOCUMENTATION_STANDARDIZATION_PLAN.md
+1 -1
View File
@@ -1,7 +1,7 @@
# Documentation Standardization Plan # Documentation Standardization Plan
**Date**: 2026-02-12 **Date**: 2026-02-12
**Repositories**: headlamp-polaris-plugin, headlamp-sealed-secrets-plugin **Repositories**: headlamp-polaris, headlamp-sealed-secrets-plugin
**Goal**: Establish consistent documentation standards across Headlamp plugin projects **Goal**: Establish consistent documentation standards across Headlamp plugin projects
## Executive Summary ## Executive Summary
docs/README.md
+1 -1
View File
@@ -68,4 +68,4 @@ Production deployment guides:
--- ---
**Need help?** Open an issue on [GitHub](https://github.com/privilegedescalation/headlamp-polaris-plugin/issues) or check [CONTRIBUTING.md](../CONTRIBUTING.md) for development guidelines. **Need help?** Open an issue on [GitHub](https://github.com/privilegedescalation/headlamp-polaris/issues) or check [CONTRIBUTING.md](../CONTRIBUTING.md) for development guidelines.
docs/TROUBLESHOOTING.md
+8 -8
View File
@@ -36,7 +36,7 @@ This guide covers common issues encountered when using the Headlamp Polaris Plug
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin kubectl logs -n kube-system 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-X.Y.Z.tar.gz
# Plugin installed successfully # Plugin installed successfully
``` ```
@@ -44,7 +44,7 @@ kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
```bash ```bash
kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/ kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
# Should show: headlamp-polaris-plugin/ # Should show: headlamp-polaris/
``` ```
**2. JavaScript Cached by Browser** **2. JavaScript Cached by Browser**
@@ -297,7 +297,7 @@ Upgrade to v0.3.3 or later:
If manually installing, ensure plugin name matches `package.json`: If manually installing, ensure plugin name matches `package.json`:
```typescript ```typescript
registerPluginSettings('headlamp-polaris-plugin', PolarisSettings, true); registerPluginSettings('headlamp-polaris', PolarisSettings, true);
// NOT 'polaris' — must match package.json name // NOT 'polaris' — must match package.json name
``` ```
@@ -597,7 +597,7 @@ kubectl get configmap headlamp-plugin-config -n kube-system -o yaml
Expected format: Expected format:
``` ```
https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz https://github.com/privilegedescalation/headlamp-polaris/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
--- ---
@@ -649,7 +649,7 @@ ArtifactHub pulls metadata every 30 minutes. There is no webhook or push mechani
**Wait 30 minutes** after pushing a GitHub release, then check: **Wait 30 minutes** after pushing a GitHub release, then check:
``` ```
https://artifacthub.io/packages/headlamp/headlamp-polaris-plugin/headlamp-polaris-plugin https://artifacthub.io/packages/headlamp/headlamp-polaris/headlamp-polaris
``` ```
**Verify metadata**: **Verify metadata**:
@@ -683,7 +683,7 @@ If none of these solutions work, gather debugging information and open an issue:
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 kube-system deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris/package.json`
3. **Browser Console Output**: 3. **Browser Console Output**:
@@ -709,7 +709,7 @@ If none of these solutions work, gather debugging information and open an issue:
### Where to Get Help ### Where to Get Help
- **GitHub Issues**: [https://github.com/privilegedescalation/headlamp-polaris-plugin/issues](https://github.com/privilegedescalation/headlamp-polaris-plugin/issues) - **GitHub Issues**: [https://github.com/privilegedescalation/headlamp-polaris/issues](https://github.com/privilegedescalation/headlamp-polaris/issues)
- **GitHub Discussions**: [https://github.com/privilegedescalation/headlamp-polaris-plugin/discussions](https://github.com/privilegedescalation/headlamp-polaris-plugin/discussions) - **GitHub Discussions**: [https://github.com/privilegedescalation/headlamp-polaris/discussions](https://github.com/privilegedescalation/headlamp-polaris/discussions)
Include the debugging information above when opening an issue. Include the debugging information above when opening an issue.
docs/deployment/helm.md
+4 -4
View File
@@ -180,9 +180,9 @@ metadata:
namespace: kube-system namespace: kube-system
data: data:
plugin.yml: | plugin.yml: |
- name: headlamp-polaris-plugin - name: headlamp-polaris
version: 0.3.5 version: 0.3.5
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/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
Apply ConfigMap then deploy Headlamp: Apply ConfigMap then deploy Headlamp:
@@ -357,7 +357,7 @@ helm upgrade headlamp headlamp/headlamp \
### Upgrade Plugin (Plugin Manager Method) ### Upgrade Plugin (Plugin Manager Method)
1. Navigate to **Settings → Plugins** in Headlamp UI 1. Navigate to **Settings → Plugins** in Headlamp UI
2. Find "headlamp-polaris-plugin" 2. Find "headlamp-polaris"
3. Click **Update** if new version available 3. Click **Update** if new version available
4. Hard refresh browser (**Cmd+Shift+R** / **Ctrl+Shift+R**) 4. Hard refresh browser (**Cmd+Shift+R** / **Ctrl+Shift+R**)
@@ -386,7 +386,7 @@ helm get values headlamp -n kube-system
# Verify plugin files exist # Verify plugin files exist
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \ kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# 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 kube-system logs deployment/headlamp -c install-polaris-plugin
docs/deployment/kubernetes.md
+6 -6
View File
@@ -26,7 +26,7 @@ metadata:
name: polaris-proxy-reader name: polaris-proxy-reader
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
rules: rules:
- apiGroups: [''] - apiGroups: ['']
@@ -42,7 +42,7 @@ metadata:
name: headlamp-polaris-proxy name: headlamp-polaris-proxy
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
@@ -96,9 +96,9 @@ metadata:
app.kubernetes.io/component: plugin-config app.kubernetes.io/component: plugin-config
data: data:
plugin.yml: | plugin.yml: |
- name: headlamp-polaris-plugin - name: headlamp-polaris
version: 0.3.5 version: 0.3.5
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/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
### Headlamp Deployment with Plugin Init Container ### Headlamp Deployment with Plugin Init Container
@@ -256,7 +256,7 @@ kubectl -n kube-system logs deployment/headlamp -c install-plugins
# Verify plugin files exist # Verify plugin files exist
kubectl -n kube-system exec deployment/headlamp -c headlamp -- \ kubectl -n kube-system exec deployment/headlamp -c headlamp -- \
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# Expected output: # Expected output:
# drwxr-xr-x dist/ # drwxr-xr-x dist/
@@ -388,7 +388,7 @@ For GitOps with FluxCD:
apiVersion: kustomize.toolkit.fluxcd.io/v1 apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization kind: Kustomization
metadata: metadata:
name: headlamp-polaris-plugin name: headlamp-polaris
namespace: flux-system namespace: flux-system
spec: spec:
interval: 10m interval: 10m
docs/deployment/production.md
+3 -3
View File
@@ -70,14 +70,14 @@ kubectl -n kube-system 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 kube-system exec deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris/
# Expected: dist/, package.json present # Expected: dist/, package.json present
``` ```
### UI Verification ### UI Verification
- [ ] Navigate to **Settings → Plugins** - [ ] Navigate to **Settings → Plugins**
- [ ] Verify "headlamp-polaris-plugin" is listed with correct version - [ ] Verify "headlamp-polaris" is listed with correct version
- [ ] Sidebar shows "Polaris" entry - [ ] Sidebar shows "Polaris" entry
- [ ] Click **Polaris → Overview** - page loads successfully - [ ] Click **Polaris → Overview** - page loads successfully
- [ ] Cluster score gauge displays - [ ] Cluster score gauge displays
@@ -437,7 +437,7 @@ If Headlamp or plugin becomes unavailable:
```bash ```bash
kubectl -n kube-system exec deployment/headlamp -- \ kubectl -n kube-system exec deployment/headlamp -- \
ls /headlamp/plugins/headlamp-polaris-plugin/ ls /headlamp/plugins/headlamp-polaris/
``` ```
5. **Hard refresh browser:** 5. **Hard refresh browser:**
docs/getting-started/installation.md
+13 -13
View File
@@ -28,7 +28,7 @@ Before installation, ensure all [prerequisites](prerequisites.md) are met:
**Best for:** Production deployments, managed updates, ease of use **Best for:** Production deployments, managed updates, ease of use
The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin) and can be installed via the Headlamp Plugin Manager. The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris) and can be installed via the Headlamp Plugin Manager.
#### Via Headlamp UI #### Via Headlamp UI
@@ -125,9 +125,9 @@ metadata:
namespace: kube-system namespace: kube-system
data: data:
plugin.yml: | plugin.yml: |
- name: headlamp-polaris-plugin - name: headlamp-polaris
version: 0.3.5 version: 0.3.5
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/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
#### Apply Configuration #### Apply Configuration
@@ -145,7 +145,7 @@ helm upgrade --install headlamp headlamp/headlamp \
kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=headlamp --timeout=300s kubectl -n kube-system 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 kube-system exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris/
# Expected output: # Expected output:
# drwxr-xr-x dist/ # drwxr-xr-x dist/
@@ -163,13 +163,13 @@ Download the plugin tarball and extract it into Headlamp's plugin directory.
```bash ```bash
# Download latest release # Download latest release
VERSION=0.3.5 VERSION=0.3.5
wget https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v${VERSION}/headlamp-polaris-plugin-${VERSION}.tar.gz wget https://github.com/privilegedescalation/headlamp-polaris/releases/download/v${VERSION}/headlamp-polaris-${VERSION}.tar.gz
# Extract to plugin directory # Extract to plugin directory
tar xzf headlamp-polaris-plugin-${VERSION}.tar.gz -C /headlamp/plugins/ tar xzf headlamp-polaris-${VERSION}.tar.gz -C /headlamp/plugins/
# Verify extraction # Verify extraction
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# Expected output: # Expected output:
# drwxr-xr-x dist/ # drwxr-xr-x dist/
@@ -209,8 +209,8 @@ Clone the repository and build the plugin from source.
```bash ```bash
# Clone repository # Clone repository
git clone https://github.com/privilegedescalation/headlamp-polaris-plugin.git git clone https://github.com/privilegedescalation/headlamp-polaris.git
cd headlamp-polaris-plugin cd headlamp-polaris
# Install dependencies # Install dependencies
npm install npm install
@@ -302,7 +302,7 @@ kubectl -n kube-system wait --for=condition=ready pod -l app.kubernetes.io/name=
**UI Verification:** **UI Verification:**
1. Navigate to **Settings → Plugins** 1. Navigate to **Settings → Plugins**
2. Verify "headlamp-polaris-plugin" is listed 2. Verify "headlamp-polaris" is listed
3. Check version matches installed version 3. Check version matches installed version
4. Verify **Polaris** appears in sidebar 4. Verify **Polaris** appears in sidebar
5. Click **Polaris** → Overview page loads 5. Click **Polaris** → Overview page loads
@@ -312,7 +312,7 @@ 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 kube-system exec -it deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/headlamp-polaris/
# Expected output: # Expected output:
# drwxr-xr-x dist/ # drwxr-xr-x dist/
@@ -346,7 +346,7 @@ 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 kube-system exec deployment/headlamp -c headlamp -- \
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# Expected: dist/, package.json present # Expected: dist/, package.json present
@@ -419,4 +419,4 @@ kubectl -n kube-system rollout restart deployment/headlamp
- [Headlamp Plugin Documentation](https://headlamp.dev/docs/latest/development/plugins/) - [Headlamp Plugin Documentation](https://headlamp.dev/docs/latest/development/plugins/)
- [Headlamp Helm Chart](https://github.com/headlamp-k8s/headlamp/tree/main/charts/headlamp) - [Headlamp Helm Chart](https://github.com/headlamp-k8s/headlamp/tree/main/charts/headlamp)
- [Polaris Installation](https://polaris.docs.fairwinds.com/infrastructure-as-code/) - [Polaris Installation](https://polaris.docs.fairwinds.com/infrastructure-as-code/)
- [Artifact Hub Package](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin) - [Artifact Hub Package](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris)
docs/getting-started/quick-start.md
+3 -3
View File
@@ -87,7 +87,7 @@ EOF
1. **Check Plugin is Loaded:** 1. **Check Plugin is Loaded:**
- Go to **Settings → Plugins** - Go to **Settings → Plugins**
- Verify "headlamp-polaris-plugin" is listed - Verify "headlamp-polaris" is listed
2. **Check Sidebar:** 2. **Check Sidebar:**
@@ -112,7 +112,7 @@ EOF
```bash ```bash
# Verify plugin files exist # Verify plugin files exist
kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- \ kubectl -n kube-system exec -it deployment/headlamp -c headlamp -- \
ls /headlamp/plugins/headlamp-polaris-plugin/dist/ ls /headlamp/plugins/headlamp-polaris/dist/
# Expected output: # Expected output:
# main.js # main.js
@@ -186,7 +186,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 kube-system exec -it deployment/headlamp -c headlamp -- \
ls /headlamp/plugins/headlamp-polaris-plugin/ ls /headlamp/plugins/headlamp-polaris/
# If missing, reinstall via Headlamp UI or sidecar method # If missing, reinstall via Headlamp UI or sidecar method
docs/troubleshooting/README.md
+2 -2
View File
@@ -58,7 +58,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 kube-system exec deployment/headlamp -c headlamp -- \
ls -la /headlamp/plugins/headlamp-polaris-plugin/ ls -la /headlamp/plugins/headlamp-polaris/
# Expected output: # Expected output:
# drwxr-xr-x dist/ # drwxr-xr-x dist/
@@ -153,7 +153,7 @@ If the quick diagnosis doesn't resolve your issue:
- [Deployment Guide](../deployment/kubernetes.md) - [Deployment Guide](../deployment/kubernetes.md)
3. **Open a GitHub issue:** 3. **Open a GitHub issue:**
- [GitHub Issues](https://github.com/privilegedescalation/headlamp-polaris-plugin/issues) - [GitHub Issues](https://github.com/privilegedescalation/headlamp-polaris/issues)
- Include: Headlamp version, plugin version, error messages, logs - Include: Headlamp version, plugin version, error messages, logs
## References ## References
docs/troubleshooting/common-issues.md
+8 -8
View File
@@ -36,7 +36,7 @@ This guide covers common issues encountered when using the Headlamp Polaris Plug
kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin kubectl logs -n kube-system 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-X.Y.Z.tar.gz
# Plugin installed successfully # Plugin installed successfully
``` ```
@@ -44,7 +44,7 @@ kubectl logs -n kube-system deployment/headlamp -c headlamp-plugin
```bash ```bash
kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/ kubectl exec -n kube-system deployment/headlamp -c headlamp -- ls -la /headlamp/plugins/
# Should show: headlamp-polaris-plugin/ # Should show: headlamp-polaris/
``` ```
**2. JavaScript Cached by Browser** **2. JavaScript Cached by Browser**
@@ -297,7 +297,7 @@ Upgrade to v0.3.3 or later:
If manually installing, ensure plugin name matches `package.json`: If manually installing, ensure plugin name matches `package.json`:
```typescript ```typescript
registerPluginSettings('headlamp-polaris-plugin', PolarisSettings, true); registerPluginSettings('headlamp-polaris', PolarisSettings, true);
// NOT 'polaris' — must match package.json name // NOT 'polaris' — must match package.json name
``` ```
@@ -597,7 +597,7 @@ kubectl get configmap headlamp-plugin-config -n kube-system -o yaml
Expected format: Expected format:
``` ```
https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz https://github.com/privilegedescalation/headlamp-polaris/releases/download/v0.3.10/polaris-0.3.10.tar.gz
``` ```
--- ---
@@ -649,7 +649,7 @@ ArtifactHub pulls metadata every 30 minutes. There is no webhook or push mechani
**Wait 30 minutes** after pushing a GitHub release, then check: **Wait 30 minutes** after pushing a GitHub release, then check:
``` ```
https://artifacthub.io/packages/headlamp/headlamp-polaris-plugin/headlamp-polaris-plugin https://artifacthub.io/packages/headlamp/headlamp-polaris/headlamp-polaris
``` ```
**Verify metadata**: **Verify metadata**:
@@ -683,7 +683,7 @@ If none of these solutions work, gather debugging information and open an issue:
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 kube-system deployment/headlamp -c headlamp -- cat /headlamp/plugins/headlamp-polaris/package.json`
3. **Browser Console Output**: 3. **Browser Console Output**:
@@ -709,7 +709,7 @@ If none of these solutions work, gather debugging information and open an issue:
### Where to Get Help ### Where to Get Help
- **GitHub Issues**: [https://github.com/privilegedescalation/headlamp-polaris-plugin/issues](https://github.com/privilegedescalation/headlamp-polaris-plugin/issues) - **GitHub Issues**: [https://github.com/privilegedescalation/headlamp-polaris/issues](https://github.com/privilegedescalation/headlamp-polaris/issues)
- **GitHub Discussions**: [https://github.com/privilegedescalation/headlamp-polaris-plugin/discussions](https://github.com/privilegedescalation/headlamp-polaris-plugin/discussions) - **GitHub Discussions**: [https://github.com/privilegedescalation/headlamp-polaris/discussions](https://github.com/privilegedescalation/headlamp-polaris/discussions)
Include the debugging information above when opening an issue. Include the debugging information above when opening an issue.
docs/user-guide/rbac-permissions.md
+2 -2
View File
@@ -35,7 +35,7 @@ metadata:
name: polaris-proxy-reader name: polaris-proxy-reader
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
rules: rules:
- apiGroups: [''] - apiGroups: ['']
@@ -60,7 +60,7 @@ metadata:
name: headlamp-polaris-proxy name: headlamp-polaris-proxy
namespace: polaris namespace: polaris
labels: labels:
app.kubernetes.io/name: headlamp-polaris-plugin app.kubernetes.io/name: headlamp-polaris
app.kubernetes.io/component: rbac app.kubernetes.io/component: rbac
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
package-lock.json
Generated
+3 -3
View File
@@ -1,12 +1,12 @@
{ {
"name": "headlamp-polaris", "name": "headlamp-polaris",
"version": "0.7.1", "version": "0.7.2",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "headlamp-polaris", "name": "headlamp-polaris",
"version": "0.7.1", "version": "0.7.2",
"license": "Apache-2.0", "license": "Apache-2.0",
"devDependencies": { "devDependencies": {
"@kinvolk/headlamp-plugin": "^0.13.0", "@kinvolk/headlamp-plugin": "^0.13.0",
@@ -14990,7 +14990,7 @@
} }
}, },
"node_modules/rrweb-cssom": { "node_modules/rrweb-cssom": {
"version": "0.7.1", "version": "0.7.2",
"resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.7.1.tgz", "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.7.1.tgz",
"integrity": "sha512-TrEMa7JGdVm0UThDJSx7ddw5nVm3UJS9o9CCIZ72B1vSyEZoziDqBYP3XIoi/12lKrJR8rE3jeFHMok2F/Mnsg==", "integrity": "sha512-TrEMa7JGdVm0UThDJSx7ddw5nVm3UJS9o9CCIZ72B1vSyEZoziDqBYP3XIoi/12lKrJR8rE3jeFHMok2F/Mnsg==",
"dev": true, "dev": true,
package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "headlamp-polaris", "name": "headlamp-polaris",
"version": "0.7.1", "version": "0.7.2",
"description": "Headlamp plugin for Fairwinds Polaris audit results", "description": "Headlamp plugin for Fairwinds Polaris audit results",
"repository": { "repository": {
"type": "git", "type": "git",