This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Reference

This section contains the API Reference of CRDs for the Resiliency Operator.

1 - Assets API Reference

Packages

assets.astronetes.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the assets v1alpha1 API group

Resource Types

AWSS3

Appears in:

FieldDescriptionDefaultValidation
name stringBucket nameRequired: {}
region stringAWS region nameRequired: {}
secretName stringSecret name where credentials are storedRequired: {}

Bucket

Bucket is the Schema for the buckets API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringBucket
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec BucketSpec

BucketList

BucketList contains a list of Bucket

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringBucketList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Bucket array

BucketSpec

BucketSpec defines the desired state of Bucket

Appears in:

FieldDescriptionDefaultValidation
generic GenericBucketReference a generic bucketOptional: {}
gcpCloudStorage GCPCloudStorageReference a GCP Cloud Storage serviceOptional: {}
awsS3 AWSS3Reference a AWS Bucket serviceOptional: {}

Database

Database is the Schema for the databases API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringDatabase
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec DatabaseSpec

DatabaseList

DatabaseList contains a list of Database

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringDatabaseList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Database array

DatabaseSpec

DatabaseSpec defines the desired state of Database

Appears in:

FieldDescriptionDefaultValidation
zookeeper ZookeeperZookeeper databaseOptional: {}

GCPCloudStorage

Appears in:

FieldDescriptionDefaultValidation
name stringBucket nameRequired: {}
secretName stringSecret name where credentials are storedRequired: {}

GenericBucket

Appears in:

FieldDescriptionDefaultValidation
name stringBucket nameRequired: {}
endpoint stringBucket endpointRequired: {}
useSSL booleanUse SSLOptional: {}
secretName stringSecret name where credentials are storedRequired: {}

KubernetesCluster

KubernetesCluster is the Schema for the kubernetesclusters API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringKubernetesCluster
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec KubernetesClusterSpec

KubernetesClusterList

KubernetesClusterList contains a list of KubernetesCluster

FieldDescriptionDefaultValidation
apiVersion stringassets.astronetes.io/v1alpha1
kind stringKubernetesClusterList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items KubernetesCluster array

KubernetesClusterSpec

KubernetesClusterSpec defines the desired state of KubernetesCluster

Appears in:

FieldDescriptionDefaultValidation
secretName stringReference to the secret that stores the cluster KubeconfigRequired: {}

Zookeeper

Appears in:

FieldDescriptionDefaultValidation
admin ZookeeperAdminCredentials for the admin portOptional: {}
client ZookeeperClientCredentials for the client portOptional: {}

ZookeeperAdmin

Appears in:

FieldDescriptionDefaultValidation
protocol stringZookeeper protocolRequired: {}
host stringZookeeper hostRequired: {}
port stringZookeeper portRequired: {}
secretName stringZookeeper authentication dataOptional: {}

ZookeeperClient

Appears in:

FieldDescriptionDefaultValidation
servers string arrayZookeeper serversRequired: {}

2 - Automation API Reference

Packages

automation.astronetes.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the automation v1alpha1 API group

Resource Types

Backup

Backup is the Schema for the backups API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringBackup
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec BackupSpec

BackupDestinationBucket

Appears in:

FieldDescriptionDefaultValidation
name stringReference the Bucket nameRequired: {}
basePath stringThe base path to be used to store the Backup dataOptional: {}

BackupList

BackupList contains a list of Backup

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringBackupList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Backup array

BackupPlugin

Underlying type: string

Appears in:

BackupSourceDatabase

Appears in:

FieldDescriptionDefaultValidation
name stringReference the Database nameRequired: {}

BackupSourceKubernetesCluster

Appears in:

FieldDescriptionDefaultValidation
name stringReference the KubernetesCluster nameRequired: {}
namespaces string arrayReference the Kubernetes namespaces to be includedOptional: {}

BackupSpec

BackupSpec defines the desired state of Backup

Appears in:

FieldDescriptionDefaultValidation
restartPolicy RestartPolicySuspend the CronJobOptional: {}
plugin BackupPluginBackup pluginRequired: {}
config JSONSynchronization configRequired: {}

LiveSynchronization

