Bug 1844938: Migrate to DevWorkspace CR for the terminal #5687

amisevsk · 2020-06-08T05:08:25Z

Update the custom resource used for providing the OpenShift Web terminal to the DevWorkspace API to be more compatible going forward. This PR moves the GVK and spec used for terminals from

workspace.che.eclipse.org/v1alpha1/Workspaces

to

devfile.io/v1alpha1/DevWorkspaces

as is reflected in operator PR devfile/devworkspace-operator#92

There are additional compatibility changes included as well (e.g. required webhooks are renamed)

How to test

Build image and deploy to cluster
- You may need to add 'view webhooks' cluster role to the console as in PR Bug 1839621: Grant Console SA permissions to read webhooks configurations console-operator#432
Deploy Workspace operator from changes in Switch to DevWorkspace ( devfile 2.0 ) API devfile/devworkspace-operator#92 (using built image)
```
# In che-workspace-controller repo
export WEBHOOK_ENABLED=true
make deploy
```
Start a terminal using a non-cluster-admin user

I've built the changes in this PR as image docker.io/amisevsk/console:devworkspace-api to simplify testing.

openshift-ci-robot · 2020-06-08T05:08:28Z

@amisevsk: This pull request references Bugzilla bug 1844938, which is invalid:

expected the bug to target the "4.6.0" release, but it targets "---" instead

Comment /bugzilla refresh to re-evaluate validity if changes to the Bugzilla bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Bug 1844938: Migrate to DevWorkspace CR for the terminal

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/test-infra repository.

openshift-ci-robot · 2020-06-08T05:08:47Z

Hi @amisevsk. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

christianvogt · 2020-06-08T13:17:18Z

/bugzilla refresh

openshift-ci-robot · 2020-06-08T13:17:25Z

@christianvogt: This pull request references Bugzilla bug 1844938, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.6.0) matches configured target release for branch (4.6.0)
bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

/bugzilla refresh

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/test-infra repository.

davidfestal · 2020-06-08T13:19:35Z

frontend/packages/console-app/src/models/index.ts

  kind: 'DevWorkspace',
-  label: 'Devworkspace',
-  labelPlural: 'workspaces',
-  apiGroup: 'apiextensions.k8s.io',


This change seems strange: from apiextensions.k8s.io to devfile.io. Is it a CR or a CRD ?

Hmm. Good point -- I'll look into it.

The frontend needs to create/edit DevWorkspace instances, so devfile.io is the correct option here. You may be thinking of the earlier functionality that checked if the CRD was defined on the cluster for enabling/disabling the feature -- this has been replaced by a back-end endpoint.

frontend/packages/console-app/src/components/cloud-shell/cloud-shell-utils.ts

christianvogt · 2020-06-09T19:05:49Z

/ok-to-test

amisevsk · 2020-06-10T14:15:05Z

/retest

openshift-ci-robot · 2020-06-10T14:19:26Z

