Skip to content

Latest commit

 

History

History
1385 lines (696 loc) · 34.2 KB

m2c-crds.md

File metadata and controls

1385 lines (696 loc) · 34.2 KB

API Reference

Packages

anthos-migrate.cloud.google.com/v1

Package v1 contains API Schema definitions for the anthos-migrate.cloud.google.com v1 API group

Resource Types

Migration

Migration is the Schema for the migrations API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1
kind string Migration
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec MigrationSpec
status MigrationStatus

MigrationCondition

Appears in:

Field Description
type MigrationConditionType
status ConditionStatus
reason string
message string
lastTransitionTime Time

MigrationSpec

MigrationSpec defines the desired state of a Migration. This object is immutable, once all the parameters are set.

Appears in:

Field Description
type string Type describes the type of migration, available values are dependant on what AppX plugins are installed in the current cluster.
discoveryParameters Parameter array Optional configuration for this migration
sourceSnapshotTemplate SourceSnapshotTemplate Template to use when creating a source snapshot for this migration.
artifactRepositoryRef LocalObjectReference Represents the repository to push the artifacts to during migration.
imageRepositoryRef LocalObjectReference Image repository.

MigrationStatus

MigrationStatus defines the observed state of Migration.

Appears in:

Field Description
conditions MigrationCondition array
migrationPlanRef TypedLocalObjectReference References the object containing the migration plan.
sourceSnapshotRef LocalObjectReference
discoveryTaskRef TypedLocalObjectReference

Parameter

Appears in:

Field Description
name string Name of the Parameter. Must contain only alphanumeric characters ([a-z0-9A-Z]) or underscores (_). Must match the name of existing ParameterDef.
value string Value of the parameter.

SourceSnapshotSpec

Appears in:

Field Description
sourceProviderRef LocalObjectReference
sourceId string SourceID is used by the source provider to select a specific source from all those available to the source provider. The format is source provider dependent.

SourceSnapshotTemplate

Appears in:

Field Description
labels object (keys:string, values:string) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
annotations object (keys:string, values:string) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
spec SourceSnapshotSpec Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

anthos-migrate.cloud.google.com/v1beta2

Package v1beta2 contains API Schema definitions for the anthos-migrate.cloud.google.com v1beta2 API group

Resource Types

AppXDataStatus

Appears in:

Field Description
pod PodStatus

AppXExistingPvc

Appears in:

Field Description
LocalObjectReference LocalObjectReference
subPath string

AppXGenerateArtifactsFlow

AppXGenerateArtifactsFlow is the Schema for the appxgenerateartifactsflows API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string AppXGenerateArtifactsFlow
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec AppXGenerateArtifactsFlowSpec

AppXGenerateArtifactsFlowSpec

AppXGenerateArtifactsFlowSpec defines the desired state of AppXGenerateArtifactsFlow

Appears in:

Field Description
migration LocalObjectReference
appXGenerateArtifactsConfig string Application specific configuration.
dataConfig DataConfig
warnings Warning array
dismissDiscoveryWarnings boolean

AppXGenerateArtifactsTask

AppXGenerateArtifactsTask is the Schema for the appxgenerateartifactstasks API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string AppXGenerateArtifactsTask
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec AppXGenerateArtifactsTaskSpec
status AppXGenerateArtifactsTaskStatus

AppXGenerateArtifactsTaskSpec

AppXGenerateArtifactsTaskSpec defines the desired state of AppXGenerateArtifactsTask

Appears in:

Field Description
migration LocalObjectReference
flow LocalObjectReference

AppXGenerateArtifactsTaskStatus

AppXGenerateArtifactsTaskStatus defines the observed state of AppXGenerateArtifactsTask

Appears in:

Field Description
extractPod PodStatus
dataExtract AppXDataStatus
artifacts AppXRepositoryDelivery
status OperationStatus
operation OperationInfo Note: both Operation and Status hold OperationStatus. Operation.Status is used for maintaining error state. Status is used for internal state management.

AppXNewPVC

Appears in:

Field Description
spec PersistentVolumeClaimSpec

