Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the config v1 API group +kubebuilder:object:generate=true +groupName=config.k8ssandra.io
Index ¶
Constants ¶
const ( K8ssandraConfigLabel = "k8ssandra.io/config" K8ssandraImageLabelValue = "image" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "config.k8ssandra.io", 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 Image ¶
type Image struct {
metav1.TypeMeta `json:",inline"`
// The Docker registry to use. Defaults to "docker.io", the official Docker Hub.
// +optional
Registry string `json:"registry,omitempty"`
// The Docker repository to use.
// +optional
Repository string `json:"repository,omitempty"`
// The image name to use.
// +optional
Name string `json:"name,omitempty"`
// The image tag to use. Defaults to "latest".
// +optional
Tag string `json:"tag,omitempty"`
// The image digest to use. When set, it takes precedence over Tag.
// +optional
Digest string `json:"digest,omitempty"`
// The image pull policy to use. Defaults to "Always" if the tag is "latest", otherwise to "IfNotPresent".
// +optional
// +kubebuilder:validation:Enum:=Always;IfNotPresent;Never
PullPolicy corev1.PullPolicy `json:"pullPolicy,omitempty"`
// The secret to use when pulling the image from private repositories. If specified, this secret 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
PullSecret string `json:"pullSecret,omitempty"`
}
Image uniquely describes a container image and also specifies how to pull it from its remote repository. More info: https://kubernetes.io/docs/concepts/containers/images. +kubebuilder:object:generate=true
func (*Image) ApplyOverrides ¶
ApplyOverrides modifies the image by applying overrides from a higher-priority image. Higher priority could be something that's defined in the CRD for example
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.
func (*Image) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ImageComponent ¶
type ImageComponent struct {
Suffix string `json:"suffix,omitempty"`
Prefix string `json:"prefix,omitempty"`
// We ignore Tag from the Image, but other fields are preserved.
Image
}
func (*ImageComponent) DeepCopy ¶
func (in *ImageComponent) DeepCopy() *ImageComponent
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageComponent.
func (*ImageComponent) DeepCopyInto ¶
func (in *ImageComponent) DeepCopyInto(out *ImageComponent)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageConfig ¶
type ImageConfig struct {
metav1.TypeMeta `json:",inline"`
// Images defines the images to be used for the various components.
// The key is the component name, and the value is the image definition.
// +optional
Images Images `json:"images,omitempty"`
// Defaults contains default values for images.
Defaults ImagePolicy `json:"defaults"`
// Types defines image types that can be referenced. These types are not matched to a tag
// +optional
Types ImageTypes `json:"types,omitempty"`
// Overrides contains values that override any setting images might otherwise have
// +optional
Overrides *ImagePolicy `json:"overrides,omitempty"`
}
ImageConfig is the Schema for the imageconfigs API +kubebuilder:object:root=true
func (*ImageConfig) DeepCopy ¶
func (in *ImageConfig) DeepCopy() *ImageConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageConfig.
func (*ImageConfig) DeepCopyInto ¶
func (in *ImageConfig) DeepCopyInto(out *ImageConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ImageConfig) DeepCopyObject ¶
func (in *ImageConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ImagePolicy ¶
type ImagePolicy struct {
Registry *string `json:"registry,omitempty"`
PullSecrets []string `json:"pullSecrets,omitempty"`
PullPolicy corev1.PullPolicy `json:"pullPolicy,omitempty"`
Repository *string `json:"repository,omitempty"`
}
func (*ImagePolicy) DeepCopy ¶
func (in *ImagePolicy) DeepCopy() *ImagePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImagePolicy.
func (*ImagePolicy) DeepCopyInto ¶
func (in *ImagePolicy) DeepCopyInto(out *ImagePolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageTypes ¶
type ImageTypes map[string]*ImageComponent
func (ImageTypes) DeepCopy ¶
func (in ImageTypes) DeepCopy() ImageTypes
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageTypes.
func (ImageTypes) DeepCopyInto ¶
func (in ImageTypes) DeepCopyInto(out *ImageTypes)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Images ¶
Images defines a map of images.
func (Images) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Images.
func (Images) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files