Installing the SpectroCloud Cluster Provider Plugin

This guide will help you install and set up the SpectroCloud cluster provider plugin.

Prerequisites

1. A working Backstage instance
2. The Backstage Kubernetes plugin installed
3. SpectroCloud Palette API credentials

Important: Backstage currently supports only one custom cluster supplier at a time. If you are also using the VCFA VKS Cluster Provider, only one of the two plugins can be enabled in your Backstage instance at a time.

Installation Steps

1. Add Required Package

yarn --cwd packages/backend add @terasky/backstage-plugin-spectrocloud-cluster-provider

2. Add to Backend

Modify packages/backend/src/index.ts:

backend.add(import('@terasky/backstage-plugin-spectrocloud-cluster-provider'));

3. Configure SpectroCloud

Add to your app-config.yaml:

spectrocloud:
  environments:
    - name: production
      url: https://api.spectrocloud.com
      tenant: my-tenant
      apiToken: ${SPECTROCLOUD_API_TOKEN}
      clusterProvider:
        includeProjects: [production]

Verification

After installation:

1. Check backend logs for cluster discovery messages
2. Navigate to a component with Kubernetes resources
3. Verify SpectroCloud clusters appear

Testing

Look for log messages like:

SpectroCloud: Discovered X clusters
SpectroCloud: Created RBAC for cluster Y

Troubleshooting

Common Issues

1. No Clusters Found
2. Verify API credentials
3. Check project filters

4. Review network connectivity

5. RBAC Setup Failures

6. Verify kubeconfig has admin access
7. Check cluster connectivity
8. Review backend logs

Next Steps

1. Configure project filtering
2. Customize RBAC settings