v1

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=k3s.cattle.io

+k8s:deepcopy-gen=package +groupName=k3s.cattle.io

+k8s:deepcopy-gen=package +groupName=k3s.cattle.io

Index

Constants

This section is empty.

Variables

View Source 
var (
	AddonResourceName            = "addons"
	ETCDSnapshotFileResourceName = "etcdsnapshotfiles"
)
View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: k3s.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Addon 

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

	// Spec provides information about the on-disk manifest backing this resource.
	Spec AddonSpec `json:"spec,omitempty"`
}

Addon is used to track application of a manifest file on disk. It mostly exists so that the wrangler DesiredSet Apply controller has an object to track as the owner, and ensure that all created resources are tracked when the manifest is modified or removed.

func NewAddon 

func NewAddon(namespace, name string, obj Addon) *Addon

func (*Addon) DeepCopy 

func (in *Addon) DeepCopy() *Addon

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

func (*Addon) DeepCopyInto 

func (in *Addon) DeepCopyInto(out *Addon)

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

func (*Addon) DeepCopyObject 

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

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

type AddonList 

type AddonList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Addon `json:"items"`
}

AddonList is a list of Addon resources

func (*AddonList) DeepCopy 

func (in *AddonList) DeepCopy() *AddonList

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

func (*AddonList) DeepCopyInto 

func (in *AddonList) DeepCopyInto(out *AddonList)

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

func (*AddonList) DeepCopyObject 

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

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

type AddonSpec 

type AddonSpec struct {
	// Source is the Path on disk to the manifest file that this Addon tracks.
	Source string `json:"source,omitempty" column:""`
	// Checksum is the SHA256 checksum of the most recently successfully applied manifest file.
	Checksum string `json:"checksum,omitempty" column:""`
}

func (*AddonSpec) DeepCopy 

func (in *AddonSpec) DeepCopy() *AddonSpec

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

func (*AddonSpec) DeepCopyInto 

func (in *AddonSpec) DeepCopyInto(out *AddonSpec)

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

type ETCDSnapshotError 

type ETCDSnapshotError struct {
	// Time is the timestamp when the error was encountered.
	Time *metav1.Time `json:"time,omitempty"`
	// Message is a string detailing the encountered error during snapshot creation if specified.
	// NOTE: message may be logged, and it should not contain sensitive information.
	Message *string `json:"message,omitempty"`
}

ETCDSnapshotError describes an error encountered during snapshot creation.

func (*ETCDSnapshotError) DeepCopy 

func (in *ETCDSnapshotError) DeepCopy() *ETCDSnapshotError

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

func (*ETCDSnapshotError) DeepCopyInto 

func (in *ETCDSnapshotError) DeepCopyInto(out *ETCDSnapshotError)

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

type ETCDSnapshotFile 

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

	// Spec defines properties of an etcd snapshot file
	Spec ETCDSnapshotSpec `json:"spec,omitempty"`
	// Status represents current information about a snapshot.
	Status ETCDSnapshotStatus `json:"status,omitempty"`
}

ETCDSnapshot tracks a point-in-time snapshot of the etcd datastore.

func NewETCDSnapshotFile 

func NewETCDSnapshotFile(namespace, name string, obj ETCDSnapshotFile) *ETCDSnapshotFile

func (*ETCDSnapshotFile) DeepCopy 

func (in *ETCDSnapshotFile) DeepCopy() *ETCDSnapshotFile

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

func (*ETCDSnapshotFile) DeepCopyInto 

func (in *ETCDSnapshotFile) DeepCopyInto(out *ETCDSnapshotFile)

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

func (*ETCDSnapshotFile) DeepCopyObject 

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

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

type ETCDSnapshotFileList 

type ETCDSnapshotFileList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ETCDSnapshotFile `json:"items"`
}

ETCDSnapshotFileList is a list of ETCDSnapshotFile resources

func (*ETCDSnapshotFileList) DeepCopy 

func (in *ETCDSnapshotFileList) DeepCopy() *ETCDSnapshotFileList

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

func (*ETCDSnapshotFileList) DeepCopyInto 

func (in *ETCDSnapshotFileList) DeepCopyInto(out *ETCDSnapshotFileList)

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

