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

@digital-ai/plugin-dai-deploy-backend

v0.1.5

Published

Backend functionalities for the dai-deploy backstage plugin

Downloads

158

Readme

Dai Deploy Backend

It is a simple plugin that makes API requests to Digital.ai Deploy

Setup

Installing and Configuring the Backend Plugin

The backend plugin needs to be added to your application. To do so:

1. Run the following command from the Backstage root directory:

yarn --cwd packages/backend add @digital-ai/plugin-dai-deploy-backend

2. Create plugin file for deploy backend in the packages/backend/src/plugins/ directory.

// packages/backend/src/plugins/dai-deploy.ts
 
import { createRouter } from '@digital-ai/plugin-dai-deploy-backend';
import { Router } from 'express';
import type { PluginEnvironment } from '../types';

export default function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  return createRouter({
    logger: env.logger,
    config: env.config,
    permissions: env.permissions
  });
}

3. Modify your backend router to expose the APIs for deploy backend.

// packages/backend/src/index.ts

import daiDeploy from './plugins/dai-deploy';
// ...

async function main() {
   // ...
   // Add this line under the other lines that follow the useHotMemoize pattern
   const daiDeployEnv = useHotMemoize(module, () => createEnv('dai-deploy'));
   // ...
   // Insert this line under the other lines that add their routers to apiRouter in the same way
   apiRouter.use('/dai-deploy', await daiDeploy(daiDeployEnv));

4. Configure the deploy instance by adding the following to your app-config.yaml files.

daiDeploy:
  host: <<deploy-instance-url>> #http://deploy-hostname:4516
  username: ${username}
  password: ${password}

Note: username and password must be set as environment variables.

5. Run yarn start-backend from the repo root directory.

6. Finally open http://localhost:7007/api/dai-deploy/health in a browser and returns {"status":"ok"}.

Links

For more information, see Overview and Adding Deploy to Your Backstage IDP

New Backend System

The Dai Deploy backend plugin has support for the new backend system, here's how you can set that up:

In your packages/backend/src/index.ts make the following changes:

  import { createBackend } from '@backstage/backend-defaults';

  const backend = createBackend();

  // ... other feature additions

+ backend.add(import('@digital-ai/plugin-dai-deploy-backend'));

  backend.start();