Skip to main content

Portal integrations

Portal integrations publish Promises as catalogue entries and request forms, so developers can discover and request platform capabilities. Publication and request delivery are separate: verify both before making an integration available to developers.

Choose your portal​

PortalControllerPublicationRequest journey
BackstagePortal ControllerDocuments in Git or bucket storage, discovered by BackstageInstall SKE plugins, configure backend access and permissions, then submit requests
CortexPortal ControllerEntities and workflows through the Cortex APIConfigure GitHub or GitLab integration and a GitOps agent to apply requests
Port (Preview)Separate Port ControllerPort entities and actionsFollow the Port guide for Ocean, GitHub Actions and GitOps setup

The shared Portal Controller supports Backstage and Cortex instances, Promise selection with labels, and document customisation through PortalCustomization. Start with your portal's guide, including its prerequisites and verification steps. Use How the Portal Controller works to understand the shared publication pipeline.

Port is a Preview feature

Port does not use the shared Portal Controller. Review the Preview support policy and discuss production suitability with Syntasso.

Customise the right layer​

  • Change the Promise API to change the resource contract and generated form fields.
  • Use PortalCustomization to change generated documents, optionally with Portal Patch.
  • Use the Backstage plugin APIs to change the Backstage interface.

See Backstage customisation or Cortex customisation.

Existing installations​

Upgrade from a standalone controller

The standalone Backstage and Cortex Controllers are deprecated. Follow the Backstage migration guide or Cortex migration guide.

Check component compatibility before an upgrade. For publication failures, use portal sync troubleshooting.