@amisevsk: This pull request references Bugzilla bug 1844938, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.6.0) matches configured target release for branch (4.6.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1844938: Migrate to DevWorkspace CR for the terminal

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/test-infra repository.

openshift-ci-robot · 2020-06-10T14:19:44Z

@amisevsk: This pull request references Bugzilla bug 1844938, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.6.0) matches configured target release for branch (4.6.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1844938: Migrate to DevWorkspace CR for the terminal

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/test-infra repository.

amisevsk · 2020-06-10T14:43:06Z

/retest

abhinandan13jan · 2020-06-11T11:59:21Z

frontend/packages/console-app/src/components/cloud-shell/cloud-shell-utils.ts

-export const CLOUD_SHELL_CREATOR_LABEL = 'org.eclipse.che.workspace/creator';
-export const CLOUD_SHELL_IMMUTABLE_ANNOTATION = 'org.eclipse.che.workspace/immutable';
+export const CLOUD_SHELL_CREATOR_LABEL = 'controller.devfile.io/creator';
+export const CLOUD_SHELL_IMMUTABLE_ANNOTATION = 'controller.devfile.io/restricted-access';


nit: Should it be better to name it CLOUD_SHELL_RESTRICTED_ANNOTATION ?
There are 2 other files to be changed in that case.

While I'm renaming the constants, should I name them WEB_TERMINAL_* as well, given the naming change? (cloud-shell -> web-terminal)

@amisevsk i'd keep it as cloud shell right now for consistency in the code as the entire feature is using cloud shell.
We don't surface cloud shell to the user.

Renamed to CLOUD_SHELL_RESTRICTED_ANNOTATION

christianvogt · 2020-06-11T17:16:46Z

front end changes lgtm

I tested the PR on cluster bot today and the DevWorkspace ran as expected.

amisevsk · 2020-06-11T17:32:10Z

From testing with @christianvogt, using a Foreground propagation policy results in resources not being removed; I've updated the model to use Background.

Update the custom resource used for providing the OpenShift Web terminal to the DevWorkspace API to be more compatible going forward. Signed-off-by: Sergii Leshchenko <sleshche@redhat.com>

spadgett

/approve
/lgtm

We should follow up about the propagation policy

spadgett · 2020-06-11T17:44:28Z

frontend/packages/console-app/src/models/index.ts

  apiVersion: 'v1alpha1',
  abbr: 'DW',
  namespaced: true,
  crd: true,
  plural: 'devworkspaces',
-  propagationPolicy: 'Foreground',
+  propagationPolicy: 'Background',


We should determine what isn't getting garbage collected. This doesn't necessarily fix the underlying problem since there's still some resource that isn't deleted.

It looks to be related to kubernetes/kubernetes#90512

Created issue eclipse-che/che#17146 with more details, but I still have no idea what resource isn't being cleaned up here -- all owned objects are removed but e.g. the deployment is stuck with a foregroundDeletion finalizer.

Figured this one out -- the workspace controller webhooks were blocking the removal of the foregroundDeletion finalizer. This is fixed by devfile/devworkspace-operator#107.

Is there a preference between foreground and background deletion here? The default for cli tools is background.

christianvogt · 2020-06-11T18:29:39Z

/cherry-pick release-4.5.z

openshift-cherrypick-robot · 2020-06-11T18:29:39Z

@christianvogt: once the present PR merges, I will cherry-pick it on top of release-4.5.z in a new PR and assign it to you.

In response to this:

/cherry-pick release-4.5.z

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/test-infra repository.

sleshchenko

Still LGTM =)

openshift-ci-robot · 2020-06-11T20:09:54Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amisevsk, sleshchenko, spadgett

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [spadgett]

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

openshift-ci-robot · 2020-06-11T21:46:33Z

@amisevsk: All pull requests linked via external trackers have merged: openshift/console#5687. Bugzilla bug 1844938 has been moved to the MODIFIED state.

In response to this:

Bug 1844938: Migrate to DevWorkspace CR for the terminal

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/test-infra repository.

openshift-cherrypick-robot · 2020-06-11T21:46:49Z

@christianvogt: cannot checkout release-4.5.z: error checking out release-4.5.z: exit status 1. output: error: pathspec 'release-4.5.z' did not match any file(s) known to git.

In response to this:

/cherry-pick release-4.5.z

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/test-infra repository.

rohitkrai03 · 2020-06-15T09:44:37Z

/cherry-pick release-4.5

openshift-cherrypick-robot · 2020-06-15T09:44:46Z

@rohitkrai03: new pull request created: #5730

In response to this:

/cherry-pick release-4.5

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/test-infra repository.

openshift-ci-robot added the bugzilla/severity-unspecified Referenced Bugzilla bug's severity is unspecified for the PR. label Jun 8, 2020

openshift-ci-robot added the bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. label Jun 8, 2020

openshift-ci-robot requested review from jeff-phillips-18 and jhadvig June 8, 2020 05:08

openshift-ci-robot added component/backend Related to backend component/core Related to console core functionality needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 8, 2020

openshift-ci-robot removed the bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. label Jun 8, 2020

davidfestal reviewed Jun 8, 2020

View reviewed changes

sleshchenko approved these changes Jun 9, 2020

View reviewed changes

frontend/packages/console-app/src/components/cloud-shell/cloud-shell-utils.ts Outdated Show resolved Hide resolved

openshift-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 9, 2020

abhinandan13jan reviewed Jun 11, 2020

View reviewed changes

amisevsk force-pushed the devworkpsace-crd branch from 5c1b240 to 8681df6 Compare June 11, 2020 13:11

