v1beta1

package
v1.14.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 9, 2019 License: Apache-2.0, Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package v1beta1 contains the API Registration API, which is responsible for registering an API `Group`/`Version` with another kubernetes like API server. The `APIService` holds information about the other API server in `APIServiceSpec` type as well as general `TypeMeta` and `ObjectMeta`. The `APIServiceSpec` type have the main configuration needed to do the aggregation. Any request coming for specified `Group`/`Version` will be directed to the service defined by `ServiceReference` (on port 443) after validating the target using provided `CABundle` or skipping validation if development flag `InsecureSkipTLSVerify` is set. `Priority` is controlling the order of this API group in the overall discovery document. The return status is a set of conditions for this aggregation. Currently there is only one condition named "Available", if true, it means the api/server requests will be redirected to specified API server. 

Package v1beta1 is a generated protocol buffer package.

It is generated from these files:
	k8s.io/kubernetes/vendor/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1beta1/generated.proto

It has these top-level messages:
	APIService
	APIServiceCondition
	APIServiceList
	APIServiceSpec
	APIServiceStatus
	ServiceReference

Index

Constants

View Source 
const GroupName = "apiregistration.k8s.io"

GroupName is the API group for apiregistration

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	// 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 is a common registration function for mapping packaged scoped group & version keys to a scheme
	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_apiregistration_APIServiceCondition_To_v1beta1_APIServiceCondition 

func Convert_apiregistration_APIServiceCondition_To_v1beta1_APIServiceCondition(in *apiregistration.APIServiceCondition, out *APIServiceCondition, s conversion.Scope) error

Convert_apiregistration_APIServiceCondition_To_v1beta1_APIServiceCondition is an autogenerated conversion function.

func Convert_apiregistration_APIServiceList_To_v1beta1_APIServiceList 

func Convert_apiregistration_APIServiceList_To_v1beta1_APIServiceList(in *apiregistration.APIServiceList, out *APIServiceList, s conversion.Scope) error

Convert_apiregistration_APIServiceList_To_v1beta1_APIServiceList is an autogenerated conversion function.

func Convert_apiregistration_APIServiceSpec_To_v1beta1_APIServiceSpec 

func Convert_apiregistration_APIServiceSpec_To_v1beta1_APIServiceSpec(in *apiregistration.APIServiceSpec, out *APIServiceSpec, s conversion.Scope) error

Convert_apiregistration_APIServiceSpec_To_v1beta1_APIServiceSpec is an autogenerated conversion function.

func Convert_apiregistration_APIServiceStatus_To_v1beta1_APIServiceStatus 

func Convert_apiregistration_APIServiceStatus_To_v1beta1_APIServiceStatus(in *apiregistration.APIServiceStatus, out *APIServiceStatus, s conversion.Scope) error

Convert_apiregistration_APIServiceStatus_To_v1beta1_APIServiceStatus is an autogenerated conversion function.

func Convert_apiregistration_APIService_To_v1beta1_APIService 

func Convert_apiregistration_APIService_To_v1beta1_APIService(in *apiregistration.APIService, out *APIService, s conversion.Scope) error

Convert_apiregistration_APIService_To_v1beta1_APIService is an autogenerated conversion function.

func Convert_apiregistration_ServiceReference_To_v1beta1_ServiceReference 

func Convert_apiregistration_ServiceReference_To_v1beta1_ServiceReference(in *apiregistration.ServiceReference, out *ServiceReference, s conversion.Scope) error

Convert_apiregistration_ServiceReference_To_v1beta1_ServiceReference is an autogenerated conversion function.

func Convert_v1beta1_APIServiceCondition_To_apiregistration_APIServiceCondition 

func Convert_v1beta1_APIServiceCondition_To_apiregistration_APIServiceCondition(in *APIServiceCondition, out *apiregistration.APIServiceCondition, s conversion.Scope) error

