Convert Web Terminal Operator to depend on DevWorkspace Operator #80

amisevsk · 2021-05-26T19:49:46Z

What does this PR do?

Removes duplication of CRDs/images from DevWorkspace Operator and configures this operator to depend on the DevWorkspace Operator.

What issues does this PR fix or reference?

Part of devfile/devworkspace-operator#407

Is it tested? How?

Simple: apply the catalogsource below which references bundles built from this PR and devfile/devworkspace-operator#438

cat <<EOF | oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: custom-devworkspace-demo-catalog
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/amisevsk/devworkspace-demo-index:dev
  publisher: Angel Misevski
  displayName: DevWorkspace + Web Terminal integration demo
EOF

Manual:

Add catalogsource for DWO
1. Checkout Add requirements for working with OLM devfile/devworkspace-operator#438 locally
2. Export DWO_BUNDLE_IMG and DWO_INDEX_IMG as appropriate
3. Run make generate_olm_bundle_image generate_olm_index_image
4. Add catalogsource: make register_catalogsource
Add new catalogsource for DWO
1. Build bundle and index: make build
2. Register catalogsource: make register_catalogsource
Install operator through OperatorHub UI in OpenShift. Note: there will be two options for "Web Terminal Operator". The correct one has Version 1.3.0

Screencast:

install-wto.mp4

manifests/web-terminal.clusterserviceversion.yaml

sleshchenko

LGTM
I'm just not sure about initialization-resource. It works fine for Che and CRW, where user is proposed to create CheCluster CR, but I don't this suites well for our use-case.

manifests/web-terminal.clusterserviceversion.yaml

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

pkg/config/constants.go

sleshchenko · 2021-06-04T11:49:42Z

Makefile

@@ -1,77 +1,57 @@
 SHELL := bash
 .SHELLFLAGS = -ec

+WTO_IMG ?= quay.io/wto/web-terminal-operator:latest
 BUNDLE_IMG ?= quay.io/wto/web-terminal-operator-metadata:next


One day we should rename it to WTO_BUNDLE_IMG

Yeah I tried to leave the existing variables functionality untouched. Other future improvements:

make build builds the bundle and index, make build_controller_image builds the "controller"

Building the controller image is relegated to a separate makefile, when it should maybe be the reverse, as we have in DWO

build/bin/entrypoint

build/dockerfiles/deployment.Dockerfile

build/makefiles/deployment.mk

go.mod

main.go

web-terminal-sample.yaml

sleshchenko · 2021-06-07T11:36:13Z

.gitignore

@@ -1,2 +1,3 @@
-dependencies
+.idea


manifests/web-terminal.clusterserviceversion.yaml

sleshchenko · 2021-06-07T11:42:29Z

manifests/web-terminal.clusterserviceversion.yaml

@@ -357,6 +190,8 @@ spec:
    name: David Festal
  - email: jpinkney@redhat.com
    name: Josh Pinkney
+  - email: amisevsk@redhat.com
+    name: Angel Misevski


for the line below... Since we need to request users to delete and install it, maybe we should remove replaces: but it's just dymmy assumption that may not work at all. Maybe there is another way OLM suggests for such case.

metadata/dependencies.yaml

sleshchenko · 2021-06-07T11:55:32Z

pkg/webterminal/tooling.go

+		return client.Create(ctx, specDWT)
+	}
+
+	// TODO: Figure out way to sync DWTs for updates to WTO.


just update it if it exists? )

I wanted to avoid that because we have no way of knowing if the DWTs are different because they were created by a previous version of WTO or if they're different because a user modified them on purpose :).

Either way, it's not a problem we need to fix until the second WTO release after this change 😄

sleshchenko · 2021-06-08T12:41:20Z

manifests/web-terminal.clusterserviceversion.yaml

    strategy: deployment
  installModes:
  - supported: false
    type: OwnNamespace
-  - supported: false
+  - supported: true


We need to test how it will behave if we disable multinamespace and probably drop it, since it's the just we drop it, since anyway we force users to reinstall WTO from scratch.

sleshchenko

It's good enough so, I'm OK with listing TODOs items and merging as is.

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add a basic program that ensures DevWorkspaceTemplates used by Web Terminal are present in the openshift-operators namespace. Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Signed-off-by: Josh Pinkney <joshpinkney@gmail.com>

singlenamespace mode Signed-off-by: Josh Pinkney <joshpinkney@gmail.com>

amisevsk · 2021-06-09T02:04:44Z

Rebased and autosquashed.

amisevsk requested review from JPinkney and sleshchenko as code owners May 26, 2021 19:49

amisevsk mentioned this pull request May 26, 2021

Add an ability to configure digest evaluation method #79

Merged

JPinkney reviewed May 26, 2021

View reviewed changes

manifests/web-terminal.clusterserviceversion.yaml Outdated Show resolved Hide resolved

manifests/web-terminal.clusterserviceversion.yaml Outdated Show resolved Hide resolved

sleshchenko reviewed May 27, 2021

View reviewed changes

manifests/web-terminal.clusterserviceversion.yaml Outdated Show resolved Hide resolved

manifests/web-terminal.clusterserviceversion.yaml Outdated Show resolved Hide resolved

sleshchenko mentioned this pull request May 31, 2021

Adapt Che Operator to use DevWorkspace operator as OLM dependency eclipse-che/che#19891

Closed

amisevsk added 4 commits June 2, 2021 13:53

Remove DWO manifests and script for syncing dependencies

12c23e0

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Update CSV to reuse DWO and add dependencies.yaml to metadata

a3bb0da

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Cleanup Makefile and remove rules that are no longer needed

a1c8210

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add DevWorkspaces and DevWorkspaceTemplates to required CRDs in CSV

4fc19f5

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

amisevsk force-pushed the dwo-integration branch from cd58df3 to 1792f99 Compare June 2, 2021 23:04

amisevsk mentioned this pull request Jun 4, 2021

Update Web Terminal custom resources to use v1alpha2 openshift/console#9144

Merged

sleshchenko reviewed Jun 4, 2021

View reviewed changes

JPinkney reviewed Jun 4, 2021

View reviewed changes

go.mod Outdated Show resolved Hide resolved

main.go Outdated Show resolved Hide resolved

web-terminal-sample.yaml Show resolved Hide resolved

sleshchenko reviewed Jun 7, 2021

View reviewed changes

sleshchenko reviewed Jun 8, 2021

View reviewed changes

sleshchenko approved these changes Jun 8, 2021

View reviewed changes

amisevsk and others added 9 commits June 8, 2021 22:03

Create new Go project to manage Web Terminal DWTs

149020a

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add basic implementation of web terminal operator for deploying DWTs

c66945e

Add a basic program that ensures DevWorkspaceTemplates used by Web Terminal are present in the openshift-operators namespace. Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add DWT-sync deployment to operator and add Makefile rules for build

0fe7774

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add sample web terminal for testing

dfdc620

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Add license headers to all go files

3f2c452

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

Update CSV alm-sample to reflect newer Web Terminal (v1alpha2)

e6119ff

Signed-off-by: Angel Misevski <amisevsk@redhat.com>

fix: rename container name to web-terminal-controller

0be1621

Signed-off-by: Josh Pinkney <joshpinkney@gmail.com>

fix: set minimum devworkspace-operator dependency to version 0.6.0

e5dd419

Signed-off-by: Josh Pinkney <joshpinkney@gmail.com>

feat: Add in openshift-operators suggested namespace and enable

c44dfc3

singlenamespace mode Signed-off-by: Josh Pinkney <joshpinkney@gmail.com>

amisevsk force-pushed the dwo-integration branch from d81de61 to c44dfc3 Compare June 9, 2021 02:04

sleshchenko merged commit 8966d50 into redhat-developer:main Jun 9, 2021

amisevsk deleted the dwo-integration branch June 10, 2021 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert Web Terminal Operator to depend on DevWorkspace Operator #80

Convert Web Terminal Operator to depend on DevWorkspace Operator #80

amisevsk commented May 26, 2021

sleshchenko left a comment

sleshchenko Jun 4, 2021

amisevsk Jun 5, 2021

sleshchenko Jun 7, 2021

sleshchenko Jun 7, 2021

sleshchenko Jun 7, 2021

amisevsk Jun 9, 2021

sleshchenko Jun 8, 2021

sleshchenko left a comment

amisevsk commented Jun 9, 2021

		@@ -1,2 +1,3 @@
		dependencies
		.idea

Convert Web Terminal Operator to depend on DevWorkspace Operator #80

Convert Web Terminal Operator to depend on DevWorkspace Operator #80

Conversation

amisevsk commented May 26, 2021

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

sleshchenko left a comment

Choose a reason for hiding this comment

sleshchenko Jun 4, 2021

Choose a reason for hiding this comment

amisevsk Jun 5, 2021

Choose a reason for hiding this comment

sleshchenko Jun 7, 2021

Choose a reason for hiding this comment

sleshchenko Jun 7, 2021

Choose a reason for hiding this comment

sleshchenko Jun 7, 2021

Choose a reason for hiding this comment

amisevsk Jun 9, 2021

Choose a reason for hiding this comment

sleshchenko Jun 8, 2021

Choose a reason for hiding this comment

sleshchenko left a comment

Choose a reason for hiding this comment

amisevsk commented Jun 9, 2021