Zum Inhalt

Polycrate API

Web-UI und Backend für Workspaces, Kubernetes-Ressourcen, Monitoring und Team-Betrieb. Ergänzt die lokale CLI; Blocks kommen weiter aus dem Polycrate Hub.

Komponente Rolle
CLI Lokale Actions, Blocks, Git, Operator im Cluster
API UI, Reconciliation, Alerts, Audit, Multi-Tenancy
Hub OCI-Registry / Marketplace für Blocks 
graph TB
    CLI[Polycrate CLI] -->|ActionRuns / Sync| API[Polycrate API]
    CLI -->|Pull / Push| Hub[Polycrate Hub]
    Agent[Monitoring Agent] -->|Checks| API
    Op[Operator] -->|CRs| API

Zielgruppe

Platform- und Ops-Teams, die viele Workspaces und Cluster zentral sehen und steuern wollen — inkl. MSP-Szenarien mit mehreren Organisationen.

Funktionen (Überblick)

Bereich Inhalt
Workspaces & Blocks Status, Versionen, Action-Run-Historie
Kubernetes Cluster, Apps, Volumes, Backups (Velero/CNPG), Addons
Networking LoadBalancer, Endpoints, Domains & DNS
Storage S3-Cluster und Buckets
Operations Conditions, Criticality, Wartungen, Incidents, Operations-Dashboard
Security / Compliance Credentials, Audit, Vulnerability Management
Observability Endpoint-Checks, VictoriaMetrics/VictoriaLogs, Metriken-API
AI / MCP Read-only Zugang aus der IDE: MCP (Plattform) · lokal: CLI-MCP

Action-Runs: die CLI meldet Ausführungen an die API (Audit, Logs, Exit-Codes), wenn API-Zugang konfiguriert ist.

Backups in der UI sind in der Regel read-only (Status aus dem Cluster); Trigger/Restore bleibt bei Velero/CNPG bzw. den Blocks.

Web-UI-Bereiche

  • Dashboard — Alerts, letzte Runs, Cluster-Health, Wartungen
  • Workspaces / Blocks — Konfiguration, APM-Hinweise, Run-Historie
  • Kubernetes / Storage / Networking — wie in der Tabelle oben
  • Monitoring — Endpoints, Agents, Alerts, Log-Explorer
  • Collaboration — Tasks, Notes, Knowledge Base, Conversations
  • Credentials / Administration — Secrets, Users, Orgs, API-Keys, SystemConfig

Erste Schritte

Zugang

Die API ist nicht öffentlich self-service. Zugang über Support oder Discord.

CLI anbinden (~/.polycrate/polycrate.yml):

api:
  enabled: true
  url: https://<ihre-api-host>
  api_key: <your-api-key>
  submit_action_runs: true

Danach reicht typischerweise ein polycrate run <block> <action> — Workspace und Runs erscheinen in der UI.

Stack

Django-Anwendung mit PostgreSQL, Redis (Cache/Queue), VictoriaMetrics/VictoriaLogs, Keycloak (SSO) und Alpine.js in der UI.

graph TB
    CLI[CLI] -->|ActionRuns| API[API]
    Agent[Agent] -->|Checks| API
    API --> DB[(PostgreSQL)]
    API --> Redis[(Redis)]
    API --> VL[(VictoriaLogs)]
    API --> VM[(VictoriaMetrics)]
    API --> KC[Keycloak]

Themen