headlamp

headlamp-plugin is a tool to help with making plugins for Headlamp (the extensible Kubernetes UI).

In this release:

• Cluster chooser button can be overridden (see plugins/examples/clusterchooserbuttonoverride) in https://github.com/kinvolk/headlamp/pull/501
• Clusters can be added dynamically (see plugins/examples/dynamic-clusters) in https://github.com/kinvolk/headlamp/pull/497
• Notifications can be added into the new Notification area in #442
• The default routes can now be obtained, and the Router class is exposed in https://github.com/kinvolk/headlamp/pull/474

To use this new headlamp-plugin version with existing plugins, please update your plugin package.json file:

  "devDependencies": {
    "@kinvolk/headlamp-plugin": "^0.4.8"
  }

This release of headlamp-plugin is compatible with Headlamp 0.9.0

headlamp-plugin is a tool to help with making plugins for Headlamp (the extensible Kubernetes dashboard).

In this release:

• png/jpg/css assets inside plugins are now inlined properly into the built plugin
• npm run lint will now fail if there are lint warnings in the plugin
• example plugins are now tested by CI to see if they are formatted, lint free, type checked and buildable
• npm run tsc inside plugins does not generate a index.js file when type checking

To use this new headlamp-plugin version with existing plugins, please update your plugin package.json file:

  "devDependencies": {
    "@kinvolk/headlamp-plugin": "^0.4.7"
  }

✨ Enhancements:

• Add support for string based icon descriptions (using iconify 3.1.3)
• Allow to override Headlamp's logo from plugins
• Allow to override a sidebar entry's logo from plugins
• Export all lib/k8s modules for use in plugins
• Allow to build & ship plugins in the desktop app

🐞 Bug fixes

• Encode OIDC state to avoid string length related issues
• Use the correct token type in OIDC
• Allow OIDC non-localhost HTTP callbacks to be handled
• Fix plugins path on Windows (Headlamp was looking for them in a location different from
  where they were copied to)
• Prevent plugins from being cached in desktop (so their changes can effectively be hot-reloaded)

💻 Development

• Improve headlamp-plugin create instructions
• Add a tsc script for plugins so they can type check
• Use node LTS for all Type/Javascript code
• Add a new sidebar plugin example
• Add a way to format/lint plugins
• Update plugins to use a new import format (from @kinvolk/headlamp-plugin 0.4.3)
• Add a new NetworkPolicy resource class
• Make it easier to create CustomResources by exporting the makeCustomResourceClass
• Allow using specific namespaces in the use(Api)List hooks

📖 Documentation

• Improve documentation on testing headlamp-plugin changes
• More type docs generated
• Updated plugin development examples

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.8.0
Desktop Apps:

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

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

✨ Enhancements:

• Add a list of the related pods to different workload details views
• Add a conditions table to the namespace's details view
• Adjust the desktop app's window size automatically
• Go back to the right view from any details view (e.g. sometimes a details view
  is reached from a list view of the same workload type, or any other place)
• Improve the developer experience for plugins:
  • Allow to import shared/common modules using the import syntax
  • Ship a @kinvolk/headlamp-plugin/lib module to make specific plugin
    functionality easier to use
  • Ensure the headlamp-plugin executable always creates the plugins with its
    built version number
• Add more information to several workloads' details views
  • e.g. the schedule for cronjobs, with an automatic description
    

🐞 Bug fixes

• Fix shutting down the server on Windows
• Add missing plugin section renderer to some details views
• Adapt the ConfigMap's editors to theme changes
• Fix CronJob schedule/suspend values in their list view
• Allow to apply non-grouped API resources
• Fix warning color's contrast in the dark theme variant
• Fix initializing plugins twice (which caused sometimes duplicated rendering)

💻 Development

• Fix building docs in CI
• Fix building changes related to desktop on CI
• Update electron-builder to node 16 compat version
• Improve image build times by separating the backend and frontend builds
• Updated the use of material-ui related deprecated properties
• Build on Windows without using bash

📖 Documentation

• Update plugin development docs to cover the new way of importing shared
  modules

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.7.0
Desktop Apps:

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

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

Enhancements:

