From 765f08186773b61918de55f231451f78e2688ce8 Mon Sep 17 00:00:00 2001 From: Chris Farhood Date: Thu, 12 Feb 2026 11:13:27 -0500 Subject: [PATCH] docs: standardize license to Apache-2.0 and update version references - Change license from MIT to Apache-2.0 across all documentation to match package.json - Update all version references from v0.3.4/v0.3.5 to v0.3.10 - Update tarball filenames from headlamp-polaris-plugin-*.tar.gz to polaris-0.3.10.tar.gz - Update README.md license badge - Update artifacthub-pkg.yml license field Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude Co-Authored-By: Happy --- CONTRIBUTING.md | 2 +- README.md | 10 +++++----- SECURITY.md | 2 +- artifacthub-pkg.yml | 2 +- docs/DEPLOYMENT.md | 2 +- docs/DOCUMENTATION_STANDARDIZATION_PLAN.md | 2 +- docs/TROUBLESHOOTING.md | 2 +- docs/deployment/helm.md | 4 ++-- docs/deployment/kubernetes.md | 4 ++-- docs/getting-started/installation.md | 2 +- docs/troubleshooting/common-issues.md | 2 +- 11 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7679d2f..521dd53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -454,4 +454,4 @@ For testing before stable release: ## License -By contributing, you agree that your contributions will be licensed under the MIT License. +By contributing, you agree that your contributions will be licensed under the Apache-2.0 License. diff --git a/README.md b/README.md index 6ddfbf8..a1c2160 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/polaris)](https://artifacthub.io/packages/headlamp/polaris/headlamp-polaris-plugin) [![CI](https://github.com/privilegedescalation/headlamp-polaris-plugin/actions/workflows/ci.yaml/badge.svg)](https://github.com/privilegedescalation/headlamp-polaris-plugin/actions/workflows/ci.yaml) [![E2E Tests](https://github.com/privilegedescalation/headlamp-polaris-plugin/actions/workflows/e2e.yaml/badge.svg)](https://github.com/privilegedescalation/headlamp-polaris-plugin/actions/workflows/e2e.yaml) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) A [Headlamp](https://headlamp.dev/) plugin that surfaces [Fairwinds Polaris](https://polaris.docs.fairwinds.com/) audit results directly in the Headlamp UI. @@ -62,7 +62,7 @@ config: pluginsManager: sources: - name: headlamp-polaris-plugin - url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz + 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: @@ -99,8 +99,8 @@ sidecars: 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.5/headlamp-polaris-plugin-0.3.5.tar.gz -tar xzf headlamp-polaris-plugin-0.3.5.tar.gz -C /headlamp/plugins/ +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 @@ -372,7 +372,7 @@ Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for: ## License -[MIT License](LICENSE) - see LICENSE file for details. +[Apache-2.0 License](LICENSE) - see LICENSE file for details. --- diff --git a/SECURITY.md b/SECURITY.md index a834eb6..122ccd8 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -355,4 +355,4 @@ When a security vulnerability is identified: ## License -This plugin is provided under the MIT License. See [LICENSE](LICENSE) for details. +This plugin is provided under the Apache-2.0 License. See [LICENSE](LICENSE) for details. diff --git a/artifacthub-pkg.yml b/artifacthub-pkg.yml index 5f00087..626ef2c 100644 --- a/artifacthub-pkg.yml +++ b/artifacthub-pkg.yml @@ -9,7 +9,7 @@ description: >- read-only via the Kubernetes service proxy to the Polaris dashboard. Requires a Role granting `get` on `services/proxy` for the `polaris-dashboard` service in the `polaris` namespace. -license: MIT +license: Apache-2.0 homeURL: "https://github.com/privilegedescalation/headlamp-polaris-plugin" category: security keywords: diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index dd53e39..dd716d5 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -113,7 +113,7 @@ data: plugin.yml: | - name: headlamp-polaris-plugin version: 0.3.4 - url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.4/headlamp-polaris-plugin-0.3.4.tar.gz + url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` ### Method 3: Volume Mount (Development) diff --git a/docs/DOCUMENTATION_STANDARDIZATION_PLAN.md b/docs/DOCUMENTATION_STANDARDIZATION_PLAN.md index fd3a057..b385736 100644 --- a/docs/DOCUMENTATION_STANDARDIZATION_PLAN.md +++ b/docs/DOCUMENTATION_STANDARDIZATION_PLAN.md @@ -54,7 +54,7 @@ README.md # Main entry point with badges, quick links CHANGELOG.md # Keep a Changelog format, semantic versioning CONTRIBUTING.md # Development workflow, branching, PR process SECURITY.md # Security model, vulnerability reporting, RBAC -LICENSE # MIT License +LICENSE # Apache-2.0 License package.json # Plugin metadata ``` diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index d46c9e8..ffacb18 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -572,7 +572,7 @@ kubectl get configmap headlamp-plugin-config -n kube-system -o yaml Expected format: ``` -https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz +https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` --- diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md index f5e2155..649e3f8 100644 --- a/docs/deployment/helm.md +++ b/docs/deployment/helm.md @@ -185,7 +185,7 @@ data: plugin.yml: | - name: headlamp-polaris-plugin version: 0.3.5 - url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz + url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` Apply ConfigMap then deploy Headlamp: @@ -373,7 +373,7 @@ kubectl -n kube-system edit configmap headlamp-plugin-config # Update version and URL: # version: 0.3.6 -# url: https://github.com/.../v0.3.6/headlamp-polaris-plugin-0.3.6.tar.gz +# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz # Restart deployment to trigger init container kubectl -n kube-system rollout restart deployment/headlamp diff --git a/docs/deployment/kubernetes.md b/docs/deployment/kubernetes.md index 9067f1d..01fcc6a 100644 --- a/docs/deployment/kubernetes.md +++ b/docs/deployment/kubernetes.md @@ -98,7 +98,7 @@ data: plugin.yml: | - name: headlamp-polaris-plugin version: 0.3.5 - url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz + url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` ### Headlamp Deployment with Plugin Init Container @@ -414,7 +414,7 @@ kubectl -n kube-system edit configmap headlamp-plugin-config # Update version and URL: # version: 0.3.6 -# url: https://github.com/.../v0.3.6/headlamp-polaris-plugin-0.3.6.tar.gz +# url: https://github.com/.../v0.3.6/polaris-0.3.10.tar.gz # Restart deployment to trigger init container kubectl -n kube-system rollout restart deployment/headlamp diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index fbcf73d..b6287d6 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -143,7 +143,7 @@ data: plugin.yml: | - name: headlamp-polaris-plugin version: 0.3.5 - url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz + url: https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` #### Apply Configuration diff --git a/docs/troubleshooting/common-issues.md b/docs/troubleshooting/common-issues.md index d46c9e8..ffacb18 100644 --- a/docs/troubleshooting/common-issues.md +++ b/docs/troubleshooting/common-issues.md @@ -572,7 +572,7 @@ kubectl get configmap headlamp-plugin-config -n kube-system -o yaml Expected format: ``` -https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.5/headlamp-polaris-plugin-0.3.5.tar.gz +https://github.com/privilegedescalation/headlamp-polaris-plugin/releases/download/v0.3.10/polaris-0.3.10.tar.gz ``` ---