Implement devEnvironments.workspacesPodAnnotations to provide annotations to all workspace pods #1862

dkwon17 · 2024-06-19T21:59:35Z

This PR is a draft PR for now because it requires the latest unreleased version of the devworkspace-operator

What does this PR do?

This PR implements the devEnvironments.workspacesPodAnnotations field in the CheCluster CR to provide annotations to all workspace pods

Screenshot/screencast of this PR

What issues does this PR fix or reference?

Related to:
https://issues.redhat.com/browse/CRW-6550
eclipse-che/che#22809

How to test this PR?

Prepare a patch file with an annotation hello: world:

cat > /tmp/cr-patch.yaml <<EOF
apiVersion: org.eclipse.che/v2
kind: CheCluster
spec:
  devEnvironments:
    workpsacesPodAnnotations:
      hello: world
EOF

Deploy the operator:

OpenShift

./build/scripts/olm/test-catalog-from-sources.sh --cr-patch-yaml /tmp/cr-patch.yaml

on Minikube

./build/scripts/minikube-tests/test-operator-from-sources.sh --cr-patch-yaml /tmp/cr-patch.yaml

Start a workspace and verify that the workspace pod has the hello: world annotation
Remove the devEnvironments.workspacesPodAnnotations field in the CheCluster CR and restart the workspace.
Verify that the hello: world annotation is removed

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

openshift-ci · 2024-06-19T21:59:40Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

AObuchow · 2024-06-25T16:44:53Z

pkg/deploy/dev-workspace-config/dev_workspace_config_test.go

+			dwoc := &controllerv1alpha1.DevWorkspaceOperatorConfig{}
+			err = deployContext.ClusterAPI.Client.Get(context.TODO(), types.NamespacedName{Name: devWorkspaceConfigName, Namespace: testCase.cheCluster.Namespace}, dwoc)
+			assert.NoError(t, err)
+			assert.Equal(t, testCase.expectedOperatorConfig.Workspace.ImagePullPolicy, dwoc.Config.Workspace.ImagePullPolicy)


I think this was intended to check the config annotations?

assert.Equal(t, testCase.expectedOperatorConfig.Workspace.podAnnotations, dwoc.Config.Workspace.podAnnotations)

Thank you, fixed

tolusha · 2024-06-26T07:09:13Z

go.mod

