Connectors
A connector stores the connection settings that vCluster Platform uses to reach an external service. Platform features reference it by name. For example, a database connector lets Platform provision a separate backing database for each cluster.
Platform v5.0 adds the cluster-scoped Connector resource in management.loft.sh/v1. It serves the existing connector Secrets in the Platform namespace. Existing connectors become available through this API without copying credentials or changing their names. If you're upgrading with existing connector Secrets, start with Preserve existing integrations.
Choose a connector​
Set exactly one payload section in spec. That section selects the connector type and you can't change the type after creation.
| Integration | Payload section | Backing Secret type label | Required license feature |
|---|---|---|---|
| Database, including AWS IAM authentication | sharedDatabase | shared-database | connector-external-database |
| Argo CD and Akuity | argoCd | argocd | argo-integration |
| Observability | observability | observability | fleet-observability |
| OS image storage | imageStore | os-image-store | machine-management |
| NetBox | netBox | netbox | auto-nodes-metal3 |
Create and update require the corresponding license feature. Get, list, and delete remain available after a license expires, subject to access permissions.
Manage and use connectors​
Platform admins create connectors in the UI under Secrets & Credentials > Connectors, through the management API, or, with control plane cluster access, by writing the backing Secrets directly. Every path uses the same stored configuration. The API adds validation, type-specific defaults on create, and status conditions.
Connectors are cluster-scoped. A connector's name is also the name of its backing Secret in the Platform namespace.
See Manage connectors and tenant grants for examples and API behavior that matters to automation. See the Connector API reference for fields and endpoints.
Control access to configuration​
Bind loft-connectors-viewer for get and list, or loft-connectors-admin for connector management. These roles aren't assigned by default. Project membership alone doesn't grant connector discovery.
A caller with update permission, such as through loft-connectors-admin, receives the full configuration, including credentials. Other callers, such as those with only loft-connectors-viewer, receive a reduced view. Tenant sessions always receive the reduced view, even when their role grants update.
The reduced view includes the name, display name, description, and a payload section identifying the type. It also includes these type-specific fields:
| Type | Additional configuration visible to viewers |
|---|---|
| Database | Database dialect |
| Argo CD | None |
| Observability | None |
| OS image store | Protocol (s3) |
| NetBox | URL and insecure setting |
Condition types, statuses, and reasons remain visible. Condition messages and most metadata describing management are removed. Empty connection fields in a reduced view don't mean the stored connector lacks credentials.
Grants control which connectors a tenant can see and use. Platform enforces them for database, Argo CD, observability, OS image store, and NetBox references. See Validate connector use.
The default audit policies record connector requests at metadata level, without request or response bodies. Review custom audit policies separately.
Preserve existing integrations​
Direct Secret writers remain supported. They bypass API validation, so they must keep the Secret format valid. The database, Argo CD, and NetBox guides show their Secret formats. The API serves only recognized connector types in the Platform namespace.
An API update, including a label change, rewrites the backing Secret and drops data the API doesn't model. Credential preservation also differs by type and authentication method. See Update credentials before changing a connector through automation.
The old list-only DatabaseConnector resource is deprecated in place. It remains available, and no removal is announced. See Migrate database discovery.