# abhikdps/automation-portal-plugins architecture

> Architecture diagram of the GitHub repository abhikdps/automation-portal-plugins, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abhikdps/automation-portal-plugins
- Repository: https://github.com/abhikdps/automation-portal-plugins

## Overview

This monorepo provides Ansible-focused Backstage experiences. A developer enters through the portal UI, explores catalogued AAP and source-control resources, then launches automation through self-service or scaffolder workflows; authentication and catalog synchronization support that journey. APME adds repository quality and activity features. Several product branches are documented or visible in the tree but lack sampled implementation details, so uncertain connections are omitted or marked unverified.

Main entry points: [`workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts) (Catalog API), [`workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts`](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts) (AAP API client), [`workspaces/portal-core/packages/app/src/App.tsx`](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/portal-core/packages/app/src/App.tsx) (Backstage portal), [`workspaces/aap/plugins/backstage-rhaap-common/src/AAPService/AAPService.ts`](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPService/AAPService.ts) (AAP service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_portal["Portal experience"]
  node_portal_app["Backstage portal<br/>[App.tsx]"]
  node_ansible_ui["Ansible UI<br/>[AnsiblePage.tsx]"]
  node_selfservice_ui["Self-service UI<br/>[routes.ts]"]
  node_repository_view["Repository details"]
end

subgraph group_aap["AAP integration"]
  node_auth_provider["AAP auth provider"]
  node_aap_client["AAP API client<br/>[AAPClient.ts]"]
  node_aap_service["AAP service<br/>[AAPService.ts]"]
end

subgraph group_catalog["Catalog discovery"]
  node_catalog_router["Catalog API<br/>[router.ts]"]
  node_aap_entities["AAP entity sync"]
  node_job_templates["Job template sync"]
  node_git_contents["Git contents sync"]
  node_collections["Collection sync"]
  node_sync_state[("Sync tracking")]
end

subgraph group_automation["Self-service automation"]
  node_scaffolder["AAP scaffolder actions<br/>[index.ts]"]
  node_ee_routes["Execution environments<br/>[EERoutesPage.tsx]"]
end

subgraph group_apme["APME quality"]
  node_apme_ui["APME portal UI<br/>[QualityTab.tsx]"]
  node_apme_router["APME API<br/>[router.ts]"]
  node_apme_service["APME service<br/>[ApmeClient.ts]"]
end

node_developer(("Developer"))
node_aap_external{{"AAP instance"}}
node_scm{{"GitHub / GitLab"}}
node_gateway{{"APME Gateway"}}

node_developer -->|"uses"| node_portal_app
node_portal_app -->|"routes to"| node_ansible_ui
node_portal_app -->|"routes to"| node_selfservice_ui
node_portal_app -.->|"renders"| node_repository_view
node_ansible_ui -.->|"uses"| node_aap_service
node_aap_service -.->|"delegates to"| node_aap_client
node_aap_client -->|"requests API"| node_aap_external
node_auth_provider -.->|"authenticates with"| node_aap_client
node_catalog_router -->|"dispatches sync"| node_aap_entities
node_catalog_router -->|"dispatches sync"| node_job_templates
node_catalog_router -->|"dispatches sync"| node_git_contents
node_catalog_router -->|"dispatches sync"| node_collections
node_catalog_router -->|"tracks status"| node_sync_state
node_aap_entities -.->|"reads resources"| node_aap_client
node_job_templates -.->|"reads resources"| node_aap_client
node_git_contents -.->|"scans repositories"| node_scm
node_scaffolder -.->|"runs AAP actions"| node_aap_service
node_selfservice_ui -.->|"opens EE routes"| node_ee_routes
node_repository_view -.->|"requests repository data"| node_catalog_router
node_apme_ui -.->|"calls API"| node_apme_router
node_apme_router -.->|"uses service"| node_apme_service
node_apme_service -.->|"requests operations"| node_gateway

click node_portal_app "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/portal-core/packages/app/src/App.tsx"
click node_ansible_ui "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap/src/components/AnsiblePage/AnsiblePage.tsx"
click node_selfservice_ui "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/routes.ts"
click node_repository_view "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/components/GitRepositories/RepositoryDetailsPage.tsx"
click node_auth_provider "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/auth-backend-module-rhaap-provider/src/userJobTemplatesRouter.ts"
click node_aap_client "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts"
click node_aap_service "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPService/AAPService.ts"
click node_catalog_router "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts"
click node_aap_entities "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPEntityProvider.ts"
click node_job_templates "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPJobTemplateProvider.ts"
click node_git_contents "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AnsibleGitContentsProvider.ts"
click node_collections "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/PAHCollectionProvider.ts"
click node_sync_state "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/SyncStateTracker.ts"
click node_scaffolder "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/scaffolder-backend-module-backstage-rhaap/src/actions/index.ts"
click node_ee_routes "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/components/ExecutionEnvironments/EERoutesPage.tsx"
click node_apme_ui "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/backstage-apme/src/components/QualityTab/QualityTab.tsx"
click node_apme_router "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/catalog-backend-module-apme/src/router.ts"
click node_apme_service "https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/backstage-apme-common/src/ApmeService/ApmeClient.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_portal_app,node_ansible_ui,node_selfservice_ui,node_repository_view toneBlue
class node_auth_provider,node_aap_client,node_aap_service toneAmber
class node_catalog_router,node_aap_entities,node_job_templates,node_git_contents,node_collections,node_sync_state toneMint
class node_scaffolder,node_ee_routes toneRose
class node_apme_ui,node_apme_router,node_apme_service,node_developer,node_aap_external,node_scm,node_gateway toneIndigo
```

## Components

### Portal experience

- [Backstage portal](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/portal-core/packages/app/src/App.tsx): `workspaces/portal-core/packages/app/src/App.tsx`
- [Ansible UI](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap/src/components/AnsiblePage/AnsiblePage.tsx): `workspaces/aap/plugins/backstage-rhaap/src/components/AnsiblePage/AnsiblePage.tsx`
- [Self-service UI](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/routes.ts): `workspaces/self-service/plugins/self-service/src/routes.ts`
- [Repository details](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/components/GitRepositories/RepositoryDetailsPage.tsx): `workspaces/self-service/plugins/self-service/src/components/GitRepositories/RepositoryDetailsPage.tsx`

### AAP integration

- [AAP auth provider](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/auth-backend-module-rhaap-provider/src/userJobTemplatesRouter.ts): `workspaces/aap/plugins/auth-backend-module-rhaap-provider/src/userJobTemplatesRouter.ts`
- [AAP API client](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts): `workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts`
- [AAP service](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/backstage-rhaap-common/src/AAPService/AAPService.ts): `workspaces/aap/plugins/backstage-rhaap-common/src/AAPService/AAPService.ts`

### Catalog discovery

- [Catalog API](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`
- [AAP entity sync](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPEntityProvider.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPEntityProvider.ts`
- [Job template sync](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPJobTemplateProvider.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AAPJobTemplateProvider.ts`
- [Git contents sync](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AnsibleGitContentsProvider.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/AnsibleGitContentsProvider.ts`
- [Collection sync](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/PAHCollectionProvider.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/PAHCollectionProvider.ts`
- [Sync tracking](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/SyncStateTracker.ts): `workspaces/aap/plugins/catalog-backend-module-rhaap/src/providers/SyncStateTracker.ts`

### Self-service automation

- [AAP scaffolder actions](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/aap/plugins/scaffolder-backend-module-backstage-rhaap/src/actions/index.ts): `workspaces/aap/plugins/scaffolder-backend-module-backstage-rhaap/src/actions/index.ts`
- [Execution environments](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/self-service/plugins/self-service/src/components/ExecutionEnvironments/EERoutesPage.tsx): `workspaces/self-service/plugins/self-service/src/components/ExecutionEnvironments/EERoutesPage.tsx`

### APME quality

- [APME portal UI](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/backstage-apme/src/components/QualityTab/QualityTab.tsx): `workspaces/apme/plugins/backstage-apme/src/components/QualityTab/QualityTab.tsx`
- [APME API](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/catalog-backend-module-apme/src/router.ts): `workspaces/apme/plugins/catalog-backend-module-apme/src/router.ts`
- [APME service](https://github.com/abhikdps/automation-portal-plugins/blob/anstrat-2497-poc/workspaces/apme/plugins/backstage-apme-common/src/ApmeService/ApmeClient.ts): `workspaces/apme/plugins/backstage-apme-common/src/ApmeService/ApmeClient.ts`

### Other components

- **Developer**
- **AAP instance**
- **GitHub / GitLab**
- **APME Gateway**

## Connections

- Developer → Backstage portal: uses (evidence: `workspaces/portal-core/packages/app/src/App.tsx`)
- Backstage portal → Ansible UI: routes to (evidence: `workspaces/portal-core/packages/app/src/App.tsx`)
- Backstage portal → Self-service UI: routes to (evidence: `workspaces/portal-core/packages/app/src/App.tsx`)
- Backstage portal → Repository details: renders
- Ansible UI → AAP service: uses
- AAP service → AAP API client: delegates to
- AAP API client → AAP instance: requests API (evidence: `workspaces/aap/plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts`)
- AAP auth provider → AAP API client: authenticates with
- Catalog API → AAP entity sync: dispatches sync (evidence: `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`)
- Catalog API → Job template sync: dispatches sync (evidence: `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`)
- Catalog API → Git contents sync: dispatches sync (evidence: `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`)
- Catalog API → Collection sync: dispatches sync (evidence: `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`)
- Catalog API → Sync tracking: tracks status (evidence: `workspaces/aap/plugins/catalog-backend-module-rhaap/src/router.ts`)
- AAP entity sync → AAP API client: reads resources
- Job template sync → AAP API client: reads resources
- Git contents sync → GitHub / GitLab: scans repositories
- AAP scaffolder actions → AAP service: runs AAP actions
- Self-service UI → Execution environments: opens EE routes
- Repository details → Catalog API: requests repository data
- APME portal UI → APME API: calls API
- APME API → APME service: uses service
- APME service → APME Gateway: requests operations
