API Reference

Packages

dr.astronetes.io/v1alpha1

dr.astronetes.io/v1alpha1

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

Resource Types

BucketRef

Appears in:

Field	Description
`name` string	Bucket name
`namespace` string	Bucket namespace
`objectPrefix` string	ObjectPrefix to contain the objects for this recovery plan

ClusterRef

Appears in:

RecoveryPlanSpec

Field	Description
`name` string	Cluster name
`namespace` string	Cluster namespace

Components

Appears in:

RecoveryPlanSpec

Field	Description
`eventsListener` EventsListener	EventsListener configuration
`processor` Processor	Processor configuration
`reconciler` Reconciler	Reconciler configuration
`restorer` Reconciler	Restorer configuration
`synchronizer` Synchronizer	Synchronizer configuration
`nats` Nats	Nats configuration
`redis` Redis	Redis configuration
`metricsExporter` MetricsExporter	Redis configuration

ContainerSelector

Underlying type: struct{Name string “json:"name"”; Type ContainerSelectorType “json:"type"”}

Appears in:

OperationFilters

EventsListener

Appears in:

Components

Field	Description
`logLevel` string	Log level debug;info;warm;error;panic;fatal
`imagePullPolicy` PullPolicy	EventsListener ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to EventsListener

ExecutionPlanResource

Appears in:

RecoveryExecutionPlanSpec

Field	Description
`group` string	Resource group
`version` string	Resource version
`resource` string	Resource
`patchOptions` PatchOpts
`fromPatch` PatchOperation array	List of JSONPatch operations to apply to the resources
`operations` Operation array
`fromOriginal` FromOriginal	FromOriginal to apply to the resources

Filters

Appears in:

Resource

Field	Description
`selector` LabelSelector	Filter the resources to be processed by Selector
`namespaceSelector` LabelSelector	Filter the resources to be processed by Namespace’s Selector

FromOriginal

FromOriginal resources are cloned in Bucket

Appears in:

Field	Description
`enabled` boolean

ManagedCluster

ManagedCluster is the Schema for the managedclusters API

Appears in:

ManagedClusterList

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`ManagedCluster`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` ManagedClusterSpec

ManagedClusterList

ManagedClusterList contains a list of ManagedCluster

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`ManagedClusterList`
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` ManagedCluster array

ManagedClusterSpec

ManagedClusterSpec defines the desired state of ManagedCluster

Appears in:

ManagedCluster

Field	Description
`secretRef` SecretRef	Reference to the secret that stores the cluster Kubeconfig

MetricsExporter

Appears in:

Components

Field	Description
`logLevel` string	Log level debug;info;warm;error;panic;fatal
`imagePullPolicy` PullPolicy	MetricsExporter ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to MetricsExporter

Nats

Appears in:

Components

Field	Description
`imagePullPolicy` PullPolicy	Nats ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to Nats

Observability

Appears in:

RecoveryPlanSpec

Field	Description
`interval` Duration
`enabledV1` boolean
`enabledV2` boolean

OnAddStrategy

Underlying type: string

Appears in:

Strategy

OnDeleteStrategy

Underlying type: string

Appears in:

Strategy

OnUpdateStrategy

Underlying type: string

Appears in:

Strategy

Op

Underlying type: string

Op types

Appears in:

Operation

Operation

Appears in:

Field	Description
`op` Op	EnvVar
`filters` OperationFilters
`env` EnvVar

OperationFilters

Appears in:

Operation

Field	Description
`containerSelector` ContainerSelector	Filter the resources to be processed by Selector

PatchOperation

Appears in:

Field	Description
`op` string
`path` string
`value` JSON

PatchOpts

Appears in:

Field	Description
`skipIfNotFoundOnDelete` boolean	SkipIfNotFoundOnDelete determines if errors should be ignored when trying to remove an field that doesn’t exist.

Processor

Appears in:

Components

Field	Description
`concurrentTasks` integer	Number of concurrent tasks
`replicas` integer	Number of replicas
`logLevel` string	Log level debug;info;warm;error;panic;fatal
`imagePullPolicy` PullPolicy	Processor ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to Processor

Reconciler

Appears in:

Components

Field	Description
`concurrentTasks` integer	Number of concurrent tasks
`replicas` integer	Number of replicas
`logLevel` string	Log level debug;info;warn;error;panic;fatal
`imagePullPolicy` PullPolicy	Reconciler ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to Reconciler

Reconciliation

Appears in:

RecoveryPlanSpec

Field	Description
`resyncPeriod` Duration	Time between reconciliation processes

RecoveryBucket

RecoveryBucket is the Schema for the recoverybuckets API

Appears in:

RecoveryBucketList

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryBucket`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` RecoveryBucketSpec

RecoveryBucketList

RecoveryBucketList contains a list of RecoveryBucket

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryBucketList`
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` RecoveryBucket array

RecoveryBucketSpec

RecoveryBucketSpec defines the desired state of RecoveryBucket

Appears in:

RecoveryBucket

Field	Description
`endpoint` string	Bucket endpoint
`bucketName` string	Bucket name
`secretRef` SecretRef	Reference to the secret that stores the bucket credentials

