Migrate Azure Resource plugin #1856

kajahanne · 2024-11-06T12:44:34Z

Hey, I just made a Pull Request!

I raised this pull request to move the Azure Resources plugin from repos https://github.com/vippsas/backstage-azure-resources-backend and https://github.com/vippsas/backstage-azure-resource-frontend to the backstage/community-plugins repo so it is easy to manage, collaborate & improve with the Backstage community and standards.
This move also includes handing over ownership of this plugin to @deepan10.

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or updated documentation
Tests for new functionality and regression tests for bug fixes
Screenshots attached (for UI changes)
All your commits have a Signed-off-by line in the message. (more info)

backstage-goalie · 2024-11-06T12:57:53Z

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

…ackstage#1826) Signed-off-by: Nowacki, Kacper <kacper.nowacki@dynatrace.com> Co-authored-by: Nick Boldt <nboldt@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Signed-off-by: Kashish Mittal <kmittal@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

…ckstage#1850) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

…namic plugin build step (backstage#1849) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

…amic plugin build step (backstage#1848) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

deepan10 · 2024-11-07T08:11:37Z

Hello @kajahanne

You have to move both frontend & backend plugin in to /workspaces/azure-resources/plugins/ directory with the default version 0.0.0 and create a changeset.

Here is reference PR #711

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

…e/community-plugins into migrate-azure-resources

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

awanlin · 2024-11-13T20:51:49Z

Hi @deepan10, can you give this a review please? Once you have approved I'll give it another look over.

Hi @kajahanne, as @deepan10 will be helping own this plugin I'd like them to review it first, just wanting to keep you in the loop as to how the review process will work. 👍

deepan10 · 2024-11-16T18:53:18Z

Hello @kajahanne ,

Good to see the plugin (Frontend + Backend). It is good to migrate the backend plugin to align with the New backend system https://backstage.io/docs/backend-system/architecture/index

Also, Can you migrate packages/app and packages/backend so that it gets easier running the plugins locally?

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts

workspaces/azure-resources/plugins/backstage-azure-resources-backend/README.md

workspaces/azure-resources/package.json

github-actions · 2024-12-10T18:06:31Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Co-authored-by: Kashish Mittal <113269381+04kash@users.noreply.github.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

…ackend/README.md Co-authored-by: Deepankumar <deepan0433@gmail.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

…ackend/src/service/router.ts Co-authored-by: Deepankumar <deepan0433@gmail.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

awanlin · 2024-12-17T15:34:20Z

Hi @deepan10 @04kash, looks like the requested changes have been made, can you give it another look, please? 🚀

awanlin · 2024-12-20T13:25:40Z

Hi @kajahanne, looks like one of the commits have not been signed with the DCO, can you look into that, please?

deepan10

Hello @kajahanne ,

To migrate to the new backend system add the below in to workspaces/azure-resources/plugins/backstage-azure-resoures-backend/src/plugin.ts. Also look at the review comments and DSO of your commits.

import {
  coreServices,
  createBackendPlugin,
} from '@backstage/backend-plugin-api';
import { createRouter } from './service/router';

/**
 *
 * @public
 */
export const azureResourcesPlugin = createBackendPlugin({
  pluginId: 'azure-resources',
  register(env) {
    env.registerInit({
      deps: {
        httpRouter: coreServices.httpRouter,
        logger: coreServices.logger,
        config: coreServices.rootConfig,
      },
      async init({
        config,
        logger,
        httpRouter,
      }) {
        httpRouter.use(
          await createRouter({
            config,
            logger
          }),
        );
        httpRouter.addAuthPolicy({
          path: '/health',
          allow: 'unauthenticated',
        });
      },
    });
  },
});

Note: We need to use the createApiFactory with API Refs in frontend plugin to align with the Backstage common practices. As an initial version let the frontend call directly identityApiRef & discoveryApiRef.

deepan10 · 2024-12-22T11:52:28Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/index.ts

+ * limitations under the License.
+ */
+
+export * from './service/router';


Suggested change

export * from './service/router';

export * from './service/router';

export {azureResourcesPlugin as default } from './plugin'

deepan10 · 2024-12-22T11:53:05Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts

+ * limitations under the License.
+ */
+
+import { errorHandler } from '@backstage/backend-common';


Suggested change

import { errorHandler } from '@backstage/backend-common';

deepan10 · 2024-12-22T11:53:23Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts

+import { errorHandler } from '@backstage/backend-common';
+import express from 'express';
+import Router from 'express-promise-router';
+import { Logger } from 'winston';


Suggested change

import { Logger } from 'winston';

import {

LoggerService,

} from '@backstage/backend-plugin-api';

deepan10 · 2024-12-22T11:53:41Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts

+  ClientSecretCredential,
+  DefaultAzureCredential,
+} from '@azure/identity';
+import { AzureResourceConfig } from '../config';


Suggested change

import { AzureResourceConfig } from '../config';

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

import { AzureResourceConfig } from '../config';

deepan10 · 2024-12-22T11:53:55Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts

+import { AzureResourceConfig } from '../config';
+
+export interface RouterOptions {
+  logger: Logger;


Suggested change

logger: Logger;

logger: LoggerService;

deepan10 · 2024-12-22T12:07:01Z

...azure-resource-frontend/src/components/EntityFetchAzureData/EntityFetchAzureSecurityData.tsx

+    entity?.metadata.annotations?.[AZURE_ANNOTATION_TAG_SELECTOR] ?? '/'
+  ).split('/');
+
+  const config = useApi(configApiRef);


Suggested change

const config = useApi(configApiRef);

const config = useApi(configApiRef);

const identityApi = useApi(identityApiRef);

deepan10 · 2024-12-22T12:07:33Z

...azure-resource-frontend/src/components/EntityFetchAzureData/EntityFetchAzureSecurityData.tsx

+    const response = await fetch(
+      `${backendUrl}/api/azure-resources/rg/${tagKey}/${tagValue}/secrecommendations`,
+    );


Suggested change

const response = await fetch(

`${backendUrl}/api/azure-resources/rg/${tagKey}/${tagValue}/secrecommendations`,

);

const { token: accessToken } = await identityApi.getCredentials();

const response = await fetch(

`${backendUrl}/api/azure-resources/rg/${tagKey}/${tagValue}/secrecommendations`, {

headers: {

'Content-Type': 'application/json',

...(accessToken && { Authorization: `Bearer ${accessToken}` }),

},

}

);

deepan10 · 2024-12-22T12:10:10Z

workspaces/azure-resources/package-lock.json

We need to delete this file, since its not required

deepan10 · 2024-12-22T12:13:59Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/run.ts

We need to delete this file, Since it is not needed.

deepan10 · 2024-12-22T12:14:16Z

...es/azure-resources/plugins/backstage-azure-resources-backend/src/service/standaloneServer.ts

We need to delete this file, Since it is not needed.

deepan10 · 2024-12-22T12:21:03Z

workspaces/azure-resources/plugins/backstage-azure-resource-frontend/package.json

+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+  "private": false,


Remove this line, Since this meant to be public.

Suggested change

"private": false,

deepan10 · 2024-12-22T12:21:28Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/package.json

+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+  "private": false,


Remove this line, Since this meant to be public.

Suggested change

"private": false,

deepan10 · 2024-12-22T12:28:03Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/README.md

+```
+# From the Backstage root directory
+cd packages/backend
+yarn add @backstage-community/plugin-azure-resources-backend
+```


Suggested change

```

# From the Backstage root directory

cd packages/backend

yarn add @backstage-community/plugin-azure-resources-backend

```

```bash

# From the Backstage root directory

yarn --cwd packages/backend add @backstage-community/plugin-azure-resources-backend

deepan10 · 2024-12-22T12:29:31Z

workspaces/azure-resources/plugins/backstage-azure-resources-backend/README.md

+```TypeScript
+/// ./packages/backend/src/plugins/azure-resources-backend.ts
+import { createRouter } from '@backstage-community/plugin-azure-resources-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    logger: env.logger,
+    config: env.config,
+  });
+}
+```
+
+```TypeScript
+/// ./packages/backend/src/index.ts
+
+import azureResourcesBackend from './plugins/azure-resources-backend';
+const azureResourcesBackendEnv = useHotMemoize(module, () => createEnv('azure-resources-backend'));
+apiRouter.use('/azure-resources', await azureResourcesBackend(azureResourcesBackendEnv));
+```


Suggested change

```TypeScript