Convert_v1beta1_APIServiceCondition_To_apiregistration_APIServiceCondition is an autogenerated conversion function.

func Convert_v1beta1_APIServiceList_To_apiregistration_APIServiceList 

func Convert_v1beta1_APIServiceList_To_apiregistration_APIServiceList(in *APIServiceList, out *apiregistration.APIServiceList, s conversion.Scope) error

Convert_v1beta1_APIServiceList_To_apiregistration_APIServiceList is an autogenerated conversion function.

func Convert_v1beta1_APIServiceSpec_To_apiregistration_APIServiceSpec 

func Convert_v1beta1_APIServiceSpec_To_apiregistration_APIServiceSpec(in *APIServiceSpec, out *apiregistration.APIServiceSpec, s conversion.Scope) error

Convert_v1beta1_APIServiceSpec_To_apiregistration_APIServiceSpec is an autogenerated conversion function.

func Convert_v1beta1_APIServiceStatus_To_apiregistration_APIServiceStatus 

func Convert_v1beta1_APIServiceStatus_To_apiregistration_APIServiceStatus(in *APIServiceStatus, out *apiregistration.APIServiceStatus, s conversion.Scope) error

Convert_v1beta1_APIServiceStatus_To_apiregistration_APIServiceStatus is an autogenerated conversion function.

func Convert_v1beta1_APIService_To_apiregistration_APIService 

func Convert_v1beta1_APIService_To_apiregistration_APIService(in *APIService, out *apiregistration.APIService, s conversion.Scope) error

Convert_v1beta1_APIService_To_apiregistration_APIService is an autogenerated conversion function.

func Convert_v1beta1_ServiceReference_To_apiregistration_ServiceReference 

func Convert_v1beta1_ServiceReference_To_apiregistration_ServiceReference(in *ServiceReference, out *apiregistration.ServiceReference, s conversion.Scope) error

Convert_v1beta1_ServiceReference_To_apiregistration_ServiceReference is an autogenerated conversion function.

func RegisterConversions 

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion 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

Types

type APIService 

type APIService struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec contains information for locating and communicating with a server
	Spec APIServiceSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	// Status contains derived information about an API server
	Status APIServiceStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

APIService represents a server for a particular GroupVersion. Name must be "version.group".

func (*APIService) DeepCopy added in v1.8.0 

func (in *APIService) DeepCopy() *APIService

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

func (*APIService) DeepCopyInto added in v1.8.0 

func (in *APIService) DeepCopyInto(out *APIService)

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

func (*APIService) DeepCopyObject added in v1.8.0 

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

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

func (*APIService) Descriptor 

func (*APIService) Descriptor() ([]byte, []int)

func (*APIService) Marshal 

func (m *APIService) Marshal() (dAtA []byte, err error)

func (*APIService) MarshalTo 

func (m *APIService) MarshalTo(dAtA []byte) (int, error)

func (*APIService) ProtoMessage 

func (*APIService) ProtoMessage()

func (*APIService) Reset 

func (m *APIService) Reset()

func (*APIService) Size 

func (m *APIService) Size() (n int)

func (*APIService) String 

func (this *APIService) String() string

func (*APIService) Unmarshal 

func (m *APIService) Unmarshal(dAtA []byte) error

type APIServiceCondition 

