feat: Add DevWorkspace as a dependency in che operator #890

flacatus · 2021-07-06T14:16:11Z

What does this PR do?

Create a new channel to install Che Operator in AllNamespace Mode:

Install Che using stable-all-namespaces channel

To install Eclipse Che in cluster wide availability after uploading the new bundles for stable-all-namespaces we need to go to OperatorHub, select Eclipse Che and then select the new channel stable-all-namespaces. By default the che operator will be installed in AllNamespace mode and will start to listen for all CheCluster APIS in all cluster.

Migrate che from single Namespace mode to all Namespace mode

If you already have an Eclipse Che installed from stable/nightly channel and you want to try the new channel you need to consider the following:

It is not possible to have Eclipse Che installed in single Namespace (currently the default one) and then try to install Che in All Namespace mode using the new channel stable-all-namespaces.
To update to stable-all-namespaces channel you need first to remove all subscriptions created for che installed from nightly or stable channels. IMPORTANT: Removing subscriptions doesn’t mean Eclipse Che operands(che-server, keycloak or roles) will be removed from the cluster.
DevWorkspace engine will be by default enabled in the new channel.

In case if you have already installed Che with devWorkspace enabled from channels nightly or stable you need to uninstall DevWorkspace completely from the cluster and then install the Che Operator using stable-all-namespaces channel.

If you already have all these considerations done you can proceed to install the Che Operator from the OperatorHub using the new channel and the operator will start to manage the resources previously created by the old operators.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

eclipse-che/che#19891

How to test this PR?

Create a new Catalog Source with the new channel and Devworkspace Operator:

export CRW_CATALOG_SOURCE=$(
      oc create -f - -o jsonpath='{.metadata.name}' <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  generateName: che-catalog-
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/flacatus/eclipse-che-openshift-opm-catalog:preview
  displayName: Eclipse Che Catalog
  publisher: Eclipse Che
  updateStrategy:
    registryPoll: 
      interval: 30m
EOF
)

echo "Che Catalog: ${CRW_CATALOG_SOURCE}"

export DWO_CATALOG_SOURCE=$(
      oc create -f - -o jsonpath='{.metadata.name}' <<EOF
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  generateName: dwo-catalog-
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/devfile/devworkspace-operator-index:next
  displayName: DevWorkspace Catalog
  publisher: DevWorkspace
  updateStrategy:
    registryPoll: 
      interval: 30m
EOF
)

Install The new stable-all-namespaces channel from Operator Hub:

Installation Results:

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.

pkg/deploy/dev-workspace/dev_workspace.go

tolusha · 2021-07-07T08:54:36Z

rename channel to stable-all-namespaces (check with OLM team)
update release scripts
keep the same version (check with OLM team)
update chectl to install Eclipse Che from the new channel
update olm/README.md to mention how to install Eclipse Che from the new channel
document how to switch Eclipse Che from one channel to another (channel promotion ?)

bundle/stable-all-namespaces/eclipse-che-preview-openshift/bundle.Dockerfile

...espaces/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml.diff

...lipse-che-preview-openshift/manifests/org.eclipse.che_chebackupserverconfigurations_crd.yaml

bundle/stable-all-namespaces/eclipse-che-preview-openshift/metadata/dependencies.yaml

olm/prepare-community-operators-update.sh

olm/release-olm-files.sh

pkg/deploy/dev-workspace/dev_workspace.go

olm/prepare-community-operators-update.sh

.ci/oci-stable-all-namespaces.sh

make-release.sh

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

sleshchenko

I was not able to test it precisely but nothing critical found.

Two important things:

we need to sync on target openshift version.
I'm not sure if operator should install DWO resources directly, because potentially it can lead to two controllers on the cluster, which would break the stuff.

README.md

sleshchenko · 2021-07-28T10:00:53Z

README.md

