# Kubernetes Operator API reference This page lists every field on every custom resource defined by [plakar-operator](https://github.com/PlakarKorp/plakar-operator). For an introduction to what these resources are and how to use them, see [Kubernetes Operator](../../infrastructure-as-code/kubernetes-operator). ## Packages - [connector.plakar.io/v1alpha1](#connectorplakariov1alpha1) - [task.plakar.io/v1alpha1](#taskplakariov1alpha1) ## connector.plakar.io/v1alpha1 Package v1alpha1 contains API Schema definitions for the connector v1alpha1 API group. ### Resource Types - [Destination](#destination) - [Source](#source) - [Store](#store) #### Destination Destination is the Schema for the destinations API | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | ------- | --------------------- | | `apiVersion` _string_ | `connector.plakar.io/v1alpha1` | | | | `kind` _string_ | `Destination` | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[DestinationSpec](#destinationspec)_ | spec defines the desired state of Destination | | Required: \{\}
| | `status` _[DestinationStatus](#destinationstatus)_ | status defines the observed state of Destination | | Optional: \{\}
| #### DestinationSpec DestinationSpec defines the desired state of Destination _Appears in:_ - [Destination](#destination) | 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)_ | Integration specifies the integration to use. | | Required: \{\}
| | `fieldsFrom` _[FieldsFromSource](#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](#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:_ - [Destination](#destination) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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:_ - [FieldValueFrom](#fieldvaluefrom) | 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:_ - [DestinationSpec](#destinationspec) - [SourceSpec](#sourcespec) - [StoreSpec](#storespec) | Field | Description | Default | Validation | | ----------------------------------------------- | -------------------------------------------------------- | ------- | --------------------- | | `value` _string_ | Value is a literal string value. | | Optional: \{\}
| | `valueFrom` _[FieldValueFrom](#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:_ - [FieldValue](#fieldvalue) | Field | Description | Default | Validation | | --------------------------------------------------------- | ----------------------------------------------- | ------- | --------------------- | | `secretKeyRef` _[FieldKeySelector](#fieldkeyselector)_ | SecretKeyRef selects a key from a Secret. | | Optional: \{\}
| | `configMapKeyRef` _[FieldKeySelector](#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:_ - [DestinationSpec](#destinationspec) - [SourceSpec](#sourcespec) - [StoreSpec](#storespec) | Field | Description | Default | Validation | | -------------------------------------------------------------- | --------------------------------------------------------------------- | ------- | --------------------- | | `configMapRef` _[LocalObjectReference](#localobjectreference)_ | ConfigMapRef references a ConfigMap whose data is imported as fields. | | Optional: \{\}
| | `secretRef` _[LocalObjectReference](#localobjectreference)_ | SecretRef references a Secret whose data is imported as fields. | | Optional: \{\}
| #### Integration _Appears in:_ - [DestinationSpec](#destinationspec) - [SourceSpec](#sourcespec) - [StoreSpec](#storespec) | Field | Description | Default | Validation | | --------------- | ---------------- | ------- | --------------------- | | `name` _string_ | Integration name | | Required: \{\}
| #### LocalObjectReference LocalObjectReference names an object in the same namespace. _Appears in:_ - [FieldsFromSource](#fieldsfromsource) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[SourceSpec](#sourcespec)_ | spec defines the desired state of Source | | Required: \{\}
| | `status` _[SourceStatus](#sourcestatus)_ | status defines the observed state of Source | | Optional: \{\}
| #### SourceSpec SourceSpec defines the desired state of Source _Appears in:_ - [Source](#source) | 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)_ | Integration specifies the integration to use. | | Required: \{\}
| | `fieldsFrom` _[FieldsFromSource](#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](#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:_ - [Source](#source) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[StoreSpec](#storespec)_ | spec defines the desired state of Store | | Required: \{\}
| | `status` _[StoreStatus](#storestatus)_ | status defines the observed state of Store | | Optional: \{\}
| #### StoreSpec StoreSpec defines the desired state of Store _Appears in:_ - [Store](#store) | 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)_ | Integration specifies the integration to use. | | Required: \{\}
| | `fieldsFrom` _[FieldsFromSource](#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](#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:_ - [Store](#store) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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 - [Plakar](#plakar) - [Restore](#restore) - [ScheduleBackup](#schedulebackup) - [ScheduleCheck](#schedulecheck) - [ScheduleSync](#schedulesync) - [TaskRun](#taskrun) #### APIKeyRef _Appears in:_ - [PlakarSpec](#plakarspec) | Field | Description | Default | Validation | | --------------------- | -------------------------- | ------- | --------------------- | | `secretName` _string_ | Name of the Secret | | Required: \{\}
| | `key` _string_ | Key within the Secret data | | Required: \{\}
| #### ConnectorRef _Appears in:_ - [RestoreSpec](#restorespec) - [ScheduleBackupSpec](#schedulebackupspec) - [ScheduleCheckSpec](#schedulecheckspec) - [ScheduleSyncSpec](#schedulesyncspec) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[PlakarSpec](#plakarspec)_ | spec defines the desired state of Plakar | | Required: \{\}
| | `status` _[PlakarStatus](#plakarstatus)_ | status defines the observed state of Plakar | | Optional: \{\}
| #### PlakarSpec PlakarSpec defines the desired state of Plakar _Appears in:_ - [Plakar](#plakar) | 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](#apikeyref)_ | API key. | | Required: \{\}
| #### PlakarStatus PlakarStatus defines the observed state of Plakar. _Appears in:_ - [Plakar](#plakar) | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[RestoreSpec](#restorespec)_ | spec defines the desired state of Restore | | Required: \{\}
| | `status` _[RestoreStatus](#restorestatus)_ | status defines the observed state of Restore | | Optional: \{\}
| #### RestoreSpec RestoreSpec defines the desired state of Restore. _Appears in:_ - [Restore](#restore) | Field | Description | Default | Validation | | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------------- | | `store` _[ConnectorRef](#connectorref)_ | Store is the connector where the backup to restore from lives. | | Required: \{\}
| | `destination` _[ConnectorRef](#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:_ - [Restore](#restore) | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------- | --------------------- | | `atID` _string_ | AtID is the at-job identifier returned by plakman when the restore
was submitted. | | Optional: \{\}
| | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[ScheduleBackupSpec](#schedulebackupspec)_ | spec defines the desired state of ScheduleBackup | | Required: \{\}
| | `status` _[ScheduleBackupStatus](#schedulebackupstatus)_ | status defines the observed state of ScheduleBackup | | Optional: \{\}
| #### ScheduleBackupSpec ScheduleBackupSpec defines the desired state of ScheduleBackup _Appears in:_ - [ScheduleBackup](#schedulebackup) | Field | Description | Default | Validation | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------- | | `periodicity` _integer_ | Periodicity is the interval in second for the operation. | | Minimum: 1
Required: \{\}
| | `source` _[ConnectorRef](#connectorref)_ | Source is the UUID of the source | | Required: \{\}
| | `store` _[ConnectorRef](#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:_ - [ScheduleBackup](#schedulebackup) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[ScheduleCheckSpec](#schedulecheckspec)_ | spec defines the desired state of ScheduleCheck | | Required: \{\}
| | `status` _[ScheduleCheckStatus](#schedulecheckstatus)_ | status defines the observed state of ScheduleCheck | | Optional: \{\}
| #### ScheduleCheckSpec ScheduleCheckSpec defines the desired state of ScheduleCheck _Appears in:_ - [ScheduleCheck](#schedulecheck) | Field | Description | Default | Validation | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------- | | `periodicity` _integer_ | Periodicity is the interval in second for the operation. | | Minimum: 1
Required: \{\}
| | `store` _[ConnectorRef](#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:_ - [ScheduleCheck](#schedulecheck) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[ScheduleSyncSpec](#schedulesyncspec)_ | spec defines the desired state of ScheduleSync | | Required: \{\}
| | `status` _[ScheduleSyncStatus](#schedulesyncstatus)_ | status defines the observed state of ScheduleSync | | Optional: \{\}
| #### ScheduleSyncSpec ScheduleSyncSpec defines the desired state of ScheduleSync _Appears in:_ - [ScheduleSync](#schedulesync) | Field | Description | Default | Validation | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------- | | `periodicity` _integer_ | Periodicity is the interval in second for the operation. | | Minimum: 1
Required: \{\}
| | `sourceStore` _[ConnectorRef](#connectorref)_ | SourceStore is the store to sync from. | | Required: \{\}
| | `destinationStore` _[ConnectorRef](#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:_ - [ScheduleSync](#schedulesync) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) 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:_ - [TaskRunSpec](#taskrunspec) | 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](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: \{\}
| | `spec` _[TaskRunSpec](#taskrunspec)_ | spec identifies the execution; it is set once at creation and never mutated. | | Required: \{\}
| | `status` _[TaskRunStatus](#taskrunstatus)_ | status reflects the observed execution state. | | Optional: \{\}
| #### TaskRunSpec TaskRunSpec defines the (immutable) identity of a single execution. _Appears in:_ - [TaskRun](#taskrun) | Field | Description | Default | Validation | | ------------------------------- | -------------------------------------------------------------- | ------- | --------------------- | | `taskRef` _[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:_ - [TaskRun](#taskrun) | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------- | --------------------- | | `phase` _string_ | Phase is the current lifecycle phase of the execution:
queued, running, canceled, succeeded, or failed. | | Optional: \{\}
| | `scheduledAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta)_ | ScheduledAt is the time the execution was scheduled to run. | | Optional: \{\}
| | `startedAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta)_ | StartedAt is the time the execution actually started. | | Optional: \{\}
| | `stoppedAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta)_ | StoppedAt is the time the execution finished (success or failure). | | Optional: \{\}
| | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta) array_ | conditions represent the current state of the TaskRun resource. | | Optional: \{\}
|