/// ./packages/backend/src/plugins/azure-resources-backend.ts

import { createRouter } from '@backstage-community/plugin-azure-resources-backend';

import { Router } from 'express';

import { PluginEnvironment } from '../types';

export default async function createPlugin(

env: PluginEnvironment,

): Promise<Router> {

return await createRouter({

logger: env.logger,

config: env.config,

});

}

```

```TypeScript

/// ./packages/backend/src/index.ts

import azureResourcesBackend from './plugins/azure-resources-backend';

const azureResourcesBackendEnv = useHotMemoize(module, () => createEnv('azure-resources-backend'));

apiRouter.use('/azure-resources', await azureResourcesBackend(azureResourcesBackendEnv));

```

### New Backend System

This backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/), here's how you can set that up:

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

```diff

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

const backend = createBackend();

// ... other feature additions

+backend.add(import('@backstage-community/plugin-azure-resources-backend'));

// ...

backend.start();

github-actions · 2025-01-05T18:05:33Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

Sarabadu · 2025-01-14T15:54:57Z

hey @kajahanne gentle ping, is this still in plan to get merged?

kajahanne · 2025-01-15T08:18:45Z

I will start fresh with a new PR, so this one can stay closed.

kajahanne requested review from a team and backstage-service as code owners November 6, 2024 12:44

