Skip to main content

Plugins

Plugins let you connect any external tool to Cycloid and display its data directly where your teams already work, inside components, projects, or as dedicated pages in the sidebar. Whether it's error tracking from Sentry, code quality from SonarQube, or any internal system your organization relies on, plugins bring that context into Cycloid without requiring users to switch between tools.

note

The Plugins system is only available on dedicated (self-hosted) Cycloid installations. Refer to the on-premises installation guide to enable the plugin services on your infrastructure before following this guide.

Who this is for

  • Platform Teams — responsible for registering, configuring, and managing plugins for their organization.
  • End Users (developers, ops, project managers) — who want consolidated, context-specific views of external tool data without leaving Cycloid.
  • Plugin Developers — building plugins to extend Cycloid with new data sources and views.

How it works

When the plugin system is enabled on your Cycloid installation, three services are deployed alongside Cycloid and are always reachable at the same internal addresses regardless of your setup:

ServiceInternal addressPurpose
Docker Registrydocker-registry:5000Stores the container images for each plugin version
Plugin Registryhttp://plugin-registry:4000Catalog where plugins and versions are published and validated
Plugin Managerhttp://plugin-manager:4000Runs plugin containers and manages their lifecycle

These addresses are the same on every installation — Kubernetes or on-premises — so the URLs you use to connect services in the Cycloid UI will always be the same.

All organizations that connect to the same Plugin Registry share the same plugin catalog. This works similarly to a catalog repository in Cycloid: any plugin created in the registry is visible and installable by all organizations connected to it.

Where to go next

I want to…Go to…
Connect a registry and get startedPlugin Registry
Accept a Plugin Manager connection requestPlugin Manager
Create, install, and manage plugins end-to-endManaging Plugins
Build my own pluginWriting a Plugin
Look up permissions, file specs, or API endpointsReference