@@ -5,7 +5,7 @@ go 1.19
 require (
 	github.com/che-incubator/kubernetes-image-puller-operator v0.0.0-20210929175054-0128446f5af7
 	github.com/devfile/api/v2 v2.2.2
-	github.com/devfile/devworkspace-operator v0.25.0
+	github.com/devfile/devworkspace-operator v0.29.0


Please update DEPENDENCIES.md file with a new DWO version and link to https://clearlydefined.io/

tolusha · 2024-06-26T07:09:57Z

go.mod

@@ -14,7 +14,7 @@ require (
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.8.4
 	go.uber.org/zap v1.24.0
-	golang.org/x/net v0.19.0
+	golang.org/x/net v0.23.0


Please update DEPENDENCIES.md file to update the version of the following libs (no links to https://clearlydefined.io/ are requested)

golang.org/x/net v0.23.0

golang.org/x/sys v0.18.0

golang.org/x/term v0.18.0

tolusha · 2024-06-26T07:11:11Z

api/v2/checluster_types.go

@@ -189,6 +189,9 @@ type CheClusterDevEnvironments struct {
 	// +optional
 	// +kubebuilder:validation:Enum=Always;IfNotPresent;Never
 	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
+	// Annotations defines additional annotations for workspace pods.
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`


What do you think?

Suggested change

Annotations map[string]string `json:"annotations,omitempty"`

WorkspacesPodAnnotations map[string]string `json:"workspacesPodAnnotations,omitempty"`

Sounds good, updated

dkwon17 · 2024-06-26T21:38:48Z

Thank you for the review @tolusha , WDYT?

tolusha · 2024-06-27T08:40:19Z

/test v14-devworkspace-happy-path

openshift-ci · 2024-06-27T11:35:36Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dkwon17, ibuziuk, tolusha

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: dkwon17 <[email protected]>

openshift-ci · 2024-06-27T13:58:11Z

New changes are detected. LGTM label has been removed.

dkwon17 · 2024-06-27T13:58:47Z

I've squashed the commits, merging soon

openshift-ci · 2024-06-27T14:12:27Z

@dkwon17: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v14-che-behind-proxy	`0a1cc70`	link	true	`/test v14-che-behind-proxy`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Signed-off-by: dkwon17 <[email protected]>

devstudio-release · 2024-06-28T14:38:58Z

Build 3.16 :: sync-to-downstream_3.x/6996: Console, Changes, Git Data

devstudio-release · 2024-06-28T14:44:43Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6950: Console, Changes, Git Data

devstudio-release · 2024-06-28T15:12:17Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6950:

devspaces-operator-bundle : 3.x :: Failed in 62253699 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-06-28T15:13:25Z

Build 3.16 :: operator-bundle_3.x/3134: Console, Changes, Git Data

devstudio-release · 2024-06-28T15:16:49Z

Build 3.16 :: sync-to-downstream_3.x/6997: Console, Changes, Git Data

devstudio-release · 2024-06-28T15:22:06Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6952: Console, Changes, Git Data

devstudio-release · 2024-06-28T15:29:48Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6952:

devspaces-operator-bundle : 3.x :: Failed in 62253993 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-06-28T18:24:59Z

Build 3.15 :: operator-bundle_3.15/11: Console, Changes, Git Data

devstudio-release · 2024-06-28T18:27:43Z

Build 3.15 :: sync-to-downstream_3.15/25: Console, Changes, Git Data

devstudio-release · 2024-06-28T18:47:59Z

Build 3.16 :: operator-bundle_3.x/3135: Console, Changes, Git Data

devstudio-release · 2024-06-28T18:50:27Z

Build 3.16 :: sync-to-downstream_3.x/6998: Console, Changes, Git Data

devstudio-release · 2024-06-28T18:55:12Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6954: Console, Changes, Git Data

devstudio-release · 2024-06-28T18:59:20Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6954:

devspaces-operator-bundle : 3.x :: Failed in 62255856 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-06-28T22:25:03Z

Build 3.15 :: operator-bundle_3.15/12: Console, Changes, Git Data

devstudio-release · 2024-06-28T22:28:11Z

Build 3.15 :: sync-to-downstream_3.15/26: Console, Changes, Git Data

devstudio-release · 2024-06-28T22:47:44Z

Build 3.16 :: operator-bundle_3.x/3136: Console, Changes, Git Data

devstudio-release · 2024-06-28T22:54:56Z

Build 3.16 :: sync-to-downstream_3.x/7000: Console, Changes, Git Data

devstudio-release · 2024-06-28T23:00:15Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6956: Console, Changes, Git Data

devstudio-release · 2024-06-28T23:03:08Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6956:

devspaces-operator-bundle : 3.x :: Failed in 62258212 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-06-28T23:05:35Z

Build 3.16 :: operator-bundle_3.x/3137: Console, Changes, Git Data

devstudio-release · 2024-06-28T23:08:32Z

Build 3.16 :: sync-to-downstream_3.x/7001: Console, Changes, Git Data

devstudio-release · 2024-06-28T23:08:58Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6957: Console, Changes, Git Data

devstudio-release · 2024-06-28T23:11:06Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6957:

devspaces-operator-bundle : 3.x :: Failed in 62258381 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

devstudio-release · 2024-06-29T02:25:02Z

Build 3.15 :: operator-bundle_3.15/13: Console, Changes, Git Data

devstudio-release · 2024-06-29T02:28:13Z

Build 3.15 :: sync-to-downstream_3.15/27: Console, Changes, Git Data

devstudio-release · 2024-06-29T02:48:03Z

Build 3.16 :: operator-bundle_3.x/3138: Console, Changes, Git Data

devstudio-release · 2024-06-29T02:51:21Z

Build 3.16 :: sync-to-downstream_3.x/7002: Console, Changes, Git Data

devstudio-release · 2024-06-29T02:51:49Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6958: Console, Changes, Git Data

devstudio-release · 2024-06-29T02:54:19Z

Build 3.16 :: get-sources-rhpkg-container-build_3.x/6958:

devspaces-operator-bundle : 3.x :: Failed in 62258967 : BREW:BUILD/STATUS:UNKNOWN
FAILURE:; copied to quay

openshift-ci bot added the do-not-merge/work-in-progress label Jun 19, 2024

dkwon17 force-pushed the devworkspace-annotations branch 2 times, most recently from 7ba6ad8 to 8fb52b8 Compare June 25, 2024 15:46

dkwon17 marked this pull request as ready for review June 25, 2024 15:46

dkwon17 requested review from SDawley, tolusha and ibuziuk as code owners June 25, 2024 15:46

openshift-ci bot removed the do-not-merge/work-in-progress label Jun 25, 2024

AObuchow reviewed Jun 25, 2024

View reviewed changes

ibuziuk approved these changes Jun 26, 2024

View reviewed changes

openshift-ci bot assigned ibuziuk Jun 26, 2024

openshift-ci bot added the lgtm label Jun 26, 2024

tolusha reviewed Jun 26, 2024

View reviewed changes

openshift-ci bot removed the lgtm label Jun 26, 2024

tolusha approved these changes Jun 27, 2024

View reviewed changes

openshift-ci bot assigned tolusha Jun 27, 2024

openshift-ci bot added the lgtm label Jun 27, 2024

Upgrade DWO dependency to v0.29.0

b6101e9

Signed-off-by: dkwon17 <[email protected]>

dkwon17 force-pushed the devworkspace-annotations branch from 941d418 to 0a1cc70 Compare June 27, 2024 13:58

openshift-ci bot removed the lgtm label Jun 27, 2024

feat: implement devEnvironments.workspacesPodAnnotations

db792ec

Signed-off-by: dkwon17 <[email protected]>

dkwon17 force-pushed the devworkspace-annotations branch from 0a1cc70 to db792ec Compare June 27, 2024 14:24

dkwon17 merged commit f5d60a0 into eclipse-che:main Jun 27, 2024
15 of 19 checks passed

dkwon17 changed the title ~~Implement devEnvironments.annotations to provide annotations to all workspace pods~~ Implement devEnvironments.workspacesPodAnnotations to provide annotations to all workspace pods Jul 8, 2024

	Annotations map[string]string `json:"annotations,omitempty"`
	WorkspacesPodAnnotations map[string]string `json:"workspacesPodAnnotations,omitempty"`

Implement devEnvironments.workspacesPodAnnotations to provide annotations to all workspace pods #1862

Implement devEnvironments.workspacesPodAnnotations to provide annotations to all workspace pods #1862

Conversation

dkwon17 commented Jun 19, 2024 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

OpenShift

on Minikube

PR Checklist

Reviewers

openshift-ci bot commented Jun 19, 2024

AObuchow Jun 25, 2024

Choose a reason for hiding this comment

dkwon17 Jun 25, 2024

Choose a reason for hiding this comment

tolusha Jun 26, 2024

Choose a reason for hiding this comment

tolusha Jun 26, 2024

Choose a reason for hiding this comment

tolusha Jun 26, 2024

Choose a reason for hiding this comment

dkwon17 Jun 26, 2024

Choose a reason for hiding this comment

dkwon17 commented Jun 26, 2024

tolusha commented Jun 27, 2024

openshift-ci bot commented Jun 27, 2024

openshift-ci bot commented Jun 27, 2024

dkwon17 commented Jun 27, 2024

openshift-ci bot commented Jun 27, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 28, 2024

devstudio-release commented Jun 29, 2024

devstudio-release commented Jun 29, 2024

devstudio-release commented Jun 29, 2024

devstudio-release commented Jun 29, 2024

devstudio-release commented Jun 29, 2024

devstudio-release commented Jun 29, 2024

dkwon17 commented Jun 19, 2024 •

edited

Loading