kajahanne requested a review from awanlin November 6, 2024 12:44

backstage-service and others added 9 commits November 6, 2024 14:06

Version Packages (backstage#1839)

99bfcd9

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Version Packages (backstage#1838)

f292744

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Remove unused @backstage/backend-common package from dependencies. (b…

869d684

…ackstage#1826) Signed-off-by: Nowacki, Kacper <kacper.nowacki@dynatrace.com> Co-authored-by: Nick Boldt <nboldt@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Migrate Azure Resource plugin

b99ab54

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Version Packages (backstage#1834)

8faf65c

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

plugin(keycloak): fix plugin metadata (backstage#1855)

4aea1c5

Signed-off-by: Kashish Mittal <kmittal@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

chore: add additional codeowners for acr, ocm and rbac workspaces (ba…

2000349

…ckstage#1850) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

refactor(scaffolder-relation-processor): remove @janus-idp/cli and dy…

da5aaa9

…namic plugin build step (backstage#1849) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

refactor(redhat-resource-optimization): remove @janus-idp/cli and dyn…

d62c3fe

…amic plugin build step (backstage#1848) Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

kajahanne force-pushed the migrate-azure-resources branch from 7cec930 to d62c3fe Compare November 6, 2024 13:06

kajahanne requested review from 04kash, christoph-jerolimov, karthikjeeyar, kuangp, riginoommen, schultzp2020 and yashoswalyo as code owners November 6, 2024 13:06

Merge branch 'main' into migrate-azure-resources

7571640

kajahanne and others added 7 commits November 11, 2024 10:52

Add plugin folders

f0ae74c

Add plugin folders

7ea1225

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Merge branch 'migrate-azure-resources' of https://github.com/kajahann…

464f885

…e/community-plugins into migrate-azure-resources

Remove plugin folders temporarily

d532998

Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Version Packages (backstage#1836)

7c5d479

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Version Packages (backstage#1839)

ebd5d41

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

Version Packages (backstage#1838)

3d404b0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Kaja Hannestad <kaja.hannestad@vipps.no>

awanlin removed request for 04kash, karthikjeeyar, schultzp2020 and yashoswalyo November 13, 2024 20:50

deepan10 requested changes Nov 16, 2024

View reviewed changes

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts Outdated Show resolved Hide resolved

workspaces/azure-resources/plugins/backstage-azure-resources-backend/src/service/router.ts Outdated Show resolved Hide resolved

deepan10 requested changes Nov 17, 2024

View reviewed changes

workspaces/azure-resources/plugins/backstage-azure-resources-backend/README.md Outdated Show resolved Hide resolved

04kash requested changes Nov 26, 2024

View reviewed changes

workspaces/azure-resources/package.json Outdated Show resolved Hide resolved

github-actions bot added the stale label Dec 10, 2024

kajahanne and others added 4 commits December 11, 2024 11:12

Update workspaces/azure-resources/package.json

45bc05f

Co-authored-by: Kashish Mittal <113269381+04kash@users.noreply.github.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

Update workspaces/azure-resources/plugins/backstage-azure-resources-b…

debf03f

…ackend/README.md Co-authored-by: Deepankumar <deepan0433@gmail.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

Update workspaces/azure-resources/plugins/backstage-azure-resources-b…

36fc706

…ackend/src/service/router.ts Co-authored-by: Deepankumar <deepan0433@gmail.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

Update workspaces/azure-resources/plugins/backstage-azure-resources-b…

ea4903b

…ackend/src/service/router.ts Co-authored-by: Deepankumar <deepan0433@gmail.com> Signed-off-by: kajahanne <93928338+kajahanne@users.noreply.github.com>

github-actions bot removed the stale label Dec 11, 2024

awanlin requested review from 04kash and deepan10 December 20, 2024 13:09

Merge branch 'main' into migrate-azure-resources

89f509a

deepan10 requested changes Dec 22, 2024

View reviewed changes

github-actions bot added the stale label Jan 5, 2025

github-actions bot closed this Jan 13, 2025

Sarabadu mentioned this pull request Jan 23, 2025

add azureResources workspace and service #2510

Merged

5 tasks

	export * from './service/router';
	export * from './service/router';
	export {azureResourcesPlugin as default } from './plugin'

	import { AzureResourceConfig } from '../config';
	import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
	import { AzureResourceConfig } from '../config';

	const config = useApi(configApiRef);
	const config = useApi(configApiRef);
	const identityApi = useApi(identityApiRef);

-    const response = await fetch(
-      `${backendUrl}/api/azure-resources/rg/${tagKey}/${tagValue}/secrecommendations`,
-    );
+    const { token: accessToken } = await identityApi.getCredentials();
+    const response = await fetch(
+      `${backendUrl}/api/azure-resources/rg/${tagKey}/${tagValue}/secrecommendations`, {
+        headers: {
+          'Content-Type': 'application/json',
+          ...(accessToken && { Authorization: `Bearer ${accessToken}` }),
+        },
+      }
+    );

Migrate Azure Resource plugin #1856

Migrate Azure Resource plugin #1856

Uh oh!

Conversation

kajahanne commented Nov 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Hey, I just made a Pull Request!

✔️ Checklist

Uh oh!

backstage-goalie bot commented Nov 6, 2024

Uh oh!

deepan10 commented Nov 7, 2024

Uh oh!

awanlin commented Nov 13, 2024

Uh oh!

deepan10 commented Nov 16, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 10, 2024

Uh oh!

awanlin commented Dec 17, 2024

Uh oh!

awanlin commented Dec 20, 2024

Uh oh!

deepan10 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 5, 2025

Uh oh!

Sarabadu commented Jan 14, 2025

Uh oh!

kajahanne commented Jan 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

kajahanne commented Nov 6, 2024 •

edited

Loading