func (*ETCDSnapshotFileList) DeepCopyObject 

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

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

type ETCDSnapshotS3 

type ETCDSnapshotS3 struct {
	// Endpoint is the host or host:port of the S3 service
	Endpoint string `json:"endpoint,omitempty"`
	// EndpointCA is the path on disk to the S3 service's trusted CA list. Leave empty to use the OS CA bundle.
	EndpointCA string `json:"endpointCA,omitempty"`
	// SkipSSLVerify is true if TLS certificate verification is disabled
	SkipSSLVerify bool `json:"skipSSLVerify,omitempty"`
	// Bucket is the bucket holding the snapshot
	Bucket string `json:"bucket,omitempty"`
	// Region is the region of the S3 service
	Region string `json:"region,omitempty"`
	// Prefix is the prefix in which the snapshot file is stored.
	Prefix string `json:"prefix,omitempty"`
	// Insecure is true if the S3 service uses HTTP instead of HTTPS
	Insecure bool `json:"insecure,omitempty"`
}

ETCDSnapshotS3 holds information about the S3 storage system holding the snapshot.

func (*ETCDSnapshotS3) DeepCopy 

func (in *ETCDSnapshotS3) DeepCopy() *ETCDSnapshotS3

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

func (*ETCDSnapshotS3) DeepCopyInto 

func (in *ETCDSnapshotS3) DeepCopyInto(out *ETCDSnapshotS3)

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

type ETCDSnapshotSpec 

type ETCDSnapshotSpec struct {
	// SnapshotName contains the base name of the snapshot file. CLI actions that act
	// on snapshots stored locally or within a pre-configured S3 bucket and
	// prefix usually take the snapshot name as their argument.
	SnapshotName string `json:"snapshotName" column:""`
	// NodeName contains the name of the node that took the snapshot.
	NodeName string `json:"nodeName" column:"name=Node"`
	// Location is the absolute file:// or s3:// URI address of the snapshot.
	Location string `json:"location" column:""`
	// Metadata contains point-in-time snapshot of the contents of the
	// k3s-etcd-snapshot-extra-metadata ConfigMap's data field, at the time the
	// snapshot was taken. This is intended to contain data about cluster state
	// that may be important for an external system to have available when restoring
	// the snapshot.
	Metadata map[string]string `json:"metadata,omitempty"`
	// S3 contains extra metadata about the S3 storage system holding the
	// snapshot. This is guaranteed to be set for all snapshots uploaded to S3.
	// If not specified, the snapshot was not uploaded to S3.
	S3 *ETCDSnapshotS3 `json:"s3,omitempty"`
}

ETCDSnapshotSpec desribes an etcd snapshot file

func (*ETCDSnapshotSpec) DeepCopy 

func (in *ETCDSnapshotSpec) DeepCopy() *ETCDSnapshotSpec

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

func (*ETCDSnapshotSpec) DeepCopyInto 

func (in *ETCDSnapshotSpec) DeepCopyInto(out *ETCDSnapshotSpec)

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

type ETCDSnapshotStatus 

type ETCDSnapshotStatus struct {
	// Size is the size of the snapshot file, in bytes. If not specified, the snapshot failed.
	Size *resource.Quantity `json:"size,omitempty" column:""`
	// CreationTime is the timestamp when the snapshot was taken by etcd.
	CreationTime *metav1.Time `json:"creationTime,omitempty" column:""`
	// ReadyToUse indicates that the snapshot is available to be restored.
	ReadyToUse *bool `json:"readyToUse,omitempty"`
	// Error is the last observed error during snapshot creation, if any.
	// If the snapshot is retried, this field will be cleared on success.
	Error *ETCDSnapshotError `json:"error,omitempty"`
}

ETCDSnapshotStatus is the status of the ETCDSnapshotFile object.

func (*ETCDSnapshotStatus) DeepCopy 

func (in *ETCDSnapshotStatus) DeepCopy() *ETCDSnapshotStatus

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

func (*ETCDSnapshotStatus) DeepCopyInto 

func (in *ETCDSnapshotStatus) DeepCopyInto(out *ETCDSnapshotStatus)

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.