API Reference
Packages
infrahub.operators.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the infrahub v1alpha1 API group
Resource Types
InfrahubSync
InfrahubSync is the Schema for the infrahubsyncs API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrahub.operators.com/v1alpha1 | ||
kind string | InfrahubSync | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec InfrahubSyncSpec | Spec defines the desired state of InfrahubSync | ||
status InfrahubSyncStatus | Status defines the observed state of InfrahubSync |
InfrahubSyncDestination
VidraResourceDestination contains information about where the resource will be sent
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
server string | Only needed if you need to deploy to two Kubernetis cluster (multicluster) if set to "httlps://kubernetes.default.svc" or omitted, the operator will use the current cluster | Optional: {} Pattern: ^(http|https)://[a-zA-Z0-9.-]+(:[0-9]+)?(?:/[a-zA-Z0-9-]+)*$ | |
namespace string | Default Namespace in the Kubernetes cluster where the resource should be sent, if they do not hava a namespace already set | Optional: {} | |
reconcileOnEvents boolean | If true, the operator will reconcile resources based on k8s events. (default: false) - changes to the resource will trigger a reconciliation | false |
InfrahubSyncSource
VidraResourceSource contains the source information for the resource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
infrahubAPIURL string | URL for the Infrahub API (e.g., https://infrahub.example.com) | Pattern: ^(http|https)://[a-zA-Z0-9.-]+(:[0-9]+)?(?:/[a-zA-Z0-9-]+)*$ Required: {} | |
targetBranch string | The target branch in Infrahub to interact with | main | MinLength: 1 Required: {} |
targetDate string | The target date in Infrahub for all the interactions (e.g., "2025-01-01T00:00:00Z or -2d" for the artifact from two days ago). If not set, the operator will use the current date. | Optional: {} | |
artefactName string | Artifact name that is being handled by the operator, this is used to identify the resource in Infrahub | MinLength: 1 Required: {} |
InfrahubSyncSpec
InfrahubSyncSpec defines the desired state of InfrahubSync
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
source InfrahubSyncSource | Foo is an example field of InfrahubSync. Edit infrahubsync_types.go to remove/update Source contains the source information for the Infrahub API interaction | ||
destination InfrahubSyncDestination | Destination contains the destination information for the resource |
InfrahubSyncStatus
InfrahubSyncStatus defines the observed state of InfrahubSync
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
checksums string array | Checksums contains a list of checksums for synced resources | ||
syncState State | SyncState indicates the current state of the sync operation | Enum: [Pending Running Succeeded Failed Stale] | |
lastError string | LastError provides details about the last error encountered during the sync operation | ||
lastSyncTime Time | LastSyncTime indicates the last time the sync operation was performed |
ManagedResourceStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
kind string | Kind of the resource (e.g., Deployment, Service) | ||
apiVersion string | APIVersion of the resource (e.g., apps/v1) | ||
name string | Name of the resource | ||
namespace string | Namespace of the resource |
State
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Running | Indicates the resource is currently reconciling |
Succeeded | Indicates the resource reconciliation was successful |
Failed | Indicates the resource reconciliation failed |
Stale | Indicates the resource has achieved the desired state but still has old resources which are not yet cleaned up |
VidraResource
VidraResource is the Schema for the Vidraresources API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | infrahub.operators.com/v1alpha1 | ||
kind string | VidraResource | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec VidraResourceSpec | VidraResourceSpec defines the desired state of VidraResource | ||
status VidraResourceStatus | VidraResourceStatus defines the observed state of VidraResource |
VidraResourceSpec
VidraResourceSpec defines the desired state of VidraResource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
destination InfrahubSyncDestination | Destination contains the destination information for the resource | ||
manifest string | Manifest contains the manifest information for the resource | ||
reconciledAt Time | The last time the resource was reconciled |
VidraResourceStatus
VidraResourceStatus defines the observed state of VidraResource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
managedResources ManagedResourceStatus array | ManagedResources contains a list of resources managed by this VidraResource | ||
DeployState State | DeployState indicates the current state of the deployment | Enum: [Pending Running Succeeded Failed Stale] | |
lastError string | LastError contains the last error message if any | ||
lastSyncTime Time | LastSyncTime indicates the last time the resource was synchronized |