type APIServiceCondition struct {
	// Type is the type of the condition.
	Type APIServiceConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=APIServiceConditionType"`
	// Status is the status of the condition.
	// Can be True, False, Unknown.
	Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=ConditionStatus"`
	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"`
	// Unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

APIServiceCondition describes the state of an APIService at a particular point

func (*APIServiceCondition) DeepCopy added in v1.8.0 

func (in *APIServiceCondition) DeepCopy() *APIServiceCondition

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

func (*APIServiceCondition) DeepCopyInto added in v1.8.0 

func (in *APIServiceCondition) DeepCopyInto(out *APIServiceCondition)

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

func (*APIServiceCondition) Descriptor 

func (*APIServiceCondition) Descriptor() ([]byte, []int)

func (*APIServiceCondition) Marshal 

func (m *APIServiceCondition) Marshal() (dAtA []byte, err error)

func (*APIServiceCondition) MarshalTo 

func (m *APIServiceCondition) MarshalTo(dAtA []byte) (int, error)

func (*APIServiceCondition) ProtoMessage 

func (*APIServiceCondition) ProtoMessage()

func (*APIServiceCondition) Reset 

func (m *APIServiceCondition) Reset()

func (*APIServiceCondition) Size 

func (m *APIServiceCondition) Size() (n int)

func (*APIServiceCondition) String 

func (this *APIServiceCondition) String() string

func (*APIServiceCondition) Unmarshal 

func (m *APIServiceCondition) Unmarshal(dAtA []byte) error

type APIServiceConditionType 

type APIServiceConditionType string

APIServiceConditionType 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 `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Items []APIService `json:"items" protobuf:"bytes,2,rep,name=items"`
}

APIServiceList is a list of APIService objects.

func (*APIServiceList) DeepCopy added in v1.8.0 

func (in *APIServiceList) DeepCopy() *APIServiceList

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

func (*APIServiceList) DeepCopyInto added in v1.8.0 

func (in *APIServiceList) DeepCopyInto(out *APIServiceList)

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

func (*APIServiceList) DeepCopyObject added in v1.8.0 

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

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

func (*APIServiceList) Descriptor 

func (*APIServiceList) Descriptor() ([]byte, []int)

func (*APIServiceList) Marshal 

func (m *APIServiceList) Marshal() (dAtA []byte, err error)

func (*APIServiceList) MarshalTo 

func (m *APIServiceList) MarshalTo(dAtA []byte) (int, error)

func (*APIServiceList) ProtoMessage 

func (*APIServiceList) ProtoMessage()

func (*APIServiceList) Reset 

func (m *APIServiceList) Reset()

func (*APIServiceList) Size 

func (m *APIServiceList) Size() (n int)

func (*APIServiceList) String 

func (this *APIServiceList) String() string

func (*APIServiceList) Unmarshal 

func (m *APIServiceList) Unmarshal(dAtA []byte) error

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 `json:"service" protobuf:"bytes,1,opt,name=service"`
	// Group is the API group name this server hosts
	Group string `json:"group,omitempty" protobuf:"bytes,2,opt,name=group"`
	// Version is the API version this server hosts.  For example, "v1"
	Version string `json:"version,omitempty" protobuf:"bytes,3,opt,name=version"`

	// InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server.
	// This is strongly discouraged.  You should use the CABundle instead.
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty" protobuf:"varint,4,opt,name=insecureSkipTLSVerify"`
	// CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
	// If unspecified, system trust roots on the apiserver are used.
	// +optional
	CABundle []byte `json:"caBundle,omitempty" protobuf:"bytes,5,opt,name=caBundle"`

	// GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones.
	// Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority.
	// The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10).
	// 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 18000 and
	// PaaSes (OpenShift, Deis) are recommended to be in the 2000s
	GroupPriorityMinimum int32 `json:"groupPriorityMinimum" protobuf:"varint,7,opt,name=groupPriorityMinimum"`

	// VersionPriority controls the ordering of this API version inside of its group.  Must be greater than zero.
	// The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10).
	// Since it's inside of a group, the number can be small, probably in the 10s.
	// In case of equal version priorities, the version string will be used to compute the order inside a group.
	// If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered
	// lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version),
	// then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first
	// by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major
	// version, then minor version. An example sorted list of versions:
	// v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
	VersionPriority int32 `json:"versionPriority" protobuf:"varint,8,opt,name=versionPriority"`
}

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

func (*APIServiceSpec) DeepCopy added in v1.8.0 

func (in *APIServiceSpec) DeepCopy() *APIServiceSpec

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

