v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=resourcequota.admission.k8s.io

Index

• Constants
• Variables
• func Convert_resourcequota_Configuration_To_v1alpha1_Configuration(in *resourcequota.Configuration, out *Configuration, s conversion.Scope) error
• func Convert_resourcequota_LimitedResource_To_v1alpha1_LimitedResource(in *resourcequota.LimitedResource, out *LimitedResource, s conversion.Scope) error
• func Convert_v1alpha1_Configuration_To_resourcequota_Configuration(in *Configuration, out *resourcequota.Configuration, s conversion.Scope) error
• func Convert_v1alpha1_LimitedResource_To_resourcequota_LimitedResource(in *LimitedResource, out *resourcequota.LimitedResource, s conversion.Scope) error
• func DeepCopy_v1alpha1_Configuration(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_v1alpha1_LimitedResource(in interface{}, out interface{}, c *conversion.Cloner) error
• func RegisterConversions(scheme *runtime.Scheme) error
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func RegisterDefaults(scheme *runtime.Scheme) error
• func SetDefaults_Configuration(obj *Configuration)
• func SetObjectDefaults_Configuration(in *Configuration)
• type Configuration
• type LimitedResource

Constants

const GroupName = "resourcequota.admission.k8s.io"

GroupName is the group name use in this package

Variables

var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_resourcequota_Configuration_To_v1alpha1_Configuration

func Convert_resourcequota_Configuration_To_v1alpha1_Configuration(in *resourcequota.Configuration, out *Configuration, s conversion.Scope) error

Convert_resourcequota_Configuration_To_v1alpha1_Configuration is an autogenerated conversion function.

func Convert_resourcequota_LimitedResource_To_v1alpha1_LimitedResource

func Convert_resourcequota_LimitedResource_To_v1alpha1_LimitedResource(in *resourcequota.LimitedResource, out *LimitedResource, s conversion.Scope) error

Convert_resourcequota_LimitedResource_To_v1alpha1_LimitedResource is an autogenerated conversion function.

func Convert_v1alpha1_Configuration_To_resourcequota_Configuration

func Convert_v1alpha1_Configuration_To_resourcequota_Configuration(in *Configuration, out *resourcequota.Configuration, s conversion.Scope) error

Convert_v1alpha1_Configuration_To_resourcequota_Configuration is an autogenerated conversion function.

func Convert_v1alpha1_LimitedResource_To_resourcequota_LimitedResource

func Convert_v1alpha1_LimitedResource_To_resourcequota_LimitedResource(in *LimitedResource, out *resourcequota.LimitedResource, s conversion.Scope) error

Convert_v1alpha1_LimitedResource_To_resourcequota_LimitedResource is an autogenerated conversion function.

func DeepCopy_v1alpha1_Configuration

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

DeepCopy_v1alpha1_Configuration is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_LimitedResource

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

DeepCopy_v1alpha1_LimitedResource is an autogenerated deepcopy function.

func RegisterConversions

func RegisterConversions(scheme *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

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

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 SetDefaults_Configuration

func SetDefaults_Configuration(obj *Configuration)

func SetObjectDefaults_Configuration

func SetObjectDefaults_Configuration(in *Configuration)

Types

type Configuration

type Configuration struct {
	metav1.TypeMeta `json:",inline"`

	// LimitedResources whose consumption is limited by default.
	// +optional
	LimitedResources []LimitedResource `json:"limitedResources"`
}

Configuration provides configuration for the ResourceQuota admission controller.

type LimitedResource

type LimitedResource struct {

	// APIGroup is the name of the APIGroup that contains the limited resource.
	// +optional
	APIGroup string `json:"apiGroup,omitempty"`

	// Resource is the name of the resource this rule applies to.
	// For example, if the administrator wants to limit consumption
	// of a storage resource associated with persistent volume claims,
	// the value would be "persistentvolumeclaims".
	Resource string `json:"resource"`

	// For each intercepted request, the quota system will evaluate
	// its resource usage.  It will iterate through each resource consumed
	// and if the resource contains any substring in this listing, the
	// quota system will ensure that there is a covering quota.  In the
	// absence of a covering quota, the quota system will deny the request.
	// For example, if an administrator wants to globally enforce that
	// that a quota must exist to consume persistent volume claims associated
	// with any storage class, the list would include
	// ".storageclass.storage.k8s.io/requests.storage"
	MatchContains []string `json:"matchContains,omitempty"`
}

LimitedResource matches a resource whose consumption is limited by default. To consume the resource, there must exist an associated quota that limits its consumption.