Files
open-cluster-management/pkg/helpers/helpers.go

419 lines
15 KiB
Go

package helpers
import (
"context"
"fmt"
operatorv1client "github.com/open-cluster-management/api/client/operator/clientset/versioned/typed/operator/v1"
operatorapiv1 "github.com/open-cluster-management/api/operator/v1"
admissionv1 "k8s.io/api/admissionregistration/v1"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
apiextensionsclient "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/runtime/serializer"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/client-go/kubernetes"
admissionclient "k8s.io/client-go/kubernetes/typed/admissionregistration/v1"
"k8s.io/client-go/util/retry"
apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
apiregistrationclient "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset/typed/apiregistration/v1"
"github.com/openshift/api"
"github.com/openshift/library-go/pkg/operator/events"
"github.com/openshift/library-go/pkg/operator/resource/resourceapply"
"github.com/openshift/library-go/pkg/operator/resource/resourcemerge"
)
var (
genericScheme = runtime.NewScheme()
genericCodecs = serializer.NewCodecFactory(genericScheme)
genericCodec = genericCodecs.UniversalDeserializer()
)
func init() {
utilruntime.Must(api.InstallKube(genericScheme))
utilruntime.Must(apiextensionsv1beta1.AddToScheme(genericScheme))
utilruntime.Must(apiregistrationv1.AddToScheme(genericScheme))
utilruntime.Must(admissionv1.AddToScheme(genericScheme))
}
type UpdateClusterManagerStatusFunc func(status *operatorapiv1.ClusterManagerStatus) error
func UpdateClusterManagerStatus(
ctx context.Context,
client operatorv1client.ClusterManagerInterface,
clusterManagerName string,
updateFuncs ...UpdateClusterManagerStatusFunc) (*operatorapiv1.ClusterManagerStatus, bool, error) {
updated := false
var updatedClusterManagerStatus *operatorapiv1.ClusterManagerStatus
err := retry.RetryOnConflict(retry.DefaultBackoff, func() error {
clusterManager, err := client.Get(ctx, clusterManagerName, metav1.GetOptions{})
if err != nil {
return err
}
oldStatus := &clusterManager.Status
newStatus := oldStatus.DeepCopy()
for _, update := range updateFuncs {
if err := update(newStatus); err != nil {
return err
}
}
if equality.Semantic.DeepEqual(oldStatus, newStatus) {
// We return the newStatus which is a deep copy of oldStatus but with all update funcs applied.
updatedClusterManagerStatus = newStatus
return nil
}
clusterManager.Status = *newStatus
updatedClusterManager, err := client.UpdateStatus(ctx, clusterManager, metav1.UpdateOptions{})
if err != nil {
return err
}
updatedClusterManagerStatus = &updatedClusterManager.Status
updated = err == nil
return err
})
return updatedClusterManagerStatus, updated, err
}
func UpdateClusterManagerConditionFn(conds ...metav1.Condition) UpdateClusterManagerStatusFunc {
return func(oldStatus *operatorapiv1.ClusterManagerStatus) error {
for _, cond := range conds {
meta.SetStatusCondition(&oldStatus.Conditions, cond)
}
return nil
}
}
type UpdateKlusterletStatusFunc func(status *operatorapiv1.KlusterletStatus) error
func UpdateKlusterletStatus(
ctx context.Context,
client operatorv1client.KlusterletInterface,
klusterletName string,
updateFuncs ...UpdateKlusterletStatusFunc) (*operatorapiv1.KlusterletStatus, bool, error) {
updated := false
var updatedKlusterletStatus *operatorapiv1.KlusterletStatus
err := retry.RetryOnConflict(retry.DefaultBackoff, func() error {
klusterlet, err := client.Get(ctx, klusterletName, metav1.GetOptions{})
if err != nil {
return err
}
oldStatus := &klusterlet.Status
newStatus := oldStatus.DeepCopy()
for _, update := range updateFuncs {
if err := update(newStatus); err != nil {
return err
}
}
if equality.Semantic.DeepEqual(oldStatus, newStatus) {
// We return the newStatus which is a deep copy of oldStatus but with all update funcs applied.
updatedKlusterletStatus = newStatus
return nil
}
klusterlet.Status = *newStatus
updatedKlusterlet, err := client.UpdateStatus(ctx, klusterlet, metav1.UpdateOptions{})
if err != nil {
return err
}
updatedKlusterletStatus = &updatedKlusterlet.Status
updated = err == nil
return err
})
return updatedKlusterletStatus, updated, err
}
func UpdateKlusterletConditionFn(conds ...metav1.Condition) UpdateKlusterletStatusFunc {
return func(oldStatus *operatorapiv1.KlusterletStatus) error {
for _, cond := range conds {
meta.SetStatusCondition(&oldStatus.Conditions, cond)
}
return nil
}
}
func CleanUpStaticObject(
ctx context.Context,
client kubernetes.Interface,
apiExtensionClient apiextensionsclient.Interface,
apiRegistrationClient apiregistrationclient.APIServicesGetter,
manifests resourceapply.AssetFunc,
file string) error {
objectRaw, err := manifests(file)
if err != nil {
return err
}
object, _, err := genericCodec.Decode(objectRaw, nil, nil)
if err != nil {
return err
}
switch t := object.(type) {
case *corev1.Namespace:
err = client.CoreV1().Namespaces().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *corev1.Service:
err = client.CoreV1().Services(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *corev1.ServiceAccount:
err = client.CoreV1().ServiceAccounts(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *corev1.ConfigMap:
err = client.CoreV1().ConfigMaps(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *corev1.Secret:
err = client.CoreV1().Secrets(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *rbacv1.ClusterRole:
err = client.RbacV1().ClusterRoles().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *rbacv1.ClusterRoleBinding:
err = client.RbacV1().ClusterRoleBindings().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *rbacv1.Role:
err = client.RbacV1().Roles(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *rbacv1.RoleBinding:
err = client.RbacV1().RoleBindings(t.Namespace).Delete(ctx, t.Name, metav1.DeleteOptions{})
case *apiextensionsv1.CustomResourceDefinition:
err = apiExtensionClient.ApiextensionsV1().CustomResourceDefinitions().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *apiextensionsv1beta1.CustomResourceDefinition:
err = apiExtensionClient.ApiextensionsV1beta1().CustomResourceDefinitions().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *apiregistrationv1.APIService:
err = apiRegistrationClient.APIServices().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *admissionv1.ValidatingWebhookConfiguration:
err = client.AdmissionregistrationV1().ValidatingWebhookConfigurations().Delete(ctx, t.Name, metav1.DeleteOptions{})
case *admissionv1.MutatingWebhookConfiguration:
err = client.AdmissionregistrationV1().MutatingWebhookConfigurations().Delete(ctx, t.Name, metav1.DeleteOptions{})
default:
err = fmt.Errorf("unhandled type %T", object)
}
if errors.IsNotFound(err) {
return nil
}
return err
}
func ApplyValidatingWebhookConfiguration(
client admissionclient.ValidatingWebhookConfigurationsGetter,
required *admissionv1.ValidatingWebhookConfiguration) (*admissionv1.ValidatingWebhookConfiguration, bool, error) {
existing, err := client.ValidatingWebhookConfigurations().Get(context.TODO(), required.Name, metav1.GetOptions{})
if errors.IsNotFound(err) {
actual, err := client.ValidatingWebhookConfigurations().Create(context.TODO(), required, metav1.CreateOptions{})
return actual, true, err
}
if err != nil {
return nil, false, err
}
modified := resourcemerge.BoolPtr(false)
existingCopy := existing.DeepCopy()
resourcemerge.EnsureObjectMeta(modified, &existingCopy.ObjectMeta, required.ObjectMeta)
if !equality.Semantic.DeepEqual(existingCopy.Webhooks, required.Webhooks) {
*modified = true
existing.Webhooks = required.Webhooks
}
if !*modified {
return existing, false, nil
}
actual, err := client.ValidatingWebhookConfigurations().Update(context.TODO(), existingCopy, metav1.UpdateOptions{})
return actual, true, err
}
func ApplyMutatingWebhookConfiguration(
client admissionclient.MutatingWebhookConfigurationsGetter,
required *admissionv1.MutatingWebhookConfiguration) (*admissionv1.MutatingWebhookConfiguration, bool, error) {
existing, err := client.MutatingWebhookConfigurations().Get(context.TODO(), required.Name, metav1.GetOptions{})
if errors.IsNotFound(err) {
actual, err := client.MutatingWebhookConfigurations().Create(context.TODO(), required, metav1.CreateOptions{})
return actual, true, err
}
if err != nil {
return nil, false, err
}
modified := resourcemerge.BoolPtr(false)
existingCopy := existing.DeepCopy()
resourcemerge.EnsureObjectMeta(modified, &existingCopy.ObjectMeta, required.ObjectMeta)
if !equality.Semantic.DeepEqual(existingCopy.Webhooks, required.Webhooks) {
*modified = true
existing.Webhooks = required.Webhooks
}
if !*modified {
return existing, false, nil
}
actual, err := client.MutatingWebhookConfigurations().Update(context.TODO(), existingCopy, metav1.UpdateOptions{})
return actual, true, err
}
func ApplyDeployment(
client kubernetes.Interface,
generationStatuses []operatorapiv1.GenerationStatus,
manifests resourceapply.AssetFunc,
recorder events.Recorder, file string) (operatorapiv1.GenerationStatus, error) {
deploymentBytes, err := manifests(file)
if err != nil {
return operatorapiv1.GenerationStatus{}, err
}
deployment, _, err := genericCodec.Decode(deploymentBytes, nil, nil)
if err != nil {
return operatorapiv1.GenerationStatus{}, fmt.Errorf("%q: %v", file, err)
}
generationStatus := NewGenerationStatus(appsv1.SchemeGroupVersion.WithResource("deployments"), deployment)
currentGenerationStatus := FindGenerationStatus(generationStatuses, generationStatus)
if currentGenerationStatus != nil {
generationStatus.LastGeneration = currentGenerationStatus.LastGeneration
}
updatedDeployment, updated, err := resourceapply.ApplyDeployment(
client.AppsV1(),
recorder,
deployment.(*appsv1.Deployment), generationStatus.LastGeneration)
if err != nil {
return generationStatus, fmt.Errorf("%q (%T): %v", file, deployment, err)
}
if updated {
generationStatus.LastGeneration = updatedDeployment.ObjectMeta.Generation
}
return generationStatus, nil
}
func ApplyDirectly(
client kubernetes.Interface,
apiExtensionClient apiextensionsclient.Interface,
apiRegistrationClient apiregistrationclient.APIServicesGetter,
recorder events.Recorder,
manifests resourceapply.AssetFunc,
files ...string) []resourceapply.ApplyResult {
ret := []resourceapply.ApplyResult{}
genericApplyFiles := []string{}
for _, file := range files {
result := resourceapply.ApplyResult{File: file}
objBytes, err := manifests(file)
if err != nil {
result.Error = fmt.Errorf("missing %q: %v", file, err)
ret = append(ret, result)
continue
}
requiredObj, _, err := genericCodec.Decode(objBytes, nil, nil)
if err != nil {
result.Error = fmt.Errorf("cannot decode %q: %v", file, err)
ret = append(ret, result)
continue
}
result.Type = fmt.Sprintf("%T", requiredObj)
switch t := requiredObj.(type) {
case *admissionv1.ValidatingWebhookConfiguration:
result.Result, result.Changed, result.Error = ApplyValidatingWebhookConfiguration(
client.AdmissionregistrationV1(), t)
case *admissionv1.MutatingWebhookConfiguration:
result.Result, result.Changed, result.Error = ApplyMutatingWebhookConfiguration(
client.AdmissionregistrationV1(), t)
case *apiregistrationv1.APIService:
result.Result, result.Changed, result.Error = resourceapply.ApplyAPIService(apiRegistrationClient, recorder, t)
default:
genericApplyFiles = append(genericApplyFiles, file)
}
}
clientHolder := resourceapply.NewKubeClientHolder(client).WithAPIExtensionsClient(apiExtensionClient)
applyResults := resourceapply.ApplyDirectly(
clientHolder,
recorder,
manifests,
genericApplyFiles...,
)
ret = append(ret, applyResults...)
return ret
}
// NumOfUnavailablePod is to check if a deployment is in degraded state.
func NumOfUnavailablePod(deployment *appsv1.Deployment) int32 {
desiredReplicas := int32(1)
if deployment.Spec.Replicas != nil {
desiredReplicas = *(deployment.Spec.Replicas)
}
if desiredReplicas <= deployment.Status.AvailableReplicas {
return 0
}
return desiredReplicas - deployment.Status.AvailableReplicas
}
func NewGenerationStatus(gvr schema.GroupVersionResource, object runtime.Object) operatorapiv1.GenerationStatus {
accessor, _ := meta.Accessor(object)
return operatorapiv1.GenerationStatus{
Group: gvr.Group,
Version: gvr.Version,
Resource: gvr.Resource,
Namespace: accessor.GetNamespace(),
Name: accessor.GetName(),
LastGeneration: accessor.GetGeneration(),
}
}
func FindGenerationStatus(generationStatuses []operatorapiv1.GenerationStatus, generation operatorapiv1.GenerationStatus) *operatorapiv1.GenerationStatus {
for i := range generationStatuses {
if generationStatuses[i].Group != generation.Group {
continue
}
if generationStatuses[i].Resource != generation.Resource {
continue
}
if generationStatuses[i].Version != generation.Version {
continue
}
if generationStatuses[i].Name != generation.Name {
continue
}
if generationStatuses[i].Namespace != generation.Namespace {
continue
}
return &generationStatuses[i]
}
return nil
}
func SetGenerationStatuses(generationStatuses *[]operatorapiv1.GenerationStatus, newGenerationStatus operatorapiv1.GenerationStatus) {
if generationStatuses == nil {
generationStatuses = &[]operatorapiv1.GenerationStatus{}
}
existingGeneration := FindGenerationStatus(*generationStatuses, newGenerationStatus)
if existingGeneration == nil {
*generationStatuses = append(*generationStatuses, newGenerationStatus)
return
}
existingGeneration.LastGeneration = newGenerationStatus.LastGeneration
}
func UpdateClusterManagerGenerationsFn(generations ...operatorapiv1.GenerationStatus) UpdateClusterManagerStatusFunc {
return func(oldStatus *operatorapiv1.ClusterManagerStatus) error {
for _, generation := range generations {
SetGenerationStatuses(&oldStatus.Generations, generation)
}
return nil
}
}
func UpdateKlusterletGenerationsFn(generations ...operatorapiv1.GenerationStatus) UpdateKlusterletStatusFunc {
return func(oldStatus *operatorapiv1.KlusterletStatus) error {
for _, generation := range generations {
SetGenerationStatuses(&oldStatus.Generations, generation)
}
return nil
}
}