Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the clusterregistry API, whose internal version is defined in k8s.io/cluster-registry/pkg/apis/clusterregistry.
+k8s:conversion-gen=k8s.io/cluster-registry/pkg/apis/clusterregistry +k8s:deepcopy-gen=package,register +k8s:openapi-gen=true +groupName=clusterregistry.k8s.io
Index ¶
- Constants
- Variables
- func Convert_clusterregistry_AuthInfo_To_v1alpha1_AuthInfo(in *clusterregistry.AuthInfo, out *AuthInfo, s conversion.Scope) error
- func Convert_clusterregistry_AuthProviderConfig_To_v1alpha1_AuthProviderConfig(in *clusterregistry.AuthProviderConfig, out *AuthProviderConfig, ...) error
- func Convert_clusterregistry_CloudProvider_To_v1alpha1_CloudProvider(in *clusterregistry.CloudProvider, out *CloudProvider, s conversion.Scope) error
- func Convert_clusterregistry_ClusterList_To_v1alpha1_ClusterList(in *clusterregistry.ClusterList, out *ClusterList, s conversion.Scope) error
- func Convert_clusterregistry_ClusterSpec_To_v1alpha1_ClusterSpec(in *clusterregistry.ClusterSpec, out *ClusterSpec, s conversion.Scope) error
- func Convert_clusterregistry_ClusterStatus_To_v1alpha1_ClusterStatus(in *clusterregistry.ClusterStatus, out *ClusterStatus, s conversion.Scope) error
- func Convert_clusterregistry_Cluster_To_v1alpha1_Cluster(in *clusterregistry.Cluster, out *Cluster, s conversion.Scope) error
- func Convert_clusterregistry_KubernetesAPIEndpoints_To_v1alpha1_KubernetesAPIEndpoints(in *clusterregistry.KubernetesAPIEndpoints, out *KubernetesAPIEndpoints, ...) error
- func Convert_clusterregistry_ServerAddressByClientCIDR_To_v1alpha1_ServerAddressByClientCIDR(in *clusterregistry.ServerAddressByClientCIDR, out *ServerAddressByClientCIDR, ...) error
- func Convert_v1alpha1_AuthInfo_To_clusterregistry_AuthInfo(in *AuthInfo, out *clusterregistry.AuthInfo, s conversion.Scope) error
- func Convert_v1alpha1_AuthProviderConfig_To_clusterregistry_AuthProviderConfig(in *AuthProviderConfig, out *clusterregistry.AuthProviderConfig, ...) error
- func Convert_v1alpha1_CloudProvider_To_clusterregistry_CloudProvider(in *CloudProvider, out *clusterregistry.CloudProvider, s conversion.Scope) error
- func Convert_v1alpha1_ClusterList_To_clusterregistry_ClusterList(in *ClusterList, out *clusterregistry.ClusterList, s conversion.Scope) error
- func Convert_v1alpha1_ClusterSpec_To_clusterregistry_ClusterSpec(in *ClusterSpec, out *clusterregistry.ClusterSpec, s conversion.Scope) error
- func Convert_v1alpha1_ClusterStatus_To_clusterregistry_ClusterStatus(in *ClusterStatus, out *clusterregistry.ClusterStatus, s conversion.Scope) error
- func Convert_v1alpha1_Cluster_To_clusterregistry_Cluster(in *Cluster, out *clusterregistry.Cluster, s conversion.Scope) error
- func Convert_v1alpha1_KubernetesAPIEndpoints_To_clusterregistry_KubernetesAPIEndpoints(in *KubernetesAPIEndpoints, out *clusterregistry.KubernetesAPIEndpoints, ...) error
- func Convert_v1alpha1_ServerAddressByClientCIDR_To_clusterregistry_ServerAddressByClientCIDR(in *ServerAddressByClientCIDR, out *clusterregistry.ServerAddressByClientCIDR, ...) error
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) errordeprecated
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- type AuthInfo
- type AuthProviderConfig
- type CloudProvider
- type Cluster
- type ClusterList
- type ClusterSpec
- type ClusterStatus
- type KubernetesAPIEndpoints
- type ServerAddressByClientCIDR
Constants ¶
const GroupName = "clusterregistry.k8s.io"
GroupName is the group name use in this package
Variables ¶
var ( // SchemeBuilder builds runtime.Scheme objects for the Cluster API objects. See // https://godoc.org/k8s.io/apimachinery/pkg/runtime#Scheme for more info. SchemeBuilder runtime.SchemeBuilder // AddToScheme is a function that adds objects to the Cluster API scheme builder. AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_clusterregistry_AuthInfo_To_v1alpha1_AuthInfo ¶
func Convert_clusterregistry_AuthInfo_To_v1alpha1_AuthInfo(in *clusterregistry.AuthInfo, out *AuthInfo, s conversion.Scope) error
Convert_clusterregistry_AuthInfo_To_v1alpha1_AuthInfo is an autogenerated conversion function.
func Convert_clusterregistry_AuthProviderConfig_To_v1alpha1_AuthProviderConfig ¶
func Convert_clusterregistry_AuthProviderConfig_To_v1alpha1_AuthProviderConfig(in *clusterregistry.AuthProviderConfig, out *AuthProviderConfig, s conversion.Scope) error
Convert_clusterregistry_AuthProviderConfig_To_v1alpha1_AuthProviderConfig is an autogenerated conversion function.
func Convert_clusterregistry_CloudProvider_To_v1alpha1_CloudProvider ¶
func Convert_clusterregistry_CloudProvider_To_v1alpha1_CloudProvider(in *clusterregistry.CloudProvider, out *CloudProvider, s conversion.Scope) error
Convert_clusterregistry_CloudProvider_To_v1alpha1_CloudProvider is an autogenerated conversion function.
func Convert_clusterregistry_ClusterList_To_v1alpha1_ClusterList ¶
func Convert_clusterregistry_ClusterList_To_v1alpha1_ClusterList(in *clusterregistry.ClusterList, out *ClusterList, s conversion.Scope) error
Convert_clusterregistry_ClusterList_To_v1alpha1_ClusterList is an autogenerated conversion function.
func Convert_clusterregistry_ClusterSpec_To_v1alpha1_ClusterSpec ¶
func Convert_clusterregistry_ClusterSpec_To_v1alpha1_ClusterSpec(in *clusterregistry.ClusterSpec, out *ClusterSpec, s conversion.Scope) error
Convert_clusterregistry_ClusterSpec_To_v1alpha1_ClusterSpec is an autogenerated conversion function.
func Convert_clusterregistry_ClusterStatus_To_v1alpha1_ClusterStatus ¶
func Convert_clusterregistry_ClusterStatus_To_v1alpha1_ClusterStatus(in *clusterregistry.ClusterStatus, out *ClusterStatus, s conversion.Scope) error
Convert_clusterregistry_ClusterStatus_To_v1alpha1_ClusterStatus is an autogenerated conversion function.
func Convert_clusterregistry_Cluster_To_v1alpha1_Cluster ¶
func Convert_clusterregistry_Cluster_To_v1alpha1_Cluster(in *clusterregistry.Cluster, out *Cluster, s conversion.Scope) error
Convert_clusterregistry_Cluster_To_v1alpha1_Cluster is an autogenerated conversion function.
func Convert_clusterregistry_KubernetesAPIEndpoints_To_v1alpha1_KubernetesAPIEndpoints ¶
func Convert_clusterregistry_KubernetesAPIEndpoints_To_v1alpha1_KubernetesAPIEndpoints(in *clusterregistry.KubernetesAPIEndpoints, out *KubernetesAPIEndpoints, s conversion.Scope) error
Convert_clusterregistry_KubernetesAPIEndpoints_To_v1alpha1_KubernetesAPIEndpoints is an autogenerated conversion function.
func Convert_clusterregistry_ServerAddressByClientCIDR_To_v1alpha1_ServerAddressByClientCIDR ¶
func Convert_clusterregistry_ServerAddressByClientCIDR_To_v1alpha1_ServerAddressByClientCIDR(in *clusterregistry.ServerAddressByClientCIDR, out *ServerAddressByClientCIDR, s conversion.Scope) error
Convert_clusterregistry_ServerAddressByClientCIDR_To_v1alpha1_ServerAddressByClientCIDR is an autogenerated conversion function.
func Convert_v1alpha1_AuthInfo_To_clusterregistry_AuthInfo ¶
func Convert_v1alpha1_AuthInfo_To_clusterregistry_AuthInfo(in *AuthInfo, out *clusterregistry.AuthInfo, s conversion.Scope) error
Convert_v1alpha1_AuthInfo_To_clusterregistry_AuthInfo is an autogenerated conversion function.
func Convert_v1alpha1_AuthProviderConfig_To_clusterregistry_AuthProviderConfig ¶
func Convert_v1alpha1_AuthProviderConfig_To_clusterregistry_AuthProviderConfig(in *AuthProviderConfig, out *clusterregistry.AuthProviderConfig, s conversion.Scope) error
Convert_v1alpha1_AuthProviderConfig_To_clusterregistry_AuthProviderConfig is an autogenerated conversion function.
func Convert_v1alpha1_CloudProvider_To_clusterregistry_CloudProvider ¶
func Convert_v1alpha1_CloudProvider_To_clusterregistry_CloudProvider(in *CloudProvider, out *clusterregistry.CloudProvider, s conversion.Scope) error
Convert_v1alpha1_CloudProvider_To_clusterregistry_CloudProvider is an autogenerated conversion function.
func Convert_v1alpha1_ClusterList_To_clusterregistry_ClusterList ¶
func Convert_v1alpha1_ClusterList_To_clusterregistry_ClusterList(in *ClusterList, out *clusterregistry.ClusterList, s conversion.Scope) error
Convert_v1alpha1_ClusterList_To_clusterregistry_ClusterList is an autogenerated conversion function.
func Convert_v1alpha1_ClusterSpec_To_clusterregistry_ClusterSpec ¶
func Convert_v1alpha1_ClusterSpec_To_clusterregistry_ClusterSpec(in *ClusterSpec, out *clusterregistry.ClusterSpec, s conversion.Scope) error
Convert_v1alpha1_ClusterSpec_To_clusterregistry_ClusterSpec is an autogenerated conversion function.
func Convert_v1alpha1_ClusterStatus_To_clusterregistry_ClusterStatus ¶
func Convert_v1alpha1_ClusterStatus_To_clusterregistry_ClusterStatus(in *ClusterStatus, out *clusterregistry.ClusterStatus, s conversion.Scope) error
Convert_v1alpha1_ClusterStatus_To_clusterregistry_ClusterStatus is an autogenerated conversion function.
func Convert_v1alpha1_Cluster_To_clusterregistry_Cluster ¶
func Convert_v1alpha1_Cluster_To_clusterregistry_Cluster(in *Cluster, out *clusterregistry.Cluster, s conversion.Scope) error
Convert_v1alpha1_Cluster_To_clusterregistry_Cluster is an autogenerated conversion function.
func Convert_v1alpha1_KubernetesAPIEndpoints_To_clusterregistry_KubernetesAPIEndpoints ¶
func Convert_v1alpha1_KubernetesAPIEndpoints_To_clusterregistry_KubernetesAPIEndpoints(in *KubernetesAPIEndpoints, out *clusterregistry.KubernetesAPIEndpoints, s conversion.Scope) error
Convert_v1alpha1_KubernetesAPIEndpoints_To_clusterregistry_KubernetesAPIEndpoints is an autogenerated conversion function.
func Convert_v1alpha1_ServerAddressByClientCIDR_To_clusterregistry_ServerAddressByClientCIDR ¶
func Convert_v1alpha1_ServerAddressByClientCIDR_To_clusterregistry_ServerAddressByClientCIDR(in *ServerAddressByClientCIDR, out *clusterregistry.ServerAddressByClientCIDR, s conversion.Scope) error
Convert_v1alpha1_ServerAddressByClientCIDR_To_clusterregistry_ServerAddressByClientCIDR is an autogenerated conversion function.
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies
deprecated
func RegisterDefaults ¶
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
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AuthInfo ¶
type AuthInfo struct { // AuthProviders is a list of configurations for auth providers. // +optional Providers []AuthProviderConfig `json:"providers" protobuf:"bytes,1,rep,name=providers"` }
AuthInfo holds public information that describes how a client can get credentials to access the cluster. For example, OAuth2 client registration endpoints and supported flows, or Kerberos servers locations.
It should not hold any private or sensitive information.
func (*AuthInfo) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthInfo.
func (*AuthInfo) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AuthProviderConfig ¶
type AuthProviderConfig struct { // Name is the name of this configuration. // +optional Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"` // Config is a map of values that contains the information necessary for a // client to determine how to authenticate to a Kubernetes API server. // +optional Config map[string]string `json:"config,omitempty" protobuf:"bytes,2,rep,name=config"` }
AuthProviderConfig contains the information necessary for a client to authenticate to a Kubernetes API server. It is modeled after k8s.io/client-go/tools/clientcmd/api/v1.AuthProviderConfig.
func (*AuthProviderConfig) DeepCopy ¶
func (in *AuthProviderConfig) DeepCopy() *AuthProviderConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthProviderConfig.
func (*AuthProviderConfig) DeepCopyInto ¶
func (in *AuthProviderConfig) DeepCopyInto(out *AuthProviderConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CloudProvider ¶
type CloudProvider struct { // Name is the name of the cloud provider for this cluster. // +optional Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"` }
CloudProvider contains information about the cloud provider this cluster is running on.
func (*CloudProvider) DeepCopy ¶
func (in *CloudProvider) DeepCopy() *CloudProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudProvider.
func (*CloudProvider) DeepCopyInto ¶
func (in *CloudProvider) DeepCopyInto(out *CloudProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Cluster ¶
type Cluster struct { metav1.TypeMeta `json:",inline"` // Standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Spec is the specification of the cluster. This may or may not be // reconciled by an active controller. // +optional Spec ClusterSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` // Status is the status of the cluster. It is optional, and can be left nil // to imply that the cluster status is not being reported. // +optional Status *ClusterStatus `json:"status" protobuf:"bytes,3,opt,name=status"` }
Cluster contains information about a cluster in a cluster registry.
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterList ¶
type ClusterList struct { metav1.TypeMeta `json:",inline"` // Standard list metadata. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds // +optional metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // List of Cluster objects. Items []Cluster `json:"items" protobuf:"bytes,2,rep,name=items"` }
ClusterList is a list of Kubernetes clusters in the cluster registry.
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSpec ¶
type ClusterSpec struct { // KubernetesAPIEndpoints represents the endpoints of the API server for this // cluster. // +optional KubernetesAPIEndpoints KubernetesAPIEndpoints `json:"kubernetesApiEndpoints,omitempty" protobuf:"bytes,1,opt,name=kubernetesApiEndpoints"` // AuthInfo contains public information that can be used to authenticate // to and authorize with this cluster. It is not meant to store private // information (e.g., tokens or client certificates) and cluster registry // implementations are not expected to provide hardened storage for // secrets. // +optional AuthInfo AuthInfo `json:"authInfo,omitempty" protobuf:"bytes,2,opt,name=authInfo"` // CloudProvider contains information about the cloud provider this cluster // is running on. // +optional CloudProvider *CloudProvider `json:"cloudProvider" protobuf:"bytes,3,opt,name=cloudProvider"` }
ClusterSpec contains the specification of a cluster.
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct { }
ClusterStatus contains the status of a cluster.
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubernetesAPIEndpoints ¶
type KubernetesAPIEndpoints struct { // ServerEndpoints specifies the address(es) of the Kubernetes API server’s // network identity or identities. // +optional ServerEndpoints []ServerAddressByClientCIDR `json:"serverEndpoints,omitempty" protobuf:"bytes,1,rep,name=serverEndpoints"` // CABundle contains the certificate authority information. // +optional CABundle []byte `json:"caBundle,omitempty" protobuf:"bytes,2,opt,name=caBundle"` }
KubernetesAPIEndpoints represents the endpoints for one and only one Kubernetes API server.
func (*KubernetesAPIEndpoints) DeepCopy ¶
func (in *KubernetesAPIEndpoints) DeepCopy() *KubernetesAPIEndpoints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubernetesAPIEndpoints.
func (*KubernetesAPIEndpoints) DeepCopyInto ¶
func (in *KubernetesAPIEndpoints) DeepCopyInto(out *KubernetesAPIEndpoints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServerAddressByClientCIDR ¶
type ServerAddressByClientCIDR struct { // The CIDR with which clients can match their IP to figure out if they should // use the corresponding server address. // +optional ClientCIDR string `json:"clientCIDR,omitempty" protobuf:"bytes,1,opt,name=clientCIDR"` // Address of this server, suitable for a client that matches the above CIDR. // This can be a hostname, hostname:port, IP or IP:port. // +optional ServerAddress string `json:"serverAddress,omitempty" protobuf:"bytes,2,opt,name=serverAddress"` }
ServerAddressByClientCIDR helps clients determine the server address that they should use, depending on the ClientCIDR that they match.
func (*ServerAddressByClientCIDR) DeepCopy ¶
func (in *ServerAddressByClientCIDR) DeepCopy() *ServerAddressByClientCIDR
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerAddressByClientCIDR.
func (*ServerAddressByClientCIDR) DeepCopyInto ¶
func (in *ServerAddressByClientCIDR) DeepCopyInto(out *ServerAddressByClientCIDR)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.