v1beta2

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1beta2 contains API Schema definitions for the ververicaplatform v1beta2 API group +kubebuilder:object:generate=true +groupName=ververicaplatform.fintechstudios.com

Index

Constants

View Source
const (
	CancelledState     = VpDeploymentState("CANCELLED") // non-US spelling intentional
	RunningState       = VpDeploymentState("RUNNING")
	TransitioningState = VpDeploymentState("TRANSITIONING")
	SuspendedState     = VpDeploymentState("SUSPENDED")
	FailedState        = VpDeploymentState("FAILED")
	FinishedState      = VpDeploymentState("FINISHED")
)

All the allowed DeploymentStates

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "ververicaplatform.fintechstudios.com", Version: "v1beta2"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type VpArtifact

type VpArtifact struct {
	Kind string `json:"kind"`

	JarURI string `json:"jarUri"`
	// +optional
	MainArgs string `json:"mainArgs,omitempty"`
	// +optional
	EntryClass string `json:"entryClass,omitempty"`
	// +optional
	FlinkVersion string `json:"flinkVersion,omitempty"`
	// +optional
	FlinkImageRegistry string `json:"flinkImageRegistry,omitempty"`
	// +optional
	FlinkImageRepository string `json:"flinkImageRepository,omitempty"`
	// +optional
	FlinkImageTag string `json:"flinkImageTag,omitempty"`
}

VpArtifact describes a jar to run along with the Flink requirements

func (*VpArtifact) DeepCopy

func (in *VpArtifact) DeepCopy() *VpArtifact

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpArtifact.

func (*VpArtifact) DeepCopyInto

func (in *VpArtifact) DeepCopyInto(out *VpArtifact)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeployment

type VpDeployment struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec VpDeploymentObjectSpec `json:"spec"`
	// +optional
	Status *VpDeploymentStatus `json:"status,omitempty"`
}

VpDeployment is the Schema for the vpdeployments API

func (*VpDeployment) ConvertFrom

func (dst *VpDeployment) ConvertFrom(srcRaw conversion.Hub) error

ConvertTo converts from the "Hub" version to a v1beta2 version

func (*VpDeployment) ConvertTo

func (src *VpDeployment) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this v1beta2 version to a v1beta1 "Hub" version

func (*VpDeployment) DeepCopy

func (in *VpDeployment) DeepCopy() *VpDeployment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeployment.

func (*VpDeployment) DeepCopyInto

func (in *VpDeployment) DeepCopyInto(out *VpDeployment)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VpDeployment) DeepCopyObject

func (in *VpDeployment) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VpDeploymentList

type VpDeploymentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VpDeployment `json:"items"`
}

VpDeploymentList contains a list of VpDeployment

func (*VpDeploymentList) DeepCopy

func (in *VpDeploymentList) DeepCopy() *VpDeploymentList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentList.

func (*VpDeploymentList) DeepCopyInto

func (in *VpDeploymentList) DeepCopyInto(out *VpDeploymentList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VpDeploymentList) DeepCopyObject

