v1

package
v0.0.0-...-7a1d551 Latest Latest
Warning

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

 Go to latest Published: Apr 3, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=submarine.apache.org

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "submarine.apache.org", Version: "v1"}

	// 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 CommonImage 

type CommonImage struct {
	// McImage is the image used by the submarine service resource (server...) to check whether the minio is started in the initcontainer
	McImage string `json:"mc,omitempty"`
	// BusyboxImage is the image used by the submarine service resource (server...) to check whether the minio is started in the initcontainer
	BusyboxImage string `json:"busybox,omitempty"`
	// PullSecrets is a specified array of imagePullSecrets. This secrets must be manually created in the namespace.
	PullSecrets []string `json:"pullSecrets,omitempty"`
}

CommonImage defines the observed common image info

func (*CommonImage) DeepCopy 

func (in *CommonImage) DeepCopy() *CommonImage

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

func (*CommonImage) DeepCopyInto 

func (in *CommonImage) DeepCopyInto(out *CommonImage)

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

type Submarine 

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

	Spec   SubmarineSpec   `json:"spec,omitempty"`
	Status SubmarineStatus `json:"status,omitempty"`
}

Submarine is the Schema for the submarines API

func (*Submarine) DeepCopy 

func (in *Submarine) DeepCopy() *Submarine

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

func (*Submarine) DeepCopyInto 

func (in *Submarine) DeepCopyInto(out *Submarine)

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

func (*Submarine) DeepCopyObject 

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

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

type SubmarineAgent 

type SubmarineAgent struct {
	// Image is the submarine agent's docker image
	Image string `json:"image,omitempty"`
}

SubmarineAgent defines the observed submarine agent

func (*SubmarineAgent) DeepCopy 

func (in *SubmarineAgent) DeepCopy() *SubmarineAgent

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

func (*SubmarineAgent) DeepCopyInto 

func (in *SubmarineAgent) DeepCopyInto(out *SubmarineAgent)

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

type SubmarineCommon 

type SubmarineCommon struct {
	// Image is the basic image used in initcontainer in some submarine resources
	Image CommonImage `json:"image"`
}

SubmarineCommon defines the observed common configuration

func (*SubmarineCommon) DeepCopy 

func (in *SubmarineCommon) DeepCopy() *SubmarineCommon

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

func (*SubmarineCommon) DeepCopyInto 

func (in *SubmarineCommon) DeepCopyInto(out *SubmarineCommon)

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

type SubmarineDatabaseSpec 

type SubmarineDatabaseSpec struct {
	// Image is the submarine database's docker image
	Image string `json:"image,omitempty"`
	// StorageSize is the storage size of the database
	StorageSize string `json:"storageSize"`
	// MysqlRootPasswordSecret is the mysql root password secret, secret must have key MYSQL_ROOT_PASSWORD as root password
	MysqlRootPasswordSecret string `json:"mysqlRootPasswordSecret,omitempty"`
}

SubmarineDatabaseSpec defines the desired submarine database

func (*SubmarineDatabaseSpec) DeepCopy 

func (in *SubmarineDatabaseSpec) DeepCopy() *SubmarineDatabaseSpec

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

func (*SubmarineDatabaseSpec) DeepCopyInto 

func (in *SubmarineDatabaseSpec) DeepCopyInto(out *SubmarineDatabaseSpec)

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

type SubmarineList 

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

+kubebuilder:object:root=true SubmarineList contains a list of Submarine

func (*SubmarineList) DeepCopy 

func (in *SubmarineList) DeepCopy() *SubmarineList

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

func (*SubmarineList) DeepCopyInto 

func (in *SubmarineList) DeepCopyInto(out *SubmarineList)

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

func (*SubmarineList) DeepCopyObject 

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

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

type SubmarineMinioSpec 

type SubmarineMinioSpec struct {
	// Image is the submarine minio's docker image
	Image string `json:"image,omitempty"`
	// Enabled defines whether to enable minio or not
	Enabled *bool `json:"enabled"`
	// StorageSize defines the storage size of minio
	StorageSize string `json:"storageSize"`
	// AccessKey defines the access_key of minio
	AccessKey string `json:"accessKey,omitempty"`
	// SecretKey defines the secret_key of minio
	SecretKey string `json:"secretKey,omitempty"`
}

SubmarineMinioSpec defines the desired submarine minio

func (*SubmarineMinioSpec) DeepCopy 

func (in *SubmarineMinioSpec) DeepCopy() *SubmarineMinioSpec

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

func (*SubmarineMinioSpec) DeepCopyInto 

func (in *SubmarineMinioSpec) DeepCopyInto(out *SubmarineMinioSpec)

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

type SubmarineMlflowSpec 

type SubmarineMlflowSpec struct {
	// Image is the submarine mlflow's docker image
	Image string `json:"image,omitempty"`
	// Enabled defines whether to enable mlflow or not
	Enabled *bool `json:"enabled"`
	// StorageSize defines the storage size of mlflow
	StorageSize string `json:"storageSize"`
}

SubmarineMlflowSpec defines the desired submarine mlflow

func (*SubmarineMlflowSpec) DeepCopy 

func (in *SubmarineMlflowSpec) DeepCopy() *SubmarineMlflowSpec

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

func (*SubmarineMlflowSpec) DeepCopyInto 

func (in *SubmarineMlflowSpec) DeepCopyInto(out *SubmarineMlflowSpec)

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

