v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the types v1alpha1 API group this group is a duck type only package that hosts common objects and interfaces in katanomi very similar to knative.dev/pkg/apis/duck/v1 or k8s.io/apimachinery/pkg/apis/meta/v1 +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=data.katanomi.dev

Index

• Variables
• func StorageResourceAttributes(verb string) authv1.ResourceAttributes
• type BackendType
• type GC
  • func (in *GC) DeepCopy() *GC
  • func (in *GC) DeepCopyInto(out *GC)
• type Payload
  • func (in *Payload) DeepCopy() *Payload
  • func (in *Payload) DeepCopyInto(out *Payload)
• type PayloadType
  • func (p PayloadType) String() string
• type Resource
  • func (in *Resource) DeepCopy() *Resource
  • func (in *Resource) DeepCopyInto(out *Resource)
• type Storage
  • func (in *Storage) DeepCopy() *Storage
  • func (in *Storage) DeepCopyInto(out *Storage)
• type StorageList
  • func (in *StorageList) DeepCopy() *StorageList
  • func (in *StorageList) DeepCopyInto(out *StorageList)
• type StorageResourceType
  • func (s StorageResourceType) String() string
• type StorageSpec
  • func (in *StorageSpec) DeepCopy() *StorageSpec
  • func (in *StorageSpec) DeepCopyInto(out *StorageSpec)

Variables

var (
	BaseGroup = "katanomi.dev"
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "data." + BaseGroup, 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
)

var StorageGVK = GroupVersion.WithKind("Storage")

var StorageListGVK = GroupVersion.WithKind("StorageList")

Functions

func StorageResourceAttributes

func StorageResourceAttributes(verb string) authv1.ResourceAttributes

StorageResourceAttributes returns a ResourceAttribute object to be used in a filter

Types

type BackendType

type BackendType string

BackendType backend storage type

const (
	// pv type
	BackendTypePV BackendType = "pv"

	// memory type
	BackendTypeMemory BackendType = "memory"
)

type GC

type GC struct {
	// Period duration for data to be purged from the system after creation. This is a hard deadline if GC fails to execute
	// +optional
	Period time.Duration `json:"period,omitempty"`
}

GC storage gc policy

func (*GC) DeepCopy

func (in *GC) DeepCopy() *GC

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

func (*GC) DeepCopyInto

func (in *GC) DeepCopyInto(out *GC)

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

type Payload

type Payload struct {
	// Type payload type, eg. build or deploy
	Type PayloadType `json:"type"`

	// payload uid
	// +optional
	Uid string `json:"uid,omitempty"`

	// CreatedTime describe payload upload time
	// +optional
	CreatedTime metav1.Time `json:"createdTime,omitempty"`

	// Properties extended properties for payload
	// +optional
	Properties *runtime.RawExtension `json:"properties,omitempty"`
}

Payload save artifact data

func (*Payload) DeepCopy

func (in *Payload) DeepCopy() *Payload

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

func (*Payload) DeepCopyInto

func (in *Payload) DeepCopyInto(out *Payload)

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

type PayloadType

type PayloadType string

PayloadType payload type

const (
	// build type
	PayloadTypeBuild PayloadType = "build"

	// deploy type
	PayloadTypeDeploy PayloadType = "deploy"
)

func (PayloadType) String

func (p PayloadType) String() string

type Resource

type Resource struct {
	// IntegrationClassName sets the name of IntegrationClass that this integration is implemented
	IntegrationClassName string `json:"integrationClassName"`

	// Uri stores the artifact address
	Uri string `json:"uri"`

	// ResourceType storage resource type
	ResourceType StorageResourceType `json:"resourceType"`

	// SecretRef stores a secret that is used to access the integrated service
	SecretRef *corev1.ObjectReference `json:"secretRef,omitempty"`
}

Resource describe storage base info

func (*Resource) DeepCopy

func (in *Resource) DeepCopy() *Resource

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

func (*Resource) DeepCopyInto

func (in *Resource) DeepCopyInto(out *Resource)

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

type Storage

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

	Spec StorageSpec `json:"spec"`
}

Storage object for data service

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 StorageList

type StorageList struct {
	metav1.TypeMeta       `json:",inline"`
	metav1alpha1.ListMeta `json:"metadata,omitempty"`

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

StorageList list of storages

func (*StorageList) DeepCopy

func (in *StorageList) DeepCopy() *StorageList

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

func (*StorageList) DeepCopyInto

func (in *StorageList) DeepCopyInto(out *StorageList)

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

type StorageResourceType

type StorageResourceType string

StorageResourceType storage resource type

const (
	// OCI resource type
	ResourceTypeOCI StorageResourceType = "OCI"
)

func (StorageResourceType) String

func (s StorageResourceType) String() string

type StorageSpec

type StorageSpec struct {
	// Resource describe storage base info
	Resource Resource `json:"resource"`

	// GC storage gc policy
	GC GC `json:"gc"`

	// Payloads save artifact data
	Payloads []*Payload `json:"payloads"`
}

StorageSpec spec for storage

func (*StorageSpec) DeepCopy

func (in *StorageSpec) DeepCopy() *StorageSpec

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

func (*StorageSpec) DeepCopyInto

func (in *StorageSpec) DeepCopyInto(out *StorageSpec)

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