+* To update to stable-all-namespaces channel you need first to remove all subscriptions created for che installed from nightly or stable
+channels. IMPORTANT: Removing subscriptions doesn’t mean Eclipse Che operands(che-server, keycloak or roles) will be removed from the cluster.
+* DevWorkspace engine will be by default enabled in the new channel.
+* In case if you have already installed Che with DevWorkspace engine enabled from channels nightly or stable you need to remove all DevWorkspace resources from the cluster following the next [scripts](https://github.com/devfile/devworkspace-operator/blob/main/build/make/deploy.mk#L77).


what about DevWorkspace Che Operator resources(in devworkpsace-che-operator namespace)? Then also may exist, but I see that it's not really related to the new channel.

README.md

sleshchenko · 2021-07-28T10:05:20Z

bundle/stable-all-namespaces/eclipse-che-preview-openshift/bundle.Dockerfile

+FROM scratch
+
+# Core bundle labels.
+LABEL operators.operatorframework.io.bundle.mediatype.v1=registry+v1


We need to sync on which OpenShift versions it's supported.
DWO seems to be available only on OpenShift 4.8+ see here
if lower version is needed - we need to sync how it affects Web Terminals

bundle/stable-all-namespaces/eclipse-che-preview-openshift/metadata/dependencies.yaml

pkg/deploy/dev-workspace/dev_workspace.go

sleshchenko · 2021-07-28T11:01:46Z

pkg/deploy/dev-workspace/dev_workspace.go

@@ -113,6 +116,12 @@ func ReconcileDevWorkspace(deployContext *deploy.DeployContext) (bool, error) {
 		return true, nil
 	}

+	// Check if exists devworkspace operator csv is already installed
+	devWorkspaceOperatorCSVExists := isDevWorkspaceControllerCSVExists(deployContext)
+	if devWorkspaceOperatorCSVExists {


As far as I understand it means that if you install Che with chectl operator installer, DWO will be installed from resources but not with OLM dependency, which may be unexpected in some corner cases, like when WTO is installed after Che with chectl operator installer.

So, I would say Che on OpenShift should install DWO with olm, or at least into openshift-operators namespace...

Yes, make sense your comments. I think we need to have a dedicate issue for this.

openshift-ci · 2021-07-28T11:03:10Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: flacatus, mkuznyetsov, sleshchenko, 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

openshift-ci · 2021-07-28T11:22:45Z

New changes are detected. LGTM label has been removed.

flacatus · 2021-07-28T11:39:25Z

/retest

openshift-ci · 2021-07-28T11:55:39Z

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

Test name	Commit	Details	Rerun command
ci/prow/v7-devworkspace-happy-path	`e73a7bc`	link	`/test v7-devworkspace-happy-path`
ci/prow/v8-multi-host-nightly-deployment	`e73a7bc`	link	`/test v8-multi-host-nightly-deployment`
ci/prow/v8-single-host-nightly-deployment	`e73a7bc`	link	`/test v8-single-host-nightly-deployment`
ci/prow/v8-che-behind-proxy	`e73a7bc`	link	`/test v8-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/test-infra repository. I understand the commands that are listed here.

AndrienkoAleksandr · 2021-07-28T12:02:05Z

README.md

+Before installing Eclipse Che using channel `stable-all-namespaces` we need to consider the following:
+
+* It is not possible to have Eclipse Che installed in single Namespace (currently the default one) and then try to install Che in All Namespace mode using the new channel stable-all-namespaces.
+* To update to stable-all-namespaces channel you need first to remove all subscriptions created for che installed from nightly or stable


Minor: che => Che

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

flacatus requested review from AndrienkoAleksandr, mmorhun, nickboldt and tolusha as code owners July 6, 2021 14:16

flacatus marked this pull request as draft July 6, 2021 14:16

openshift-ci bot added the do-not-merge/work-in-progress label Jul 6, 2021

flacatus force-pushed the dwo_dep branch 2 times, most recently from d9b8db1 to 23eba87 Compare July 6, 2021 14:26

flacatus commented Jul 6, 2021

View reviewed changes

pkg/deploy/dev-workspace/dev_workspace.go Outdated Show resolved Hide resolved

sleshchenko mentioned this pull request Jul 9, 2021

feat: Make DevWorkspaceRouting a pre-requisite of che-operator. #894

Closed

11 tasks

tolusha mentioned this pull request Jul 12, 2021

Che Deploy Sprint #204 eclipse-che/che#20085

Closed

24 tasks

openshift-ci bot added the needs-rebase label Jul 16, 2021

sleshchenko added this to the 7.34 milestone Jul 20, 2021

openshift-ci bot removed needs-rebase labels Jul 25, 2021

flacatus force-pushed the dwo_dep branch from b3b936c to 23eba87 Compare July 25, 2021 10:07

openshift-ci bot added needs-rebase labels Jul 25, 2021

flacatus closed this Jul 25, 2021

flacatus force-pushed the dwo_dep branch from 23eba87 to b9ccdb7 Compare July 25, 2021 10:08

flacatus reopened this Jul 25, 2021

openshift-ci bot removed needs-rebase labels Jul 25, 2021

flacatus force-pushed the dwo_dep branch 3 times, most recently from e6c06a5 to 49103d6 Compare July 25, 2021 22:15

tolusha mentioned this pull request Jul 26, 2021

Che Deploy Sprint #205 eclipse-che/che#20194

Closed

31 tasks

tolusha reviewed Jul 26, 2021

View reviewed changes

flacatus marked this pull request as ready for review July 26, 2021 09:12

tolusha reviewed Jul 27, 2021

View reviewed changes

olm/prepare-community-operators-update.sh Show resolved Hide resolved

flacatus force-pushed the dwo_dep branch from 02481b1 to 052abd2 Compare July 27, 2021 08:46

flacatus changed the title ~~feat: Add DevWorkspace like a dependency in che operator~~ feat: Add DevWorkspace as a dependency in che operator Jul 27, 2021

tolusha approved these changes Jul 27, 2021

View reviewed changes

.ci/oci-stable-all-namespaces.sh Show resolved Hide resolved

openshift-ci bot assigned tolusha Jul 27, 2021

openshift-ci bot added the lgtm label Jul 27, 2021

flacatus force-pushed the dwo_dep branch from 052abd2 to 78e150f Compare July 27, 2021 10:17

openshift-ci bot removed the lgtm label Jul 27, 2021

flacatus mentioned this pull request Jul 27, 2021

[DO NOT APPROVE] feat: Create e2e tests for stable-all-namespaces channel openshift/release#20610

Closed

flacatus force-pushed the dwo_dep branch from 78e150f to 46a9573 Compare July 27, 2021 10:29

flacatus requested a review from nickboldt July 27, 2021 12:20

mkuznyetsov reviewed Jul 27, 2021

View reviewed changes

make-release.sh Outdated Show resolved Hide resolved

fix: update unit tests and update e2e description

f8e0577

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

flacatus force-pushed the dwo_dep branch from 46a9573 to f8e0577 Compare July 27, 2021 13:24

mkuznyetsov approved these changes Jul 27, 2021

View reviewed changes

openshift-ci bot assigned mkuznyetsov Jul 27, 2021

openshift-ci bot added the lgtm label Jul 27, 2021

sleshchenko approved these changes Jul 28, 2021

View reviewed changes

openshift-ci bot assigned sleshchenko Jul 28, 2021

openshift-ci bot removed the lgtm label Jul 28, 2021

AndrienkoAleksandr reviewed Jul 28, 2021

View reviewed changes

fix suggestions

1624742

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

flacatus force-pushed the dwo_dep branch from e73a7bc to 1624742 Compare July 28, 2021 12:20

flacatus merged commit 8d90bb1 into main Jul 28, 2021

flacatus deleted the dwo_dep branch July 28, 2021 12:20

flacatus mentioned this pull request Jul 28, 2021

feat: Add support to install che using stable-all-namespaces olm channel che-incubator/chectl#1478

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add DevWorkspace as a dependency in che operator #890

feat: Add DevWorkspace as a dependency in che operator #890

flacatus commented Jul 6, 2021 •

edited

tolusha commented Jul 7, 2021

sleshchenko left a comment

sleshchenko Jul 28, 2021

sleshchenko Jul 28, 2021

flacatus Jul 28, 2021

sleshchenko Jul 28, 2021

flacatus Jul 28, 2021

openshift-ci bot commented Jul 28, 2021

openshift-ci bot commented Jul 28, 2021

flacatus commented Jul 28, 2021

openshift-ci bot commented Jul 28, 2021

AndrienkoAleksandr Jul 28, 2021

feat: Add DevWorkspace as a dependency in che operator #890

feat: Add DevWorkspace as a dependency in che operator #890

Conversation

flacatus commented Jul 6, 2021 • edited

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

tolusha commented Jul 7, 2021

sleshchenko left a comment

Choose a reason for hiding this comment

sleshchenko Jul 28, 2021

Choose a reason for hiding this comment

sleshchenko Jul 28, 2021

Choose a reason for hiding this comment

flacatus Jul 28, 2021

Choose a reason for hiding this comment

sleshchenko Jul 28, 2021

Choose a reason for hiding this comment

flacatus Jul 28, 2021

Choose a reason for hiding this comment

openshift-ci bot commented Jul 28, 2021

openshift-ci bot commented Jul 28, 2021

flacatus commented Jul 28, 2021

openshift-ci bot commented Jul 28, 2021

AndrienkoAleksandr Jul 28, 2021

Choose a reason for hiding this comment

flacatus commented Jul 6, 2021 •

edited