How ansible/ansible-backstage-plugins works
This monorepo delivers Ansible self-service and AAP capabilities inside a Backstage developer portal. Developers enter through the Backstage app, browse cataloged automation resources, and use self-service screens or scaffolder workflows to create and launch automation; catalog providers synchronize AAP and SCM content for those experiences. Shared clients connect backend features to AAP and source-control services. The README documents authentication, RBAC, catalog integration, scaffolder actions, and dynamic-plugin deployment. Some subsystem links below are documented capabilities rather than verified calls; the source excerpts are incomplete.
Main entry points: App.tsx Backstage app · router.ts Catalog sync API · AAPService.ts AAP service · syncPollingService.ts Sync notifications
Components 25
Backstage portal
- Backstage app
packages/app/src/App.tsx - Global header
packages/app/src/components/GlobalHeader/GlobalHeader.tsx - Catalog UI
packages/app/src/components/catalog/EntityPage.tsx
Ansible experiences
- Ansible portal
plugins/backstage-rhaap/src/components/AnsiblePage/AnsiblePage.tsx - Self-service UI
plugins/self-service/src/components/LandingPage/LandingPage.tsx - Job templates
plugins/self-service/src/components/Home/Home.tsx - Collections catalog
plugins/self-service/src/components/CollectionsCatalog/CollectionsCatalogPage.tsx - Execution environments
plugins/self-service/src/components/ExecutionEnvironments/EERoutesPage.tsx - Git repositories
plugins/self-service/src/components/GitRepositories/GitRepositoriesPage.tsx - Create workflows
plugins/self-service/src/components/CreateTask/CreateTask.tsx - Run workflows
plugins/self-service/src/components/RunTask/RunTask.tsx - Sync notifications
plugins/self-service/src/components/notifications/syncPollingService.ts
Automation backend
- Catalog sync API
plugins/catalog-backend-module-rhaap/src/router.ts - AAP catalog providers
plugins/catalog-backend-module-rhaap/src/providers/AAPEntityProvider.ts - SCM content provider
plugins/catalog-backend-module-rhaap/src/providers/AnsibleGitContentsProvider.ts - Entity parsing
plugins/catalog-backend-module-rhaap/src/providers/entityParser.ts - AAP scaffolder actions
plugins/scaffolder-backend-module-backstage-rhaap/src/actions - AAP authentication
plugins/auth-backend-module-rhaap-provider/src/authenticator.ts - User template API
plugins/auth-backend-module-rhaap-provider/src/userJobTemplatesRouter.ts - AAP service
plugins/backstage-rhaap-common/src/AAPService/AAPService.ts - AAP API client
plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts - SCM client
plugins/backstage-rhaap-common/src/ScmClient/ScmClient.ts
External services
- Ansible Automation Platform
- GitHub / GitLab
Other components
- Developer
Connections 27
- Developer → Backstage app: opens portal
- Backstage app → Ansible portal: routes to
packages/app/src/App.tsx - Backstage app → Self-service UI: routes to
packages/app/src/App.tsx - Backstage app → Catalog UI: routes to
packages/app/src/App.tsx - Backstage app → Global header: renders
packages/app/src/App.tsx - Developer → Job templates: browses and launches
- Developer → Collections catalog: browses
- Developer → Execution environments: manages
- Developer → Git repositories: browses
- Developer → Create workflows: creates workflows
- Developer → Run workflows: triggers automation
- Catalog sync API → AAP catalog providers: routes sync
plugins/catalog-backend-module-rhaap/src/router.ts - Catalog sync API → SCM content provider: routes sync
plugins/catalog-backend-module-rhaap/src/router.ts - AAP catalog providers → Entity parsing: parses entities
- SCM content provider → Entity parsing: parses entities
- AAP catalog providers → AAP service: reads AAP resources
- SCM content provider → SCM client: reads repositories
- Catalog sync API → Ansible Automation Platform: syncs resources
- AAP scaffolder actions → AAP service: interacts with AAP
- AAP authentication → Ansible Automation Platform: authenticates
- User template API → AAP service: fetches templates
plugins/auth-backend-module-rhaap-provider/src/userJobTemplatesRouter.ts - AAP service → AAP API client: delegates requests
plugins/backstage-rhaap-common/src/AAPService/AAPService.ts - AAP API client → Ansible Automation Platform: calls API
plugins/backstage-rhaap-common/src/AAPClient/AAPClient.ts - SCM client → GitHub / GitLab: reads source
- Sync notifications → Catalog sync API: polls sync status
- Sync notifications → Collections catalog: invalidates catalog cache
plugins/self-service/src/components/notifications/syncPollingService.ts - Sync notifications → Git repositories: invalidates repository cache
plugins/self-service/src/components/notifications/syncPollingService.ts