@digital-ai/plugin-dai-release-backend NPM

Digital.ai Release Backend

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

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-release-backend

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

// packages/backend/src/plugins/dai-release.ts

import { createRouter } from '@digital-ai/plugin-dai-release-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 release backend.

// packages/backend/src/index.ts

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

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

The Dai Release plugin requires the following YAML to be added to your app-config.yaml: Dai Release plugin supports Digital-ai Release multi instance integration option. ***Note: all values are mandatory, if any of the keys or values not entered application startup will fail

For single instance setup:

daiRelease:
  instances:
    - name: { name-of-first-instance } #
      host: { host-of-first-instance } #http://digital-ai-1.release.com:4516
      token: { token-of-first-instance }

For multi instance setup:

daiRelease:
  instances:
    - name: { name-of-first-instance } #
      host: { host-of-first-instance } #http://digital-ai-1.release.com:4516
      token: { token-of-first-instance }
    - name: { name-of-second-instance }
      host: { host-of-second-instance } #http://digital-ai-2.release.com:4516
      token: { token-of-second-instance }

Configuration Details:

name will be used to display in UI for instance choosing
host will be your release application host.
token environment variable must be set, that is your release application api token. Create an account with read permission and use that.

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

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

New Backend System

The Dai Release 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-release-backend'));

  backend.start();

Permissions

The DAI release plugin supports the permissions framework, the following sections outline how you can use them with the assumption that you have the permissions framework setup and working.

Note: These sections are intended as guidance and are completely optional. The dai-release plugin will work with the permission framework off or on without any specific policy setup.

Secure Sidebar Option

To use the permission framework to secure the Digital.ai Release sidebar option you'll want to do the following:

First we need to add the @backstage/plugin-dai-release-common package to your frontend app:

# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-dai-release-common

Then open the packages/app/src/components/Root/Root.tsx file

Then add these imports after all the existing import statements:

import { daiReleaseViewPermission } from '@digital-ai/plugin-dai-release-common';
import { RequirePermission } from '@backstage/plugin-permission-react';

Then make the following change:

-   <SidebarItem icon={ReleaseSvgIcon} to="dai-release" text="Digital.ai Release" />
+   <RequirePermission
+     permission={daiReleaseViewPermission}
+     errorPage={<></>}>
+     <SidebarItem icon={ReleaseSvgIcon} to="dai-release" text="Digital.ai Release" />
+   </RequirePermission>

Secure the dai-release Route

To use the permission framework to secure the dai-release route you'll want to do the following:

First we need to add the @backstage/plugin-dai-release-common package to your frontend app (skip this step if you've already done this):
```
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-dai-release-common
```
Then open the packages/app/src/App.tsx file

The add this import after all the existing import statements:

import { daiReleaseViewPermission } from '@digital-ai/plugin-dai-release-common';

Then make the following change:

-   <Route path="/dai-release" element={<DaiReleasePage />} />
+   <Route path="/dai-release"
+     element={
+     <RequirePermission permission={daiReleaseViewPermission}>
+       <DaiReleasePage/>
+     </RequirePermission>
+     }
+   />

Permission Policy

Here is an example permission policy that you might use to secure the Digital.ai Release plugin:

// packages/backend/src/plugins/permission.ts

class TestPermissionPolicy implements PermissionPolicy {
  async handle(request: PolicyQuery): Promise<PolicyDecision> {
    if (isPermission(request.permission, daiReleaseViewPermission)) {
      if (
        user?.identity.ownershipEntityRefs.includes(
          'group:default/release-admins',
        )
      ) {
        return { result: AuthorizeResult.ALLOW };
      }
      return { result: AuthorizeResult.DENY };
    }

    return { result: AuthorizeResult.ALLOW };
  }
}

To use this policy you'll need to make sure to add the @backstage/plugin-dai-release-common package to your backend you can do that by running this command:

# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-dai-release-common

You'll also need to add these imports:

import { daiReleaseViewPermission } from '@digital-ai/plugin-dai-release-common';

Note: The group "group:default/release-admins" is simply an example and might not exist. You can point this to any group you have in your catalog instead.