Documentation ¶
Index ¶
- Constants
- Variables
- func ClusterNameInContext(ctx context.Context) string
- func ContextInLocalCluster(ctx context.Context) context.Context
- func ContextWithClusterName(ctx context.Context, clusterName string) context.Context
- func DetachCluster(ctx context.Context, cli client.Client, clusterName string, ...) error
- func FormatProxyURL(clusterName, originalPath string) string
- func GetClusterGatewayService(ctx context.Context, c client.Client) (*apiregistrationv1.ServiceReference, error)
- func GetMulticlusterKubernetesClient() (client.Client, *rest.Config, error)
- func Initialize(restConfig *rest.Config, autoUpgrade bool) (client.Client, error)
- func IsClusterDisconnect(err error) bool
- func IsClusterNotExists(err error) bool
- func IsInLocalCluster(ctx context.Context) bool
- func IsNotFoundOrClusterNotExists(err error) bool
- func ListExistingClusterSecrets(ctx context.Context, c client.Client) ([]v1.Secret, error)
- func NewClusterGatewayRoundTripperWrapperGenerator(clusterName string) transport.WrapperFunc
- func NewSecretModeMultiClusterRoundTripper(rt http.RoundTripper) http.RoundTripper
- func NewSecretModeMultiClusterRoundTripperForCluster(rt http.RoundTripper, clusterName string) http.RoundTripper
- func RenameCluster(ctx context.Context, k8sClient client.Client, oldClusterName string, ...) error
- func ResourcesWithClusterName(clusterName string, objs ...*unstructured.Unstructured) []*unstructured.Unstructured
- func UpgradeExistingClusterSecret(ctx context.Context, c client.Client) error
- func WaitUntilClusterGatewayReady(ctx context.Context, c client.Client, maxRetry int, interval time.Duration) (svc *apiregistrationv1.ServiceReference, err error)
- type ClusterInfo
- type ClusterManagementError
- type ClusterMetrics
- type ClusterMetricsHelper
- type ClusterMetricsMgr
- type ClusterUsageMetrics
- type DetachClusterArgs
- type DetachClusterManagedClusterKubeConfigPathOption
- type DetachClusterOption
- type FakeClient
- func (c *FakeClient) AddCluster(cluster string, cli client.Client)
- func (c *FakeClient) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error
- func (c *FakeClient) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error
- func (c *FakeClient) DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error
- func (c *FakeClient) Get(ctx context.Context, key client.ObjectKey, obj client.Object) error
- func (c *FakeClient) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
- func (c *FakeClient) Patch(ctx context.Context, obj client.Object, patch client.Patch, ...) error
- func (c *FakeClient) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error
- type JoinClusterArgs
- type JoinClusterCreateNamespaceOption
- type JoinClusterEngineOption
- type JoinClusterOCMOptions
- type JoinClusterOption
- type KubeClusterConfig
- func (clusterConfig *KubeClusterConfig) RegisterByVelaSecret(ctx context.Context, cli client.Client) error
- func (clusterConfig *KubeClusterConfig) RegisterClusterManagedByOCM(ctx context.Context, args *JoinClusterArgs) error
- func (clusterConfig *KubeClusterConfig) SetClusterName(clusterName string) *KubeClusterConfig
- func (clusterConfig *KubeClusterConfig) SetCreateNamespace(createNamespace string) *KubeClusterConfig
- func (clusterConfig *KubeClusterConfig) Validate() error
- type MatchVirtualClusterLabels
- type VirtualCluster
- func FindVirtualClustersByLabels(ctx context.Context, c client.Client, labels map[string]string) ([]VirtualCluster, error)
- func GetVirtualCluster(ctx context.Context, c client.Client, clusterName string) (vc *VirtualCluster, err error)
- func ListVirtualClusters(ctx context.Context, c client.Client) ([]VirtualCluster, error)
- func NewVirtualClusterFromManagedCluster(managedCluster *clusterv1.ManagedCluster) (*VirtualCluster, error)
- func NewVirtualClusterFromSecret(secret *corev1.Secret) (*VirtualCluster, error)
Constants ¶
const ( // ClusterGateWayEngine cluster-gateway cluster management solution ClusterGateWayEngine = "cluster-gateway" // OCMEngine ocm cluster management solution OCMEngine = "ocm" )
const ( // ClusterContextKey is the name of cluster using in client http context ClusterContextKey = contextKey("ClusterName") // ClusterLocalName specifies the local cluster ClusterLocalName = "local" )
const ( // CredentialTypeOCMManagedCluster identifies the virtual cluster from ocm CredentialTypeOCMManagedCluster v1alpha1.CredentialType = "ManagedCluster" )
Variables ¶
var ( // ErrClusterExists cluster already exists ErrClusterExists = ClusterManagementError(fmt.Errorf("cluster already exists")) // ErrClusterNotExists cluster not exists ErrClusterNotExists = ClusterManagementError(fmt.Errorf("no such cluster")) // ErrReservedLocalClusterName reserved cluster name is used ErrReservedLocalClusterName = ClusterManagementError(fmt.Errorf("cluster name `local` is reserved for kubevela hub cluster")) )
var ( // ClusterGatewaySecretNamespace the namespace where cluster-gateway secret locates ClusterGatewaySecretNamespace string )
Functions ¶
func ClusterNameInContext ¶
ClusterNameInContext extract cluster name from context
func ContextInLocalCluster ¶
ContextInLocalCluster create context in local cluster
func ContextWithClusterName ¶
ContextWithClusterName create context with multi-cluster by cluster name
func DetachCluster ¶
func DetachCluster(ctx context.Context, cli client.Client, clusterName string, options ...DetachClusterOption) error
DetachCluster detach cluster by name, if cluster is using by application, it will return error
func FormatProxyURL ¶
FormatProxyURL will format the request API path by the cluster gateway resources rule
func GetClusterGatewayService ¶
func GetClusterGatewayService(ctx context.Context, c client.Client) (*apiregistrationv1.ServiceReference, error)
GetClusterGatewayService get cluster gateway backend service reference if service is ready, service is returned and no error is returned if service exists but is not ready, both service and error are returned if service does not exist, only error is returned
func GetMulticlusterKubernetesClient ¶
GetMulticlusterKubernetesClient get client with multicluster function enabled
func Initialize ¶
Initialize prepare multicluster environment by checking cluster gateway service in clusters and hack rest config to use cluster gateway if cluster gateway service is not ready, it will wait up to 5 minutes
func IsClusterDisconnect ¶
IsClusterDisconnect check if error is cluster disconnect
func IsClusterNotExists ¶
IsClusterNotExists check if error is cluster not exists
func IsInLocalCluster ¶
IsInLocalCluster check if target cluster is local cluster
func IsNotFoundOrClusterNotExists ¶
IsNotFoundOrClusterNotExists check if error is not found or cluster not exists
func ListExistingClusterSecrets ¶
ListExistingClusterSecrets list existing cluster secrets
func NewClusterGatewayRoundTripperWrapperGenerator ¶
func NewClusterGatewayRoundTripperWrapperGenerator(clusterName string) transport.WrapperFunc
NewClusterGatewayRoundTripperWrapperGenerator create RoundTripper WrapperFunc that redirect requests to target cluster
func NewSecretModeMultiClusterRoundTripper ¶
func NewSecretModeMultiClusterRoundTripper(rt http.RoundTripper) http.RoundTripper
NewSecretModeMultiClusterRoundTripper will re-write the API path to one of the multi-cluster resource for a request if context has the value
func NewSecretModeMultiClusterRoundTripperForCluster ¶
func NewSecretModeMultiClusterRoundTripperForCluster(rt http.RoundTripper, clusterName string) http.RoundTripper
NewSecretModeMultiClusterRoundTripperForCluster will re-write the API path to the specific cluster
func RenameCluster ¶
func RenameCluster(ctx context.Context, k8sClient client.Client, oldClusterName string, newClusterName string) error
RenameCluster rename cluster
func ResourcesWithClusterName ¶
func ResourcesWithClusterName(clusterName string, objs ...*unstructured.Unstructured) []*unstructured.Unstructured
ResourcesWithClusterName set cluster name for resources
func UpgradeExistingClusterSecret ¶
UpgradeExistingClusterSecret upgrade outdated cluster secrets in v1.1.1 to latest
func WaitUntilClusterGatewayReady ¶
func WaitUntilClusterGatewayReady(ctx context.Context, c client.Client, maxRetry int, interval time.Duration) (svc *apiregistrationv1.ServiceReference, err error)
WaitUntilClusterGatewayReady wait cluster gateway service to be ready to serve
Types ¶
type ClusterInfo ¶
type ClusterInfo struct { Nodes *corev1.NodeList WorkerNumber int MasterNumber int MemoryCapacity resource.Quantity CPUCapacity resource.Quantity PodCapacity resource.Quantity MemoryAllocatable resource.Quantity CPUAllocatable resource.Quantity PodAllocatable resource.Quantity StorageClasses *storagev1.StorageClassList }
ClusterInfo describes the basic information of a cluster
func GetClusterInfo ¶
func GetClusterInfo(_ctx context.Context, k8sClient client.Client, clusterName string) (*ClusterInfo, error)
GetClusterInfo retrieves current cluster info from cluster
type ClusterManagementError ¶
type ClusterManagementError error
ClusterManagementError multicluster management error
type ClusterMetrics ¶
type ClusterMetrics struct { IsConnected bool ClusterInfo *ClusterInfo ClusterUsageMetrics *ClusterUsageMetrics }
ClusterMetrics describes the metrics of a cluster
type ClusterMetricsHelper ¶
type ClusterMetricsHelper interface {
Refresh() error
}
ClusterMetricsHelper is the interface that provides operations for cluster metrics
type ClusterMetricsMgr ¶
type ClusterMetricsMgr struct {
// contains filtered or unexported fields
}
ClusterMetricsMgr manage metrics of clusters
func NewClusterMetricsMgr ¶
func NewClusterMetricsMgr(kubeClient client.Client) (*ClusterMetricsMgr, error)
NewClusterMetricsMgr will create a cluster metrics manager
func (*ClusterMetricsMgr) Refresh ¶
func (cmm *ClusterMetricsMgr) Refresh() error
Refresh will re-collect cluster metrics and refresh cache
type ClusterUsageMetrics ¶
ClusterUsageMetrics describes the usage metrics of a cluster
func GetClusterMetricsFromMetricsAPI ¶
func GetClusterMetricsFromMetricsAPI(ctx context.Context, k8sClient client.Client, clusterName string) (*ClusterUsageMetrics, error)
GetClusterMetricsFromMetricsAPI retrieves current cluster metrics based on GetNodeMetricsFromMetricsAPI
type DetachClusterArgs ¶
type DetachClusterArgs struct {
// contains filtered or unexported fields
}
DetachClusterArgs args for detaching cluster
type DetachClusterManagedClusterKubeConfigPathOption ¶
type DetachClusterManagedClusterKubeConfigPathOption string
DetachClusterManagedClusterKubeConfigPathOption configure the managed cluster kubeconfig path while detach ocm cluster
func (DetachClusterManagedClusterKubeConfigPathOption) ApplyToArgs ¶
func (op DetachClusterManagedClusterKubeConfigPathOption) ApplyToArgs(args *DetachClusterArgs)
ApplyToArgs apply to args
type DetachClusterOption ¶
type DetachClusterOption interface {
ApplyToArgs(args *DetachClusterArgs)
}
DetachClusterOption option for detach cluster
type FakeClient ¶
FakeClient set default client and multicluster clients
func NewFakeClient ¶
func NewFakeClient(baseClient client.Client) *FakeClient
NewFakeClient create a new fake client
func (*FakeClient) AddCluster ¶
func (c *FakeClient) AddCluster(cluster string, cli client.Client)
AddCluster add cluster to client map
func (*FakeClient) Create ¶
func (c *FakeClient) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error
Create saves the object obj in the Kubernetes cluster.
func (*FakeClient) Delete ¶
func (c *FakeClient) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error
Delete deletes the given obj from Kubernetes cluster.
func (*FakeClient) DeleteAllOf ¶
func (c *FakeClient) DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error
DeleteAllOf deletes all objects of the given type matching the given options.
func (*FakeClient) Get ¶
Get retrieves an obj for the given object key from the Kubernetes Cluster. obj must be a struct pointer so that obj can be updated with the response returned by the Server.
func (*FakeClient) List ¶
func (c *FakeClient) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
List retrieves list of objects for a given namespace and list options. On a successful call, Items field in the list will be populated with the result returned from the server.
func (*FakeClient) Patch ¶
func (c *FakeClient) Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error
Patch patches the given obj in the Kubernetes cluster. obj must be a struct pointer so that obj can be updated with the content returned by the Server.
func (*FakeClient) Update ¶
func (c *FakeClient) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error
Update updates the given obj in the Kubernetes cluster. obj must be a struct pointer so that obj can be updated with the content returned by the Server.
type JoinClusterArgs ¶
type JoinClusterArgs struct {
// contains filtered or unexported fields
}
JoinClusterArgs args for join cluster
type JoinClusterCreateNamespaceOption ¶
type JoinClusterCreateNamespaceOption string
JoinClusterCreateNamespaceOption create namespace when join cluster, if empty, no creation
func (JoinClusterCreateNamespaceOption) ApplyToArgs ¶
func (op JoinClusterCreateNamespaceOption) ApplyToArgs(args *JoinClusterArgs)
ApplyToArgs apply to args
type JoinClusterEngineOption ¶
type JoinClusterEngineOption string
JoinClusterEngineOption configure engine for join cluster, either cluster-gateway or ocm
func (JoinClusterEngineOption) ApplyToArgs ¶
func (op JoinClusterEngineOption) ApplyToArgs(args *JoinClusterArgs)
ApplyToArgs apply to args
type JoinClusterOCMOptions ¶
type JoinClusterOCMOptions struct { IoStreams cmdutil.IOStreams HubConfig *rest.Config InClusterBootstrap *bool TrackingSpinnerFactory func(string) *spinner.Spinner }
JoinClusterOCMOptions options used when joining clusters by ocm, only support cli for now
func (JoinClusterOCMOptions) ApplyToArgs ¶
func (op JoinClusterOCMOptions) ApplyToArgs(args *JoinClusterArgs)
ApplyToArgs apply to args
type JoinClusterOption ¶
type JoinClusterOption interface {
ApplyToArgs(args *JoinClusterArgs)
}
JoinClusterOption option for join cluster
type KubeClusterConfig ¶
type KubeClusterConfig struct { ClusterName string CreateNamespace string *clientcmdapi.Config *clientcmdapi.Cluster *clientcmdapi.AuthInfo // Logs records intermediate logs (which do not return error) during running Logs bytes.Buffer }
KubeClusterConfig info for cluster management
func JoinClusterByKubeConfig ¶
func JoinClusterByKubeConfig(ctx context.Context, cli client.Client, kubeconfigPath string, clusterName string, options ...JoinClusterOption) (*KubeClusterConfig, error)
JoinClusterByKubeConfig add child cluster by kubeconfig path, return cluster info and error
func LoadKubeClusterConfigFromFile ¶
func LoadKubeClusterConfigFromFile(filepath string) (*KubeClusterConfig, error)
LoadKubeClusterConfigFromFile create KubeClusterConfig from kubeconfig file
func (*KubeClusterConfig) RegisterByVelaSecret ¶
func (clusterConfig *KubeClusterConfig) RegisterByVelaSecret(ctx context.Context, cli client.Client) error
RegisterByVelaSecret create cluster secrets for KubeVela to use
func (*KubeClusterConfig) RegisterClusterManagedByOCM ¶
func (clusterConfig *KubeClusterConfig) RegisterClusterManagedByOCM(ctx context.Context, args *JoinClusterArgs) error
RegisterClusterManagedByOCM create ocm managed cluster for use TODO(somefive): OCM ManagedCluster only support cli join now
func (*KubeClusterConfig) SetClusterName ¶
func (clusterConfig *KubeClusterConfig) SetClusterName(clusterName string) *KubeClusterConfig
SetClusterName set cluster name if not empty
func (*KubeClusterConfig) SetCreateNamespace ¶
func (clusterConfig *KubeClusterConfig) SetCreateNamespace(createNamespace string) *KubeClusterConfig
SetCreateNamespace set create namespace, if empty, no namespace will be created
func (*KubeClusterConfig) Validate ¶
func (clusterConfig *KubeClusterConfig) Validate() error
Validate check if config is valid for join
type MatchVirtualClusterLabels ¶
MatchVirtualClusterLabels filters the list/delete operation of cluster list
func (MatchVirtualClusterLabels) ApplyToDeleteAllOf ¶
func (m MatchVirtualClusterLabels) ApplyToDeleteAllOf(opts *client.DeleteAllOfOptions)
ApplyToDeleteAllOf applies this configuration to the given a List options.
func (MatchVirtualClusterLabels) ApplyToList ¶
func (m MatchVirtualClusterLabels) ApplyToList(opts *client.ListOptions)
ApplyToList applies this configuration to the given list options.
type VirtualCluster ¶
type VirtualCluster struct { Name string Type v1alpha1.CredentialType EndPoint string Accepted bool Labels map[string]string Metrics *ClusterMetrics }
VirtualCluster contains base info of cluster, it unifies the difference between different cluster implementations like cluster secret or ocm managed cluster
func FindVirtualClustersByLabels ¶
func FindVirtualClustersByLabels(ctx context.Context, c client.Client, labels map[string]string) ([]VirtualCluster, error)
FindVirtualClustersByLabels will get all virtual clusters with matched labels in control plane
func GetVirtualCluster ¶
func GetVirtualCluster(ctx context.Context, c client.Client, clusterName string) (vc *VirtualCluster, err error)
GetVirtualCluster returns virtual cluster with given clusterName
func ListVirtualClusters ¶
ListVirtualClusters will get all registered clusters in control plane
func NewVirtualClusterFromManagedCluster ¶
func NewVirtualClusterFromManagedCluster(managedCluster *clusterv1.ManagedCluster) (*VirtualCluster, error)
NewVirtualClusterFromManagedCluster extract virtual cluster from ocm managed cluster
func NewVirtualClusterFromSecret ¶
func NewVirtualClusterFromSecret(secret *corev1.Secret) (*VirtualCluster, error)
NewVirtualClusterFromSecret extract virtual cluster from cluster secret