func (in *VpDeploymentList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VpDeploymentObjectSpec

type VpDeploymentObjectSpec struct {

	// VP
	Metadata VpMetadata       `json:"metadata"`
	Spec     VpDeploymentSpec `json:"spec"`

	// DeploymentTargetName is an extension on the VP API
	// Must provide a spec.deploymentTargetId if not set
	// +optional
	DeploymentTargetName string `json:"deploymentTargetName,omitempty"`
}

VpDeploymentObjectSpec defines the desired state of VpDeployment

func (*VpDeploymentObjectSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentObjectSpec.

func (*VpDeploymentObjectSpec) DeepCopyInto

func (in *VpDeploymentObjectSpec) DeepCopyInto(out *VpDeploymentObjectSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentRestoreStrategy

type VpDeploymentRestoreStrategy struct {
	// +optional
	Kind string `json:"kind,omitempty"`
	// +optional
	AllowNonRestoredState bool `json:"allowNonRestoredState,omitempty"`
}

VpDeploymentRestoreStrategy describes how to restore a job

func (*VpDeploymentRestoreStrategy) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentRestoreStrategy.

func (*VpDeploymentRestoreStrategy) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentRunningCondition added in v0.7.1

type VpDeploymentRunningCondition struct {
	Type               string      `json:"type"`
	Status             string      `json:"status"`
	Message            string      `json:"message"`
	Reason             string      `json:"reason"`
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	LastUpdateTime     metav1.Time `json:"lastUpdateTime,omitempty"`
}

VpDeploymentRunningCondition provide more details about the state of deployment

func (*VpDeploymentRunningCondition) DeepCopy added in v0.7.1

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentRunningCondition.

func (*VpDeploymentRunningCondition) DeepCopyInto added in v0.7.1

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentRunningStatus added in v0.7.1

type VpDeploymentRunningStatus struct {
	// +optional
	Conditions []VpDeploymentRunningCondition `json:"conditions,omitempty"`
	JobID      string                         `json:"jobId"`
	// +optional
	TransitionTime metav1.Time `json:"transitionTime,omitempty"`
}

VpDeploymentRunningStatus gives extra information about the status of the underlying Flink job see: https://docs.ververica.com/user_guide/deployments/index.html#running

func (*VpDeploymentRunningStatus) DeepCopy added in v0.7.1

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentRunningStatus.

func (*VpDeploymentRunningStatus) DeepCopyInto added in v0.7.1

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentSpec

type VpDeploymentSpec struct {
	State VpDeploymentState `json:"state"`

	UpgradeStrategy *VpDeploymentUpgradeStrategy `json:"upgradeStrategy"`
	// +optional
	RestoreStrategy *VpDeploymentRestoreStrategy `json:"restoreStrategy,omitempty"`
	// +optional
	DeploymentTargetID string `json:"deploymentTargetId,omitempty"`
	// +optional
	MaxSavepointCreationAttempts *int32 `json:"maxSavepointCreationAttempts,omitempty"`
	// +optional
	MaxJobCreationAttempts *int32 `json:"maxJobCreationAttempts,omitempty"`

	Template *VpDeploymentTemplate `json:"template"`
}

VpDeploymentSpec is the spec in the Ververica Platform

func (*VpDeploymentSpec) DeepCopy

func (in *VpDeploymentSpec) DeepCopy() *VpDeploymentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentSpec.

func (*VpDeploymentSpec) DeepCopyInto

func (in *VpDeploymentSpec) DeepCopyInto(out *VpDeploymentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentState added in v0.7.1

type VpDeploymentState string

VpDeploymentState is the enum of all possible deployment states Only one of the following states may be specified. +kubebuilder:validation:Enum=CANCELLED;RUNNING;TRANSITIONING;SUSPENDED;FAILED;FINISHED

type VpDeploymentStatus

type VpDeploymentStatus struct {

	// +optional
	State VpDeploymentState `json:"state,omitempty"`

	// see: https://docs.ververica.com/user_guide/deployments/index.html#running
	// +optional
	Running *VpDeploymentRunningStatus `json:"running,omitempty"`
}

VpDeploymentStatus defines the observed state of VpDeployment

func (*VpDeploymentStatus) DeepCopy

func (in *VpDeploymentStatus) DeepCopy() *VpDeploymentStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentStatus.

func (*VpDeploymentStatus) DeepCopyInto

func (in *VpDeploymentStatus) DeepCopyInto(out *VpDeploymentStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentTarget

type VpDeploymentTarget struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec VpDeploymentTargetObjectSpec `json:"spec,omitempty"`
}

VpDeploymentTarget is the Schema for the vpdeploymenttargets API

func (*VpDeploymentTarget) ConvertFrom

func (dst *VpDeploymentTarget) ConvertFrom(srcRaw conversion.Hub) error

ConvertTo converts from the "Hub" version to a v1beta2 version

func (*VpDeploymentTarget) ConvertTo

func (src *VpDeploymentTarget) ConvertTo(dstRaw conversion.Hub) error

ConvertTo converts this v1beta2 version to a v1beta1 "Hub" version

func (*VpDeploymentTarget) DeepCopy

func (in *VpDeploymentTarget) DeepCopy() *VpDeploymentTarget

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTarget.

func (*VpDeploymentTarget) DeepCopyInto

func (in *VpDeploymentTarget) DeepCopyInto(out *VpDeploymentTarget)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VpDeploymentTarget) DeepCopyObject

func (in *VpDeploymentTarget) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VpDeploymentTargetList

type VpDeploymentTargetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VpDeploymentTarget `json:"items"`
}

VpDeploymentTargetList contains a list of VpDeploymentTarget

func (*VpDeploymentTargetList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTargetList.

func (*VpDeploymentTargetList) DeepCopyInto

func (in *VpDeploymentTargetList) DeepCopyInto(out *VpDeploymentTargetList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VpDeploymentTargetList) DeepCopyObject

func (in *VpDeploymentTargetList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VpDeploymentTargetObjectSpec

type VpDeploymentTargetObjectSpec struct {

	// +optional
	Metadata VpMetadata `json:"metadata,omitempty"`
	// +optional
	Spec VpDeploymentTargetSpec `json:"spec,omitempty"`
}

VpDeploymentTargetObjectSpec defines the desired state of VpDeploymentTarget

func (*VpDeploymentTargetObjectSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTargetObjectSpec.

func (*VpDeploymentTargetObjectSpec) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentTargetSpec

type VpDeploymentTargetSpec struct {
	Kubernetes VpKubernetesTarget `json:"kubernetes"`
}

VpDeploymentTargetSpec allows a users to set defaults for deployments and configure K8s

func (*VpDeploymentTargetSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTargetSpec.

func (*VpDeploymentTargetSpec) DeepCopyInto

func (in *VpDeploymentTargetSpec) DeepCopyInto(out *VpDeploymentTargetSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentTemplate

type VpDeploymentTemplate struct {
	// +optional
	Metadata *VpDeploymentTemplateMetadata `json:"metadata,omitempty"`

	Spec *VpDeploymentTemplateSpec `json:"spec"`
}

VpDeploymentTemplate is the template for Deployment jobs

func (*VpDeploymentTemplate) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTemplate.

func (*VpDeploymentTemplate) DeepCopyInto

func (in *VpDeploymentTemplate) DeepCopyInto(out *VpDeploymentTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentTemplateMetadata

type VpDeploymentTemplateMetadata struct {
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

VpDeploymentTemplateMetadata

func (*VpDeploymentTemplateMetadata) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTemplateMetadata.

func (*VpDeploymentTemplateMetadata) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentTemplateSpec

type VpDeploymentTemplateSpec struct {
	Artifact *VpArtifact `json:"artifact"`
	// +optional
	// +kubebuilder:validation:Minimum=1
	Parallelism *int32 `json:"parallelism,omitempty"`
	// +optional
	// +kubebuilder:validation:Minimum=1
	NumberOfTaskManagers *int32 `json:"numberOfTaskManagers,omitempty"`
	// +optional
	Resources map[string]VpResourceSpec `json:"resources,omitempty"`
	// +optional
	FlinkConfiguration map[string]string `json:"flinkConfiguration,omitempty"`
	// +optional
	Logging *VpLogging `json:"logging,omitempty"`
	// +optional
	Kubernetes *VpKubernetesOptions `json:"kubernetes,omitempty"`
}

VpDeploymentTemplateSpec is the base spec for Deployment jobs

func (*VpDeploymentTemplateSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentTemplateSpec.

func (*VpDeploymentTemplateSpec) DeepCopyInto

func (in *VpDeploymentTemplateSpec) DeepCopyInto(out *VpDeploymentTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpDeploymentUpgradeStrategy

type VpDeploymentUpgradeStrategy struct {
	// +optional
	Kind string `json:"kind,omitempty"`
}

VpDeploymentUpgradeStrategy describes how to upgrade a job

func (*VpDeploymentUpgradeStrategy) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpDeploymentUpgradeStrategy.

func (*VpDeploymentUpgradeStrategy) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpKubernetesOptions

type VpKubernetesOptions struct {
	Pods *VpPodSpec `json:"pods,omitempty"`
}

VpKubernetesOptions allows users to configure K8s pods for Deployments

func (*VpKubernetesOptions) DeepCopy

func (in *VpKubernetesOptions) DeepCopy() *VpKubernetesOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpKubernetesOptions.

func (*VpKubernetesOptions) DeepCopyInto

func (in *VpKubernetesOptions) DeepCopyInto(out *VpKubernetesOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpKubernetesTarget

type VpKubernetesTarget struct {
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

VpKubernetesTarget allows a user to configure k8s specific options

func (*VpKubernetesTarget) DeepCopy

func (in *VpKubernetesTarget) DeepCopy() *VpKubernetesTarget

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpKubernetesTarget.

func (*VpKubernetesTarget) DeepCopyInto

func (in *VpKubernetesTarget) DeepCopyInto(out *VpKubernetesTarget)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpLogging

type VpLogging struct {
	// +optional
	Log4jLoggers map[string]string `json:"log4jLoggers,omitempty"`
}

VpLogging configures various loggers

func (*VpLogging) DeepCopy

func (in *VpLogging) DeepCopy() *VpLogging

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpLogging.

func (*VpLogging) DeepCopyInto

func (in *VpLogging) DeepCopyInto(out *VpLogging)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpMetadata

type VpMetadata struct {
	// +optional
	Namespace string `json:"namespace,omitempty"`
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

VpMetadata represents the base metadata for VP resources

func (*VpMetadata) DeepCopy

func (in *VpMetadata) DeepCopy() *VpMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpMetadata.

func (*VpMetadata) DeepCopyInto

func (in *VpMetadata) DeepCopyInto(out *VpMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpPodSpec

type VpPodSpec struct {
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
	// List of environment variables to set in the container.
	// Cannot be updated.
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	EnvVars []core.EnvVar `json:"envVars,omitempty" patchStrategy:"merge" patchMergeKey:"name"`

	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// +optional
	VolumeMounts []VpVolumeAndMount `json:"volumeMounts,omitempty"`

	// NodeSelector is a selector which must be true for the pod to fit on a node.
	// Selector which must match a node's labels for the pod to be scheduled on that node.
	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
	// +optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty" protobuf:"bytes,7,rep,name=nodeSelector"`
	// SecurityContext holds pod-level security attributes and common container settings.
	// Optional: Defaults to empty.  See type description for default values of each field.
	// +optional
	SecurityContext *core.PodSecurityContext `json:"securityContext,omitempty" protobuf:"bytes,14,opt,name=securityContext"`
	// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
	// If specified, these secrets will be passed to individual puller implementations for them to use. For example,
	// in the case of docker, only DockerConfig type secrets are honored.
	// More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	ImagePullSecrets []core.LocalObjectReference `json:"imagePullSecrets,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,15,rep,name=imagePullSecrets"`
	// If specified, the pod's scheduling constraints
	// +optional
	Affinity *core.Affinity `json:"affinity,omitempty" protobuf:"bytes,18,opt,name=affinity"`
	// If specified, the pod's tolerations.
	// +optional
	Tolerations []core.Toleration `json:"tolerations,omitempty" protobuf:"bytes,22,opt,name=tolerations"`
}

VpPodSpec is a subset of core.PodSpec, with annotations, env => envVars, and volume mounts

func (*VpPodSpec) DeepCopy

func (in *VpPodSpec) DeepCopy() *VpPodSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpPodSpec.

func (*VpPodSpec) DeepCopyInto

func (in *VpPodSpec) DeepCopyInto(out *VpPodSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpResourceSpec

type VpResourceSpec struct {
	// +optional
	CPU resource.Quantity `json:"cpu,omitempty"`
	// +optional
	// +kubebuilder:validation:minLength=2
	Memory *string `json:"memory,omitempty"`
}

VpResourceSpec represents the resource requirements for components like the job and task managers

func (*VpResourceSpec) DeepCopy

func (in *VpResourceSpec) DeepCopy() *VpResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpResourceSpec.

func (*VpResourceSpec) DeepCopyInto

func (in *VpResourceSpec) DeepCopyInto(out *VpResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VpVolumeAndMount

type VpVolumeAndMount struct {
	Name        string            `json:"name"`
	Volume      *core.Volume      `json:"volume"`
	VolumeMount *core.VolumeMount `json:"volumeMount"`
}

VpVolumeAndMount is a wrapper around both core.Volume and core.VolumeMount

func (*VpVolumeAndMount) DeepCopy

func (in *VpVolumeAndMount) DeepCopy() *VpVolumeAndMount

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VpVolumeAndMount.

func (*VpVolumeAndMount) DeepCopyInto

func (in *VpVolumeAndMount) DeepCopyInto(out *VpVolumeAndMount)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL