v1

Documentation

Overview

+k8s:openapi-gen=true +k8s:deepcopy-gen=package +k8s:defaulter-gen=TypeMeta +groupName=storage.loft.sh

Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group +kubebuilder:object:generate=true +groupName=storage.loft.sh

Index

• Variables
• func RegisterDefaults(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type ClusterQuota
  • func (in *ClusterQuota) DeepCopy() *ClusterQuota
  • func (in *ClusterQuota) DeepCopyInto(out *ClusterQuota)
  • func (in *ClusterQuota) DeepCopyObject() runtime.Object
• type ClusterQuotaList
  • func (in *ClusterQuotaList) DeepCopy() *ClusterQuotaList
  • func (in *ClusterQuotaList) DeepCopyInto(out *ClusterQuotaList)
  • func (in *ClusterQuotaList) DeepCopyObject() runtime.Object
• type ClusterQuotaSpec
  • func (in *ClusterQuotaSpec) DeepCopy() *ClusterQuotaSpec
  • func (in *ClusterQuotaSpec) DeepCopyInto(out *ClusterQuotaSpec)
• type ClusterQuotaStatus
  • func (in *ClusterQuotaStatus) DeepCopy() *ClusterQuotaStatus
  • func (in *ClusterQuotaStatus) DeepCopyInto(out *ClusterQuotaStatus)
• type ClusterQuotaStatusByNamespace
  • func (in *ClusterQuotaStatusByNamespace) DeepCopy() *ClusterQuotaStatusByNamespace
  • func (in *ClusterQuotaStatusByNamespace) DeepCopyInto(out *ClusterQuotaStatusByNamespace)
• type ClusterQuotasStatusByNamespace
  • func (in ClusterQuotasStatusByNamespace) DeepCopy() ClusterQuotasStatusByNamespace
  • func (in ClusterQuotasStatusByNamespace) DeepCopyInto(out *ClusterQuotasStatusByNamespace)
• type Condition
  • func (in *Condition) DeepCopy() *Condition
  • func (in *Condition) DeepCopyInto(out *Condition)
• type ConditionSeverity
• type ConditionType
• type Conditions
  • func (in Conditions) DeepCopy() Conditions
  • func (in Conditions) DeepCopyInto(out *Conditions)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "storage.loft.sh", Version: "v1"}

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

	// SchemeGroupVersion is a shim that expect this to be present in the api package
	SchemeGroupVersion = GroupVersion
)

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Types

type ClusterQuota

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

	Spec ClusterQuotaSpec `json:"spec,omitempty"`

	// +optional
	Status ClusterQuotaStatus `json:"status,omitempty"`
}

ClusterQuota is the Schema for the cluster quotas api +k8s:openapi-gen=true

func (*ClusterQuota) DeepCopy

func (in *ClusterQuota) DeepCopy() *ClusterQuota

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

func (*ClusterQuota) DeepCopyInto

func (in *ClusterQuota) DeepCopyInto(out *ClusterQuota)

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

func (*ClusterQuota) DeepCopyObject

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

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

type ClusterQuotaList

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

ClusterQuotaList contains a list of ClusterQuota

func (*ClusterQuotaList) DeepCopy

func (in *ClusterQuotaList) DeepCopy() *ClusterQuotaList

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

func (*ClusterQuotaList) DeepCopyInto

func (in *ClusterQuotaList) DeepCopyInto(out *ClusterQuotaList)

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

func (*ClusterQuotaList) DeepCopyObject

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

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

type ClusterQuotaSpec

type ClusterQuotaSpec struct {
	// User is the name of the user this quota should apply to
	// +optional
	User string `json:"user,omitempty"`

	// Team is the name of the team this quota should apply to
	// +optional
	Team string `json:"team,omitempty"`

	// Project is the project that this cluster quota should apply to
	// +optional
	Project string `json:"project,omitempty"`

	// quota is the quota definition with all the limits and selectors
	// +optional
	Quota corev1.ResourceQuotaSpec `json:"quota,omitempty"`
}

ClusterQuotaSpec defines the desired state of ClusterQuota

func (*ClusterQuotaSpec) DeepCopy

func (in *ClusterQuotaSpec) DeepCopy() *ClusterQuotaSpec

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

func (*ClusterQuotaSpec) DeepCopyInto

func (in *ClusterQuotaSpec) DeepCopyInto(out *ClusterQuotaSpec)

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

type ClusterQuotaStatus

