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

@seatgeek/backstage-plugin-aws-catalog-backend

v1.0.1

Published

This plugin offers the ability to ingest certain types of resources from [AWS](https://aws.amazon.com/) into the Backstage catalog.

Downloads

272

Readme

@seatgeek/backstage-plugin-aws-catalog-backend

This plugin offers the ability to ingest certain types of resources from AWS into the Backstage catalog.

npm latest version

Supported Resources

  • [x] RDS Databases

Installation

Install the @seatgeek/backstage-plugin-aws-catalog-backend package in your backend package:

# From your Backstage root directory
yarn add --cwd packages/backend @seatgeek/backstage-plugin-aws-catalog-backend

Then add the following config to your app-config.yml:

catalog:
  providers:
    aws:
      myOrganizationAws:
        region: 'us-east-1' # required
        # Omit the following fields if using IAM roles (https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-iam.html)
        accessKeyId: ${AWS_ACCESS_KEY_ID} # optional
        secretAccessKey: ${AWS_SECRET_ACCESS_KEY} # optional
        sessionToken: ${AWS_SESSION_TOKEN} # optional

You'll then need to add whichever entity providers you wish to use into your Backstage application's packages/backend/src/plugins/catalog.ts and add it to the CatalogBuilder. For example, to add the RDS entity provider:

import { RDSEntityProvider } from '@seatgeek/backstage-plugin-aws-catalog-backend';

// ...

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  const builder = await CatalogBuilder.create(env);
  builder.addEntityProvider(
    ...RDSEntityProvider.fromConfig(env.config, {
      logger: env.logger,
      schedule: env.scheduler.createScheduledTaskRunner({
        frequency: { days: 1 },
        timeout: { minutes: 5 },
      }),
      // transforms the RDS data from AWS into a ResourceEntity
      dbInstanceTransformer: rdsDBInstance => ({
        apiVersion: 'backstage.io/v1alpha1',
        kind: 'Resource',
        metadata: {
          name: `db-${db.DBInstanceIdentifier}`,
          tags: [db.Engine!],
        },
        spec: {
          type: 'rds',
          owner: 'somebody',
        },
      }),
      // optional filter to limit which entities are ingested
      dbInstanceFilter: dbInstance => true,
    }),
  );
  // ...
}