|
| 1 | +package controller |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/json" |
| 6 | + "errors" |
| 7 | + "fmt" |
| 8 | + "sort" |
| 9 | + "strings" |
| 10 | + |
| 11 | + semver "github.com/blang/semver/v4" |
| 12 | + "github.com/go-logr/logr" |
| 13 | + operatorv1 "github.com/openshift/api/operator/v1" |
| 14 | + "github.com/openshift/cluster-olm-operator/internal/utils" |
| 15 | + "github.com/openshift/cluster-olm-operator/pkg/clients" |
| 16 | + "github.com/openshift/library-go/pkg/controller/factory" |
| 17 | + "github.com/openshift/library-go/pkg/operator/events" |
| 18 | + "github.com/openshift/library-go/pkg/operator/v1helpers" |
| 19 | + storage "github.com/operator-framework/helm-operator-plugins/pkg/storage" |
| 20 | + "github.com/operator-framework/operator-registry/alpha/property" |
| 21 | + helm "helm.sh/helm/v3/pkg/storage" |
| 22 | + "helm.sh/helm/v3/pkg/storage/driver" |
| 23 | + "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" |
| 24 | + "k8s.io/apimachinery/pkg/labels" |
| 25 | + "k8s.io/client-go/kubernetes" |
| 26 | + v1 "k8s.io/client-go/kubernetes/typed/core/v1" |
| 27 | + "k8s.io/klog/v2" |
| 28 | +) |
| 29 | + |
| 30 | +const ( |
| 31 | + reasonIncompatibleOperatorsInstalled = "IncompatibleOperatorsInstalled" |
| 32 | + maxOpenShiftVersionProperty = "olm.maxOpenShiftVersion" |
| 33 | + ownerKindKey = "olm.operatorframework.io/owner-kind" |
| 34 | + ownerNameKey = "olm.operatorframework.io/owner-name" |
| 35 | + packageNameKey = "olm.operatorframework.io/package-name" |
| 36 | + bundleNameKey = "olm.operatorframework.io/bundle-name" |
| 37 | + bundleVersionKey = "olm.operatorframework.io/bundle-version" |
| 38 | +) |
| 39 | + |
| 40 | +type incompatibleOperatorController struct { |
| 41 | + name string |
| 42 | + nextOCPMinorVersion *semver.Version |
| 43 | + kubeclient kubernetes.Interface |
| 44 | + clusterExtensionClient *clients.ClusterExtensionClient |
| 45 | + operatorClient *clients.OperatorClient |
| 46 | + logger logr.Logger |
| 47 | +} |
| 48 | + |
| 49 | +func NewIncompatibleOperatorController(name string, nextOCPMinorVersion *semver.Version, kubeclient kubernetes.Interface, clusterExtensionClient *clients.ClusterExtensionClient, operatorClient *clients.OperatorClient, eventRecorder events.Recorder) factory.Controller { |
| 50 | + c := &incompatibleOperatorController{ |
| 51 | + name: name, |
| 52 | + nextOCPMinorVersion: nextOCPMinorVersion, |
| 53 | + kubeclient: kubeclient, |
| 54 | + clusterExtensionClient: clusterExtensionClient, |
| 55 | + operatorClient: operatorClient, |
| 56 | + logger: klog.NewKlogr().WithName(name), |
| 57 | + } |
| 58 | + |
| 59 | + return factory.New().WithSync(c.sync).WithSyncDegradedOnError(operatorClient).WithInformers(operatorClient.Informer(), clusterExtensionClient.Informer().Informer()).ToController(name, eventRecorder) |
| 60 | +} |
| 61 | + |
| 62 | +func (c *incompatibleOperatorController) sync(ctx context.Context, _ factory.SyncContext) error { |
| 63 | + c.logger.Info("sync started") |
| 64 | + defer c.logger.Info("sync finished") |
| 65 | + |
| 66 | + incompatibleOperators, err := c.getIncompatibleOperators() |
| 67 | + if err != nil { |
| 68 | + c.logger.V(4).Error(err, "error checking incompatible operators") |
| 69 | + return err |
| 70 | + } |
| 71 | + |
| 72 | + var updateStatusFn v1helpers.UpdateStatusFunc |
| 73 | + if len(incompatibleOperators) > 0 { |
| 74 | + updateStatusFn = v1helpers.UpdateConditionFn(operatorv1.OperatorCondition{ |
| 75 | + Type: "InstalledOLMOperatorsUpgradeable", |
| 76 | + Status: operatorv1.ConditionFalse, |
| 77 | + Reason: reasonIncompatibleOperatorsInstalled, |
| 78 | + Message: strings.Join(incompatibleOperators, ","), |
| 79 | + }) |
| 80 | + } else { |
| 81 | + updateStatusFn = v1helpers.UpdateConditionFn(operatorv1.OperatorCondition{ |
| 82 | + Type: "InstalledOLMOperatorsUpgradeable", |
| 83 | + Status: operatorv1.ConditionTrue, |
| 84 | + }) |
| 85 | + } |
| 86 | + |
| 87 | + if _, _, updateErr := v1helpers.UpdateStatus(ctx, c.operatorClient, updateStatusFn); updateErr != nil { |
| 88 | + c.logger.V(4).Info(fmt.Sprintf("Error updating operator condition status: %v", updateErr)) |
| 89 | + return updateErr |
| 90 | + } |
| 91 | + return nil |
| 92 | +} |
| 93 | + |
| 94 | +func (c *incompatibleOperatorController) getIncompatibleOperators() ([]string, error) { |
| 95 | + var incompatibleOperators []string |
| 96 | + |
| 97 | + ceList, err := c.clusterExtensionClient.Informer().Lister().List(labels.NewSelector()) |
| 98 | + if err != nil { |
| 99 | + c.logger.V(4).Error(err, "Error listing cluster extensions") |
| 100 | + return nil, err |
| 101 | + } |
| 102 | + |
| 103 | + store := c.buildHelmStore(c.kubeclient.CoreV1().Secrets("openshift-operator-controller")) |
| 104 | + |
| 105 | + // Get all ClusterExtensions incompatible with next Y-stream |
| 106 | + for _, obj := range ceList { |
| 107 | + ce, ok := obj.(*unstructured.Unstructured) |
| 108 | + if !ok { |
| 109 | + c.logger.V(4).Error(nil, fmt.Sprintf("Unable to Cast Object to unstructured.Unstructured. Object is of type %T", obj)) |
| 110 | + return nil, nil |
| 111 | + } |
| 112 | + |
| 113 | + rel, err := store.Deployed(ce.GetName()) |
| 114 | + if errors.Is(err, driver.ErrNoDeployedReleases) { |
| 115 | + c.logger.Info("Cluster Extension not yet deployed - will check again later") |
| 116 | + continue |
| 117 | + } |
| 118 | + if err != nil { |
| 119 | + c.logger.V(4).Error(err, "Error returning the last deployed release") |
| 120 | + return nil, err |
| 121 | + } |
| 122 | + |
| 123 | + if rel.Chart == nil || rel.Chart.Metadata == nil { |
| 124 | + continue |
| 125 | + } |
| 126 | + props, err := propertyListFromPropertiesAnnotation(rel.Chart.Metadata.Annotations["olm.properties"]) |
| 127 | + if err != nil { |
| 128 | + c.logger.V(4).Error(err, "Error converting olm.properties") |
| 129 | + return nil, err |
| 130 | + } |
| 131 | + for _, p := range props { |
| 132 | + if p.Type == maxOpenShiftVersionProperty { |
| 133 | + version := string(p.Value) |
| 134 | + maxOCPVersion, err := utils.ToSemver(version) |
| 135 | + if err != nil { |
| 136 | + c.logger.V(4).Info(fmt.Sprintf("Error converting to semver for version %s: %v", version, err)) |
| 137 | + continue |
| 138 | + } |
| 139 | + if maxOCPVersion != nil && !maxOCPVersion.GTE(*c.nextOCPMinorVersion) { |
| 140 | + // Incompatible |
| 141 | + incompatibleOperators = append(incompatibleOperators, rel.Labels[bundleNameKey]) |
| 142 | + } |
| 143 | + } |
| 144 | + } |
| 145 | + } |
| 146 | + // deterministic ordering |
| 147 | + sort.Strings(incompatibleOperators) |
| 148 | + |
| 149 | + return incompatibleOperators, nil |
| 150 | +} |
| 151 | + |
| 152 | +func propertyListFromPropertiesAnnotation(raw string) ([]property.Property, error) { |
| 153 | + var props []property.Property |
| 154 | + if err := json.Unmarshal([]byte(raw), &props); err != nil { |
| 155 | + return nil, fmt.Errorf("failed to unmarshal properties annotation: %w", err) |
| 156 | + } |
| 157 | + return props, nil |
| 158 | +} |
| 159 | + |
| 160 | +func (c *incompatibleOperatorController) buildHelmStore(secretClient v1.SecretInterface) helm.Storage { |
| 161 | + log := func(s string, args ...interface{}) { c.logger.V(4).Info(fmt.Sprintf(s, args...)) } |
| 162 | + csConfig := storage.ChunkedSecretsConfig{Log: log} |
| 163 | + |
| 164 | + return helm.Storage{ |
| 165 | + Driver: storage.NewChunkedSecrets(secretClient, "operator-controller", csConfig), |
| 166 | + Log: log, |
| 167 | + } |
| 168 | +} |
0 commit comments