v1alpha1

package
v0.0.0-...-07eeed4 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the amalthea.dev v1alpha1 API group +kubebuilder:object:generate=true +groupName=amalthea.dev

Index

Constants

View Source 
const SessionContainerName string = prefix + "session"

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "amalthea.dev", Version: "v1alpha1"}

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

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

	Spec AmaltheaSessionSpec `json:"spec,omitempty"`
	// +kubebuilder:default:={}
	Status AmaltheaSessionStatus `json:"status,omitempty"`
}

+kubebuilder:printcolumn:name="Status",type="string",JSONPath=`.status.state`,description="The overall status of the session." +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=`.status.containerCounts.ready`,description="The number of containers in a ready state for the session, disregarding init containers." +kubebuilder:printcolumn:name="Total",type="string",JSONPath=`.status.containerCounts.total`,description="The total numeber of containers in the session, disregarding init containers." +kubebuilder:printcolumn:name="Idle",type="boolean",JSONPath=`.status.idle`,description="Whether the session is idle or not." +kubebuilder:printcolumn:name="URL",type="string",JSONPath=`.status.url`,description="The URL where the session can be accessed." AmaltheaSession is the Schema for the amaltheasessions API

func (*AmaltheaSession) AdoptedSecrets 

func (cr *AmaltheaSession) AdoptedSecrets() v1.SecretList

Returns the list of all the secrets used in this CR

func (*AmaltheaSession) DataSources 

func (as *AmaltheaSession) DataSources() ([]v1.PersistentVolumeClaim, []v1.Volume, []v1.VolumeMount)

Assuming that the csi-rclone driver from https://github.com/SwissDataScienceCenter/csi-rclone is installed, this will generate PVCs for the data sources that have the rclone type.

func (*AmaltheaSession) DeepCopy 

func (in *AmaltheaSession) DeepCopy() *AmaltheaSession

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

func (*AmaltheaSession) DeepCopyInto 

func (in *AmaltheaSession) DeepCopyInto(out *AmaltheaSession)

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

func (*AmaltheaSession) DeepCopyObject 

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

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

func (*AmaltheaSession) GetHealthcheckURL 

func (a *AmaltheaSession) GetHealthcheckURL() *url.URL

func (*AmaltheaSession) GetURL 

func (a *AmaltheaSession) GetURL() *url.URL

func (*AmaltheaSession) GetURLString 

func (a *AmaltheaSession) GetURLString() string

func (*AmaltheaSession) Ingress 

func (cr *AmaltheaSession) Ingress() *networkingv1.Ingress

Ingress returns a AmaltheaSession Ingress object

func (*AmaltheaSession) NeedsDeletion 

func (cr *AmaltheaSession) NeedsDeletion() bool

func (*AmaltheaSession) PVC 

func (cr *AmaltheaSession) PVC() v1.PersistentVolumeClaim

PVC returned the desired specification for a persistent volume claim

func (*AmaltheaSession) Pod 

func (cr *AmaltheaSession) Pod(ctx context.Context, clnt client.Client) (*v1.Pod, error)

func (*AmaltheaSession) Service 

func (cr *AmaltheaSession) Service() v1.Service

Service returns a AmaltheaSession Service object

func (*AmaltheaSession) SessionVolumes 

func (cr *AmaltheaSession) SessionVolumes() ([]v1.Volume, []v1.VolumeMount)

func (*AmaltheaSession) StatefulSet 

func (cr *AmaltheaSession) StatefulSet() (appsv1.StatefulSet, error)

StatefulSet returns a AmaltheaSession StatefulSet object

type AmaltheaSessionCondition 

type AmaltheaSessionCondition struct {
	Type   AmaltheaSessionConditionType `json:"type"`
	Status metav1.ConditionStatus       `json:"status"`
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// +optional
	Reason string `json:"reason,omitempty"`
	// +optional
	Message string `json:"message,omitempty"`
}

func NewConditions 

func NewConditions() []AmaltheaSessionCondition

func (*AmaltheaSessionCondition) DeepCopy 

func (in *AmaltheaSessionCondition) DeepCopy() *AmaltheaSessionCondition

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