• Add a new details view for Custom Resources
• Improve the status label for pods (to show details when they're failing to become ready)
• Allow to run the desktop app using a kubeconfig from a different location
• Add a 404 page (finally!)
• Add more details about to the Pod details view about its containers (restart counts,
  actual status + failure reasons, image and container IDs, ...)
• Add the containers' volumes mount list to the Pod details view
• Add links to the events list (this way it's a direct click to go to a resource in trouble)
• Improve how multiple containers are displayed in the Pod details view

Bug fixes

• Fix showing objects in the Custom Resource Definition details page
• Allow to apply any resource configuration; before, only standard K8s resources
  (non-custom resources) were allowed
• Fix auto-focusing the search entry when enabling the filters UI
• Fix fetching the resource in the RoleBinding details views
• Show Pods as ready only when their containers are ready, not when the Pods are running
• Fix resource filtering and advanced search (especially noticeable in the Workloads list view)

Development

• Allow plugin defined routes to take precedence when matching routes (allows plugins to
  replace default routes)
• Add commands to run the app and automatically use the backend and frontend without
  having to run those separately
• Prevent multiple warnings related to the translation
• Add notistack and react-router to the plugin lib object

Documentation

• Embed video about plugin development
• Mention how to use kube configs from non-default locations when running the desktop app

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.6.0
Desktop Apps:

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

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

Bug fixes

• Fix reloading/accessing a direct URL in the hosted mode (bug #345 )

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.5.3
Desktop Apps:

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

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

Enhancements:

• Support different/older versions of the Kubernetes API by using a list of groups/version/resource
  in API factory methods
• Enable and publish builds of Linux ARM (32bit and 64bit) versions
• Add new API versions for the CustomResourceDefinition, SelfSubjectAccessReview, CronJobs, and Ingress
• Show errors in details views when a resource couldn't be loaded

Bug fixes

• Fix getting the right URL scheme for OIDC callbacks (thanks to @zdzichu )
• Fix building plugins from within their own folder
• Prevent unnecessary rendering of plugin details component
• Catch errors when getting permissions in Edit/Delete buttons
• Fix race when setting Roles and ClusterRoles in list (it was either getting one or the other)
• Fix cancelling of actions (the cancel button was not reached by the pointer due to an issue in an older version
  of notistack)
• Fix CustomResourceDefinitions details view's back button

Development

• The plugins can now register a section in the details view (since headlamp-plugin 0.3.1)
• Fix stalling when installing of dependencies for plugins on npm 7
• Backend now supports the PATCH HTML method
• Build nsis version for Windows instead of msi

Documentation

• Add Vultr Kubernetes Engine to the list of tested platforms (thanks to @ddymko )

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.5.2
Desktop Apps:

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

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

Bug fixes

• Show the right version in the release notes (it was showing the previous version from the app, not the newly running one)

Changes in version 0.5.0:

Enhancements

• Allow to sort by most of the tables' columns (in all views)
• Greatly improve the UI on very small resolutions and high zoom displays
• Table filter/search will now take into account also the type for all tables that have it
• Show a notification about a new Headlamp version being available (desktop app only)
• Show the release notes the first time a new version is run (desktop app only)

Other

• Use ghcr.io instead of quay.io for Headlamp's container image
• Build all platforms in the CI system (to find platform breaks earlier)
• Minor bug fixes

Screenshots of some of the new features:

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.5.1
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage (AMD64)
🐧 Linux (Tarball)
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

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

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

Enhancements:

• Completely reviewed + improved accessibility. Including an alternative/simpler editor for adding/editing resources.
• Add internationalization support. With the Spanish and Portuguese languages available, besides English.
• Many additions to the documentation, including Flatpak (Linux) use, port-forwarding example, i18n
• Add a new link to node in the pod details view
• Add owner references for the resources that should display them
• Use browser/OS preferences for setting the light/dark theme variants by default

Bug fixes

• Consider the base URL for the OIDC's redirect URL
• Minor issues like typos

Development

• More storybook coverage
• Fix an issue when building the backend in app mode
• Add helper commands for creating new translations
• Add list of tested platforms.

Container image: 🐳 ghcr.io/kinvolk/headlamp:v0.4.0
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage (AMD64)
🐧 Linux (Tarball)
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

Enhancements:

• Improved plugin development experience (see blog post and video)
• New ARM64 app version for Mac OS (M1 chips)
• Plugins are now supported in the desktop version as well
• New YAML view button when users have no credentials for editing a resource
• Add a new CLI option for disabling the GPU in the desktop app (--disable-gpu) in order to prevent issues in certain environments
• Allow to override the OIDC scopes using a CLI option
• Reflect the namespace selection/filtering in the URL, so views can be more easily shared between users
• New network issues/status bar (shows up if there's a problem connecting to the backend)
• Base URL option (for serving Headlamp's files from a URL path different than the root)
• Now the Apple MacOS binaries are notarized (no more warnings about the app coming from an unknown source)

Bug fixes

• Add namespace column to events table
• Do not add groups to the OIDC scopes by default (this prevented using some OIDC providers such as KeyCloak)
• List top bar actions from plugins to the left of the static theme and account buttons (before it would appear in the middle of those buttons)
• Fix issue that showed a blank screen for the Cronjobs view in some cases
• Stop server running in background when closing app

Development

• Storybooks for more components
• Use of prettier for automatically formatting (allowing for faster PR reviews)
• New @kinvolk/headlamp-plugin version (related to the plugin development experience improvements)
• New API reference docs
• New documentation for running Headlamp on minikube
• New plugin development docs

⚠️ Breaking changes

• OIDC use: If you were relying on the use of groups as an OIDC scope, you need to use the new -oidc-scopes server CLI option, i.e. -oidc-scopes profile,email,groups to have the previous behavior.

Container image: 🐳 quay.io/kinvolk/headlamp:v0.3.0
Desktop Apps:

🐧 Flatpak / Linux (AMD64)
🐧 Linux (AMD64)
🐧 Linux (Tarball)
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

⚠️ Breaking changes (since version 0.2.1)

• OIDC use: If you were relying on the use of groups as an OIDC scope, you need to use the new -oidc-scopes server CLI option, i.e. -oidc-scopes profile,email,groups to have the previous behavior.

Other Changes

• (more changes to the be listed in the final 0.3.0 release)

Container image: quay.io/kinvolk/headlamp:v0.3.0-beta1
v0.3.0-beta1
Desktop Apps:

• Linux (AMD64)
• Linux (Tarball)
• Mac (AMD64)
• Mac (ARM/M1)
• Windows (AMD64)

⚠️ Breaking changes

• OIDC use: If you were relying on the use of groups as an OIDC scope, you need to use the new -oidc-scopes server CLI option, i.e. -oidc-scopes profile,email,groups to have the previous behavior.

Other Changes

• Now the Apple binaries are notarized (no more warnings about the app coming from an unknown source)
• (more changes to the be listed in the final 0.3.0 release)

Container image: quay.io/kinvolk/headlamp:v0.3.0-beta
Desktop Apps:

• Linux (AMD64)
• Linux (Tarball)
• Mac (AMD64)
• Mac (ARM/M1)
• Windows (AMD64)