From d64db24240a23e74fdf613563573f1edd5d55d1c Mon Sep 17 00:00:00 2001 From: "gandalf-the-greybeard[bot]" <266323920+gandalf-the-greybeard[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 17:04:35 +0000 Subject: [PATCH] docs: remove manual install sections from README ArtifactHub plugin installer is the only supported installation method. Remove sidecar, manual tarball, and build-from-source install options to align documentation with company policy. Co-authored-by: Gandalf the Greybeard Co-authored-by: Paperclip --- README.md | 59 +++++++------------------------------------------------ 1 file changed, 7 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 35ca4d4..d73104f 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,14 @@ Polaris must be deployed in the `polaris` namespace with the dashboard component ## Installing -### Option 1: Headlamp Plugin Manager (Recommended) +The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin). Install via the Headlamp UI: -The plugin is published on [Artifact Hub](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin). Configure Headlamp via Helm: +1. Go to **Settings → Plugins** +2. Click **Catalog** tab +3. Search for "Polaris" +4. Click **Install** + +Or configure Headlamp via Helm: ```yaml config: @@ -62,56 +67,6 @@ pluginsManager: url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` -Or install via the Headlamp UI: - -1. Go to **Settings → Plugins** -2. Click **Catalog** tab -3. Search for "Polaris" -4. Click **Install** - -### Option 2: Sidecar Container (Alternative) - -For detailed sidecar installation instructions, see [docs/DEPLOYMENT.md#installation-method-2-sidecar-container](docs/DEPLOYMENT.md#installation-method-2-sidecar-container). - -```yaml -sidecars: - - name: headlamp-plugin - image: node:lts-alpine - command: ['/bin/sh'] - args: - - -c - - | - npm install -g @kinvolk/headlamp-plugin - headlamp-plugin install --config /config/plugin.yml - tail -f /dev/null - volumeMounts: - - name: plugins - mountPath: /headlamp/plugins - - name: plugin-config - mountPath: /config -``` - -### Option 3: Manual Tarball Install - -Download the `.tar.gz` from the [GitHub releases page](https://github.com/privilegedescalation/headlamp-polaris-plugin/releases), then extract into Headlamp's plugin directory: - -```bash -wget https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz -tar xzf polaris-0.3.10.tar.gz -C /headlamp/plugins/ -``` - -### Option 4: Build from Source - -```bash -git clone https://github.com/privilegedescalation/headlamp-polaris-plugin.git -cd headlamp-polaris-plugin -npm install -npm run build -npx @kinvolk/headlamp-plugin extract . /headlamp/plugins -``` - -For complete installation instructions including Helm integration, FluxCD examples, and production deployment checklist, see **[docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)**. - ## RBAC / Security Setup The plugin fetches audit data through the Kubernetes API server's **service proxy** sub-resource. The identity making the request (Headlamp's service account, or the user's own token in token-auth mode) must be granted: