backstage-rhaap

The backstage-rhaap frontend plugin enables the Ansible sidebar option and provides access to the frontend plugin

Note: This plugin was created through the Backstage CLI

Installation - with upstream backstage

The plugin is tested with backstage version '1.27.7'

Setup backstage

git clone git@github.com:backstage/backstage.git
cd backstage
yarn install

Note: This has been tested with node version v18.19.0.

Configure Backstage with the GitHub authentication

Refer https://backstage.io/docs/auth/github/provider

Add the package

# From your Backstage root directory
yarn --cwd packages/backend add @ansible/plugin-backstage-rhaap

Or

cd plugins/backstage-rhaap
yarn install

Add the following line in the dependencies section of the packages/app/package.json file.

     "@backstage/plugin-azure-sites-common": "workspace:^",
+    "@ansible/plugin-backstage-rhaap": "^x.y.z",
     "@backstage/plugin-badges-backend": "workspace:^",

Adding the plugin to your packages/app

Add the Ansible plugin route in the packages/app/src/App.tsx file as shown in the following diff output.

% git diff packages/app/src/App.tsx
diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx
index 3d8bd45e5aab..752e5e2e9190 100644
--- a/packages/app/src/App.tsx
+++ b/packages/app/src/App.tsx
@@ -108,6 +108,7 @@ import { DevToolsPage } from '@backstage/plugin-devtools';
 import { customDevToolsPage } from './components/devtools/CustomDevToolsPage';
 import { CatalogUnprocessedEntitiesPage } from '@backstage/plugin-catalog-unprocessed-entities';
 import { NotificationsPage } from '@backstage/plugin-notifications';
+import { AnsiblePage } from '@ansible.plugin-backstage-rhaap';

 const app = createApp({
   apis,
@@ -274,6 +275,7 @@ const routes = (
       {customDevToolsPage}
     </Route>
     <Route path="/notifications" element={<NotificationsPage />} />
+    <Route path="/ansible" element={<AnsiblePage />} />
   </FlatRoutes>
 );

Register the plugin in the sidebar navigation by applying the following diff in the packages/app/src/components/Root/Root.tsx file.

% git diff  packages/app/src/components/Root/Root.tsx
diff --git a/packages/app/src/components/Root/Root.tsx b/packages/app/src/components/Root/Root.tsx
index 6294aa785671..f23085e4e0cb 100644
--- a/packages/app/src/components/Root/Root.tsx
+++ b/packages/app/src/components/Root/Root.tsx
@@ -53,6 +53,7 @@ import Score from '@material-ui/icons/Score';
 import { useApp } from '@backstage/core-plugin-api';
 import BuildIcon from '@material-ui/icons/Build';
 import { NotificationsSidebarItem } from '@backstage/plugin-notifications';
+import { AnsibleLogo } from '@ansible.plugin-backstage-rhaap'

 const useSidebarLogoStyles = makeStyles({
   root: {
@@ -164,6 +165,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
             text="Cost Insights"
           />
           <SidebarItem icon={Score} to="score-board" text="Score board" />
+          <SidebarItem icon={AnsibleLogo} to="ansible" text="Ansible" />
         </SidebarScrollWrapper>
         <SidebarDivider />
         <Shortcuts allowExternalLinks />

Update the apis.ts to enable analytics, follow the changes in the diff add it to the file at packages/app/src/apis.ts.

+
 import {
   ScmIntegrationsApi,
   scmIntegrationsApiRef,
@@ -21,11 +22,14 @@ import {
 } from '@backstage/integration-react';
 import {
   AnyApiFactory,
+  analyticsApiRef,
   configApiRef,
   createApiFactory,
   discoveryApiRef,
+  identityApiRef,
 } from '@backstage/core-plugin-api';
 import { AuthProxyDiscoveryApi } from './AuthProxyDiscoveryApi';
+import { AnsibleSegmentAnalytics } from '@janus-idp/backstage-plugin-ansible';

 export const apis: AnyApiFactory[] = [
   createApiFactory({
@@ -38,6 +42,11 @@ export const apis: AnyApiFactory[] = [
     deps: { configApi: configApiRef },
     factory: ({ configApi }) => ScmIntegrationsApi.fromConfig(configApi),
   }),
-
+  createApiFactory({
+    api: analyticsApiRef,
+    deps: { configApi: configApiRef, identityApi: identityApiRef },
+    factory: ({ configApi, identityApi }) =>
+      AnsibleSegmentAnalytics.fromConfig(configApi, identityApi),
+  }),
   ScmAuth.createDefaultApiFactory(),
 ];

Start frontend and backend

Run the following commands in separate terminals from the root folder of backstage.

Frontend

yarn start

Backend

yarn start-backend

Backend - VS Code debug

Enable > Auto Attach: With Flag

yarn start-backend --inspect

Installation - with rhdh

Refer to the step mentioned here https://github.com//blob/main/docs/dynamic-plugins/packaging-dynamic-plugins.md

Plugin registration with

• Update the below section in app-config.local.yaml file

dynamicPlugins:
  frontend:
    ansible.plugin-backstage-rhaap:
      appIcons:
        - importName: AnsibleLogo
          name: AnsibleLogo
      dynamicRoutes:
        - importName: AnsiblePage
          menuItem:
            icon: AnsibleLogo
            text: Ansible
          path: /ansible

Start the front end and backend by running the command in the root folder of rhdh cloned repository path.

LOG_LEVEL=debug yarn start

AAP secrets configuration setup

Add Ansible Automation Platform (AAP) controller configuration in app-config.yaml file. The analytics tag is required to enable analytics.

ansible:
  analytics:
    enabled: true
  rhaap:
    baseUrl: '<AAP controller base URL>'
    token: '<access token>'
    checkSSL: true