strimzi-headlamp 0.3.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Angelo Cesaro
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,396 @@
+# Strimzi Headlamp Plugin
+
+A Headlamp plugin for managing Strimzi (Apache Kafka on Kubernetes) resources directly from the Headlamp UI.
+
+## ✨ Features
+
+- **Kafka Clusters**: View Kafka cluster resources with KRaft/ZooKeeper mode detection
+- **Kafka Topics**: Full CRUD operations (Create, Read, Update, Delete)
+  - Create topics with custom partitions, replicas, retention, and compression
+  - Edit topic configurations (partitions, replicas, retention, min ISR)
+  - Delete topics with confirmation
+- **Kafka Users**: Complete user management with security
+  - Create users with SCRAM-SHA-512 or TLS authentication
+  - Configure ACLs for fine-grained authorization
+  - View passwords and certificates (secrets)
+  - Delete users with confirmation
+- **Search & Filter**: Real-time search and advanced filtering on all lists
+  - Filter by status, mode, authentication type, partitions, replicas, and more
+- Real-time status monitoring for all Strimzi resources
+- Multi-namespace support - view resources across all namespaces
+
+## 📋 Prerequisites
+
+- [Headlamp](https://headlamp.dev/) installed
+- A Kubernetes cluster with [Strimzi operator](https://strimzi.io/) deployed
+
+## 🚀 Quick Start
+
+### Install the Plugin
+
+#### 📦 Install from npm
+
+```bash
+npm install strimzi-headlamp
+```
+
+#### 💾 Manual Installation
+
+1. Download the latest release package (.tar.gz file)
+2. Extract the plugin to your Headlamp plugins directory:
+
+**macOS:**
+```bash
+mkdir -p ~/Library/Application\ Support/Headlamp/plugins/strimzi
+tar -xzf headlamp-k8s-strimzi-*.tar.gz -C ~/Library/Application\ Support/Headlamp/plugins/strimzi --strip-components=1
+```
+
+**Linux:**
+```bash
+mkdir -p ~/.config/Headlamp/plugins/strimzi
+tar -xzf headlamp-k8s-strimzi-*.tar.gz -C ~/.config/Headlamp/plugins/strimzi --strip-components=1
+```
+
+3. Restart Headlamp
+
+#### Using Headlamp Server
+
+```bash
+headlamp-server -plugins-dir=/path/to/extracted/plugin
+```
+
+## 🛠️ Development
+
+### Building the Plugin
+
+```bash
+# Install dependencies
+npm install
+
+# Build the plugin
+npm run build
+```
+
+The build creates a `dist/` directory with:
+- `main.js` - Plugin entry point (required by Headlamp)
+
+### Testing
+
+```bash
+# Run all tests
+npm run test
+
+# Run tests in watch mode
+npm run test -- --watch
+
+# Run tests with coverage
+npm run test -- --coverage
+```
+
+Tests are written using Vitest and cover utility functions and CRD helpers.
+
+### Packaging the Plugin
+
+To create a distributable package with all required files:
+
+```bash
+npm run package
+```
+
+This creates a tarball `headlamp-k8s-strimzi-<version>.tar.gz` containing:
+- `strimzi-headlamp/main.js` - Compiled plugin
+- `strimzi-headlamp/package.json` - Plugin metadata
+
+### Testing Locally
+
+#### Method 1: Using Headlamp Desktop App
+
+1. Build the plugin:
+   ```bash
+   npm run build
+   ```
+
+2. Install to Headlamp's plugins directory:
+
+   **macOS:**
+   ```bash
+   mkdir -p ~/Library/Application\ Support/Headlamp/plugins/strimzi
+   cp -r dist/* ~/Library/Application\ Support/Headlamp/plugins/strimzi/
+
+   # Create package.json (required)
+   cat > ~/Library/Application\ Support/Headlamp/plugins/strimzi/package.json << 'EOF'
+   {
+     "name": "strimzi-headlamp",
+     "version": "0.1.0",
+     "main": "main.js"
+   }
+   EOF
+   ```
+
+   **Linux:**
+   ```bash
+   mkdir -p ~/.config/Headlamp/plugins/strimzi
+   cp -r dist/* ~/.config/Headlamp/plugins/strimzi/
+
+   # Create package.json (required)
+   cat > ~/.config/Headlamp/plugins/strimzi/package.json << 'EOF'
+   {
+     "name": "strimzi-headlamp",
+     "version": "0.1.0",
+     "main": "main.js"
+   }
+   EOF
+   ```
+
+3. Restart Headlamp completely (quit and reopen)
+
+**Required structure:**
+```
+plugins/strimzi/
+├── main.js          # Entry point (required)
+├── package.json     # Plugin metadata (required)
+├── components/      # Compiled components
+└── other files...
+```
+
+### Method 2: Using Headlamp in Development Mode
+
+If you have Headlamp's source code:
+
+```bash
+# In Headlamp's repository
+cd headlamp
+
+# Set the plugins directory to your plugin's dist folder
+export HEADLAMP_PLUGINS_DIR=/path/to/strimzi-headlamp/dist
+
+# Start Headlamp in development mode
+make run-frontend
+```
+
+### Method 3: Using Headlamp Server with Plugin Directory
+
+```bash
+# Build your plugin
+npm run build
+
+# Run Headlamp server with plugins directory
+headlamp-server -plugins-dir=/path/to/strimzi-headlamp/dist
+```
+
+### Method 4: Deploy Headlamp to Kubernetes (Docker Desktop)
+
+Deploy Headlamp with the Strimzi plugin directly to your Kubernetes cluster.
+
+**Step 1: Build and package the plugin**
+```bash
+npm run build
+npm run package
+
+# Extract to plugins directory
+mkdir -p plugins
+tar -xzf headlamp-k8s-strimzi-*.tar.gz -C plugins/
+```
+
+**Step 2: Update the manifest path**
+
+Edit `deploy/headlamp.yaml` and update the hostPath to your plugins directory:
+```yaml
+volumes:
+  - name: plugins
+    hostPath:
+      path: /path/to/your/strimzi-headlamp/plugins  # Update this path
+      type: Directory
+```
+
+**Step 3: Deploy**
+```bash
+kubectl apply -f deploy/headlamp.yaml
+
+# Generate authentication token (valid 24h)
+kubectl -n headlamp create token headlamp --duration=24h
+```
+
+**Step 4: Access Headlamp**
+- URL: http://localhost:30080
+- Use the generated token to authenticate
+
+**Alternative: Use port-forward**
+```bash
+kubectl port-forward -n headlamp svc/headlamp 8080:80
+# Access at http://localhost:8080
+```
+
+**Updating the plugin:**
+```bash
+# Rebuild and repackage
+npm run build && npm run package
+
+# Remove old version and extract new
+rm -rf plugins/strimzi-headlamp
+tar -xzf headlamp-k8s-strimzi-*.tar.gz -C plugins/
+
+# Restart Headlamp deployment
+kubectl rollout restart deployment/headlamp -n headlamp
+
+# Clear browser cache: Cmd+Shift+R (macOS) or Ctrl+Shift+R (Linux)
+```
+
+To uninstall: `kubectl delete -f deploy/headlamp.yaml`
+
+## 📊 Supported Strimzi Resources
+
+### Kafka (kafka.strimzi.io/v1beta2)
+- View Kafka cluster status and configuration
+- Monitor replicas and versions
+- Check listener addresses and connection details
+- KRaft and ZooKeeper mode detection
+
+### KafkaTopic (kafka.strimzi.io/v1beta2)
+- **Create** topics with configurable:
+  - Partitions and replicas
+  - Retention period
+  - Compression type (gzip, snappy, lz4, zstd, producer)
+  - Min in-sync replicas
+- **Edit** existing topic configurations
+- **Delete** topics with confirmation dialog
+- View partition and replica counts
+- Monitor topic status (Ready/Not Ready)
+
+### KafkaUser (kafka.strimzi.io/v1beta2)
+- **Create** users with:
+  - SCRAM-SHA-512 or TLS authentication
+  - Simple ACL authorization with custom rules
+  - Support for topic, group, and cluster resources
+- **View secrets**: Display passwords (SCRAM) or certificates/keys (TLS)
+- **Delete** users with confirmation dialog
+- Monitor user status (Ready/Not Ready)
+- View authentication and authorization types
+
+
+## 📁 Plugin Structure
+
+```
+strimzi-headlamp/
+├── src/
+│   ├── components/       # React components for UI
+│   ├── crds.ts          # Strimzi CRD definitions
+│   └── index.tsx        # Plugin entry point
+├── deploy/              # Kubernetes manifests
+│   └── headlamp.yaml    # Headlamp deployment
+├── dist/                # Build output
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## 🚀 Releases and Versioning
+
+This project uses semantic versioning (MAJOR.MINOR.PATCH) and GitHub Actions for automated releases.
+
+### Creating a New Release
+
+**Important:** Always create releases from the `main` branch after merging your PR and ensuring all checks pass.
+
+**Step 1: Merge your changes**
+```bash
+# Create feature branch, make changes, commit
+git checkout -b feature/my-changes
+# ... make changes ...
+git add .
+git commit -m "feat: description"
+git push origin feature/my-changes
+
+# Create PR, wait for tests to pass, then merge to main
+```
+
+**Step 2: Create release from main**
+```bash
+# Switch to main branch
+git checkout main
+git pull origin main
+
+# Run npm version (automatically creates commit + tag)
+npm version patch  # 0.1.0 → 0.1.1 (bug fixes)
+npm version minor  # 0.1.0 → 0.2.0 (new features)
+npm version major  # 0.1.0 → 1.0.0 (breaking changes)
+```
+
+The `npm version` command automatically:
+- Updates `package.json` version
+- Creates a git commit with the version number
+- Creates a git tag (e.g., `v0.1.1`)
+
+**Step 3: Push to trigger release workflow**
+```bash
+git push origin main
+git push origin v0.1.1  # Push the tag created by npm version
+```
+
+**Step 4: Automated workflow runs**
+
+The `release.yml` workflow automatically:
+- ✅ Verifies package.json version matches tag version
+- ✅ Runs tests and linter
+- ✅ Builds the plugin
+- ✅ Creates `.tar.gz` package
+- ✅ Calculates SHA-256 checksum
+- ✅ Creates GitHub Release with artifacts
+- ✅ Publishes to npm (if `NPM_TOKEN` secret is configured)
+
+### Version Verification
+
+The release workflow enforces version consistency. If `package.json` version doesn't match the git tag, the workflow fails:
+
+```bash
+# Tag: v0.1.1
+# package.json: "version": "0.1.1"  ✅ Match - workflow succeeds
+
+# Tag: v0.1.1
+# package.json: "version": "0.1.0"  ❌ Mismatch - workflow fails
+```
+
+### NPM Publishing (Optional)
+
+To enable automatic npm publishing:
+
+1. Generate npm token at https://www.npmjs.com/settings/tokens
+2. Add `NPM_TOKEN` as repository secret in GitHub Settings → Secrets
+3. The workflow will automatically publish on release
+
+If `NPM_TOKEN` is not configured, the workflow skips npm publishing (no error).
+
+## 📦 Publishing to npm
+
+This plugin is published to npm for easy installation:
+
+```bash
+# Login to npm (first time only)
+npm login
+
+# Build the plugin
+npm run build
+
+# Publish to npm
+npm publish --access public
+```
+
+The `files` field in `package.json` ensures only these are published:
+- `dist/**/*` (compiled JavaScript)
+- `README.md`
+- `LICENSE`
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Developed on 🌎
+
+## 📚 Resources
+
+- [Strimzi Documentation](https://strimzi.io/documentation/)
+- [Headlamp Plugin Development](https://headlamp.dev/docs/latest/development/plugins/)
+- [Apache Kafka](https://kafka.apache.org/)
+