LiveSynchronization is the Schema for the livesynchronizations API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringLiveSynchronization
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec LiveSynchronizationSpec

LiveSynchronizationList

LiveSynchronizationList contains a list of LiveSynchronization

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringLiveSynchronizationList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items LiveSynchronization array

LiveSynchronizationPlugin

Underlying type: string

Appears in:

LiveSynchronizationSpec

LiveSynchronizationSpec defines the desired state of LiveSynchronization

Appears in:

FieldDescriptionDefaultValidation
suspend booleanSuspend the executionfalseOptional: {}
plugin LiveSynchronizationPluginLiveSynchronization pluginRequired: {}
config JSONLiveSynchronization configRequired: {}

Resource

Appears in:

FieldDescriptionDefaultValidation
group stringResource groupOptional: {}
version stringResource versionRequired: {}
resource stringResourceRequired: {}

Synchronization

Synchronization is the Schema for the synchronizations API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringSynchronization
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec SynchronizationSpec

SynchronizationList

SynchronizationList contains a list of Synchronization

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringSynchronizationList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Synchronization array

SynchronizationPlan

SynchronizationPlan is the Schema for the synchronizationplans API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringSynchronizationPlan
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec SynchronizationPlanSpec

SynchronizationPlanList

SynchronizationPlanList contains a list of SynchronizationPlan

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringSynchronizationPlanList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items SynchronizationPlan array

SynchronizationPlanSpec

SynchronizationPlanSpec defines the desired state of SynchronizationPlan

Appears in:

FieldDescriptionDefaultValidation
schedule stringSchedule in Cron formatRequired: {}
startingDeadlineSeconds integerOptional deadline in seconds for starting the job if it misses scheduled
time for any reason. Missed jobs executions will be counted as failed ones.		Optional: {}
concurrencyPolicy ConcurrencyPolicySpecifies how to treat concurrent executions of a Job.
Valid values are:

- “Allow” (default): allows CronJobs to run concurrently;
- “Forbid”: forbids concurrent runs, skipping next run if previous run hasn’t finished yet;
- “Replace”: cancels currently running job and replaces it with a new one		Optional: {}
suspend booleanSuspend the executionfalseOptional: {}
template SynchronizationTemplateSpecSpecify the Synchronization that will be created when executing the CronOptional: {}
successfulJobsHistoryLimit integerThe number of successful finished jobs to retain. Value must be non-negative integer2Optional: {}
failedJobsHistoryLimit integerThe number of failed finished jobs to retain. Value must be non-negative integer2Optional: {}

SynchronizationPlugin

Underlying type: string

Appears in:

SynchronizationSpec

SynchronizationSpec defines the desired state of Synchronization

Appears in:

FieldDescriptionDefaultValidation
restartPolicy RestartPolicyRestart policyOptional: {}
plugin SynchronizationPluginSynchronization pluginRequired: {}
config JSONSynchronization configRequired: {}

SynchronizationTemplateSpec

Appears in:

FieldDescriptionDefaultValidation
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec SynchronizationSpecSpecification of the desired behavior of the SynchronizationOptional: {}

Task

Task is the Schema for the tasks API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringTask
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec TaskSpec

TaskList

TaskList contains a list of Task

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringTaskList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items Task array

TaskPlugin

Underlying type: string

Appears in:

TaskRun

TaskRun is the Schema for the taskruns API

Appears in:

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringTaskRun
metadata ObjectMetaRefer to Kubernetes API documentation for fields of metadata.
spec TaskRunSpec

TaskRunList

TaskRunList contains a list of TaskRun

FieldDescriptionDefaultValidation
apiVersion stringautomation.astronetes.io/v1alpha1
kind stringTaskRunList
metadata ListMetaRefer to Kubernetes API documentation for fields of metadata.
items TaskRun array

TaskRunSpec

TaskRunSpec defines the desired state of TaskRun

Appears in:

FieldDescriptionDefaultValidation
taskName stringTask nameRequired: {}

TaskSpec

TaskSpec defines the desired state of Task

Appears in:

FieldDescriptionDefaultValidation
restartPolicy RestartPolicyRestart policyOptional: {}
plugin TaskPluginTask pluginRequired: {}
config JSONTask configRequired: {}