Fix install docs and archive URL to use GitHub (from QA review)
- Restore install as multi-line Markdown guide (was replaced by url/digest object) - Point annotations.archive-url to github.com instead of git.farh.net
This commit is contained in:
committed by
Gandalf the Greybeard [agent]
parent
639e4eaa68
commit
791935947d
+25
-4
@@ -23,9 +23,30 @@ links:
|
|||||||
url: https://github.com/privilegedescalation/headlamp-polaris-plugin
|
url: https://github.com/privilegedescalation/headlamp-polaris-plugin
|
||||||
- name: Polaris
|
- name: Polaris
|
||||||
url: https://polaris.docs.fairwinds.com/
|
url: https://polaris.docs.fairwinds.com/
|
||||||
install:
|
install: |
|
||||||
url: https://git.farh.net/privilegedescalation/headlamp-polaris-plugin/releases/download/v1.0.1/headlamp-polaris-1.0.1.tar.gz
|
## Installation
|
||||||
digest: sha256:1e05d079c7032cf55ebde85e116cb65b686d207f4b6a3b0f716f0af93f933e7e
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
1. [Headlamp](https://headlamp.dev) v0.26.0 or later
|
||||||
|
2. [Fairwinds Polaris](https://polaris.docs.fairwinds.com/) installed and the dashboard running in your cluster
|
||||||
|
|
||||||
|
### Install via Headlamp Plugin Catalog
|
||||||
|
|
||||||
|
1. Open Headlamp and navigate to **Settings → Plugin Catalog**
|
||||||
|
2. Search for **"Polaris"**
|
||||||
|
3. Click **Install** and restart Headlamp when prompted
|
||||||
|
|
||||||
|
The plugin is sourced directly from [ArtifactHub](https://artifacthub.io/packages/headlamp/headlamp/headlamp-polaris).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
After installation, the Polaris plugin adds:
|
||||||
|
- A **cluster score badge** in the Headlamp app bar
|
||||||
|
- A **Polaris** section in the sidebar with the full dashboard and namespace drill-downs
|
||||||
|
- An **inline audit panel** on Deployment, StatefulSet, DaemonSet, Job, and CronJob detail pages
|
||||||
|
|
||||||
|
For more information, see the [README](https://github.com/privilegedescalation/headlamp-polaris-plugin/blob/main/README.md).
|
||||||
changes:
|
changes:
|
||||||
- kind: security
|
- kind: security
|
||||||
description: Patched 8 npm audit vulnerabilities via pnpm.overrides
|
description: Patched 8 npm audit vulnerabilities via pnpm.overrides
|
||||||
@@ -54,7 +75,7 @@ maintainers:
|
|||||||
- name: privilegedescalation
|
- name: privilegedescalation
|
||||||
email: chris@farhood.org
|
email: chris@farhood.org
|
||||||
annotations:
|
annotations:
|
||||||
headlamp/plugin/archive-url: https://git.farh.net/privilegedescalation/headlamp-polaris-plugin/releases/download/v1.0.1/headlamp-polaris-1.0.1.tar.gz
|
headlamp/plugin/archive-url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v1.0.1/headlamp-polaris-1.0.1.tar.gz
|
||||||
headlamp/plugin/version-compat: '>=0.26'
|
headlamp/plugin/version-compat: '>=0.26'
|
||||||
headlamp/plugin/archive-checksum: sha256:1e05d079c7032cf55ebde85e116cb65b686d207f4b6a3b0f716f0af93f933e7e
|
headlamp/plugin/archive-checksum: sha256:1e05d079c7032cf55ebde85e116cb65b686d207f4b6a3b0f716f0af93f933e7e
|
||||||
headlamp/plugin/distro-compat: in-cluster,web,desktop
|
headlamp/plugin/distro-compat: in-cluster,web,desktop
|
||||||
|
|||||||
Reference in New Issue
Block a user