headlamp-plugin 0.10.0

For those making Headlamp plugins, a new release of the headlamp-plugin tool.

• Latest packages and types matching the Headlamp 0.26.0 release
• New eslint and typescript matching Headlamp
• New package command for creating packages for publishing on artifact hub
• Uses vitest instead of jest
• We attempt to keep backwards and forwards compatibility with plugins, and provide an upgrade command to help migrate code where we can

Upgrading your plugin

To upgrade your plugin from within your plugin folder (after first backing up your folder...) do:

npx @kinvolk/headlamp-plugin ugprade .

  headlamp-plugin upgrade [package]      Upgrade the plugin to latest
  <skip-package-updates>                    headlamp-plugin; audits, formats,
  <headlamp-plugin-version>                 lints and type checks.<package>
                                            defaults to current working
                                            directory. Can also be a folder of
                                            packages.

New package command

To create a package .tar.gz file and print a checksum use the package command:

npm install
npm run build
npx @kinvolk/headlamp-plugin package
Copying "/home/user/dev/headlamp/plugins/examples/app-menus/dist/main.js" to "/tmp/headlamp-plugin-mDMZia/app-menus/main.js".
Copying "/home/user/dev/headlamp/plugins/examples/app-menus/package.json" to "/tmp/headlamp-plugin-mDMZia/app-menus/package.json".
Created tarball: "/home/rene/dev/headlamp/plugins/examples/app-menus/app-menus-0.0.1.tar.gz".
Tarball checksum (sha256): 5772251744730c823046873d8cf3d8b0a9dc372c7c69e97aad00d48afd301d3d

  headlamp-plugin package [pluginPath]   Creates a tarball of the plugin
  [outputDir]                               package in the format Headlamp
                                            expects.

0.26.0

✨ Enhancements:

• Add brand new Map view of a cluster (beta)
  • Allows users to view a graph representation of the cluster, at the desired zoom level
  • Errors are indicated in the map view which allows for a quick identification of resources needing attention
  • Users can select different resources for a more detailed and relational view
  • Allows searching and filtering cluster resources by different criteria
  • Allows to open resource details in the same view, without having to navigate to a new page
• Make the app snappier by adding a new caching layer for requests as
  this avoids requesting the same data multiple times
• Allow doing common actions (edit, view, remove) directly in resource list's rows to avoid
  having to go into the details view to perform them (thanks to @farodin91 )
• Unify general, cluster, and plugin settings under the same section, preventing the confusion of having
  different and separate settings views
• Move Custom Resources sidebar item to the top level, to highlight this section
• Update Headlamp logo to the new one
• Helm: Add change ClusterRole option + docs (thanks to @SegFault02 )
• Helm: Support deploying additional manifests inline (thanks to @guydomb )
• Use translated labels for workload charts' titles (also improves readability even in English)
• Add a way to copy the error when the app shows the error (Uh-Oh) view
• Add CLI option to list plugins
• Big improvements to the YAML editor and the terminal thanks to the Monaco and xterm teams
• Prevent the entire app from getting to the error state if the error is in the main view. This means the user may still
  be able to navigate to a different view without having to go to the home view
• Add Custom Resources instances view (thanks to @Guilamb ). This allows to look for CR instances in the user's
  allowed namespaces, whereas before the user had to go through each CR Definition and required access to their
  namespaces

New Map view:

Watch the video demo on Youtube.

New Map view with details open:

Context actions for resource lists:

🧩 Shipped plugins

• Update shipped plugin app-catalog 0.3.1 (desktop only)
  • The YAML in the install dialog is updated to reflect the Helm chart version, displaying the latest
    version by default and showing the version number in the dialog for clarity
  • The install dialog now sets default values, including the namespace to "default," the version to
    the latest available, and the description to "[app name] deployment
• Update shipped plugin plugin-catalog 0.1.1 (desktop only)
  • Prompt user to reload the app after installing/uninstalling a plugin (so the settings show up).
    This makes sure the plugin is activated/deactivated
• Update shipped plugin prometheus 0.2.2
  • Add settings for configuring Prometheus, allowing the users to configure the service address,
    timespan, and to enable/disable metrics for each cluster (under Settings > Plugins > prometheus)

🐞 Bug fixes

• Fix issues rendering the release notes in dark theme
• Prevent refreshing the app when it's just finished loading
• Fix cluster chooser popup header visibility
• Show the actual issues that happen when loading clusters from KubeConfig
• Fix problem in port forwarding when there's no token
• Fix a11y issues with the notification popups
• Fix broken cluster settings URL from the cluster auth dialog
• Fix typo in values.yaml comment (thanks to @JoniJnm )
• Fix crashing in Job status label when encountering an unknown label
• Fix resource status label alignment
• Fix Headlamp event type when restarting a resource
• Fix duplicate notifications for cluster actions
• Fix issue in cluster login flashing the "auth unsuccessful" state by mistake
• Update home view on an interval
• Allow to apply resources when user's role can only update, not create (thanks to @jda258 )

💻 Development

• Add missing MUI date pickers (need for material-react-table)
• Export getAllowedNamespaces function (so plugins can use it)
• Add more backend test coverage
• Refactor API related modules so now they are versioned
• Refactor KubeObject to allow more extensive type coverage of the Kubernetes data layer
• Improve how KubeObject classes can be declared (assigning an API endpoint directly is no
  longer needed)
• Use react-query for backend requests, which adds caching and centralizes calls
• Add unit tests for frontend API
• Allow routes to render their main component in full width
• Automatically set the cluster param to the ResourceLink component
• Add easy generation of frontend and backend test coverage reports to help develop with a higher quality
  • Through new backend-coverage and backend-coverage-html make targets
