helpers

package
v0.13.2 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2024 License: Apache-2.0 Imports: 45 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FeatureGatesTypeValid             = "ValidFeatureGates"
	FeatureGatesReasonAllValid        = "FeatureGatesAllValid"
	FeatureGatesReasonInvalidExisting = "InvalidFeatureGatesExisting"
)
View Source 
const (
	// ClusterManagerDefaultNamespace is the default namespace of clustermanager
	ClusterManagerDefaultNamespace = "open-cluster-management-hub"
	// KlusterletDefaultNamespace is the default namespace of klusterlet
	KlusterletDefaultNamespace = "open-cluster-management-agent"
	// BootstrapHubKubeConfig is the secret name of bootstrap kubeconfig secret to connect to hub
	BootstrapHubKubeConfig = "bootstrap-hub-kubeconfig" // #nosec G101
	// HubKubeConfig is the secret name of kubeconfig secret to connect to hub with mtls
	HubKubeConfig = "hub-kubeconfig-secret"
	// ExternalHubKubeConfig is the secret name of kubeconfig secret to connecting to the hub cluster.
	ExternalHubKubeConfig = "external-hub-kubeconfig"
	// ExternalManagedKubeConfig is the secret name of kubeconfig secret to connecting to the managed cluster
	// Only applicable to Hosted mode, klusterlet-operator uses it to install resources on the managed cluster.
	ExternalManagedKubeConfig = "external-managed-kubeconfig"
	// ExternalManagedKubeConfigRegistration is the secret name of kubeconfig secret to connecting to the managed cluster
	// Only applicable to Hosted mode, registration-agent uses it to connect to the managed cluster.
	ExternalManagedKubeConfigRegistration = "external-managed-kubeconfig-registration"
	// ExternalManagedKubeConfigWork is the secret name of kubeconfig secret to connecting to the managed cluster
	// Only applicable to Hosted mode, work-agent uses it to connect to the managed cluster.
	ExternalManagedKubeConfigWork = "external-managed-kubeconfig-work"
	// ExternalManagedKubeConfigAgent is the secret name of kubeconfig secret to connecting to the managed cluster
	// Only applicable to SingletonHosted mode, agent uses it to connect to the managed cluster.
	ExternalManagedKubeConfigAgent = "external-managed-kubeconfig-agent"

	RegistrationWebhookSecret  = "registration-webhook-serving-cert"
	RegistrationWebhookService = "cluster-manager-registration-webhook"
	WorkWebhookSecret          = "work-webhook-serving-cert" // #nosec G101
	WorkWebhookService         = "cluster-manager-work-webhook"

	SignerSecret      = "signer-secret"
	CaBundleConfigmap = "ca-bundle-configmap"
)

Variables

View Source 
var (
	DefaultHubRegistrationFeatureGates = []operatorapiv1.FeatureGate{
		{Feature: "DefaultClusterSet", Mode: operatorapiv1.FeatureGateModeTypeEnable},
	}
	DefaultSpokeRegistrationFeatureGates = []operatorapiv1.FeatureGate{
		{Feature: "AddonManagement", Mode: operatorapiv1.FeatureGateModeTypeEnable},
	}
)

Functions

func AgentNamespace 

func AgentNamespace(klusterlet *operatorapiv1.Klusterlet) string

AgentNamespace returns the namespace to deploy the agents. It is on the managed cluster in the Default mode, and on the management cluster in the Hosted mode.

func AgentPriorityClassName added in v0.13.0 

func AgentPriorityClassName(klusterlet *operatorapiv1.Klusterlet, kubeVersion *version.Version) string

AgentPriorityClassName return the name of the PriorityClass that should be used for the klusterlet agents

func ApplyDeployment 

func ApplyDeployment(
	ctx context.Context,
	client kubernetes.Interface,
	generationStatuses []operatorapiv1.GenerationStatus,
	nodePlacement operatorapiv1.NodePlacement,
	manifests resourceapply.AssetFunc,
	recorder events.Recorder, file string) (*appsv1.Deployment, operatorapiv1.GenerationStatus, error)

func ApplyDirectly 

func ApplyDirectly(
	ctx context.Context,
	client kubernetes.Interface,
	apiExtensionClient apiextensionsclient.Interface,
	recorder events.Recorder,
	cache resourceapply.ResourceCache,
	manifests resourceapply.AssetFunc,
	files ...string) []resourceapply.ApplyResult

func ApplyEndpoints 

func ApplyEndpoints(ctx context.Context, client coreclientv1.EndpointsGetter, required *corev1.Endpoints) (*corev1.Endpoints, bool, error)

func ApplyMutatingWebhookConfiguration 