AppXPlugin

AppXPlugin describes the discovery and extraction images used for application migration.

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string AppXPlugin
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec AppXPluginSpec Specification of the desired behavior of AppXPlugin. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status AppXPluginStatus Most recently observed status of AppXPlugin. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

AppXPluginSpec

AppXPluginSpec is a description of AppXPlugin.

Appears in:

Field Description
compatibleVersion string CompatibleVersion is the minimal Migrate to Containers version that is compatible with the AppXPlugin.
discoverImage string Name of the Discover container image. More info: https://kubernetes.io/docs/concepts/containers/images/#image-names
discoverCommand string array Entrypoint array for the Discover container.
generateArtifactsImage string Name of the GenerateArtifacts container image. More info: https://kubernetes.io/docs/concepts/containers/images/#image-names
generateArtifactsCommand string array Entrypoint array for the GenerateArtifacts container.
imagePullSecrets LocalObjectReference array ImagePullSecrets is an optional list of references to secrets in the same namespace, used for pulling any of the images used by Discover and GenerateArtifacts pods. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
validationSchema string JSON scheme used for validating the scheme of the AppXPlugin. More info: http://json-schema.org
osType OsType Specifies the OS of VMs that are suitable for migration using the AppXPlugin. Valid options are: Linux, Windows. Defaults to Linux.
parameterDefs ParameterDef array ParameterDef list. Defines environment variables that can be used by the Discover and GenerateArtifacts containers.
defaultArguments Parameter array Parameter list. Sets default values of environment variable defined by ParameterDefs.

AppXRepositoryDelivery

AppXRepositoryDelivery is not a standalone CRD, but rather a field contained in discovery and extract task statuses to describe their produced items for posterity

Appears in:

Field Description
type string
bucket string
region string Region is only set when type is s3
folder string

AppXVolume

Appears in:

Field Description
existingPvc AppXExistingPvc
newPvc AppXNewPVC
folders string array
deploymentPvcName string The name of the PVC that deployed pods in the target cluster (specified in the deployment spec yaml) will use to access the data in this volume

ArtifactsRepository

ArtifactsRepository is the Schema for the artifactsrepositories API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string ArtifactsRepository
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ArtifactsRepositorySpec
status ArtifactsRepositoryStatus

ArtifactsRepositoryCondition

ArtifactsRepositoryCondition is derieved from the v1.Condition type of kubernetes. ObservedGeneration was removed as we consider it part of the Status. The types of Type and Reason have been changed to match specific enums.

Appears in:

Field Description
type ArtifactsRepositoryConditionType type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
status ConditionStatus status of the condition, one of True, False, Unknown.
lastTransitionTime Time 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.
reason ArtifactsRepositoryConditionReason 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.
message string message is a human readable message indicating details about the transition. This may be an empty string.

ArtifactsRepositoryCredentials

deprecated

Appears in:

Field Description
type string
secret string

ArtifactsRepositoryRef

Appears in:

Field Description
LocalObjectReference LocalObjectReference
spec ArtifactsRepositorySpec

ArtifactsRepositorySpec

ArtifactsRepositorySpec defines the desired state of ArtifactsRepository

Appears in:

Field Description
credentials ArtifactsRepositoryCredentials deprecated
bucket string deprecated
gcs GcsRespositorySpec
s3 S3RespositorySpec

ArtifactsRepositoryStatus

ArtifactsRepositoryStatus defines the observed state of ArtifactsRepository

Appears in:

Field Description
observedGeneration integer Contains the spec generation the reconciler saw the last time it woke up.
conditions ArtifactsRepositoryCondition array A list of current statuses of the repository.

AwsCredentialsSpec

Appears in:

Field Description
secretRef SecretReference

BasicState

Underlying type: string

Appears in:

ComputeEngineSourceSnapshot

Appears in:

Field Description
diskSnapshots string array
sourceDisks Volume array
copiedDisks Volume array
pvcs string array

ComputeEngineSourceSnapshotStatus

Appears in:

