npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@headlamp-k8s/backstage-plugin-headlamp

v0.1.0-beta-1

Published

The Headlamp plugin for Backstage embeds the Headlamp UI within your Backstage instance using an iframe. The plugin can be used in two modes:

Downloads

63

Readme

Headlamp Plugin (beta)

The Headlamp plugin for Backstage embeds the Headlamp UI within your Backstage instance using an iframe. The plugin can be used in two modes:

  1. Standalone Mode:

    • Simply displays an existing Headlamp instance using the URL configured in app-config.yaml
    • Requires only configuring the headlamp.url parameter
  2. Backend Integration Mode:

    • Works in conjunction with the headlamp-backend plugin
    • Automatically starts a Headlamp server instance
    • Uses the Kubernetes context specified in your app-config.yaml for interoperability with the backstage kubernetes plugin
    • Provides a more integrated experience within Backstage

Configuration

The Headlamp plugin is configured by setting the headlamp.url in the app-config.yaml file.

1. Install the plugin

yarn --cwd packages/app add @headlamp-k8s/backstage-plugin-headlamp

2. Add Headlamp route to packages/app/src/App.tsx

Add the following import

import { HeadlampPage } from '@headlamp-k8s/backstage-plugin-headlamp';

Add the following route to the const routes

const routes = [
    <FlatRoutes>
    ...
    <Route path="/headlamp" element={<HeadlampPage />} />
    </FlatRoutes>
]

3. Add Headlamp to the Sidebar

Add the following import to packages/app/src/components/Root/Root.tsx

import { HeadlampIcon } from '@headlamp-k8s/backstage-plugin-headlamp';  

Add the SidebarItem within any SidebarGroup in your Root component:

export const Root = ({ children }: PropsWithChildren<{}>) => (
  <SidebarPage>
    <Sidebar>
        <SidebarItem icon={HeadlampIcon} to="headlamp" text="Headlamp" />
        {/* ... other items ... */}
    </Sidebar>
    {children}
  </SidebarPage>
);

4. Configure Headlamp url (Optional)

If you are deploying the Headlamp backend plugin ie using the backend integration mode, you can configure the url of the Headlamp instance by setting the headlamp.url parameter in the app-config.yaml file.

example:

headlamp:
  url: https://headlamp.example.com