• Use Ubuntu 22 on CI
• Refactor istokenAboutToExpire to improve clarity and maintainability (thanks to @guipguia )
• Remove axe-react for a11y testing in favor of using the Playwright a11y testing facilities
• Add GitHub issue templates for easier filing of bugs and enhancement requests
• Drop certain 3rd party dependencies to improve security
• Improve security of the build environment
• Misc dependency updates

📖 Documentation

• Add new and more comprehensive contributors guide
• Improve a11y of docs including readability
• Fix broken link in plugin development docs (thanks to @kingdonb )
• Fix broken links after API changes (thanks to @BelovedAugustine )
• Add ADOPTERS file (if your company uses or builds on top of Headlamp, please add yourselves!)

Container image: 🐳 ghcr.io/headlamp-k8s/headlamp:v0.26.0
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage AMD64, ARM64, ARMv7l
🐧 Linux Tarball AMD64, ARM64, ARMv7l
🐧 Debian / Linux AMD64
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

headlamp-helm-0.26.0

Headlamp is an easy-to-use and extensible Kubernetes web UI.

headlamp-helm-0.25.0

Headlamp is an easy-to-use and extensible Kubernetes web UI.

0.25.1

🐞 Bug fixes

• Fix issues with EKS/AKS on MacOS
  • Fix app to not assume data is there in authentication tokens
  • Fix handling of context names which are not DNS compatible
  • Fix app so that it can include environment variables used in the users terminal
• Update winget templates to 1.6 schema version
• Replace non-existent redux entrypoint for typedocs
• Remove unused if-env package
• Fix mac builds with their symlinks in node_modules
• Fix Overview workload charts
• Refactor istokenAboutToExpire for clarify and maintainability (thanks @guipguia)
• Fix backend so it prints an error if server fails to start
• Add a better error message for problems with kube configs
• Fix some button colors to be readable
• Fix issue when renaming stateless clusters
• Show an error if trying to rename a cluster context to one that already exists
• Fix installing plugins on Flatpak

💻 Development

• Update + pin alpine version (to 3.20.2) in Dockerfile
• Fix tests of helm chart templates
• Fix minor TypeScript issues in app

📖 Documentation

• Fix redirect for broken links (thanks @BelovedAugustine)
• Fix bad link in plugin dev docs (thanks @kingdonb)
• Fix typo in values.yaml comment (thanks @JoniJnm)
• Fix wording to explain how things are now with available binaries
• Fix/simplify AKS status
• Add missing install command when building plugins

Container image: 🐳 ghcr.io/headlamp-k8s/headlamp:v0.25.1
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage AMD64, ARM64, ARMv7l
🐧 Linux Tarball AMD64, ARM64, ARMv7l
🐧 Debian / Linux AMD64
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

headlamp-helm-0.24.0

Headlamp is an easy-to-use and extensible Kubernetes web UI.

0.25.0

✨ Enhancements:

• Add plugin catalog to easily install plugins from ArtifactHub
• Add UI for easily creating a namespace
• Add cluster renaming feature
• Add navigation menu to app, so users can go back/forth in history (desktop only)
• Replace icon for the Deployment/ReplicaSet scale action with a more intuitive one
• Hide non-editable fields when editing in CustomResources (thanks to @Guilamb )
• Charts from the Workloads now have a link to their respective workload pages

New plugin catalog:

🐞 Bug fixes

• Fix release notes viewer
• Add auth header only if token exists (thanks to @LudovicTOURMAN )
• Fix imagePullSecrets in value schema
• Allow editor to auto-resize to adapt to the window size
• Fix reduced motion styling
• Fix visibility for scale action (in Deployment/ReplicaSet)
• Do not allow negative values in the scale UI
• Fix use of scaling requests when user cannot update the resource
• Fix showing successful popup when editor operations were not successful

💻 Development

• Replace deprecated create-react-app with vite
• Bump dependencies both in Dockerfile, frontend, backend, and plugins
• Add plugin management capabilities to app
• Increase more testing coverage
• Add signing of Helm charts
• Add i18n test coverage to CI
• Allow passing namespace to testAuth function
• Replace minikube with kind in CI

Container image: 🐳 ghcr.io/headlamp-k8s/headlamp:v0.25.0
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage AMD64, ARM64, ARMv7l
🐧 Linux Tarball AMD64, ARM64, ARMv7l
🐧 Debian / Linux AMD64
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

headlamp-helm-0.23.0

Headlamp is an easy-to-use and extensible Kubernetes web UI.

0.24.1

🐞 Bug fixes

• Fix viewing the Network > Services page when there are services without ports
• Fix top bar and sidebar on small screens (thanks to @tazo90 )
• Fix misc regressions in several components
• Do not log errors related to OIDC when OIDC is not set up
• Remove mistakenly added package*.json files from root folder
• Fix hiding back link when it's set as null
• charts: Fix wrong OIDC external secret loading
• charts: Fix config.extraArgs and env values type
• charts: Fix ingress (thanks to @BlindB0 )

💻 Development

• chart: Add schema for values
• Make KubeService.spec.ports as optional in interface
• Update some dependencies

📖 Documentation

• Fix link to FAQ in README
• chart: Add example docs for ingress

Container image: 🐳 ghcr.io/headlamp-k8s/headlamp:v0.24.1
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage AMD64, ARM64, ARMv7l
🐧 Linux Tarball AMD64, ARM64, ARMv7l
🐧 Debian / Linux AMD64
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

headlamp-helm-0.22.0

Headlamp is an easy-to-use and extensible Kubernetes web UI.