func (*AmaltheaSessionCondition) DeepCopyInto 

func (in *AmaltheaSessionCondition) DeepCopyInto(out *AmaltheaSessionCondition)

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

type AmaltheaSessionConditionType 

type AmaltheaSessionConditionType string
const (
	AmaltheaSessionReady        AmaltheaSessionConditionType = "Ready"
	AmaltheaSessionRoutingReady AmaltheaSessionConditionType = "RoutingReady"
)

type AmaltheaSessionList 

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

AmaltheaSessionList contains a list of AmaltheaSession

func (*AmaltheaSessionList) DeepCopy 

func (in *AmaltheaSessionList) DeepCopy() *AmaltheaSessionList

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

func (*AmaltheaSessionList) DeepCopyInto 

func (in *AmaltheaSessionList) DeepCopyInto(out *AmaltheaSessionList)

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

func (*AmaltheaSessionList) DeepCopyObject 

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

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

type AmaltheaSessionSpec 

type AmaltheaSessionSpec struct {
	// Specification for the main session container that the user will access and use
	Session Session `json:"session"`

	// +optional
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="CodeRepositories is immutable"
	// A list of code repositories and associated configuration that will be cloned in the session
	CodeRepositories []CodeRepository `json:"codeRepositories,omitempty"`

	// +optional
	// A list of data sources that should be added to the session
	DataSources []DataSource `json:"dataSources,omitempty"`

	// Authentication configuration for the session
	// +optional
	Authentication *Authentication `json:"authentication,omitempty"`

	// Culling configuration
	Culling Culling `json:"culling,omitempty"`

	// +kubebuilder:default:=false
	// Will hibernate the session, scaling the session's statefulset to zero.
	Hibernated bool `json:"hibernated"`

	// +optional
	// Additional containers to add to the session statefulset.
	// NOTE: The container names provided will be partially overwritten and randomized to avoid collisions
	ExtraContainers []v1.Container `json:"extraContainers,omitempty"`

	// +optional
	// Additional init containers to add to the session statefulset
	// NOTE: The container names provided will be partially overwritten and randomized to avoid collisions
	ExtraInitContainers []v1.Container `json:"initContainers,omitempty"`

	// +optional
	// Additional volumes to include in the statefulset for a session
	// Volumes used internally by amalthea are all prefixed with 'amalthea-' so as long as you
	// avoid that naming you will avoid conflicts with the volumes that amalthea generates.
	ExtraVolumes []v1.Volume `json:"extraVolumes,omitempty"`

	// +optional
	// Configuration for an ingress to the session, if omitted a Kubernetes Ingress will not be created
	Ingress *Ingress `json:"ingress,omitempty"`

	// Selector which must match a node's labels for the pod to be scheduled on that node.
	// Passed right through to the Statefulset used for the session.
	// +optional
	// +mapType=atomic
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// If specified, the pod's scheduling constraints
	// Passed right through to the Statefulset used for the session.
	// +optional
	Affinity *v1.Affinity `json:"affinity,omitempty"`

	// If specified, the pod's tolerations.
	// Passed right through to the Statefulset used for the session.
	// +optional
	Tolerations []v1.Toleration `json:"tolerations,omitempty"`

	// +kubebuilder:default:="always"
	// Indicates how Amalthea should reconcile the child resources for a session. This can be problematic because
	// newer versions of Amalthea may include new versions of the sidecars or other changes not reflected
	// in the AmaltheaSession CRD, so simply updating Amalthea could cause existing sessions to restart
	// because the sidecars will have a newer image or for other reasons because the code changed.
	// Hibernating the session and deleting it will always work as expected regardless of the strategy.
	// The status of the session and all hibernation or auto-cleanup functionality will always work as expected.
	// A few values are possible:
	// - never: Amalthea will never update any of the child resources and will ignore any changes to the CR
	// - always: This is the expected method of operation for an operator, changes to the spec are always reconciled
	// - whenHibernatedOrFailed: To avoid interrupting a running session, reconciliation of the child components
	//   are only done when the session has a Failed or Hibernated status
	ReconcileStrategy ReconcileStrategy `json:"reconcileStrategy,omitempty"`

	// +optional
	// The name of the priority class assigned to the session Pod.
	PriorityClassName string `json:"priorityClassName,omitempty"`

	//+optional
	//List of secrets that contain credentials for pulling private images
	ImagePullSecrets []SessionSecretRef `json:"imagePullSecrets,omitempty"`
}

