clusterregistry

package
v0.0.3 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2018 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package clusterregistry contains the Go definitions for the cluster registry API, as well as some scaffolding code for using this API in Go code.

+k8s:deepcopy-gen=package,register +groupName=clusterregistry.k8s.io

Index

Constants

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

GroupName is the group name use in this package

Variables

View Source 
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.NewSchemeBuilder(addKnownTypes)

	// AddToScheme is a function that adds objects to the Cluster API scheme builder.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

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 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
}

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 

func (in *AuthInfo) DeepCopy() *AuthInfo

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

func (*AuthInfo) DeepCopyInto 

func (in *AuthInfo) DeepCopyInto(out *AuthInfo)

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

	// Type contains type information about this auth provider. Clients of the
	// cluster registry should use this field to differentiate between different
	// kinds of authentication providers.
	// +optional
	Type AuthProviderType

	// 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
}

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 AuthProviderType added in v0.0.3 

type AuthProviderType struct {
	// Name is the name of the auth provider.
	// +optional
	Name string
}

AuthProviderType contains metadata about the auth provider. It should be used by clients to differentiate between different kinds of auth providers, and to select a relevant provider for the client's configuration. For example, a controller would look for a provider type that denotes a service account that it should use to access the cluster, whereas a user would look for a provider type that denotes an authentication system from which they should request a token.

func (*AuthProviderType) DeepCopy added in v0.0.3 

func (in *AuthProviderType) DeepCopy() *AuthProviderType

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

func (*AuthProviderType) DeepCopyInto added in v0.0.3 

func (in *AuthProviderType) DeepCopyInto(out *AuthProviderType)

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
}

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
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta

	// Spec is the specification of the cluster. This may or may not be reconciled
	// by an active controller.
	// +optional
	Spec ClusterSpec

	// 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
}

Cluster contains information about a cluster in a cluster registry.

func (*Cluster) DeepCopy 

func (in *Cluster) DeepCopy() *Cluster

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

func (*Cluster) DeepCopyInto 

func (in *Cluster) DeepCopyInto(out *Cluster)

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

func (*Cluster) DeepCopyObject 

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

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

type ClusterList 

type ClusterList struct {
	metav1.TypeMeta
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	// +optional
	metav1.ListMeta

	// List of Cluster objects.
	Items []Cluster
}

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

	// 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

	// CloudProvider contains information about the cloud provider this cluster
	// is running on.
	// +optional
	CloudProvider *CloudProvider
}

ClusterSpec contains the spec 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

	// CABundle contains the certificate authority information.
	// +optional
	CABundle []byte
}

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
	// 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
}

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.

Source Files

View all Source files

Directories

Path Synopsis
Package install registers the clusterregistry API group and adds its types to a scheme.
 Package install registers the clusterregistry API group and adds its types to a scheme.
Package v1alpha1 is the v1alpha1 version of the clusterregistry API, whose internal version is defined in k8s.io/cluster-registry/pkg/apis/clusterregistry.
 Package v1alpha1 is the v1alpha1 version of the clusterregistry API, whose internal version is defined in k8s.io/cluster-registry/pkg/apis/clusterregistry.
Package validation defines validation routines for the clusterregistry API.
 Package validation defines validation routines for the clusterregistry API.

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.