amisevsk force-pushed the devworkpsace-crd branch from ae9bf77 to 9425cda Compare June 11, 2020 17:31

Migrate to DevWorkspace CR for the terminal

50dbb66

Update the custom resource used for providing the OpenShift Web terminal to the DevWorkspace API to be more compatible going forward. Signed-off-by: Sergii Leshchenko <sleshche@redhat.com>

amisevsk force-pushed the devworkpsace-crd branch from 9425cda to 50dbb66 Compare June 11, 2020 17:46

spadgett approved these changes Jun 11, 2020

View reviewed changes

openshift-ci-robot assigned spadgett Jun 11, 2020

openshift-ci-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 11, 2020

sleshchenko approved these changes Jun 11, 2020

View reviewed changes

openshift-merge-robot merged commit 2715a74 into openshift:master Jun 11, 2020

sleshchenko deleted the devworkpsace-crd branch June 15, 2020 08:48

sleshchenko mentioned this pull request Jun 15, 2020

[devworkspace-api] Propagate devfile 2.0 and related changes to console eclipse-che/che#17097

Closed

openshift-cherrypick-robot mentioned this pull request Jun 15, 2020

[release-4.5] Bug 1846969: Migrate to DevWorkspace CR for the terminal #5730

Merged

spadgett added this to the v4.6 milestone Jun 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug 1844938: Migrate to DevWorkspace CR for the terminal #5687

Bug 1844938: Migrate to DevWorkspace CR for the terminal #5687

amisevsk commented Jun 8, 2020 •

edited

openshift-ci-robot commented Jun 8, 2020

openshift-ci-robot commented Jun 8, 2020

christianvogt commented Jun 8, 2020

openshift-ci-robot commented Jun 8, 2020

davidfestal Jun 8, 2020

amisevsk Jun 8, 2020

amisevsk Jun 8, 2020

davidfestal Jun 8, 2020

christianvogt commented Jun 9, 2020

amisevsk commented Jun 10, 2020

openshift-ci-robot commented Jun 10, 2020

openshift-ci-robot commented Jun 10, 2020

amisevsk commented Jun 10, 2020

abhinandan13jan Jun 11, 2020

amisevsk Jun 11, 2020

christianvogt Jun 11, 2020

amisevsk Jun 11, 2020

christianvogt commented Jun 11, 2020

amisevsk commented Jun 11, 2020

spadgett left a comment

spadgett Jun 11, 2020

amisevsk Jun 11, 2020

amisevsk Jun 11, 2020

amisevsk Jun 11, 2020

christianvogt commented Jun 11, 2020

openshift-cherrypick-robot commented Jun 11, 2020

sleshchenko left a comment

openshift-ci-robot commented Jun 11, 2020

openshift-ci-robot commented Jun 11, 2020

openshift-cherrypick-robot commented Jun 11, 2020

rohitkrai03 commented Jun 15, 2020

openshift-cherrypick-robot commented Jun 15, 2020

Bug 1844938: Migrate to DevWorkspace CR for the terminal #5687

Bug 1844938: Migrate to DevWorkspace CR for the terminal #5687

Conversation

amisevsk commented Jun 8, 2020 • edited

How to test

openshift-ci-robot commented Jun 8, 2020

openshift-ci-robot commented Jun 8, 2020

christianvogt commented Jun 8, 2020

openshift-ci-robot commented Jun 8, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christianvogt commented Jun 9, 2020

amisevsk commented Jun 10, 2020

openshift-ci-robot commented Jun 10, 2020

openshift-ci-robot commented Jun 10, 2020

amisevsk commented Jun 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christianvogt commented Jun 11, 2020

amisevsk commented Jun 11, 2020

spadgett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christianvogt commented Jun 11, 2020

openshift-cherrypick-robot commented Jun 11, 2020

sleshchenko left a comment

Choose a reason for hiding this comment

openshift-ci-robot commented Jun 11, 2020

openshift-ci-robot commented Jun 11, 2020

openshift-cherrypick-robot commented Jun 11, 2020

rohitkrai03 commented Jun 15, 2020

openshift-cherrypick-robot commented Jun 15, 2020

amisevsk commented Jun 8, 2020 •

edited