type ClusterQuotaStatus struct {
	// Total defines the actual enforced quota and its current usage across all projects
	// +optional
	Total corev1.ResourceQuotaStatus `json:"total"`

	// Namespaces slices the usage by project.  This division allows for quick resolution of
	// deletion reconciliation inside of a single project without requiring a recalculation
	// across all projects.  This can be used to pull the deltas for a given project.
	// +optional
	// +nullable
	Namespaces ClusterQuotasStatusByNamespace `json:"namespaces"`
}

ClusterQuotaStatus defines the observed state of ClusterQuota

func (*ClusterQuotaStatus) DeepCopy

func (in *ClusterQuotaStatus) DeepCopy() *ClusterQuotaStatus

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

func (*ClusterQuotaStatus) DeepCopyInto

func (in *ClusterQuotaStatus) DeepCopyInto(out *ClusterQuotaStatus)

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

type ClusterQuotaStatusByNamespace

type ClusterQuotaStatusByNamespace struct {
	// Namespace of the account this account quota applies to
	Namespace string `json:"namespace"`

	// Status indicates how many resources have been consumed by this project
	// +optional
	Status corev1.ResourceQuotaStatus `json:"status"`
}

ClusterQuotaStatusByNamespace holds the status of a specific namespace

func (*ClusterQuotaStatusByNamespace) DeepCopy

func (in *ClusterQuotaStatusByNamespace) DeepCopy() *ClusterQuotaStatusByNamespace

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

func (*ClusterQuotaStatusByNamespace) DeepCopyInto

func (in *ClusterQuotaStatusByNamespace) DeepCopyInto(out *ClusterQuotaStatusByNamespace)

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

type ClusterQuotasStatusByNamespace

type ClusterQuotasStatusByNamespace []ClusterQuotaStatusByNamespace

ClusterQuotasStatusByNamespace bundles multiple resource quota status

func (ClusterQuotasStatusByNamespace) DeepCopy

func (in ClusterQuotasStatusByNamespace) DeepCopy() ClusterQuotasStatusByNamespace

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

func (ClusterQuotasStatusByNamespace) DeepCopyInto

func (in ClusterQuotasStatusByNamespace) DeepCopyInto(out *ClusterQuotasStatusByNamespace)

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

type Condition

type Condition struct {
	// Type of condition in CamelCase or in foo.example.com/CamelCase.
	// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
	// can be useful (see .node.status.conditions), the ability to deconflict is important.
	// +required
	Type ConditionType `json:"type"`

	// Status of the condition, one of True, False, Unknown.
	// +required
	Status corev1.ConditionStatus `json:"status"`

	// Severity provides an explicit classification of Reason code, so the users or machines can immediately
	// understand the current situation and act accordingly.
	// The Severity field MUST be set only when Status=False.
	// +optional
	Severity ConditionSeverity `json:"severity,omitempty"`

	// Last time the condition transitioned from one status to another.
	// This should be when the underlying condition changed. If that is not known, then using the time when
	// the API field changed is acceptable.
	// +required
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// The reason for the condition's last transition in CamelCase.
	// The specific API may choose whether this field is considered a guaranteed API.
	// This field may not be empty.
	// +optional
	Reason string `json:"reason,omitempty"`

	// A human readable message indicating details about the transition.
	// This field may be empty.
	// +optional
	Message string `json:"message,omitempty"`
}

Condition defines an observation of a Cluster API resource operational state.

func (*Condition) DeepCopy

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto

func (in *Condition) DeepCopyInto(out *Condition)

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

type ConditionSeverity

type ConditionSeverity string

ConditionSeverity expresses the severity of a Condition Type failing.

const (
	// ConditionSeverityError specifies that a condition with `Status=False` is an error.
	ConditionSeverityError ConditionSeverity = "Error"

	// ConditionSeverityWarning specifies that a condition with `Status=False` is a warning.
	ConditionSeverityWarning ConditionSeverity = "Warning"

	// ConditionSeverityInfo specifies that a condition with `Status=False` is informative.
	ConditionSeverityInfo ConditionSeverity = "Info"

	// ConditionSeverityNone should apply only to conditions with `Status=True`.
	ConditionSeverityNone ConditionSeverity = ""
)

type ConditionType

type ConditionType string

ConditionType is a valid value for Condition.Type.

const (
	// ReadyCondition defines the Ready condition type that summarizes the operational state of the virtual cluster API object.
	ReadyCondition ConditionType = "Ready"
)

Common ConditionTypes used by Cluster API objects.

type Conditions

type Conditions []Condition

Conditions is an array of conditions

func (Conditions) DeepCopy

func (in Conditions) DeepCopy() Conditions

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

func (Conditions) DeepCopyInto

func (in Conditions) DeepCopyInto(out *Conditions)

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