Documentation ¶
Overview ¶
Package api is the internal version of the API. +groupName=apiregistration.k8s.io
Index ¶
- Constants
- Variables
- func APIServiceNameToGroupVersion(apiServiceName string) schema.GroupVersion
- func DeepCopy_apiregistration_APIService(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_apiregistration_APIServiceCondition(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_apiregistration_APIServiceList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_apiregistration_APIServiceSpec(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_apiregistration_APIServiceStatus(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_apiregistration_ServiceReference(in interface{}, out interface{}, c *conversion.Cloner) error
- func IsAPIServiceConditionTrue(apiService *APIService, conditionType APIServiceConditionType) bool
- func Kind(kind string) schema.GroupKind
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- func SetAPIServiceCondition(apiService *APIService, newCondition APIServiceCondition)
- func SortedByGroup(servers []*APIService) [][]*APIService
- type APIService
- type APIServiceCondition
- type APIServiceConditionType
- type APIServiceList
- type APIServiceSpec
- type APIServiceStatus
- type ByPriority
- type ConditionStatus
- type ServiceReference
Constants ¶
const GroupName = "apiregistration.k8s.io"
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func APIServiceNameToGroupVersion ¶ added in v1.7.0
func APIServiceNameToGroupVersion(apiServiceName string) schema.GroupVersion
APIServiceNameToGroupVersion returns the GroupVersion for a given apiServiceName. The name must be valid, but any object you get back from an informer will be valid.
func DeepCopy_apiregistration_APIService ¶
func DeepCopy_apiregistration_APIService(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_APIService is an autogenerated deepcopy function.
func DeepCopy_apiregistration_APIServiceCondition ¶ added in v1.7.0
func DeepCopy_apiregistration_APIServiceCondition(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_APIServiceCondition is an autogenerated deepcopy function.
func DeepCopy_apiregistration_APIServiceList ¶
func DeepCopy_apiregistration_APIServiceList(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_APIServiceList is an autogenerated deepcopy function.
func DeepCopy_apiregistration_APIServiceSpec ¶
func DeepCopy_apiregistration_APIServiceSpec(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_APIServiceSpec is an autogenerated deepcopy function.
func DeepCopy_apiregistration_APIServiceStatus ¶
func DeepCopy_apiregistration_APIServiceStatus(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_APIServiceStatus is an autogenerated deepcopy function.
func DeepCopy_apiregistration_ServiceReference ¶
func DeepCopy_apiregistration_ServiceReference(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_apiregistration_ServiceReference is an autogenerated deepcopy function.
func IsAPIServiceConditionTrue ¶ added in v1.7.0
func IsAPIServiceConditionTrue(apiService *APIService, conditionType APIServiceConditionType) bool
IsAPIServiceConditionTrue indicates if the condition is present and strictly true
func RegisterDeepCopies ¶
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
func SetAPIServiceCondition ¶ added in v1.7.0
func SetAPIServiceCondition(apiService *APIService, newCondition APIServiceCondition)
SetAPIServiceCondition sets the status condition. It either overwrites the existing one or creates a new one
func SortedByGroup ¶
func SortedByGroup(servers []*APIService) [][]*APIService
Types ¶
type APIService ¶
type APIService struct { metav1.TypeMeta metav1.ObjectMeta // Spec contains information for locating and communicating with a server Spec APIServiceSpec // Status contains derived information about an API server Status APIServiceStatus }
APIService represents a server for a particular GroupVersion. Name must be "version.group".
type APIServiceCondition ¶ added in v1.7.0
type APIServiceCondition struct { // Type is the type of the condition. Type APIServiceConditionType // Status is the status of the condition. // Can be True, False, Unknown. Status ConditionStatus // Last time the condition transitioned from one status to another. LastTransitionTime metav1.Time // Unique, one-word, CamelCase reason for the condition's last transition. Reason string // Human-readable message indicating details about last transition. Message string }
APIServiceCondition describes conditions for an APIService
type APIServiceConditionType ¶ added in v1.7.0
type APIServiceConditionType string
APIConditionConditionType is a valid value for APIServiceCondition.Type
const ( // Available indicates that the service exists and is reachable Available APIServiceConditionType = "Available" )
type APIServiceList ¶
type APIServiceList struct { metav1.TypeMeta metav1.ListMeta Items []APIService }
APIServiceList is a list of APIService objects.
type APIServiceSpec ¶
type APIServiceSpec struct { // Service is a reference to the service for this API server. It must communicate // on port 443 // If the Service is nil, that means the handling for the API groupversion is handled locally on this server. // The call will simply delegate to the normal handler chain to be fulfilled. Service *ServiceReference // Group is the API group name this server hosts Group string // Version is the API version this server hosts. For example, "v1" Version string // InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. // This is strongly discouraged. You should use the CABundle instead. InsecureSkipTLSVerify bool // CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. CABundle []byte // Priority controls the ordering of this API group in the overall discovery document that gets served. // Client tools like `kubectl` use this ordering to derive preference, so this ordering mechanism is important. // Values must be between 1 and 1000 // The primary sort is based on priority, ordered lowest number to highest (10 before 20). // The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) // We'd recommend something like: *.k8s.io (except extensions) at 100, extensions at 150 // PaaSes (OpenShift, Deis) are recommended to be in the 200s Priority int64 }
APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.
type APIServiceStatus ¶
type APIServiceStatus struct { // Current service state of apiService. Conditions []APIServiceCondition }
APIServiceStatus contains derived information about an API server
type ByPriority ¶
type ByPriority []*APIService
func (ByPriority) Len ¶
func (s ByPriority) Len() int
func (ByPriority) Less ¶
func (s ByPriority) Less(i, j int) bool
func (ByPriority) Swap ¶
func (s ByPriority) Swap(i, j int)
type ConditionStatus ¶ added in v1.7.0
type ConditionStatus string
const ( ConditionTrue ConditionStatus = "True" ConditionFalse ConditionStatus = "False" ConditionUnknown ConditionStatus = "Unknown" )
These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.
type ServiceReference ¶
type ServiceReference struct { // Namespace is the namespace of the service Namespace string // Name is the name of the service Name string }
ServiceReference holds a reference to Service.legacy.k8s.io
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package v1beta1 contains the API Registration API, which is responsible for registering an API `Group`/`Version` with another kubernetes like API server.
|
Package v1beta1 contains the API Registration API, which is responsible for registering an API `Group`/`Version` with another kubernetes like API server. |