Field Description
volumes object (keys:string, values:GceVolumeStatus)
sourceDisks Volume array
v2kCsiPvc PvcStatus
bootVolumeName string
destinationZone string
destinationProject string

DataConfig

Appears in:

Field Description
volumes AppXVolume array

Ec2SnapshotInfo

Appears in:

Field Description
id string
state string

Ec2VolumeInfo

Appears in:

Field Description
id string
state string

Ec2VolumeStatus

Appears in:

Field Description
pvc PvcStatus
copiedDisk Ec2VolumeInfo
snapshot Ec2SnapshotInfo

ErrorStatus

ErrorStatus holds error handling state to be persisted on a k8s resource.

Appears in:

Field Description
numErrors integer
lastError string
lastErrorCatalogCode CatalogCode
lastErrorTime Time

GceCredentialsSpec

Appears in:

Field Description
secretRef SecretReference

GceResourceStatus

Appears in:

Field Description
name string
zone string
operationName string
operationType string
progress integer
status GceResourceOperationStatus
statusMessage string
errors string
warnings string
startTime string
endTime string

GceVolumeStatus

Appears in:

Field Description
pvc PvcStatus
copiedDisk GceResourceStatus
snapshot GceResourceStatus

GcsCredentialsSpec

Appears in:

Field Description
secretRef LocalObjectReference

GcsRepositoryLocation

Appears in:

Field Description
bucket string

GcsRespositorySpec

Appears in:

Field Description
serviceAccount GcsCredentialsSpec GCS credentials reference.
bucket string GCS bucket, will be created on demand.

HTTPConfigSpec

Appears in:

Field Description
ignoreCert boolean

ImageRepository

ImageRepository is the Schema for the imagerepositories API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string ImageRepository
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ImageRepositorySpec
status ImageRepositoryStatus

ImageRepositoryCredentials

Appears in:

Field Description
type ImageRepositoryCredentialsType
secret string

ImageRepositoryCredentialsType

Underlying type: string

Appears in:

ImageRepositoryRef

Appears in:

Field Description
LocalObjectReference LocalObjectReference
spec ImageRepositorySpec

ImageRepositorySSLConfig

Appears in:

Field Description
caPEM LocalObjectReference

ImageRepositorySpec

ImageRepositorySpec defines the desired state of ImageRepository

Appears in:

Field Description
url string
ssl ImageRepositorySSLConfig
credentials ImageRepositoryCredentials

LocalAwsSourceSpec

Appears in:

Field Description
region string
secretAccessKey AwsCredentialsSpec

LocalEc2SourceSnapshotStatus

Appears in:

Field Description
volumes object (keys:string, values:Ec2VolumeStatus)
v2kCsiPvc PvcStatus
bootVolumeName string
destinationZone string

LocalGceSourceSpec

Appears in:

Field Description
project string
serviceAccount GceCredentialsSpec

LocalOVFSourceSnapshotStatus

Appears in:

LocalOVFSourceSpec

Appears in:

Field Description
baseURL string
httpConfigSpec HTTPConfigSpec
gcsConfigSpec GceCredentialsSpec

LocalSourceSpec

Appears in:

Field Description
localVmware LocalVmwareSourceSpec
gce LocalGceSourceSpec
localAws LocalAwsSourceSpec Deprecated. Local AWS sources are no longer supported.
localOVF LocalOVFSourceSpec

LocalVmwareSourceSnapshotStatus

Appears in:

Field Description
createPvcs PvcStatus array
accessType string

LocalVmwareSourceSpec

Appears in:

Field Description
verifyCertificate boolean Whether VMware API will fail on environments with invalid certificates. defaults to false. Corresponds to the not value of vSphere insecure flag.
useHttp boolean Use a HTTP connection to vSphere
accessType string Deprecated. AccessType is now determined internally, and this value will be ignored.
address string
username string
password PasswordRef
dc string

MigrateForCECloudDetails

Appears in:

Field Description
platform string
name string

MigrateForCEManagementDetails

Appears in:

Field Description
address string
password PasswordRef
cloudDetails MigrateForCECloudDetails
cloudExtension string

MigrateForCEService