func ApplyMutatingWebhookConfiguration(
	client admissionclient.MutatingWebhookConfigurationsGetter,
	required *admissionv1.MutatingWebhookConfiguration) (*admissionv1.MutatingWebhookConfiguration, bool, error)

func ApplyValidatingWebhookConfiguration 

func ApplyValidatingWebhookConfiguration(
	client admissionclient.ValidatingWebhookConfigurationsGetter,
	required *admissionv1.ValidatingWebhookConfiguration) (*admissionv1.ValidatingWebhookConfiguration, bool, error)

func BuildFeatureCondition 

func BuildFeatureCondition(invalidMsgs ...string) metav1.Condition

func CleanUpStaticObject 

func CleanUpStaticObject(
	ctx context.Context,
	client kubernetes.Interface,
	apiExtensionClient apiextensionsclient.Interface,
	apiRegistrationClient apiregistrationclient.APIServicesGetter,
	manifests resourceapply.AssetFunc,
	file string) error

func ClusterManagerDeploymentQueueKeyFunc 

func ClusterManagerDeploymentQueueKeyFunc(clusterManagerLister operatorlister.ClusterManagerLister) factory.ObjectQueueKeysFunc

func ClusterManagerNamespace 

func ClusterManagerNamespace(clustermanagername string, mode operatorapiv1.InstallMode) string

func ClusterManagerQueueKeyFunc 

func ClusterManagerQueueKeyFunc(clusterManagerLister operatorlister.ClusterManagerLister) factory.ObjectQueueKeysFunc

func ConvertToFeatureGateFlags 

func ConvertToFeatureGateFlags(component string, features []operatorapiv1.FeatureGate,
	defaultFeatureGates map[featuregate.Feature]featuregate.FeatureSpec) ([]string, string)

func DetermineReplica 

func DetermineReplica(ctx context.Context, kubeClient kubernetes.Interface, mode operatorapiv1.InstallMode, kubeVersion *version.Version) int32

DetermineReplica determines the replica of deployment based on: - mode: if it is Hosted mode will return 1 - kube version: if the kube version is less than v1.14 reutn 1 - node: list master nodes in the cluster and return 1 if the number of master nodes is equal or less than 1. Return 3 otherwise.

func DetermineReplicaByNodes 

func DetermineReplicaByNodes(ctx context.Context, kubeClient kubernetes.Interface) int32

DetermineReplicaByNodes determines the replica of deployment based on: list master nodes in the cluster and return 1 if the number of master nodes is equal or less than 1. Return 3 otherwise.

func FeatureGateEnabled 

func FeatureGateEnabled(features []operatorapiv1.FeatureGate,
	defaultFeatures map[featuregate.Feature]featuregate.FeatureSpec, featureName featuregate.Feature) bool

FeatureGateEnabled checks if a feature is enabled or disabled in operator API, or fallback to use the the default setting

func FindClusterManagerByNamespace 

func FindClusterManagerByNamespace(namespace string, clusterManagers []*operatorapiv1.ClusterManager) (*operatorapiv1.ClusterManager, error)

func FindGenerationStatus 

func FindGenerationStatus(generationStatuses []operatorapiv1.GenerationStatus, generation operatorapiv1.GenerationStatus) *operatorapiv1.GenerationStatus

func FindKlusterletByNamespace 

func FindKlusterletByNamespace(klusterlets []*operatorapiv1.Klusterlet, namespace string) *operatorapiv1.Klusterlet

func FindRelatedResourcesStatus 

func FindRelatedResourcesStatus(
	relatedResourcesStatuses []operatorapiv1.RelatedResourceMeta,
	relatedResource operatorapiv1.RelatedResourceMeta) *operatorapiv1.RelatedResourceMeta

func GenerateRelatedResource 

func GenerateRelatedResource(objBytes []byte) (operatorapiv1.RelatedResourceMeta, error)

func GetHubKubeconfig 

func GetHubKubeconfig(ctx context.Context,
	operatorKubeconfig *rest.Config,
	operatorClient kubernetes.Interface,
	clustermamagerName string,
	clustermanagerMode operatorapiv1.InstallMode) (*rest.Config, error)

GetHubKubeconfig is used to get the kubeconfig of the hub cluster. If it's Default mode, the kubeconfig of the hub cluster should equal to the operator cluster's kubeconfig and mostly, it's the InClusterConfig. If it's Hosted mode, the kubeconfig of the hub cluster is stored as a secret under clustermanager namespace.

func IsHosted added in v0.12.0 

func IsHosted(mode operatorapiv1.InstallMode) bool

func IsSingleton added in v0.12.0 

