Federation configuration field reference
This reference provides detailed information about all configuration fields available for SPIRE federation in the SpireServer custom resource. Use this reference when customizing your federation setup.
- Top-level federation fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
object |
Yes |
N/A |
Configuration for this cluster’s federation endpoint that exposes the trust bundle to remote clusters. |
|
array |
No |
|
List of remote trust domains to federate with. |
|
string |
No |
|
Enable or disable automatic OpenShift Route creation. Set to |
- bundleEndpoint configuration fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
string (enum) |
Yes |
|
Authentication profile for the bundle endpoint. Valid values: |
|
integer |
No |
|
Suggested interval (in seconds) for remote servers to refresh the trust bundle. Valid range: 60-3600. |
|
object |
Conditional |
N/A |
Required when |
- httpsWeb configuration fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
object |
Conditional |
N/A |
ACME configuration for automatic certificate management. Mutually exclusive with |
|
object |
Conditional |
N/A |
Manual certificate configuration. Mutually exclusive with |
- ACME configuration fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
string |
Yes |
N/A |
ACME directory URL. For Let’s Encrypt production: |
|
string |
Yes |
N/A |
Fully qualified domain name for the certificate. Typically the federation endpoint hostname. |
|
string |
Yes |
N/A |
Email address for ACME account registration and certificate expiration notifications. |
|
string |
No |
|
Accept the ACME provider’s Terms of Service. Must be |
- servingCert configuration fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
integer |
No |
|
Interval (in seconds) to check for certificate updates. Valid range: 3600-7776000 (1 hour to 90 days). |
|
string |
Yes |
N/A |
Name of the Kubernetes Secret containing the TLS certificate ( |
- federatesWith configuration fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
|
string |
Yes |
N/A |
Trust domain name of the remote SPIRE deployment (for example, |
|
string |
Yes |
N/A |
HTTPS URL of the remote federation endpoint (for example, |
|
string (enum) |
Yes |
N/A |
Authentication profile of the remote endpoint. Valid values: |
|
string |
Conditional |
N/A |
SPIFFE ID of the remote SPIRE server (for example, |
- Field validation rules
-
The following validation rules are enforced by the operator:
-
Profile immutability: The
bundleEndpoint.profilefield cannot be changed after initial configuration. Changing it requires deleting and recreating theSpireServerresource (re-installation of the system). -
Mutual exclusivity: Within
httpsWeb, only one ofacmeorservingCertcan be specified. -
Conditional requirements: When
profileishttps_web, thehttpsWebobject must be present with eitheracmeorservingCertconfigured. -
SPIFFE ID requirement: When
bundleEndpointProfileishttps_spiffein thefederatesWithlist, theendpointSpiffeIdfield is required. -
Array limits: The
federatesWitharray supports a maximum of 50 entries. -
Numeric ranges:
-
refreshHint: 60-3600 seconds -
fileSyncInterval: 3600-7776000 seconds
-
-