api

Documentation

Overview

Package api is the internal version of the API.

Index

• Constants
• Variables
• func ClusterResourceQuotaToSelectableFields(quota *ClusterResourceQuota) fields.Set
• func DeepCopy_api_AppliedClusterResourceQuota(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_AppliedClusterResourceQuotaList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ClusterResourceQuota(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ClusterResourceQuotaList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ClusterResourceQuotaSelector(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ClusterResourceQuotaSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ClusterResourceQuotaStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_api_ResourceQuotasStatusByNamespace(in interface{}, out interface{}, c *conversion.Cloner) error
• func GetMatcher(selector ClusterResourceQuotaSelector) (func(obj runtime.Object) (bool, error), error)
• func Kind(kind string) unversioned.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) unversioned.GroupResource
• type AppliedClusterResourceQuota
  • func ConvertClusterResourceQuotaToAppliedClusterResourceQuota(in *ClusterResourceQuota) *AppliedClusterResourceQuota
  • func (obj *AppliedClusterResourceQuota) GetObjectKind() unversioned.ObjectKind
• type AppliedClusterResourceQuotaList
  • func (obj *AppliedClusterResourceQuotaList) GetObjectKind() unversioned.ObjectKind
• type ClusterResourceQuota
  • func ConvertAppliedClusterResourceQuotaToClusterResourceQuota(in *AppliedClusterResourceQuota) *ClusterResourceQuota
  • func (obj *ClusterResourceQuota) GetObjectKind() unversioned.ObjectKind
  • func (obj *ClusterResourceQuota) GetObjectMeta() meta.Object
• type ClusterResourceQuotaList
  • func (obj *ClusterResourceQuotaList) GetObjectKind() unversioned.ObjectKind
• type ClusterResourceQuotaSelector
• type ClusterResourceQuotaSpec
• type ClusterResourceQuotaStatus
• type ResourceQuotasStatusByNamespace
  • func (o *ResourceQuotasStatusByNamespace) Get(key string) (kapi.ResourceQuotaStatus, bool)
  • func (o *ResourceQuotasStatusByNamespace) Insert(key string, value kapi.ResourceQuotaStatus)
  • func (o *ResourceQuotasStatusByNamespace) OrderedKeys() *list.List
  • func (o *ResourceQuotasStatusByNamespace) Remove(key string)

Constants

const GroupName = ""

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

Functions

func ClusterResourceQuotaToSelectableFields

func ClusterResourceQuotaToSelectableFields(quota *ClusterResourceQuota) fields.Set

func DeepCopy_api_AppliedClusterResourceQuota

func DeepCopy_api_AppliedClusterResourceQuota(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_AppliedClusterResourceQuotaList

func DeepCopy_api_AppliedClusterResourceQuotaList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterResourceQuota

func DeepCopy_api_ClusterResourceQuota(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterResourceQuotaList

func DeepCopy_api_ClusterResourceQuotaList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterResourceQuotaSelector

func DeepCopy_api_ClusterResourceQuotaSelector(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterResourceQuotaSpec

func DeepCopy_api_ClusterResourceQuotaSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ClusterResourceQuotaStatus

func DeepCopy_api_ClusterResourceQuotaStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_api_ResourceQuotasStatusByNamespace

func DeepCopy_api_ResourceQuotasStatusByNamespace(in interface{}, out interface{}, c *conversion.Cloner) error

func GetMatcher

func GetMatcher(selector ClusterResourceQuotaSelector) (func(obj runtime.Object) (bool, error), error)

func Kind

func Kind(kind string) unversioned.GroupKind

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

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) unversioned.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type AppliedClusterResourceQuota

type AppliedClusterResourceQuota struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// Spec defines the desired quota
	Spec ClusterResourceQuotaSpec

	// Status defines the actual enforced quota and its current usage
	Status ClusterResourceQuotaStatus
}

AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.

func ConvertClusterResourceQuotaToAppliedClusterResourceQuota

func ConvertClusterResourceQuotaToAppliedClusterResourceQuota(in *ClusterResourceQuota) *AppliedClusterResourceQuota

ConvertClusterResourceQuotaToAppliedClusterQuota returns back a converted AppliedClusterResourceQuota which is NOT a deep copy.

func (*AppliedClusterResourceQuota) GetObjectKind

func (obj *AppliedClusterResourceQuota) GetObjectKind() unversioned.ObjectKind

type AppliedClusterResourceQuotaList

type AppliedClusterResourceQuotaList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of AppliedClusterResourceQuota
	Items []AppliedClusterResourceQuota
}

AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas

func (*AppliedClusterResourceQuotaList) GetObjectKind

func (obj *AppliedClusterResourceQuotaList) GetObjectKind() unversioned.ObjectKind

type ClusterResourceQuota

type ClusterResourceQuota struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	kapi.ObjectMeta

	// Spec defines the desired quota
	Spec ClusterResourceQuotaSpec

	// Status defines the actual enforced quota and its current usage
	Status ClusterResourceQuotaStatus
}

ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.

func ConvertAppliedClusterResourceQuotaToClusterResourceQuota

func ConvertAppliedClusterResourceQuotaToClusterResourceQuota(in *AppliedClusterResourceQuota) *ClusterResourceQuota

ConvertClusterResourceQuotaToAppliedClusterQuota returns back a converted AppliedClusterResourceQuota which is NOT a deep copy.

func (*ClusterResourceQuota) GetObjectKind

func (obj *ClusterResourceQuota) GetObjectKind() unversioned.ObjectKind

func (*ClusterResourceQuota) GetObjectMeta

func (obj *ClusterResourceQuota) GetObjectMeta() meta.Object

type ClusterResourceQuotaList

type ClusterResourceQuotaList struct {
	unversioned.TypeMeta
	// Standard object's metadata.
	unversioned.ListMeta

	// Items is a list of ClusterResourceQuotas
	Items []ClusterResourceQuota
}

ClusterResourceQuotaList is a collection of ClusterResourceQuotas

func (*ClusterResourceQuotaList) GetObjectKind

func (obj *ClusterResourceQuotaList) GetObjectKind() unversioned.ObjectKind

type ClusterResourceQuotaSelector

type ClusterResourceQuotaSelector struct {
	// LabelSelector is used to select projects by label.
	LabelSelector *unversioned.LabelSelector

	// AnnotationSelector is used to select projects by annotation.
	AnnotationSelector map[string]string
}

ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.

type ClusterResourceQuotaSpec

type ClusterResourceQuotaSpec struct {
	// Selector is the selector used to match projects.
	// It should only select active projects on the scale of dozens (though it can select
	// many more less active projects).  These projects will contend on object creation through
	// this resource.
	Selector ClusterResourceQuotaSelector

	// Quota defines the desired quota
	Quota kapi.ResourceQuotaSpec
}

ClusterResourceQuotaSpec defines the desired quota restrictions

type ClusterResourceQuotaStatus

type ClusterResourceQuotaStatus struct {
	// Total defines the actual enforced quota and its current usage across all projects
	Total kapi.ResourceQuotaStatus

	// Namespaces slices the usage by project.  This division allows for quick resolution of
	// deletion reconcilation inside of a single project without requiring a recalculation
	// across all projects.  This map can be used to pull the deltas for a given project.
	Namespaces ResourceQuotasStatusByNamespace
}

ClusterResourceQuotaStatus defines the actual enforced quota and its current usage

type ResourceQuotasStatusByNamespace

type ResourceQuotasStatusByNamespace struct {
	// contains filtered or unexported fields
}

ResourceQuotasStatusByNamespace provides type correct methods

func (*ResourceQuotasStatusByNamespace) Get

func (o *ResourceQuotasStatusByNamespace) Get(key string) (kapi.ResourceQuotaStatus, bool)

func (*ResourceQuotasStatusByNamespace) Insert

func (o *ResourceQuotasStatusByNamespace) Insert(key string, value kapi.ResourceQuotaStatus)

func (*ResourceQuotasStatusByNamespace) OrderedKeys

func (o *ResourceQuotasStatusByNamespace) OrderedKeys() *list.List

func (*ResourceQuotasStatusByNamespace) Remove

func (o *ResourceQuotasStatusByNamespace) Remove(key string)