@pstefans/kuadrant-backstage-plugin-frontend
v0.0.7-test
Published
Backstage plugin for Kuadrant - enables developer portals for API access management using Kuadrant Gateway API primitives.
Readme
Kuadrant Plugin for Backstage/RHDH
Backstage plugin for Kuadrant - enables developer portals for API access management using Kuadrant Gateway API primitives.
For installation instructions, see docs/installation.md.
Features
- API Access Management: Request API keys for Kuadrant-protected APIs
- Access Tiers: Support for multiple access tiers with different rate limits via PlanPolicy
- User Identity: Integrates with Backstage identity API for user-specific API keys
- Policy Visibility: View AuthPolicies, RateLimitPolicies, and PlanPolicies
- API Key Management: View, create, and delete API keys
- Approval Workflow: API owners can approve/reject API access requests
- APIProduct Integration: Sync APIProduct custom resources from Kubernetes
Components
Pages
KuadrantPage- Main page showing API products list and approval queue
Entity Content
EntityKuadrantApiKeysContent- API keys management tab for API entitiesEntityKuadrantApiProductInfoContent- APIProduct details and plan information tabEntityKuadrantApiAccessCard- Quick API key request card for API entity overview
Other
ApprovalQueueCard- Displays pending API key requests for API ownersCreateAPIProductDialog- Dialog for creating new API products
Usage
For API Consumers
- Navigate to an API entity in the catalog
- Click the "API Keys" tab
- Click "Request API Access"
- Select a tier (bronze, silver, gold) and provide use case
- Wait for approval from the API owner
- Once approved, your API key will appear in the API Keys tab
For API Owners
- Navigate to the Kuadrant page
- View all API products synced from Kubernetes
- Create new API products by selecting an HTTPRoute and configuring:
- Display name and description
- Approval mode (manual or automatic)
- Publish status (draft or published)
- Approve or reject pending API key requests in the approval queue