AmaltheaSessionSpec defines the desired state of AmaltheaSession

func (*AmaltheaSessionSpec) DeepCopy 

func (in *AmaltheaSessionSpec) DeepCopy() *AmaltheaSessionSpec

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

func (*AmaltheaSessionSpec) DeepCopyInto 

func (in *AmaltheaSessionSpec) DeepCopyInto(out *AmaltheaSessionSpec)

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

type AmaltheaSessionStatus 

type AmaltheaSessionStatus struct {
	// Conditions store the status conditions of the AmaltheaSessions. This is a standard thing that
	// many operators implement see https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []AmaltheaSessionCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
	// +kubebuilder:default:=NotReady
	State               State           `json:"state,omitempty"`
	URL                 string          `json:"url,omitempty"`
	ContainerCounts     ContainerCounts `json:"containerCounts,omitempty"`
	InitContainerCounts ContainerCounts `json:"initContainerCounts,omitempty"`
	// +kubebuilder:default:=false
	Idle bool `json:"idle,omitempty"`
	// +kubebuilder:validation:Format:=date-time
	IdleSince metav1.Time `json:"idleSince,omitempty"`
	// +kubebuilder:validation:Format:=date-time
	FailingSince metav1.Time `json:"failingSince,omitempty"`
	// +kubebuilder:validation:Format:=date-time
	HibernatedSince metav1.Time `json:"hibernatedSince,omitempty"`
	// If the state is failed then the message will contain information about what went wrong, otherwise it is empty
	// +optional
	Error string `json:"error,omitempty"`
}

AmaltheaSessionStatus defines the observed state of AmaltheaSession

func (*AmaltheaSessionStatus) DeepCopy 

func (in *AmaltheaSessionStatus) DeepCopy() *AmaltheaSessionStatus

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

func (*AmaltheaSessionStatus) DeepCopyInto 

func (in *AmaltheaSessionStatus) DeepCopyInto(out *AmaltheaSessionStatus)

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

type Authentication 

type Authentication struct {
	// +optional
	// +kubebuilder:validation:Optional
	// +kubebuilder:default:=true
	Enabled bool               `json:"enabled"`
	Type    AuthenticationType `json:"type"`
	// Kubernetes secret that contains the authentication configuration
	// For `token` a yaml file with the following keys is required:
	//   - token: the token value used to authenticate the user
	//   - cookie_key: the name of the cookie where the token will be saved and searched for
	// For `oauth2proxy` please see https://oauth2-proxy.github.io/oauth2-proxy/configuration/overview#config-file.
	// Note that the `upstream` and `http_address` configuration options cannot be set from the secret because
	// the operator knows how to set these options to the proper values.
	SecretRef SessionSecretKeyRef `json:"secretRef"`
	// +optional
	// Additional volume mounts for the authentication container.
	ExtraVolumeMounts []v1.VolumeMount `json:"extraVolumeMounts,omitempty"`
}

func (*Authentication) DeepCopy 

func (in *Authentication) DeepCopy() *Authentication

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

func (*Authentication) DeepCopyInto 

func (in *Authentication) DeepCopyInto(out *Authentication)

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

type AuthenticationType 

type AuthenticationType string

+kubebuilder:validation:Enum={token,oauth2proxy} 

const Oidc AuthenticationType = "oauth2proxy"
const Token AuthenticationType = "token"

type CodeRepository 