func (*APIServiceSpec) DeepCopyInto added in v1.8.0 

func (in *APIServiceSpec) DeepCopyInto(out *APIServiceSpec)

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

func (*APIServiceSpec) Descriptor 

func (*APIServiceSpec) Descriptor() ([]byte, []int)

func (*APIServiceSpec) Marshal 

func (m *APIServiceSpec) Marshal() (dAtA []byte, err error)

func (*APIServiceSpec) MarshalTo 

func (m *APIServiceSpec) MarshalTo(dAtA []byte) (int, error)

func (*APIServiceSpec) ProtoMessage 

func (*APIServiceSpec) ProtoMessage()

func (*APIServiceSpec) Reset 

func (m *APIServiceSpec) Reset()

func (*APIServiceSpec) Size 

func (m *APIServiceSpec) Size() (n int)

func (*APIServiceSpec) String 

func (this *APIServiceSpec) String() string

func (*APIServiceSpec) Unmarshal 

func (m *APIServiceSpec) Unmarshal(dAtA []byte) error

type APIServiceStatus 

type APIServiceStatus struct {
	// Current service state of apiService.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []APIServiceCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

APIServiceStatus contains derived information about an API server

func (*APIServiceStatus) DeepCopy added in v1.8.0 

func (in *APIServiceStatus) DeepCopy() *APIServiceStatus

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

func (*APIServiceStatus) DeepCopyInto added in v1.8.0 

func (in *APIServiceStatus) DeepCopyInto(out *APIServiceStatus)

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

func (*APIServiceStatus) Descriptor 

func (*APIServiceStatus) Descriptor() ([]byte, []int)

func (*APIServiceStatus) Marshal 

func (m *APIServiceStatus) Marshal() (dAtA []byte, err error)

func (*APIServiceStatus) MarshalTo 

func (m *APIServiceStatus) MarshalTo(dAtA []byte) (int, error)

func (*APIServiceStatus) ProtoMessage 

func (*APIServiceStatus) ProtoMessage()

func (*APIServiceStatus) Reset 

func (m *APIServiceStatus) Reset()

func (*APIServiceStatus) Size 

func (m *APIServiceStatus) Size() (n int)

func (*APIServiceStatus) String 

func (this *APIServiceStatus) String() string

func (*APIServiceStatus) Unmarshal 

func (m *APIServiceStatus) Unmarshal(dAtA []byte) error

type ConditionStatus 

type ConditionStatus string

ConditionStatus indicates the status of a condition (true, false, or unknown). 

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 `json:"namespace,omitempty" protobuf:"bytes,1,opt,name=namespace"`
	// Name is the name of the service
	Name string `json:"name,omitempty" protobuf:"bytes,2,opt,name=name"`
}

ServiceReference holds a reference to Service.legacy.k8s.io

func (*ServiceReference) DeepCopy added in v1.8.0 

func (in *ServiceReference) DeepCopy() *ServiceReference

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

func (*ServiceReference) DeepCopyInto added in v1.8.0 

func (in *ServiceReference) DeepCopyInto(out *ServiceReference)

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

func (*ServiceReference) Descriptor 

func (*ServiceReference) Descriptor() ([]byte, []int)

func (*ServiceReference) Marshal 

func (m *ServiceReference) Marshal() (dAtA []byte, err error)

func (*ServiceReference) MarshalTo 

func (m *ServiceReference) MarshalTo(dAtA []byte) (int, error)

func (*ServiceReference) ProtoMessage 

func (*ServiceReference) ProtoMessage()

func (*ServiceReference) Reset 

func (m *ServiceReference) Reset()

func (*ServiceReference) Size 

func (m *ServiceReference) Size() (n int)

func (*ServiceReference) String 

func (this *ServiceReference) String() string

func (*ServiceReference) Unmarshal 

func (m *ServiceReference) Unmarshal(dAtA []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.