DisasterRecoveryAction CRD reference

The DisasterRecoveryAction CRD represents a DR operation such as failover and failback and maps directly to Stork actions.

Example

apiVersion: multicluster.portworx.com/v1alpha1
kind: DisasterRecoveryAction
metadata:
  name: <disaster-recovery-action-name>
  namespace: <namespace>
spec:
  actionType: Failover                       # Required. One of: Failover, Failback
  protectionGroupReference: <protection-group-name>  # Required
  failoverParameters:                        # Required when actionType is Failover
    namespaces:                              # Required. Namespaces to failover
      - <namespace>

DisasterRecoveryAction

Field	Description	Type
apiVersion	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources	string
kind	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds	string
spec	DisasterRecoveryActionSpec defines the desired state of DisasterRecoveryAction	object
status	DisasterRecoveryActionStatus defines the observed state of DisasterRecoveryAction	object

spec fields

Field	Description	Type
actionType	ActionType defines the type of disaster recovery action	string
failbackParameters	FailbackParameters contains parameters for failback action	object
failbackParameters.excludeSelectors	ExcludeSelectors specifies label selectors that identify resources to be excluded from DR operations.	object
failbackParameters.namespaces	Namespaces is the list of namespaces to failback	array
failbackParameters.selectors	Selectors and ExcludeSelectors are mutually exclusive. Only one of these may be set at a time to avoid ambiguous filtering of resources during DR operations.	object
failbackParameters.types	Types restricts the DR operation to the specified Kubernetes resource kinds. If empty, all supported types are considered.	array
failbackParameters.types.group		string
failbackParameters.types.kind		string
failbackParameters.types.version		string
failoverParameters	FailoverParameters contains parameters for failover action	object
failoverParameters.excludeSelectors	ExcludeSelectors specifies label selectors that identify resources to be excluded from DR operations.	object
failoverParameters.namespaces	Namespaces is the list of namespaces to failover	array
failoverParameters.selectors	Selectors and ExcludeSelectors are mutually exclusive. Only one of these may be set at a time to avoid ambiguous filtering of resources during DR operations.	object
failoverParameters.skipSourceClusterDomainDeactivation	SkipSourceClusterDomainDeactivation indicates whether to skip deactivating the source cluster domain during failover.	boolean
failoverParameters.skipSourceOperations	SkipSourceOperations indicates whether to skip operations on source cluster	boolean
failoverParameters.types	Types restricts the DR operation to the specified Kubernetes resource kinds. If empty, all supported types are considered.	array
failoverParameters.types.group		string
failoverParameters.types.kind		string
failoverParameters.types.version		string
protectionGroupReference	ProtectionGroupReference is the reference to the protection group	string

status fields

Field	Description	Type
compliant	Compliant represents the compliance status of the disaster recovery action.	object
compliant.reason	Reason is short description of why the resource is in non compliant state.	string
compliant.status	Status: is true then resource is compliant and operational.	boolean
conditions	Conditions represent the latest available observations of the DisasterRecoveryAction's state	array
conditions.lastTransitionTime	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.	string
conditions.message	message is a human readable message indicating details about the transition. This may be an empty string.	string
conditions.observedGeneration	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.	integer
conditions.reason	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	string
conditions.status	status of the condition, one of True, False, Unknown.	string
conditions.type	type of condition in CamelCase or in foo.example.com/CamelCase.	string
finishTimestamp	FinishTimestamp is the time when the disaster recovery action operation finished	string
lastAgentUpdateTimestamp	LastAgentUpdateTimestamp is the time when the disaster recovery action status was last updated by the agent	string
reason	Reason provides additional information about the current status	string
references	References stores all sub-resources created for disaster recovery action operation Map of Kubernetes resource kind to array of object references in format: <uid>#<name>#<namespace>	object
stage	Stage represents the current stage of the disaster recovery action operation	string
startTimestamp	StartTimestamp is the time when the disaster recovery action was created	string
status	Status represents the current status of the disaster recovery action operation	string
summary	Summary provides a summary of the disaster recovery action operation	object
summary.summary	Summary contains per-namespace disaster recovery operation status	array
summary.summary.namespace	Namespace is the namespace name	string
summary.summary.reason	Reason provides additional information about the status	string
summary.summary.status	Status is the status of the operation for this namespace	string