Appears in:

Field Description
sourceName string
location string
project string
serviceAccount GceCredentialsSpec
replicatingVMDefaults ReplicatingVMDefaults

MigrateForCESourceSpec

Appears in:

Field Description
management MigrateForCEManagementDetails

MigrateForCe

Appears in:

Field Description
runMode string

MigrateForCeStatus

Appears in:

Field Description
pvc PvcStatus

OperationInfo

OperationInfo holds operation status including error status

Appears in:

Field Description
status OperationStatus
ErrorStatus ErrorStatus

OperationStatus

Underlying type: string

Appears in:

OsType

Underlying type: string

Appears in:

Parameter

Appears in:

Field Description
name string Name of the Parameter. Must contain only alphanumeric characters ([a-z0-9A-Z]) or underscores (_). Must match the name of existing ParameterDef.
value string Value of the parameter.

ParameterDef

Appears in:

Field Description
name string Name of the ParameterDef. Must contain only alphanumeric characters ([a-z0-9A-Z]) or underscores (_).
envVar string Name of the environment variable. Seen by the Discover and GenerateArtifacts containers. Must be a C_IDENTIFIER ([A-Za-z_][A-Za-z0-9_]*). It is recommended to use a unique name, prefixed by the AppXPlugin provider domain and AppXPlugin names.
usage string Description of the ParameterDef in plain text.

PasswordRef

Appears in:

Field Description
secretRef SecretReference

PodStatus

Appears in:

Field Description
pod LocalObjectReference
phase PodPhase
pod_creation_time Time
pod_deletion_time Time

PvcStatus

Appears in:

Field Description
name string
claimPhase PersistentVolumeClaimPhase
resourcePath string Original resource path in cloud (VMware disk path, gce disk name, pv name etc).
pvName string PV Name.
created boolean Was the PVC created.
csiPvc boolean A flag indicating whether the PVC represents a V2K CSI PVC.

RemoteSourceSpec

Appears in:

Field Description
migrateForCEService MigrateForCEService

ReplicatingVMDefaults

Appears in:

Field Description
groupName string
activeIdleDuration Duration
inactiveIdleDuration Duration
zone string
network string
subnet string
machineType string
machineTypeSeries string
serviceAccount string
targetProject string

S3CredentialsSpec

Appears in:

Field Description
secretRef LocalObjectReference

S3RepositoryLocation

Appears in:

Field Description
bucket string
region string

S3RespositorySpec

Appears in:

Field Description
region string Valid S3 region. Used as session endpoint and bucket location hint.
secretAccessKey S3CredentialsSpec Optional credentials reference.
bucket string An S3 bucket, must already exist and be writeable.

SourceProvider

SourceProvider is the Schema for the sourceproviders API

Field Description
apiVersion string anthos-migrate.cloud.google.com/v1beta2
kind string SourceProvider
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SourceProviderSpec
status SourceProviderStatus

SourceProviderSpec

SourceProviderSpec defines the desired state of SourceProvider

Appears in:

Field Description
migrateForCE MigrateForCESourceSpec Deprecated. Migrate to Virtual Machines 4.X sources are no longer supported.
LocalSourceSpec LocalSourceSpec
remoteSourceSpec RemoteSourceSpec

SourceProviderStatus

SourceProviderStatus defines the observed state of SourceProvider

Appears in:

Field Description
state SourceProviderState
message string
secretRef SecretReference
storageClassRef LocalObjectReference

SourceSnapshotSpec

SourceSnapshotSpec defines the desired state of SourceSnapshot.

Appears in:

Field Description
sourceProvider string
sourceId string
computeEngineSourceSnapshot ComputeEngineSourceSnapshot
osType OsType
migrateForCe MigrateForCe
remoteSourceSnapshot LocalObjectReference

Volume

Appears in:

Field Description
zone string
name string

Warning

Appears in:

Field Description
message string 'Message' is human-readable information
mitigation string 'Mitigation' is human-readable information
reason string 'Reason' is short and unique, UpperCamelCase
type string 'Type' is either Normal / MigrationBlocker