Uh oh!
There was an error while loading. Please reload this page.
✨Namespace and PVC probes#2535
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -8,6 +8,7 @@ import ( | ||||||
| "errors" | ||||||
| "fmt" | ||||||
| "strings" | ||||||
| "sync" | ||||||
| "time" | ||||||
| appsv1 "k8s.io/api/apps/v1" | ||||||
| @@ -462,10 +463,13 @@ func (c *ClusterExtensionRevisionReconciler) toBoxcutterRevision(ctx context.Con | ||||||
| previousObjs[i] = rev | ||||||
| } | ||||||
| if err = initializeProbes(); err != nil { | ||||||
| return nil, nil, err | ||||||
| } | ||||||
| opts := []boxcutter.RevisionReconcileOption{ | ||||||
| boxcutter.WithPreviousOwners(previousObjs), | ||||||
| boxcutter.WithProbe(boxcutter.ProgressProbeType, probing.And{ | ||||||
| &namespaceActiveProbe, deploymentProbe, statefulSetProbe, crdProbe, issuerProbe, certProbe, &pvcBoundProbe, | ||||||
| }), | ||||||
| } | ||||||
| @@ -511,6 +515,28 @@ func EffectiveCollisionProtection(cp ...ocv1.CollisionProtection) ocv1.Collision | ||||||
| return ecp | ||||||
| } | ||||||
| // initializeProbes is used to initialize CEL probes once, so we don't recreate them on every reconcile | ||||||
| var initializeProbes = sync.OnceValue(func() error { | ||||||
| nsCEL, err := probing.NewCELProbe(namespaceActiveCEL, `namespace phase must be "Active"`) | ||||||
| if err != nil { | ||||||
| return fmt.Errorf("initializing namespace CEL probe: %w", err) | ||||||
| } | ||||||
| pvcCEL, err := probing.NewCELProbe(pvcBoundCEL, `persistentvolumeclaim phase must be "Bound"`) | ||||||
| if err != nil { | ||||||
| return fmt.Errorf("initializing PVC CEL probe: %w", err) | ||||||
| } | ||||||
| namespaceActiveProbe = probing.GroupKindSelector{ | ||||||
| GroupKind: schema.GroupKind{Group: corev1.GroupName, Kind: "Namespace"}, | ||||||
| Prober: nsCEL, | ||||||
| } | ||||||
| pvcBoundProbe = probing.GroupKindSelector{ | ||||||
| GroupKind: schema.GroupKind{Group: corev1.GroupName, Kind: "PersistentVolumeClaim"}, | ||||||
| Prober: pvcCEL, | ||||||
| } | ||||||
| return nil | ||||||
| }) | ||||||
| var ( | ||||||
| deploymentProbe = &probing.GroupKindSelector{ | ||||||
| GroupKind: schema.GroupKind{Group: appsv1.GroupName, Kind: "Deployment"}, | ||||||
| @@ -542,6 +568,14 @@ var ( | ||||||
| }, | ||||||
| } | ||||||
| // namespaceActiveCEL is a CEL rule which asserts that the namespace is in "Active" phase | ||||||
| namespaceActiveCEL = `self.status.phase == "Active"` | ||||||
| namespaceActiveProbe probing.GroupKindSelector | ||||||
| // pvcBoundCEL is a CEL rule which asserts that the PVC is in "Bound" phase | ||||||
| pvcBoundCEL = `self.status.phase == "Bound"` | ||||||
| pvcBoundProbe probing.GroupKindSelector | ||||||
| // deplStaefulSetProbe probes Deployment, StatefulSet objects. | ||||||
There was a problem hiding this comment. The comment for
Suggested change
ContributorAuthor There was a problem hiding this comment. I didn't change this line, I can keep it in mind for a future PR though | ||||||
| deplStatefulSetProbe = &probing.ObservedGenerationProbe{ | ||||||
| Prober: probing.And{ | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| @BoxcutterRuntime | ||
| Feature: Install ClusterExtensionRevision | ||
| As an OLM user I would like to install a cluster extension revision directly, without using the cluster extension API. | ||
| Background: | ||
| Given OLM is available | ||
| And ServiceAccount "olm-sa" with needed permissions is available in ${TEST_NAMESPACE} | ||
| Scenario: Probe failure for PersistentVolumeClaim halts phase progression | ||
| When ClusterExtensionRevision is applied | ||
| """ | ||
| apiVersion: olm.operatorframework.io/v1 | ||
| kind: ClusterExtensionRevision | ||
| metadata: | ||
| annotations: | ||
| olm.operatorframework.io/service-account-name: olm-sa | ||
| olm.operatorframework.io/service-account-namespace: ${TEST_NAMESPACE} | ||
Comment on lines
+16
to
+18
Contributor There was a problem hiding this comment. are these annotations required for reconciliation to work? Contributor There was a problem hiding this comment. yeah =/ this is a bit of a rough edge since we don't expose the service account configuration in the .spec. I think it's ok to leave it like this for now since we'll need to act on it once we have a decision on the OLM MVP and whether we want to keep the service account or not. | ||
| name: ${CER_NAME} | ||
| spec: | ||
| lifecycleState: Active | ||
| collisionProtection: Prevent | ||
| phases: | ||
| - name: pvc | ||
| objects: | ||
| - object: | ||
| apiVersion: v1 | ||
| kind: PersistentVolumeClaim | ||
| metadata: | ||
| name: test-pvc | ||
| namespace: ${TEST_NAMESPACE} | ||
| spec: | ||
| accessModes: | ||
| - ReadWriteOnce | ||
| storageClassName: "" | ||
| volumeName: test-pv | ||
| resources: | ||
| requests: | ||
| storage: 1Mi | ||
| - name: configmap | ||
| objects: | ||
| - object: | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: test-configmap | ||
| namespace: ${TEST_NAMESPACE} | ||
| data: | ||
| name: test-configmap | ||
| version: v1.2.0 | ||
| revision: 1 | ||
| """ | ||
| Then resource "persistentvolumeclaim/test-pvc" is installed | ||
| And ClusterExtensionRevision "${CER_NAME}" reports Available as False with Reason ProbeFailure and Message: | ||
| """ | ||
| Object PersistentVolumeClaim.v1 ${TEST_NAMESPACE}/test-pvc: persistentvolumeclaim phase must be "Bound" | ||
| """ | ||
| And resource "configmap/test-configmap" is not installed | ||
| Scenario: Phases progress when PersistentVolumeClaim becomes "Bound" | ||
| When ClusterExtensionRevision is applied | ||
| """ | ||
| apiVersion: olm.operatorframework.io/v1 | ||
| kind: ClusterExtensionRevision | ||
| metadata: | ||
| annotations: | ||
| olm.operatorframework.io/service-account-name: olm-sa | ||
| olm.operatorframework.io/service-account-namespace: ${TEST_NAMESPACE} | ||
| name: ${CER_NAME} | ||
| spec: | ||
| lifecycleState: Active | ||
| collisionProtection: Prevent | ||
| phases: | ||
| - name: pvc | ||
| objects: | ||
| - object: | ||
| apiVersion: v1 | ||
| kind: PersistentVolumeClaim | ||
| metadata: | ||
| name: test-pvc | ||
| namespace: ${TEST_NAMESPACE} | ||
| spec: | ||
| accessModes: | ||
| - ReadWriteOnce | ||
| storageClassName: "" | ||
| volumeName: test-pv | ||
| resources: | ||
| requests: | ||
| storage: 1Mi | ||
| - object: | ||
| apiVersion: v1 | ||
| kind: PersistentVolume | ||
| metadata: | ||
| name: test-pv | ||
| spec: | ||
| accessModes: | ||
| - ReadWriteOnce | ||
| capacity: | ||
| storage: 1Mi | ||
| claimRef: | ||
| apiVersion: v1 | ||
| kind: PersistentVolumeClaim | ||
| name: test-pvc | ||
| namespace: ${TEST_NAMESPACE} | ||
| persistentVolumeReclaimPolicy: Delete | ||
| storageClassName: "" | ||
| volumeMode: Filesystem | ||
| local: | ||
| path: /tmp/persistent-volume | ||
Comment on lines
+108
to
+110
Contributor There was a problem hiding this comment. this works under kind, does it work under openshift? ContributorAuthor There was a problem hiding this comment. It does, I just tested it (aws). I can try a few other cluster types too just in case. | ||
| nodeAffinity: | ||
| required: | ||
| nodeSelectorTerms: | ||
| - matchExpressions: | ||
| - key: kubernetes.io/hostname | ||
| operator: NotIn | ||
| values: | ||
dtfranz marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| - a-node-name-that-should-not-exist | ||
| - name: configmap | ||
| objects: | ||
| - object: | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: test-configmap | ||
| namespace: ${TEST_NAMESPACE} | ||
| data: | ||
| name: test-configmap | ||
| version: v1.2.0 | ||
| revision: 1 | ||
| """ | ||
| Then ClusterExtensionRevision "${CER_NAME}" reports Progressing as True with Reason Succeeded | ||
| And ClusterExtensionRevision "${CER_NAME}" reports Available as True with Reason ProbesSucceeded | ||
| And resource "persistentvolume/test-pv" is installed | ||
| And resource "persistentvolumeclaim/test-pvc" is installed | ||
| And resource "configmap/test-configmap" is installed | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -71,7 +71,9 @@ func RegisterSteps(sc *godog.ScenarioContext) { | ||
| sc.Step(`^(?i)ClusterExtension reports ([[:alnum:]]+) as ([[:alnum:]]+) with Reason ([[:alnum:]]+)$`, ClusterExtensionReportsConditionWithoutMsg) | ||
| sc.Step(`^(?i)ClusterExtension reports ([[:alnum:]]+) as ([[:alnum:]]+)$`, ClusterExtensionReportsConditionWithoutReason) | ||
| sc.Step(`^(?i)ClusterExtensionRevision "([^"]+)" reports ([[:alnum:]]+) as ([[:alnum:]]+) with Reason ([[:alnum:]]+)$`, ClusterExtensionRevisionReportsConditionWithoutMsg) | ||
| sc.Step(`^(?i)ClusterExtensionRevision "([^"]+)" reports ([[:alnum:]]+) as ([[:alnum:]]+) with Reason ([[:alnum:]]+) and Message:$`, ClusterExtensionRevisionReportsConditionWithMsg) | ||
| sc.Step(`^(?i)ClusterExtension reports ([[:alnum:]]+) transition between (\d+) and (\d+) minutes since its creation$`, ClusterExtensionReportsConditionTransitionTime) | ||
| sc.Step(`^(?i)ClusterExtensionRevision is applied(?:\s+.*)?$`, ResourceIsApplied) | ||
| sc.Step(`^(?i)ClusterExtensionRevision "([^"]+)" is archived$`, ClusterExtensionRevisionIsArchived) | ||
| sc.Step(`^(?i)ClusterExtensionRevision "([^"]+)" contains annotation "([^"]+)" with value$`, ClusterExtensionRevisionHasAnnotationWithValue) | ||
| sc.Step(`^(?i)ClusterExtensionRevision "([^"]+)" has label "([^"]+)" with value "([^"]+)"$`, ClusterExtensionRevisionHasLabelWithValue) | ||
| @@ -80,7 +82,7 @@ func RegisterSteps(sc *godog.ScenarioContext) { | ||
| sc.Step(`^(?i)resource "([^"]+)" is installed$`, ResourceAvailable) | ||
| sc.Step(`^(?i)resource "([^"]+)" is available$`, ResourceAvailable) | ||
| sc.Step(`^(?i)resource "([^"]+)" is removed$`, ResourceRemoved) | ||
| sc.Step(`^(?i)resource "([^"]+)" is (?:eventually not found|not installed)$`, ResourceEventuallyNotFound) | ||
| sc.Step(`^(?i)resource "([^"]+)" exists$`, ResourceAvailable) | ||
| sc.Step(`^(?i)resource is applied$`, ResourceIsApplied) | ||
| sc.Step(`^(?i)resource "deployment/test-operator" reports as (not ready|ready)$`, MarkTestOperatorNotReady) | ||
| @@ -186,6 +188,7 @@ func substituteScenarioVars(content string, sc *scenarioContext) string { | ||
| vars := map[string]string{ | ||
| "TEST_NAMESPACE": sc.namespace, | ||
| "NAME": sc.clusterExtensionName, | ||
| "CER_NAME": sc.clusterExtensionRevisionName, | ||
| "CATALOG_IMG": "docker-registry.operator-controller-e2e.svc.cluster.local:5000/e2e/test-catalog:v1", | ||
| } | ||
| if v, found := os.LookupEnv("CATALOG_IMG"); found { | ||
| @@ -235,8 +238,8 @@ func ClusterExtensionVersionUpdate(ctx context.Context, version string) error { | ||
| return err | ||
| } | ||
| // ResourceIsApplied applies the provided YAML resource to the cluster and in case of ClusterExtension or ClusterExtensionRevision it captures | ||
| // its name in the test context so that it can be referred to in later steps with ${NAME} or ${CER_NAME}, respectively | ||
| func ResourceIsApplied(ctx context.Context, yamlTemplate *godog.DocString) error { | ||
| sc := scenarioCtx(ctx) | ||
| yamlContent := substituteScenarioVars(yamlTemplate.Content, sc) | ||
| @@ -246,10 +249,12 @@ func ResourceIsApplied(ctx context.Context, yamlTemplate *godog.DocString) error | ||
| } | ||
| out, err := k8scliWithInput(yamlContent, "apply", "-f", "-") | ||
| if err != nil { | ||
| return fmt.Errorf("failed to apply resource %v; err: %w; stderr: %s", out, err, stderrOutput(err)) | ||
| } | ||
| if res.GetKind() == "ClusterExtension" { | ||
| sc.clusterExtensionName = res.GetName() | ||
| } else if res.GetKind() == "ClusterExtensionRevision" { | ||
| sc.clusterExtensionRevisionName = res.GetName() | ||
| } | ||
dtfranz marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| return nil | ||
| } | ||
| @@ -378,6 +383,17 @@ type msgMatchFn func(string) bool | ||
| func alwaysMatch(_ string) bool { return true } | ||
| func messageComparison(ctx context.Context, msg *godog.DocString) msgMatchFn { | ||
| msgCmp := alwaysMatch | ||
| if msg != nil { | ||
| expectedMsg := substituteScenarioVars(strings.Join(strings.Fields(msg.Content), " "), scenarioCtx(ctx)) | ||
| msgCmp = func(actual string) bool { | ||
| return actual == expectedMsg | ||
| } | ||
| } | ||
| return msgCmp | ||
| } | ||
| func waitForCondition(ctx context.Context, resourceType, resourceName, conditionType, conditionStatus string, conditionReason *string, msgCmp msgMatchFn) error { | ||
| require.Eventually(godog.T(ctx), func() bool { | ||
| v, err := k8sClient("get", resourceType, resourceName, "-o", fmt.Sprintf("jsonpath={.status.conditions[?(@.type==\"%s\")]}", conditionType)) | ||
| @@ -412,14 +428,7 @@ func waitForExtensionCondition(ctx context.Context, conditionType, conditionStat | ||
| // ClusterExtensionReportsCondition waits for the ClusterExtension to have a condition matching the specified type, | ||
| // status, reason, and exact message. Polls with timeout. | ||
| func ClusterExtensionReportsCondition(ctx context.Context, conditionType, conditionStatus, conditionReason string, msg *godog.DocString) error { | ||
| return waitForExtensionCondition(ctx, conditionType, conditionStatus, &conditionReason, messageComparison(ctx, msg)) | ||
| } | ||
| // ClusterExtensionReportsConditionWithMessageFragment waits for the ClusterExtension to have a condition matching | ||
| @@ -512,6 +521,12 @@ func ClusterExtensionRevisionReportsConditionWithoutMsg(ctx context.Context, rev | ||
| return waitForCondition(ctx, "clusterextensionrevision", substituteScenarioVars(revisionName, scenarioCtx(ctx)), conditionType, conditionStatus, &conditionReason, nil) | ||
| } | ||
| // ClusterExtensionRevisionReportsConditionWithMsg waits for the named ClusterExtensionRevision to have a condition | ||
| // matching type, status, reason, and message. Polls with timeout. | ||
| func ClusterExtensionRevisionReportsConditionWithMsg(ctx context.Context, revisionName, conditionType, conditionStatus, conditionReason string, msg *godog.DocString) error { | ||
| return waitForCondition(ctx, "clusterextensionrevision", substituteScenarioVars(revisionName, scenarioCtx(ctx)), conditionType, conditionStatus, &conditionReason, messageComparison(ctx, msg)) | ||
| } | ||
| // ClusterExtensionRevisionIsArchived waits for the named ClusterExtensionRevision to have Progressing=False | ||
| // with reason Archived. Polls with timeout. | ||
| func ClusterExtensionRevisionIsArchived(ctx context.Context, revisionName string) error { | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.