func IsSingleton(mode operatorapiv1.InstallMode) bool

IsSingleton returns if agent is deployed in singleton mode either hosted or not

func KlusterletDeploymentQueueKeyFunc 

func KlusterletDeploymentQueueKeyFunc(klusterletLister operatorlister.KlusterletLister) factory.ObjectQueueKeysFunc

func KlusterletNamespace 

func KlusterletNamespace(klusterlet *operatorapiv1.Klusterlet) string

KlusterletNamespace returns the klusterlet namespace on the managed cluster.

func KlusterletSecretQueueKeyFunc 

func KlusterletSecretQueueKeyFunc(klusterletLister operatorlister.KlusterletLister) factory.ObjectQueueKeysFunc

func LoadClientConfigFromSecret 

func LoadClientConfigFromSecret(secret *corev1.Secret) (*rest.Config, error)

LoadClientConfigFromSecret returns a client config loaded from the given secret

func NewGenerationStatus 

func NewGenerationStatus(gvr schema.GroupVersionResource, object runtime.Object) operatorapiv1.GenerationStatus

func NumOfUnavailablePod 

func NumOfUnavailablePod(deployment *appsv1.Deployment) int32

NumOfUnavailablePod is to check if a deployment is in degraded state.

func RemoveRelatedResourcesStatus 

func RemoveRelatedResourcesStatus(
	relatedResourcesStatuses *[]operatorapiv1.RelatedResourceMeta,
	relatedResource operatorapiv1.RelatedResourceMeta)

func RemoveRelatedResourcesStatuses 

func RemoveRelatedResourcesStatuses(
	relatedResourcesStatuses *[]operatorapiv1.RelatedResourceMeta,
	rmRelatedResourcesStatus operatorapiv1.RelatedResourceMeta)

func RemoveRelatedResourcesStatusesWithObj 

func RemoveRelatedResourcesStatusesWithObj(
	relatedResourcesStatuses *[]operatorapiv1.RelatedResourceMeta, objData []byte)

func ResourceRequirements added in v0.13.0 

func ResourceRequirements(resourceRequirementAcquirer operatorapiv1.ResourceRequirementAcquirer) ([]byte, error)

ResourceRequirements get resource requirements overridden by user for ResourceQosClassResourceRequirement type

func ResourceType added in v0.13.0 

func ResourceType(resourceRequirementAcquirer operatorapiv1.ResourceRequirementAcquirer) operatorapiv1.ResourceQosClass

ResourceType set default and return resource requirements override by user

func SetGenerationStatuses 

func SetGenerationStatuses(generationStatuses *[]operatorapiv1.GenerationStatus, newGenerationStatus operatorapiv1.GenerationStatus)

func SetRelatedResourcesStatuses 

func SetRelatedResourcesStatuses(
	relatedResourcesStatuses *[]operatorapiv1.RelatedResourceMeta,
	newRelatedResourcesStatus operatorapiv1.RelatedResourceMeta)

func SetRelatedResourcesStatusesWithObj 

func SetRelatedResourcesStatusesWithObj(
	relatedResourcesStatuses *[]operatorapiv1.RelatedResourceMeta, objData []byte)

func SyncKubeConfigSecret 

func SyncKubeConfigSecret(ctx context.Context, secretName, secretNamespace, kubeconfigPath string,
	templateKubeconfig *rest.Config, secretClient coreclientv1.SecretsGetter,
	tokenGetter TokenGetterFunc, recorder events.Recorder) error

func SyncSecret 

func SyncSecret(ctx context.Context, client, targetClient coreclientv1.SecretsGetter, recorder events.Recorder,
	sourceNamespace, sourceName, targetNamespace, targetName string, ownerRefs []metav1.OwnerReference) (*corev1.Secret, bool, error)

SyncSecret forked from: https://github.com/openshift/library-go/blob/d9cdfbd844ea08465b938c46a16bed2ea23207e4/pkg/operator/resource/resourceapply/core.go#L357, add an addition targetClient parameter to support sync secret to another cluster.

Types

type TokenGetterFunc 

type TokenGetterFunc func() ([]byte, []byte, error)

func SATokenCreater 

func SATokenCreater(ctx context.Context, saName, saNamespace string, saClient kubernetes.Interface) TokenGetterFunc

SATokenCreater create the saToken of target sa.

func SATokenGetter 

func SATokenGetter(ctx context.Context, saName, saNamespace string, saClient kubernetes.Interface) TokenGetterFunc

SATokenGetter get the saToken of target sa. If there is not secrets in the sa, use the tokenrequest to get a token.

Source Files

View all Source files

Directories

Path Synopsis

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.