Kubernetes Operator API reference
#This page lists every field on every custom resource defined by plakar-operator. For an introduction to what these resources are and how to use them, see Kubernetes Operator.
Packages
#connector.plakar.io/v1alpha1
#Package v1alpha1 contains API Schema definitions for the connector v1alpha1 API group.
Resource Types
#Destination
#Destination is the Schema for the destinations API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
connector.plakar.io/v1alpha1 |
||
kind string |
Destination |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec DestinationSpec |
spec defines the desired state of Destination | Required: {} |
|
status DestinationStatus |
status defines the observed state of Destination | Optional: {} |
DestinationSpec
#DestinationSpec defines the desired state of Destination
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
endpoint string |
The Destination endpoint | Required: {} |
|
protocol string |
protocol is the protocol being used in the integration | Required: {} |
|
integration Integration |
Integration specifies the integration to use. | Required: {} |
|
fieldsFrom FieldsFromSource array |
FieldsFrom imports all keys from a list of ConfigMaps or Secrets as fields. Sources are merged in order; later entries override earlier ones. Explicit Fields entries override any key imported via FieldsFrom. |
Optional: {} |
|
fields object (keys:string, values:FieldValue) |
Fields are the parameters passed to the integration for this destination. Each value may be a literal string or a reference to a key in a ConfigMap or Secret. Fields take precedence over FieldsFrom. |
Optional: {} |
DestinationStatus
#DestinationStatus defines the observed state of Destination.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
DestinationID is the created destination id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
observedGeneration integer |
observedGeneration is the most recent generation of this resource’s spec that the controller has fully processed against plakman. |
Optional: {} |
|
conditions Condition array |
conditions represent the current state of the Destination resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
FieldKeySelector
#FieldKeySelector selects a single key from a ConfigMap or Secret.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the ConfigMap or Secret. | Required: {} |
|
key string |
Key is the key within the ConfigMap or Secret. | Required: {} |
|
optional boolean |
Optional specifies whether the reference must resolve. If true, a missing object or key is silently ignored. |
Optional: {} |
FieldValue
#FieldValue holds either a literal string value or a reference to one stored in a ConfigMap or Secret. Exactly one of Value or ValueFrom should be set.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
value string |
Value is a literal string value. | Optional: {} |
|
valueFrom FieldValueFrom |
ValueFrom references a value from a ConfigMap or Secret. | Optional: {} |
FieldValueFrom
#FieldValueFrom references a single key in a ConfigMap or Secret. Exactly one of the fields must be set.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretKeyRef FieldKeySelector |
SecretKeyRef selects a key from a Secret. | Optional: {} |
|
configMapKeyRef FieldKeySelector |
ConfigMapKeyRef selects a key from a ConfigMap. | Optional: {} |
FieldsFromSource
#FieldsFromSource imports all keys from a ConfigMap or a Secret as fields. Exactly one of ConfigMapRef or SecretRef must be set.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
configMapRef LocalObjectReference |
ConfigMapRef references a ConfigMap whose data is imported as fields. | Optional: {} |
|
secretRef LocalObjectReference |
SecretRef references a Secret whose data is imported as fields. | Optional: {} |
Integration
#Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Integration name | Required: {} |
LocalObjectReference
#LocalObjectReference names an object in the same namespace.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the referent. | Required: {} |
Source
#Source is the Schema for the sources API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
connector.plakar.io/v1alpha1 |
||
kind string |
Source |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec SourceSpec |
spec defines the desired state of Source | Required: {} |
|
status SourceStatus |
status defines the observed state of Source | Optional: {} |
SourceSpec
#SourceSpec defines the desired state of Source
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
endpoint string |
The Source endpoint | Required: {} |
|
protocol string |
protocol is the protocol being used in the integration | Required: {} |
|
integration Integration |
Integration specifies the integration to use. | Required: {} |
|
fieldsFrom FieldsFromSource array |
FieldsFrom imports all keys from a list of ConfigMaps or Secrets as fields. Sources are merged in order; later entries override earlier ones. Explicit Fields entries override any key imported via FieldsFrom. |
Optional: {} |
|
fields object (keys:string, values:FieldValue) |
Fields are the parameters passed to the integration for this source. Each value may be a literal string or a reference to a key in a ConfigMap or Secret. Fields take precedence over FieldsFrom. |
Optional: {} |
|
dataClasses string array |
dataClass is the data classes associated with the source. | Optional: {} |
|
environment string |
Environment is the data class. | Optional: {} |
SourceStatus
#SourceStatus defines the observed state of Source.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
SourceID is the created source id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
observedGeneration integer |
observedGeneration is the most recent generation of this resource’s spec that the controller has fully processed against plakman. |
Optional: {} |
|
conditions Condition array |
conditions represent the current state of the Source resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
Store
#Store is the Schema for the stores API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
connector.plakar.io/v1alpha1 |
||
kind string |
Store |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec StoreSpec |
spec defines the desired state of Store | Required: {} |
|
status StoreStatus |
status defines the observed state of Store | Optional: {} |
StoreSpec
#StoreSpec defines the desired state of Store
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
endpoint string |
The Store endpoint | Required: {} |
|
protocol string |
protocol is the protocol being used in the integration | Required: {} |
|
integration Integration |
Integration specifies the integration to use. | Required: {} |
|
fieldsFrom FieldsFromSource array |
FieldsFrom imports all keys from a list of ConfigMaps or Secrets as fields. Sources are merged in order; later entries override earlier ones. Explicit Fields entries override any key imported via FieldsFrom. |
Optional: {} |
|
fields object (keys:string, values:FieldValue) |
Fields are the parameters passed to the integration for this store. Each value may be a literal string or a reference to a key in a ConfigMap or Secret. Fields take precedence over FieldsFrom. |
Optional: {} |
StoreStatus
#StoreStatus defines the observed state of Store.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
StoreID is the created store id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
observedGeneration integer |
observedGeneration is the most recent generation of this resource’s spec that the controller has fully processed against plakman. |
Optional: {} |
|
conditions Condition array |
conditions represent the current state of the Store resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
task.plakar.io/v1alpha1
#Package v1alpha1 contains API Schema definitions for the task v1alpha1 API group.
Resource Types
#APIKeyRef
#Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretName string |
Name of the Secret | Required: {} |
|
key string |
Key within the Secret data | Required: {} |
ConnectorRef
#Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the name of the backing connector. | Required: {} |
|
namespace string |
Namespace is the namespace where to find the backing connector. If not set, the current namespace is assumed. |
Optional: {} |
Plakar
#Plakar is the Schema for the plakars API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
Plakar |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec PlakarSpec |
spec defines the desired state of Plakar | Required: {} |
|
status PlakarStatus |
status defines the observed state of Plakar | Optional: {} |
PlakarSpec
#PlakarSpec defines the desired state of Plakar
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
plakarControlPlaneUrl string |
The URL for the Plakar Control Plane instance. | Format: uri Required: {} |
|
inventoryUUID string |
The UUID of the inventory dedicated to the operator. If unset, the operator creates a self-managed inventory and records its UUID in status.inventoryUUID. |
Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ Optional: {} |
|
apiKey APIKeyRef |
API key. | Required: {} |
PlakarStatus
#PlakarStatus defines the observed state of Plakar.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
conditions represent the current state of the Plakar resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
|
inventoryUUID string |
The UUID of the inventory dedicated to the operator, either mirrored from spec.inventoryUUID or created by the operator when spec.inventoryUUID was left unset. Once set, it is never regenerated. |
Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ Optional: {} |
Restore
#Restore is the Schema for the restores API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
Restore |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec RestoreSpec |
spec defines the desired state of Restore | Required: {} |
|
status RestoreStatus |
status defines the observed state of Restore | Optional: {} |
RestoreSpec
#RestoreSpec defines the desired state of Restore.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
store ConnectorRef |
Store is the connector where the backup to restore from lives. | Required: {} |
|
destination ConnectorRef |
Destination is the connector where the data will be restored to. | Required: {} |
|
snapshotID string |
SnapshotID pins the restore to a specific snapshot. Mutually exclusive with Latest. |
Optional: {} |
|
latest boolean |
Latest instructs plakman to restore the most recent snapshot when true. Mutually exclusive with SnapshotID. |
Optional: {} |
|
edgeTags string array |
EdgeTags selects a remote edge to run this restore by tag match: all listed tags must be present on the edge. Omitted/empty matches any online edge, preferring one over local execution; if none are online it falls back to running locally. A populated list that matches no online edge fails the run instead. |
Optional: {} |
RestoreStatus
#RestoreStatus defines the observed state of Restore.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
atID string |
AtID is the at-job identifier returned by plakman when the restore was submitted. |
Optional: {} |
|
conditions Condition array |
conditions represent the current state of the Restore resource. | Optional: {} |
ScheduleBackup
#ScheduleBackup is the Schema for the schedulebackups API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
ScheduleBackup |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec ScheduleBackupSpec |
spec defines the desired state of ScheduleBackup | Required: {} |
|
status ScheduleBackupStatus |
status defines the observed state of ScheduleBackup | Optional: {} |
ScheduleBackupSpec
#ScheduleBackupSpec defines the desired state of ScheduleBackup
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
periodicity integer |
Periodicity is the interval in second for the operation. | Minimum: 1 Required: {} |
|
source ConnectorRef |
Source is the UUID of the source | Required: {} |
|
store ConnectorRef |
Store is the UUID of the store | Required: {} |
|
edgeTags string array |
EdgeTags selects a remote edge to run this task by tag match: all listed tags must be present on the edge. Omitted/empty matches any online edge, preferring one over local execution; if none are online it falls back to running locally. A populated list that matches no online edge fails the task instead. |
Optional: {} |
|
historyLimit integer |
HistoryLimit caps the number of TaskRun objects kept for this schedule. Older runs are pruned once the limit is exceeded. Defaults to 5 when unset. Maximum is 20. |
Maximum: 20 Minimum: 1 Optional: {} |
ScheduleBackupStatus
#ScheduleBackupStatus defines the observed state of ScheduleBackup.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
ID is the created backup task id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
conditions Condition array |
conditions represent the current state of the ScheduleBackup resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
ScheduleCheck
#ScheduleCheck is the Schema for the schedulechecks API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
ScheduleCheck |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec ScheduleCheckSpec |
spec defines the desired state of ScheduleCheck | Required: {} |
|
status ScheduleCheckStatus |
status defines the observed state of ScheduleCheck | Optional: {} |
ScheduleCheckSpec
#ScheduleCheckSpec defines the desired state of ScheduleCheck
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
periodicity integer |
Periodicity is the interval in second for the operation. | Minimum: 1 Required: {} |
|
store ConnectorRef |
Store is the store to check. | Required: {} |
|
edgeTags string array |
EdgeTags selects a remote edge to run this task by tag match: all listed tags must be present on the edge. Omitted/empty matches any online edge, preferring one over local execution; if none are online it falls back to running locally. A populated list that matches no online edge fails the task instead. |
Optional: {} |
|
historyLimit integer |
HistoryLimit caps the number of TaskRun objects kept for this schedule. Older runs are pruned once the limit is exceeded. Defaults to 5 when unset. Maximum is 20. |
Maximum: 20 Minimum: 1 Optional: {} |
ScheduleCheckStatus
#ScheduleCheckStatus defines the observed state of ScheduleCheck.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
ID is the created check task id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
conditions Condition array |
conditions represent the current state of the ScheduleCheck resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
ScheduleSync
#ScheduleSync is the Schema for the schedulesyncs API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
ScheduleSync |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec ScheduleSyncSpec |
spec defines the desired state of ScheduleSync | Required: {} |
|
status ScheduleSyncStatus |
status defines the observed state of ScheduleSync | Optional: {} |
ScheduleSyncSpec
#ScheduleSyncSpec defines the desired state of ScheduleSync
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
periodicity integer |
Periodicity is the interval in second for the operation. | Minimum: 1 Required: {} |
|
sourceStore ConnectorRef |
SourceStore is the store to sync from. | Required: {} |
|
destinationStore ConnectorRef |
DestinationStore is the store to sync to. | Required: {} |
|
edgeTags string array |
EdgeTags selects a remote edge to run this task by tag match: all listed tags must be present on the edge. Omitted/empty matches any online edge, preferring one over local execution; if none are online it falls back to running locally. A populated list that matches no online edge fails the task instead. |
Optional: {} |
|
historyLimit integer |
HistoryLimit caps the number of TaskRun objects kept for this schedule. Older runs are pruned once the limit is exceeded. Defaults to 5 when unset. Maximum is 20. |
Maximum: 20 Minimum: 1 Optional: {} |
ScheduleSyncStatus
#ScheduleSyncStatus defines the observed state of ScheduleSync.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
ID is the created sync task id on plakman. | Pattern: ^[0-9a-fA-F]\{8\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{4\}-[0-9a-fA-F]\{12\}$ |
|
conditions Condition array |
conditions represent the current state of the ScheduleSync resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - “Available”: the resource is fully functional - “Progressing”: the resource is being created or updated - “Degraded”: the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
Optional: {} |
TaskRef
#TaskRef identifies the schedule resource that owns this run.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the name of the parent schedule resource. | Required: {} |
|
kind string |
Kind is the kind of the parent schedule resource (ScheduleBackup, ScheduleSync, ScheduleCheck). |
Required: {} |
TaskRun
#TaskRun is a virtual record of a single execution of a scheduled task, mirroring state from the plakman control plane.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
task.plakar.io/v1alpha1 |
||
kind string |
TaskRun |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
Optional: {} |
|
spec TaskRunSpec |
spec identifies the execution; it is set once at creation and never mutated. | Required: {} |
|
status TaskRunStatus |
status reflects the observed execution state. | Optional: {} |
TaskRunSpec
#TaskRunSpec defines the (immutable) identity of a single execution.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
taskRef TaskRef |
TaskRef references the parent schedule that produced this run. | Required: {} |
|
jobID string |
JobID is the plakman job UUID for this execution. | Required: {} |
TaskRunStatus
#TaskRunStatus reflects the observed state of the execution as reported by the plakman control plane.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
phase string |
Phase is the current lifecycle phase of the execution: queued, running, canceled, succeeded, or failed. |
Optional: {} |
|
scheduledAt Time |
ScheduledAt is the time the execution was scheduled to run. | Optional: {} |
|
startedAt Time |
StartedAt is the time the execution actually started. | Optional: {} |
|
stoppedAt Time |
StoppedAt is the time the execution finished (success or failure). | Optional: {} |
|
conditions Condition array |
conditions represent the current state of the TaskRun resource. | Optional: {} |