type CodeRepository struct {
	// +kubebuilder:default:=git
	// The type of the code repository - currently the only supported kind is git.
	Type CodeRepositoryType `json:"type,omitempty"`
	// +kubebuilder:example:=repositories/project1
	// +kubebuilder:default:="."
	// Path relative to the session working directory where the repository should be cloned into.
	ClonePath string `json:"clonePath,omitempty"`
	// +kubebuilder:example:="https://github.com/SwissDataScienceCenter/renku"
	// The HTTP url to the code repository
	Remote string `json:"remote"`
	// +kubebuilder:example:=main
	// The tag, branch or commit SHA to checkout, if omitted then will be the tip of the default branch of the repo
	Revision string `json:"revision,omitempty"`
	// The Kubernetes secret that contains the code repository configuration to be used during cloning.
	// For 'git' this should contain either:
	// The username and password
	// The private key and its corresponding password
	// An empty value can be used when cloning from public repositories using the http protocol
	// NOTE: you have to specify the whole config in a single key in the secret.
	CloningConfigSecretRef *SessionSecretKeyRef `json:"cloningConfigSecretRef,omitempty"`
	// The Kubernetes secret that contains the code repository configuration to be used when the session is running.
	// For 'git' this is the git configuration which can be used to inject credentials in addition to any other repo-specific Git configuration.
	// NOTE: you have to specify the whole config in a single key in the secret.
	ConfigSecretRef *SessionSecretKeyRef `json:"configSecretRef,omitempty"`
}

func (*CodeRepository) DeepCopy 

func (in *CodeRepository) DeepCopy() *CodeRepository

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

func (*CodeRepository) DeepCopyInto 

func (in *CodeRepository) DeepCopyInto(out *CodeRepository)

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

type CodeRepositoryType 

type CodeRepositoryType string

+kubebuilder:validation:Enum={git} 

const Git CodeRepositoryType = "git"

type ContainerCounts 

type ContainerCounts struct {
	Ready int `json:"ready,omitempty"`
	Total int `json:"total,omitempty"`
}

Counts of the total and ready containers, can represent either regular or init containers.

func (*ContainerCounts) DeepCopy 

func (in *ContainerCounts) DeepCopy() *ContainerCounts

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

func (*ContainerCounts) DeepCopyInto 

func (in *ContainerCounts) DeepCopyInto(out *ContainerCounts)

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

func (ContainerCounts) Ok 

func (c ContainerCounts) Ok() bool

type Culling 

type Culling struct {
	// +kubebuilder:validation:Format:=duration
	// The maximum allowed age for a session, regardless of whether it
	// is active or not. When the threshold is reached the session is hibernated.
	// A value of zero indicates that Amalthea will not automatically hibernate
	// the session based on its age.
	// Golang's time.ParseDuration is used to parse this, so values like 2h5min will work,
	// valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxAge metav1.Duration `json:"maxAge,omitempty"`
	// +kubebuilder:validation:Format:=duration
	// How long should a server be idle for before it is hibernated. A value of
	// zero indicates that Amalthea will not automatically hibernate inactive sessions.
	// Golang's time.ParseDuration is used to parse this, so values like 2h5min will work,
	// valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxIdleDuration metav1.Duration `json:"maxIdleDuration,omitempty"`
	// +kubebuilder:validation:Format:=duration
	// How long can a server be in starting state before it gets hibernated. A
	// value of zero indicates that the server will not be automatically hibernated
	// by Amalthea because it took to long to start.
	// Golang's time.ParseDuration is used to parse this, so values like 2h5min will work,
	// valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxStartingDuration metav1.Duration `json:"maxStartingDuration,omitempty"`
	// +kubebuilder:validation:Format:=duration
	// How long can a server be in failed state before it gets hibernated. A
	// value of zero indicates that the server will not be automatically
	// hibernated by Amalthea if it is failing.
	// Golang's time.ParseDuration is used to parse this, so values like 2h5min will work,
	// valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxFailedDuration metav1.Duration `json:"maxFailedDuration,omitempty"`
	// +kubebuilder:validation:Format:=duration
	// How long can a session be in hibernated state before
	// it gets completely deleted. A value of zero indicates that hibernated servers
	// will not be automatically be deleted by Amalthea after a period of time.
	// Golang's time.ParseDuration is used to parse this, so values like 2h5min will work,
	// valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	MaxHibernatedDuration metav1.Duration `json:"maxHibernatedDuration,omitempty"`
}

func (*Culling) DeepCopy 

func (in *Culling) DeepCopy() *Culling

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

func (*Culling) DeepCopyInto 

func (in *Culling) DeepCopyInto(out *Culling)

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

