plugin-catalog

Plugin Catalog

This plugin enhances Headlamp by adding a plugin catalog powered by ArtifactHub.

Settings

Open Settings > Plugins > plugin-catalog to choose whether the catalog shows only official plugins or only verified plugins. Both filters are enabled by default. Changes are saved automatically when a switch is toggled; there is no Save or Cancel step.

Developing Headlamp Plugins

Setting up the Environment

1. Run the Headlamp app from the main branch:

   cd headlamp-k8s/headlamp/app
   npm install
   npm start

2. Set up the Plugin Catalog:

   cd headlamp-k8s/plugins/plugin-catalog
   npm install
   npm start

After completing these steps, you'll see the Plugin Catalog link in the sidebar.

Additional Resources

For comprehensive information on developing Headlamp plugins, explore the following resources:

• Getting Started Guide: Learn how to create a new Headlamp plugin.
• API Reference: Detailed documentation of available APIs.
• UI Component Storybook: Discover pre-existing components for your plugin.
• Plugin Examples: Explore real-world plugin implementations.

Contributing

We welcome contributions! If you have ideas for improvements or encounter any issues, please open an issue or submit a pull request on our GitHub repository.