Documentation
¶
Index ¶
- Constants
- Variables
- func AddToScheme(scheme *runtime.Scheme)
- func DeepCopy_federation_Cluster(in Cluster, out *Cluster, c *conversion.Cloner) error
- func DeepCopy_federation_ClusterCondition(in ClusterCondition, out *ClusterCondition, c *conversion.Cloner) error
- func DeepCopy_federation_ClusterList(in ClusterList, out *ClusterList, c *conversion.Cloner) error
- func DeepCopy_federation_ClusterMeta(in ClusterMeta, out *ClusterMeta, c *conversion.Cloner) error
- func DeepCopy_federation_ClusterSpec(in ClusterSpec, out *ClusterSpec, c *conversion.Cloner) error
- func DeepCopy_federation_ClusterStatus(in ClusterStatus, out *ClusterStatus, c *conversion.Cloner) error
- func DeepCopy_federation_ServerAddressByClientCIDR(in ServerAddressByClientCIDR, out *ServerAddressByClientCIDR, ...) error
- func Kind(kind string) unversioned.GroupKind
- func Resource(resource string) unversioned.GroupResource
- type Cluster
- type ClusterCondition
- type ClusterConditionType
- type ClusterList
- type ClusterMeta
- type ClusterSpec
- type ClusterStatus
- type ServerAddressByClientCIDR
Constants ¶
const GroupName = "federation"
GroupName is the group name use in this package
Variables ¶
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func AddToScheme ¶
Adds the list of known types to api.Scheme.
func DeepCopy_federation_Cluster ¶
func DeepCopy_federation_Cluster(in Cluster, out *Cluster, c *conversion.Cloner) error
func DeepCopy_federation_ClusterCondition ¶
func DeepCopy_federation_ClusterCondition(in ClusterCondition, out *ClusterCondition, c *conversion.Cloner) error
func DeepCopy_federation_ClusterList ¶
func DeepCopy_federation_ClusterList(in ClusterList, out *ClusterList, c *conversion.Cloner) error
func DeepCopy_federation_ClusterMeta ¶
func DeepCopy_federation_ClusterMeta(in ClusterMeta, out *ClusterMeta, c *conversion.Cloner) error
func DeepCopy_federation_ClusterSpec ¶
func DeepCopy_federation_ClusterSpec(in ClusterSpec, out *ClusterSpec, c *conversion.Cloner) error
func DeepCopy_federation_ClusterStatus ¶
func DeepCopy_federation_ClusterStatus(in ClusterStatus, out *ClusterStatus, c *conversion.Cloner) error
func DeepCopy_federation_ServerAddressByClientCIDR ¶
func DeepCopy_federation_ServerAddressByClientCIDR(in ServerAddressByClientCIDR, out *ServerAddressByClientCIDR, c *conversion.Cloner) error
func Kind ¶
func Kind(kind string) unversioned.GroupKind
Kind takes an unqualified kind and returns back a Group qualified GroupKind
func Resource ¶
func Resource(resource string) unversioned.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
Types ¶
type Cluster ¶
type Cluster struct {
unversioned.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
api.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the Cluster.
Spec ClusterSpec `json:"spec,omitempty"`
// Status describes the current status of a Cluster
Status ClusterStatus `json:"status,omitempty"`
}
Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.
func (*Cluster) CodecDecodeSelf ¶
func (*Cluster) CodecEncodeSelf ¶
func (*Cluster) GetObjectKind ¶
func (obj *Cluster) GetObjectKind() unversioned.ObjectKind
type ClusterCondition ¶
type ClusterCondition struct {
// Type of cluster condition, Complete or Failed.
Type ClusterConditionType `json:"type"`
// Status of the condition, one of True, False, Unknown.
Status api.ConditionStatus `json:"status"`
// Last time the condition was checked.
LastProbeTime unversioned.Time `json:"lastProbeTime,omitempty"`
// Last time the condition transit from one status to another.
LastTransitionTime unversioned.Time `json:"lastTransitionTime,omitempty"`
// (brief) reason for the condition's last transition.
Reason string `json:"reason,omitempty"`
// Human readable message indicating details about last transition.
Message string `json:"message,omitempty"`
}
ClusterCondition describes current state of a cluster.
func (*ClusterCondition) CodecDecodeSelf ¶
func (x *ClusterCondition) CodecDecodeSelf(d *codec1978.Decoder)
func (*ClusterCondition) CodecEncodeSelf ¶
func (x *ClusterCondition) CodecEncodeSelf(e *codec1978.Encoder)
type ClusterConditionType ¶
type ClusterConditionType string
const ( // ClusterReady means the cluster is ready to accept workloads. ClusterReady ClusterConditionType = "Ready" // ClusterOffline means the cluster is temporarily down or not reachable ClusterOffline ClusterConditionType = "Offline" )
These are valid conditions of a cluster.
func (*ClusterConditionType) CodecDecodeSelf ¶
func (x *ClusterConditionType) CodecDecodeSelf(d *codec1978.Decoder)
func (ClusterConditionType) CodecEncodeSelf ¶
func (x ClusterConditionType) CodecEncodeSelf(e *codec1978.Encoder)
type ClusterList ¶
type ClusterList struct {
unversioned.TypeMeta `json:",inline"`
// Standard list metadata.
// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
unversioned.ListMeta `json:"metadata,omitempty"`
// List of Cluster objects.
Items []Cluster `json:"items"`
}
A list of all the kubernetes clusters registered to the federation
func (*ClusterList) CodecDecodeSelf ¶
func (x *ClusterList) CodecDecodeSelf(d *codec1978.Decoder)
func (*ClusterList) CodecEncodeSelf ¶
func (x *ClusterList) CodecEncodeSelf(e *codec1978.Encoder)
func (*ClusterList) GetObjectKind ¶
func (obj *ClusterList) GetObjectKind() unversioned.ObjectKind
type ClusterMeta ¶
type ClusterMeta struct {
// Release version of the cluster.
Version string `json:"version,omitempty"`
}
Cluster metadata
func (*ClusterMeta) CodecDecodeSelf ¶
func (x *ClusterMeta) CodecDecodeSelf(d *codec1978.Decoder)
func (*ClusterMeta) CodecEncodeSelf ¶
func (x *ClusterMeta) CodecEncodeSelf(e *codec1978.Encoder)
type ClusterSpec ¶
type ClusterSpec struct {
// A map of client CIDR to server address.
// This is to help clients reach servers in the most network-efficient way possible.
// Clients can use the appropriate server address as per the CIDR that they match.
// In case of multiple matches, clients should use the longest matching CIDR.
ServerAddressByClientCIDRs []ServerAddressByClientCIDR `json:"serverAddressByClientCIDRs" patchStrategy:"merge" patchMergeKey:"clientCIDR"`
// the type (e.g. bearer token, client certificate etc) and data of the credential used to access cluster.
// It’s used for system routines (not behalf of users)
// TODO: string may not enough, https://github.com/kubernetes/kubernetes/pull/23847#discussion_r59301275
Credential string `json:"credential,omitempty"`
}
ClusterSpec describes the attributes of a kubernetes cluster.
func (*ClusterSpec) CodecDecodeSelf ¶
func (x *ClusterSpec) CodecDecodeSelf(d *codec1978.Decoder)
func (*ClusterSpec) CodecEncodeSelf ¶
func (x *ClusterSpec) CodecEncodeSelf(e *codec1978.Encoder)
type ClusterStatus ¶
type ClusterStatus struct {
// Conditions is an array of current cluster conditions.
Conditions []ClusterCondition `json:"conditions,omitempty"`
// Capacity represents the total resources of the cluster
Capacity api.ResourceList `json:"capacity,omitempty"`
// Allocatable represents the total resources of a cluster that are available for scheduling.
Allocatable api.ResourceList `json:"allocatable,omitempty"`
ClusterMeta `json:",inline"`
}
ClusterStatus is information about the current status of a cluster updated by cluster controller peridocally.
func (*ClusterStatus) CodecDecodeSelf ¶
func (x *ClusterStatus) CodecDecodeSelf(d *codec1978.Decoder)
func (*ClusterStatus) CodecEncodeSelf ¶
func (x *ClusterStatus) CodecEncodeSelf(e *codec1978.Encoder)
type ServerAddressByClientCIDR ¶
type ServerAddressByClientCIDR struct {
// The CIDR with which clients can match their IP to figure out the server address that they should use.
ClientCIDR string `json:"clientCIDR" 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.
ServerAddress string `json:"serverAddress" protobuf:"bytes,2,opt,name=serverAddress"`
}
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
func (*ServerAddressByClientCIDR) CodecDecodeSelf ¶
func (x *ServerAddressByClientCIDR) CodecDecodeSelf(d *codec1978.Decoder)
func (*ServerAddressByClientCIDR) CodecEncodeSelf ¶
func (x *ServerAddressByClientCIDR) CodecEncodeSelf(e *codec1978.Encoder)
Directories
¶
| Path | Synopsis |
|---|---|
|
+genconversion=true Package v1alpha1 is a generated protocol buffer package.
|
+genconversion=true Package v1alpha1 is a generated protocol buffer package. |