type DataSource 

type DataSource struct {
	// +kubebuilder:default:=rclone
	// The data source type
	Type StorageType `json:"type,omitempty"`
	// +kubebuilder:example:=data/storages
	// +kubebuilder:default:="data"
	// Path relative to the session working directory where the data should be mounted
	MountPath string `json:"mountPath,omitempty"`
	// +kubebuilder:default:=ReadOnlyMany
	// The access mode for the data source
	AccessMode v1.PersistentVolumeAccessMode `json:"accessMode,omitempty"`
	// The secret containing the configuration or credentials needed for access to the data.
	// The format of the configuration that is expected depends on the storage type.
	// NOTE: define all values in a single key of the Kubernetes secret.
	// rclone: any valid rclone configuration for a single remote, see the output of `rclone config providers` for validation and format.
	SecretRef *SessionSecretRef `json:"secretRef,omitempty"`
}

func (*DataSource) DeepCopy 

func (in *DataSource) DeepCopy() *DataSource

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

func (*DataSource) DeepCopyInto 

func (in *DataSource) DeepCopyInto(out *DataSource)

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

type Ingress 

type Ingress struct {
	Annotations map[string]string `json:"annotations,omitempty"`
	// +optional
	IngressClassName *string `json:"ingressClassName,omitempty"`
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Host is immutable"
	Host string `json:"host"`
	// +optional
	// The name of the TLS secret, same as what is specified in a regular Kubernetes Ingress.
	TLSSecret *SessionSecretRef `json:"tlsSecret,omitempty"`
	// +optional
	// +kubebuilder:default:="/"
	// The path prefix that will be used in the ingress. If this is explicitly set, then the
	// urlPath value should be a subpath of this value.
	PathPrefix string `json:"pathPrefix,omitempty"`
}

func (*Ingress) DeepCopy 

func (in *Ingress) DeepCopy() *Ingress

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

func (*Ingress) DeepCopyInto 

func (in *Ingress) DeepCopyInto(out *Ingress)

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

type ReadinessProbe 

type ReadinessProbe struct {
	// +kubebuilder:default:=tcp
	// +optional
	// The type of readiness probe
	Type ReadinessProbeType `json:"type,omitempty"`
}

func (*ReadinessProbe) DeepCopy 

func (in *ReadinessProbe) DeepCopy() *ReadinessProbe

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

func (*ReadinessProbe) DeepCopyInto 

func (in *ReadinessProbe) DeepCopyInto(out *ReadinessProbe)

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

type ReadinessProbeType 

type ReadinessProbeType string

+kubebuilder:validation:Enum={none,tcp,http} 

const HTTP ReadinessProbeType = "http"
const None ReadinessProbeType = "none"
const TCP ReadinessProbeType = "tcp"

type ReconcileStrategy 

type ReconcileStrategy string

+kubebuilder:validation:Enum={never,always,whenFailedOrHibernated} 

const Always ReconcileStrategy = "always"
const Never ReconcileStrategy = "never"
const WhenFailedOrHibernated ReconcileStrategy = "whenFailedOrHibernated"

type Session 

