headlamp

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

• updated types for Headlamp v0.15.0

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

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

This release of headlamp-plugin is compatible with Headlamp 0.15.0.

📢 News

• We have a new website! Check it out at headlamp.dev if you haven't yet
• We also have a Mastodon account, besides the Twitter account we already had

✨ Enhancements:

• Add a new settings section
  • For now, allows to select the language, custom number of rows for all tables, theme, and timezone to display for dates
• Add support for creating port forwards (in the pods/services details view) and a section to list all the port forwards (desktop only)
• Reload UI automatically when the kube config being used changes, to reflect any new/updated/removed clusters (desktop only)
• New French locale is available
• Add support for applying v1/List resources
• The pod's logs and shell buttons will only be visible if the user has permission to access the respective subresource
• Add support for cluster proxies (when set up in the kube config)

Port forward button:

Port forward section:

Settings view:

🐞 Bug fixes

• Fix patch method in the API factory function
• Fix editor's documentation viewer
• Fix app IPC, which was leading to issues like not being able to change the app's native UI locale
• Fix displaying notifications' messages (they were getting a "no message" under certain scenarios)

💻 Development

• Allow getAuthorization to check for a subresource
• Add a new component AuthVisible to more easily check for the user's authorization and show/hide a component (like a delete button) accordingly
• Add a new "back link" common component
• Add a new endpoint for deleting dynamically added clusters (useful for plugins, desktop only)
• Add the ability for plugins to override the get/setToken functions

📖 Documentation

• Update getting a token docs

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

🐧 Flatpak / Linux (AMD64)
🐧 Linux AppImage AMD64, ARM64, [ARMv7l](https://github.com/kinvolk/headlamp/releases/download/v0.[15](https://github.com/headlamp-k8s/headlamp/actions/runs/4074607995/jobs/7019960367#step:2:15).0/Headlamp-0.15.0-linux-armv7l.AppImage)
🐧 Linux Tarball AMD64, ARM64, ARMv7l
🐧 Debian / Linux AMD64
🍏 Mac (AMD64)
🍏 Mac (ARM/M1)
🟦 Windows (AMD64)

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

• Fix for headlamp-plugin upgrade in how it handles npm audit fixes
• update recharts and loader-utils dependencies
• updated types for Headlamp v0.14.0

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

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

This release of headlamp-plugin is compatible with Headlamp 0.14.0.

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

• frontend plugins: Add hideAppBar option to routes so routes can be shown without an appbar. See hideAppBar used in sidebar example #698
• plugins: Add registerRouteFilter and registerSidebarEntryFilter which allows plugins to remove routes, and sidebar menu items. See registerRouteFilter and registerSidebarEntryFilter used in sidebar example. #693
• headlamp-plugin: upgrade improvements - check and audit after upgrade, fail better, README #688
• plugins/examples: upgrade plugins/examples, so examples are up to date #682
• headlamp-plugin: Convert tests to js from bash, so tests run cross platform #678

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

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

This release of headlamp-plugin is compatible with Headlamp 0.12.1.

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

• material-ui/labs is available to plugins

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

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

This release of headlamp-plugin is compatible with Headlamp 0.12.0.

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

In this bugfix release:

• Updated dependencies
• With Headlamp 0.11.1 the CircularChart API can be used from plugins

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

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

This release of headlamp-plugin is compatible with Headlamp 0.11.1.

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

In this release:

• Added new and improved plugin examples and documentation #568
• Fixed Chart imports #579 thanks @t-lalexander
• Exported resource chart and lib #580
• Added API for changing App menus #566

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

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

This release of headlamp-plugin is compatible with Headlamp 0.11.0.

See the new plugin documentation and examples to see how to change the logo, customize detail views/action buttons, change side bar menu items, app menu items, and even dynamically define a cluster.

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

In this bug fix release:

• Fix importing SVG files as components now works #568
• Test the example plugins better when a headlamp-plugin version changes #568
• Fix for PageGrid and other components imported from Resource #567

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

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

This release of headlamp-plugin is compatible with Headlamp 0.10.1

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:

• 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)

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)

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)

Improvements:

• Increase the default windows size for desktop app
• Support relative certificate-authority paths in config
• Add help link for authentication docs from token prompt
• Port desktop app code to Typescript

Bug fixes:

• Add login screen back for OIDC configurations

Development:

• Add storybook and stories for several common components

Important: We're still in the process of code signing the Mac application and will update the binary here when we do it.

Enhancements:

• Add headless mode: Run Headlamp locally, but open its UI in the system's default browser
• Add a dedicated list view for each of the workload types
• Add links to secrets' details from the service account details view
• Add server logging for easier debug
• Improve the UX when logging in to a cluster fails:
  • Reduce timeout; show a "try again" button; show a back button

Bug fixes:

• Fix cancellation of a request while changing to a different cluster
  when the current one's login is ongoing
• Fix getting the user's folder on Windows

Preview of the new headless feature:

Important: We're still in the process of code signing the Mac application and will update the binary here when we do it.

Bug fixes:

• Fix plugins-dir flag typo in kubernetes-headlamp.yaml
• Decode secrets when showing them in the UI
• Fix server spawning failure on Windows
• Have the services before the deployment in kubernetes-headlamp.yaml
• Allow self signed certificates in oidc
• Don't print an error when the plugins folder doesn't exist
• Don't stop the server if no config is found
• Prevent constant config requests when clusters list is empty
• Don't show back button in login if there's only one cluster
• Show an error message if there are no clusters configured