type SubmarineServerSpec 

type SubmarineServerSpec struct {
	// Image is the submarine server's docker image
	Image string `json:"image,omitempty"`
	// Replicas is the number of submarine server's replica
	// +kubebuilder:validation:Minimum=1
	Replicas *int32 `json:"replicas"`
	// Envs is the extra environments that submarine server requires
	Env []corev1.EnvVar `json:"env,omitempty"`
}

SubmarineServerSpec defines the desired submarine server

func (*SubmarineServerSpec) DeepCopy 

func (in *SubmarineServerSpec) DeepCopy() *SubmarineServerSpec

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

func (*SubmarineServerSpec) DeepCopyInto 

func (in *SubmarineServerSpec) DeepCopyInto(out *SubmarineServerSpec)

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

type SubmarineSpec 

type SubmarineSpec struct {

	// Version is the submarine docker image version
	Version string `json:"version"`
	// Server is the spec that defines the submarine server
	Server *SubmarineServerSpec `json:"server"`
	// Database is the spec that defines the submarine database
	Database *SubmarineDatabaseSpec `json:"database"`
	// Virtualservice is the spec that defines the submarine virtualservice
	Virtualservice *SubmarineVirtualserviceSpec `json:"virtualservice,omitempty"`
	// Tensorboard is the spec that defines the submarine tensorboard
	Tensorboard *SubmarineTensorboardSpec `json:"tensorboard"`
	// Mlflow is the spec that defines the submarine mlflow
	Mlflow *SubmarineMlflowSpec `json:"mlflow"`
	// Minio is the spec that defines the submarine minio
	Minio *SubmarineMinioSpec `json:"minio"`
	// Common is the spec that defines some submarine common configurations
	Common *SubmarineCommon `json:"common,omitempty"`
	// SubmarineAgent is the spec that defines the submarine agent
	Agent *SubmarineAgent `json:"agent,omitempty"`
}

SubmarineSpec defines the desired state of Submarine

func (*SubmarineSpec) DeepCopy 

func (in *SubmarineSpec) DeepCopy() *SubmarineSpec

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

func (*SubmarineSpec) DeepCopyInto 

func (in *SubmarineSpec) DeepCopyInto(out *SubmarineSpec)

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

type SubmarineState 

type SubmarineState struct {
	State        SubmarineStateType `json:"state"`
	ErrorMessage string             `json:"errorMessage,omitempty"`
}

SubmarineState tells the current state of the submarine and an error message in case of failures.

func (*SubmarineState) DeepCopy 

func (in *SubmarineState) DeepCopy() *SubmarineState

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

func (*SubmarineState) DeepCopyInto 

func (in *SubmarineState) DeepCopyInto(out *SubmarineState)

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

type SubmarineStateType 

type SubmarineStateType string

SubmarineStateType represents the type of the current state of a submarine. 

const (
	NewState      SubmarineStateType = ""
	CreatingState SubmarineStateType = "CREATING"
	RunningState  SubmarineStateType = "RUNNING"
	FailedState   SubmarineStateType = "FAILED"
)

Different states a submarine resource may be

type SubmarineStatus 

type SubmarineStatus struct {

	// AvailableServerReplicas is the current available replicas of submarine server
	AvailableServerReplicas int32 `json:"availableServerReplicas"`
	// AvailableServerReplicas is the current available replicas of submarine database
	AvailableDatabaseReplicas int32 `json:"availableDatabaseReplicas"`
	// SubmarineState tells the overall submarine state.
	SubmarineState `json:"submarineState,omitempty"`
}

SubmarineStatus defines the observed state of Submarine

func (*SubmarineStatus) DeepCopy 

func (in *SubmarineStatus) DeepCopy() *SubmarineStatus

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

func (*SubmarineStatus) DeepCopyInto 

func (in *SubmarineStatus) DeepCopyInto(out *SubmarineStatus)

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

type SubmarineTensorboardSpec 

type SubmarineTensorboardSpec struct {
	// Image is the submarine tensorboard's docker image
	Image string `json:"image,omitempty"`
	// Enabled defines whether to enable tensorboard or not
	Enabled *bool `json:"enabled"`
	// StorageSize defines the storage size of tensorboard
	StorageSize string `json:"storageSize"`
}

SubmarineTensorboardSpec defines the desired submarine tensorboard

func (*SubmarineTensorboardSpec) DeepCopy 

func (in *SubmarineTensorboardSpec) DeepCopy() *SubmarineTensorboardSpec

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

func (*SubmarineTensorboardSpec) DeepCopyInto 

func (in *SubmarineTensorboardSpec) DeepCopyInto(out *SubmarineTensorboardSpec)

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

type SubmarineVirtualserviceSpec 

type SubmarineVirtualserviceSpec struct {
	// Hosts is the submarine virtualservice's destination hosts
	Hosts []string `json:"hosts,omitempty"`
	// Hosts is the submarine virtualservice's gateways
	Gateways []string `json:"gateways,omitempty"`
}

SubmarineVirtualserviceSpec defines the desired submarine virtualservice

func (*SubmarineVirtualserviceSpec) DeepCopy 

func (in *SubmarineVirtualserviceSpec) DeepCopy() *SubmarineVirtualserviceSpec

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

func (*SubmarineVirtualserviceSpec) DeepCopyInto 

func (in *SubmarineVirtualserviceSpec) DeepCopyInto(out *SubmarineVirtualserviceSpec)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.