type Session struct {
	Image string `json:"image"`
	// The command to run in the session container, if omitted it will use the Docker image ENTRYPOINT
	Command []string `json:"command,omitempty"`
	// The arguments to run in the session container, if omitted it will use the Docker image CMD
	Args []string    `json:"args,omitempty"`
	Env  []v1.EnvVar `json:"env,omitempty"`
	// Resource requirements and limits in the same format as a Pod in Kubernetes
	Resources v1.ResourceRequirements `json:"resources,omitempty"`
	// +kubebuilder:default:=8000
	// +kubebuilder:validation:ExclusiveMinimum:=true
	// +kubebuilder:validation:ExclusiveMaximum:=true
	// +kubebuilder:validation:Minimum:=0
	// +kubebuilder:validation:Maximum:=65535
	// The TCP port on the pod where the session can be accessed.
	// If the session has authentication enabled then the ingress and service will point to the authentication container
	// and the authentication proxy container will proxy to this port. If authentication is disabled then the ingress and service
	// route directly to this port. Note that renku reserves the highest TCP value 65535 to run the authentication proxy.
	Port int32 `json:"port,omitempty"`
	// +optional
	// +kubebuilder:default:={}
	Storage Storage `json:"storage,omitempty"`
	// +optional
	// Size of /dev/shm
	ShmSize *resource.Quantity `json:"shmSize,omitempty"`
	// The abolute path for the working directory of the session container, if omitted it will use the image
	// working directory.
	WorkingDir string `json:"workingDir,omitempty"`
	// +optional
	// +kubebuilder:default:=1000
	// +kubebuilder:validation:Minimum:=0
	RunAsUser int64 `json:"runAsUser,omitempty"`
	// +optional
	// +kubebuilder:default:=1000
	// +kubebuilder:validation:Minimum:=0
	// The group is set on the session and this value is also set as the fsgroup for the whole pod and all session
	// containers.
	RunAsGroup int64 `json:"runAsGroup,omitempty"`
	// +optional
	// +kubebuilder:default:="/"
	// The path where the session can be accessed, if an ingress is used this should be a subpath
	// of the ingress.pathPrefix field. For example if the pathPrefix is /foo, this should be /foo or /foo/bar,
	// but it cannot be /baz.
	URLPath string `json:"urlPath,omitempty"`
	// +optional
	// Additional volume mounts for the session container
	ExtraVolumeMounts []v1.VolumeMount `json:"extraVolumeMounts,omitempty"`
	// +optional
	// +kubebuilder:default:={}
	// The readiness probe to use on the session container
	ReadinessProbe ReadinessProbe `json:"readinessProbe,omitempty"`
}

func (*Session) DeepCopy 

func (in *Session) DeepCopy() *Session

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

func (*Session) DeepCopyInto 

func (in *Session) DeepCopyInto(out *Session)

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

type SessionSecretKeyRef 

type SessionSecretKeyRef struct {
	Name string `json:"name"`
	Key  string `json:"key"`
	// +optional
	// +kubebuilder:validation:Optional
	// If the secret is adopted then the operator will delete the secret when the custom resource that uses it is deleted.
	Adopt bool `json:"adopt"`
}

A reference to a Kubernetes secret and a specific field in the secret to be used in a session

func (*SessionSecretKeyRef) DeepCopy 

func (in *SessionSecretKeyRef) DeepCopy() *SessionSecretKeyRef

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

func (*SessionSecretKeyRef) DeepCopyInto 

func (in *SessionSecretKeyRef) DeepCopyInto(out *SessionSecretKeyRef)

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

type SessionSecretRef 

type SessionSecretRef struct {
	Name string `json:"name"`
	// +optional
	// +kubebuilder:validation:Optional
	// If the secret is adopted then the operator will delete the secret when the custom resource that uses it is deleted.
	Adopt bool `json:"adopt"`
}

A reference to a whole Kubernetes secret where the key is not important

func (*SessionSecretRef) DeepCopy 

func (in *SessionSecretRef) DeepCopy() *SessionSecretRef

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

func (*SessionSecretRef) DeepCopyInto 

func (in *SessionSecretRef) DeepCopyInto(out *SessionSecretRef)

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

type State 

type State string

+kubebuilder:validation:Enum={Running,Failed,Hibernated,NotReady,RunningDegraded} 

const Failed State = "Failed"
const Hibernated State = "Hibernated"
const NotReady State = "NotReady"
const Running State = "Running"
const RunningDegraded State = "RunningDegraded"

type Storage 

type Storage struct {
	// +optional
	ClassName *string `json:"className,omitempty"`
	// +optional
	// +kubebuilder:default:="1Gi"
	Size *resource.Quantity `json:"size,omitempty"`
	// The absolute mount path for the session volume
	// +optional
	// +kubebuilder:default:="/workspace"
	MountPath string `json:"mountPath,omitempty"`
}

func (*Storage) DeepCopy 

func (in *Storage) DeepCopy() *Storage

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

func (*Storage) DeepCopyInto 

func (in *Storage) DeepCopyInto(out *Storage)

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

type StorageType 

type StorageType string

+kubebuilder:validation:Enum={rclone} 

const Rclone StorageType = "rclone"

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.