federation

Documentation

Index

• Constants
• Variables
• func DeepCopy_federation_Cluster(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ClusterCondition(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ClusterList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ClusterReplicaSetPreferences(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ClusterSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ClusterStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_FederatedReplicaSetPreferences(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_federation_ServerAddressByClientCIDR(in interface{}, out interface{}, c *conversion.Cloner) error
• func Kind(kind string) schema.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type Cluster
  • func (obj *Cluster) GetObjectKind() schema.ObjectKind
• type ClusterCondition
• type ClusterConditionType
• type ClusterList
  • func (obj *ClusterList) GetObjectKind() schema.ObjectKind
• type ClusterReplicaSetPreferences
• type ClusterSpec
• type ClusterStatus
• type FederatedReplicaSetPreferences
• type ServerAddressByClientCIDR

Constants

const GroupName = "federation"

GroupName is the group name use in this package

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 DeepCopy_federation_Cluster

func DeepCopy_federation_Cluster(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ClusterCondition

func DeepCopy_federation_ClusterCondition(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ClusterList

func DeepCopy_federation_ClusterList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ClusterReplicaSetPreferences

func DeepCopy_federation_ClusterReplicaSetPreferences(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ClusterSpec

func DeepCopy_federation_ClusterSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ClusterStatus

func DeepCopy_federation_ClusterStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_FederatedReplicaSetPreferences

func DeepCopy_federation_FederatedReplicaSetPreferences(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_federation_ServerAddressByClientCIDR

func DeepCopy_federation_ServerAddressByClientCIDR(in interface{}, out interface{}, c *conversion.Cloner) error

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

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 a Group qualified GroupResource

Types

type Cluster

type Cluster struct {
	metav1.TypeMeta
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta

	// Spec defines the behavior of the Cluster.
	// +optional
	Spec ClusterSpec
	// Status describes the current status of a Cluster
	// +optional
	Status ClusterStatus
}

Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.

func (*Cluster) GetObjectKind

func (obj *Cluster) GetObjectKind() schema.ObjectKind

type ClusterCondition

type ClusterCondition struct {
	// Type of cluster condition, Complete or Failed.
	Type ClusterConditionType
	// Status of the condition, one of True, False, Unknown.
	Status api.ConditionStatus
	// Last time the condition was checked.
	// +optional
	LastProbeTime metav1.Time
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string
	// Human readable message indicating details about last transition.
	// +optional
	Message string
}

ClusterCondition describes current state of a cluster.

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.

type ClusterList

type ClusterList struct {
	metav1.TypeMeta
	// Standard list metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	// +optional
	metav1.ListMeta

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

A list of all the kubernetes clusters registered to the federation

func (*ClusterList) GetObjectKind

func (obj *ClusterList) GetObjectKind() schema.ObjectKind

type ClusterReplicaSetPreferences

type ClusterReplicaSetPreferences struct {
	// Minimum number of replicas that should be assigned to this Local ReplicaSet. 0 by default.
	// +optional
	MinReplicas int64

	// Maximum number of replicas that should be assigned to this Local ReplicaSet. Unbounded if no value provided (default).
	// +optional
	MaxReplicas *int64

	// A number expressing the preference to put an additional replica to this LocalReplicaSet. 0 by default.
	Weight int64
}

Preferences regarding number of replicas assigned to a cluster replicaset within a federated replicaset.

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
	// Name of the secret containing kubeconfig to access this cluster.
	// The secret is read from the kubernetes cluster that is hosting federation control plane.
	// Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key "kubeconfig".
	// This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets.
	// This can be left empty if the cluster allows insecure access.
	// +optional
	SecretRef *api.LocalObjectReference
}

ClusterSpec describes the attributes of a kubernetes cluster.

type ClusterStatus

type ClusterStatus struct {
	// Conditions is an array of current cluster conditions.
	// +optional
	Conditions []ClusterCondition
	// Zones is the list of availability zones in which the nodes of the cluster exist, e.g. 'us-east1-a'.
	// These will always be in the same region.
	// +optional
	Zones []string
	// Region is the name of the region in which all of the nodes in the cluster exist.  e.g. 'us-east1'.
	// +optional
	Region string
}

ClusterStatus is information about the current status of a cluster updated by cluster controller periodically.

type FederatedReplicaSetPreferences

type FederatedReplicaSetPreferences struct {
	// If set to true then already scheduled and running replicas may be moved to other clusters to
	// in order to bring cluster replicasets towards a desired state. Otherwise, if set to false,
	// up and running replicas will not be moved.
	// +optional
	Rebalance bool

	// A mapping between cluster names and preferences regarding local ReplicaSet in these clusters.
	// "*" (if provided) applies to all clusters if an explicit mapping is not provided. If there is no
	// "*" that clusters without explicit preferences should not have any replicas scheduled.
	// +optional
	Clusters map[string]ClusterReplicaSetPreferences
}

A set of preferences that can be added to federated version of ReplicaSet as a json-serialized annotation. The preferences allow the user to express in which clusters he wants to put his replicas within the mentioned FederatedReplicaSet.

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

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.