RecoveryExecutionJob

RecoveryExecutionJob is the Schema for the recoveryexecutionjobs API

Appears in:

RecoveryExecutionJobList

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryExecutionJob`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` RecoveryExecutionJobSpec

RecoveryExecutionJobList

RecoveryExecutionJobList contains a list of RecoveryExecutionJob

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryExecutionJobList`
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` RecoveryExecutionJob array

RecoveryExecutionJobSpec

RecoveryExecutionJobSpec defines the desired state of RecoveryExecutionJob

Appears in:

RecoveryExecutionJob

Field	Description
`recoveryExecutionPlanRef` RecoveryExecutionPlanRef	Reference to the RecoveryExecutionPlan
`retries` integer	Retries

RecoveryExecutionPlan

RecoveryExecutionPlan is the Schema for the recoveryexecutionplans API

Appears in:

RecoveryExecutionPlanList

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryExecutionPlan`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` RecoveryExecutionPlanSpec

RecoveryExecutionPlanList

RecoveryExecutionPlanList contains a list of RecoveryExecutionPlan

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryExecutionPlanList`
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` RecoveryExecutionPlan array

RecoveryExecutionPlanRef

Appears in:

RecoveryExecutionJobSpec

Field	Description
`name` string	RecoveryExecutionPlan name
`namespace` string	RecoveryExecutionPlan namespace

RecoveryExecutionPlanSpec

RecoveryExecutionPlanSpec defines the desired state of RecoveryExecutionPlan

Appears in:

RecoveryExecutionPlan

Field	Description
`recoveryPlan` RecoveryPlanRef	RecoveryPlan origin
`kubeconfigSecretRef` SecretRef	Secret for Kubeconfig
`licenseSecretRef` SecretRef	Secret for the license
`bucketRef` BucketRef	Bucket used to clone the original state of the resources
`sourceClusterID` string
`destinationClusterID` string
`resources` ExecutionPlanResource array	Resources to recover

RecoveryPlan

RecoveryPlan is the Schema for the recoveryplans API

Appears in:

RecoveryPlanList

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryPlan`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` RecoveryPlanSpec

RecoveryPlanList

RecoveryPlanList contains a list of RecoveryPlan

Field	Description
`apiVersion` string	`dr.astronetes.io/v1alpha1`
`kind` string	`RecoveryPlanList`
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` RecoveryPlan array

RecoveryPlanRef

Appears in:

RecoveryExecutionPlanSpec

Field	Description
`name` string	Name of the recovery plan
`namespace` string	Namespace of the recovery plan

RecoveryPlanSpec

RecoveryPlanSpec defines the desired state of RecoveryPlan

Appears in:

RecoveryPlan

Field	Description
`suspend` boolean	Suspend the process to synchronize to the destination cluster
`forceNamespaceCreation` boolean	ForceNamespaceCreation If true, the namespace will be created in case of it doesn’t exist, otherwise the resource will be omitted
`ignoreNamespaces` string array	Include kube-system namespace
`sourceClusterRef` ClusterRef	Source cluster
`destinationClusterRef` ClusterRef	Destination cluster
`bucketRef` BucketRef	Bucket used to clone the original state of the resources
`components` Components	List of components configurations to be applied to the Kubesync services deployed
`resources` Resource array	Resources to synchronize
`reconciliation` Reconciliation	Reconciliation process
`observability` Observability	Reconciliation process

RecoveryProcess

Appears in:

Resource

Field	Description
`patchOptions` PatchOpts
`fromPatch` PatchOperation array	List of JSONPatch operations to apply to the resources
`operations` Operation array
`fromOriginal` FromOriginal

Redis

Appears in:

Components

Field	Description
`imagePullPolicy` PullPolicy	Redis ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to Redis

Resource

Appears in:

RecoveryPlanSpec

Field	Description
`group` string	Resource group
`version` string	Resource version
`resource` string	Resource
`transformation` Transformation	Transformation to apply to the resources
`strategy` Strategy	Strategy to apply to apply the recover plan
`filters` Filters	Resource selection filters
`recoveryProcess` RecoveryProcess	Recovery plan configuration

SecretRef

Appears in:

Field	Description
`name` string	Secret name
`namespace` string	Secret namespace

Strategy

Strategy to be applied for the recovery plan

Appears in:

Resource

Field	Description
`onDelete` OnDeleteStrategy
`onAdd` OnAddStrategy
`onUpdate` OnUpdateStrategy

Synchronizer

Appears in:

Components

Field	Description
`concurrentTasks` integer	Number of concurrent tasks
`replicas` integer	Number of replicas
`logLevel` string	Log level debug;info;warm;error;panic;fatal
`imagePullPolicy` PullPolicy	Synchronizer ImagePullPolicy
`resources` ResourceRequirements	Resources to be assigned to Synchronizer

Transformation

Appears in:

Resource

Field	Description
`patchOptions` PatchOpts
`patch` PatchOperation array	List of JSONPatch operations to apply to the resources
`operations` Operation array