Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=scheduler.arangodb.com
Index ¶
- type Core
- type Environments
- type Image
- type Lifecycle
- type Networking
- type Probes
- type Resources
- func (r *Resources) Apply(_ *core.PodTemplateSpec, template *core.Container) error
- func (in *Resources) DeepCopy() *Resources
- func (in *Resources) DeepCopyInto(out *Resources)
- func (r *Resources) GetResources() core.ResourceRequirements
- func (r *Resources) Validate() error
- func (r *Resources) With(newResources *Resources) *Resources
- type Security
- func (s *Security) Apply(_ *core.PodTemplateSpec, template *core.Container) error
- func (in *Security) DeepCopy() *Security
- func (in *Security) DeepCopyInto(out *Security)
- func (s *Security) GetSecurityContext() core.SecurityContext
- func (s *Security) Validate() error
- func (s *Security) With(other *Security) *Security
- type VolumeMounts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Core ¶
type Core struct { *schedulerPolicyApi.Policy `json:",inline"` // Entrypoint array. Not executed within a shell. // The container image's ENTRYPOINT is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // +doc/link: Kubernetes Docs|https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell Command []string `json:"command,omitempty"` // Arguments to the entrypoint. // The container image's CMD is used if this is not provided. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless // of whether the variable exists or not. Cannot be updated. // +doc/link: Kubernetes Docs|https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell Args []string `json:"args,omitempty"` // Container's working directory. // If not specified, the container runtime's default will be used, which // might be configured in the container image. WorkingDir string `json:"workingDir,omitempty"` }
func (*Core) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Core.
func (*Core) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Environments ¶
type Environments struct { // Env keeps the information about environment variables provided to the container // +doc/type: core.EnvVar // +doc/link: Kubernetes Docs|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#envvar-v1-core Env []core.EnvVar `json:"env,omitempty"` // EnvFrom keeps the information about environment variable sources provided to the container // +doc/type: core.EnvFromSource // +doc/link: Kubernetes Docs|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#envfromsource-v1-core EnvFrom []core.EnvFromSource `json:"envFrom,omitempty"` }
func (*Environments) Apply ¶
func (e *Environments) Apply(_ *core.PodTemplateSpec, container *core.Container) error
func (*Environments) DeepCopy ¶
func (in *Environments) DeepCopy() *Environments
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Environments.
func (*Environments) DeepCopyInto ¶
func (in *Environments) DeepCopyInto(out *Environments)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Environments) Validate ¶
func (e *Environments) Validate() error
func (*Environments) With ¶
func (e *Environments) With(other *Environments) *Environments
type Image ¶
type Image struct { // Image define image details Image *string `json:"image,omitempty"` // ImagePullPolicy define Image pull policy // +doc/default: IfNotPresent ImagePullPolicy *core.PullPolicy `json:"imagePullPolicy,omitempty"` }
func (*Image) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Image.
func (*Image) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Lifecycle ¶
type Lifecycle struct { // Lifecycle keeps actions that the management system should take in response to container lifecycle events. // +doc/type: core.Lifecycle Lifecycle *core.Lifecycle `json:"lifecycle,omitempty"` }
func (*Lifecycle) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Lifecycle.
func (*Lifecycle) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Networking ¶
type Networking struct { // Ports contains list of ports to expose from the container. Not specifying a port here // DOES NOT prevent that port from being exposed. Any port which is // listening on the default "0.0.0.0" address inside a container will be // accessible from the network. // +doc/type: []core.ContainerPort Ports []core.ContainerPort `json:"ports,omitempty"` }
func (*Networking) Apply ¶
func (n *Networking) Apply(pod *core.PodTemplateSpec, template *core.Container) error
func (*Networking) DeepCopy ¶
func (in *Networking) DeepCopy() *Networking
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Networking.
func (*Networking) DeepCopyInto ¶
func (in *Networking) DeepCopyInto(out *Networking)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Networking) Validate ¶
func (n *Networking) Validate() error
func (*Networking) With ¶
func (n *Networking) With(newResources *Networking) *Networking
type Probes ¶
type Probes struct { // LivenessProbe keeps configuration of periodic probe of container liveness. // Container will be restarted if the probe fails. // +doc/type: core.Probe // +doc/link: Kubernetes docs|https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes LivenessProbe *core.Probe `json:"livenessProbe,omitempty"` // ReadinessProbe keeps configuration of periodic probe of container service readiness. // Container will be removed from service endpoints if the probe fails. // +doc/type: core.Probe // +doc/link: Kubernetes docs|https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes ReadinessProbe *core.Probe `json:"readinessProbe,omitempty"` // StartupProbe indicates that the Pod has successfully initialized. // If specified, no other probes are executed until this completes successfully. // If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. // This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, // when it might take a long time to load data or warm a cache, than during steady-state operation. // +doc/type: core.Probe // +doc/link: Kubernetes docs|https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes StartupProbe *core.Probe `json:"startupProbe,omitempty"` }
func (*Probes) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Probes.
func (*Probes) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resources ¶
type Resources struct { // Resources holds resource requests & limits for container // +doc/type: core.ResourceRequirements // +doc/link: Documentation of core.ResourceRequirements|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#resourcerequirements-v1-core Resources *core.ResourceRequirements `json:"resources,omitempty"` }
func (*Resources) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resources.
func (*Resources) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Resources) GetResources ¶
func (r *Resources) GetResources() core.ResourceRequirements
type Security ¶
type Security struct { // SecurityContext holds container-level security attributes and common container settings. // +doc/type: core.SecurityContext // +doc/link: Kubernetes docs|https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ SecurityContext *core.SecurityContext `json:"securityContext,omitempty"` }
func (*Security) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Security.
func (*Security) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Security) GetSecurityContext ¶
func (s *Security) GetSecurityContext() core.SecurityContext
type VolumeMounts ¶
type VolumeMounts struct { // VolumeMounts keeps list of pod volumes to mount into the container's filesystem. // +doc/type: []core.VolumeMount VolumeMounts []core.VolumeMount `json:"volumeMounts,omitempty"` }
func (*VolumeMounts) Apply ¶
func (v *VolumeMounts) Apply(_ *core.PodTemplateSpec, container *core.Container) error
func (*VolumeMounts) DeepCopy ¶
func (in *VolumeMounts) DeepCopy() *VolumeMounts
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeMounts.
func (*VolumeMounts) DeepCopyInto ¶
func (in *VolumeMounts) DeepCopyInto(out *VolumeMounts)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VolumeMounts) Validate ¶
func (v *VolumeMounts) Validate() error
func (*VolumeMounts) With ¶
func (v *VolumeMounts) With(other *VolumeMounts) *VolumeMounts