Merge pull request #890 from eclipse-che/dwo_dep

feat: Add DevWorkspace as a dependency in che operator

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

@@ -0,0 +1,57 @@
+#!/bin/bash
+#
+# Copyright (c) 2019-2021 Red Hat, Inc.
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+# Contributors:
+#   Red Hat, Inc. - initial API and implementation
+
+# exit immediately when a command fails
+set -e
+# only exit with zero if all commands of the pipeline exit successfully
+set -o pipefail
+# error on unset variables
+set -u
+
+################################ !!!   IMPORTANT   !!! ################################
+########### THIS JOB USE openshift ci operators workflows to run  #####################
+##########  More info about how it is configured can be found here: https://docs.ci.openshift.org/docs/how-tos/testing-operator-sdk-operators #############
+######### Script which install the given bundles from stable-all-namespace https://steps.ci.openshift.org/reference/optional-operators-subscribe ##########
+######## !!! Related PR in openshift CI is: https://github.com/openshift/release/pull/20610 ##############################################################
+#######################################################################################################################################################
+
+
+export OPERATOR_REPO=$(dirname $(dirname $(readlink -f "$0")));
+source "${OPERATOR_REPO}"/.github/bin/common.sh
+source "${OPERATOR_REPO}"/.github/bin/oauth-provision.sh
+
+#Stop execution on any error
+trap "catchFinish" EXIT SIGINT
+
+overrideDefaults() {
+  export DEV_WORKSPACE_ENABLE="true"
+  export CHE_EXPOSURE_STRATEGY="single-host"
+}
+
+runTests() {
+    # create namespace
+    oc create namespace eclipse-che || true
+
+    # Deploy Eclipse Che applying CR
+    applyOlmCR
+    waitEclipseCheDeployed "${LAST_PACKAGE_VERSION}"
+
+    sleep 10s
+    createWorkspaceDevWorkspaceCheOperator
+    waitAllPodsRunning ${DEVWORKSPACE_CHE_OPERATOR_TEST_NAMESPACE}
+}
+
+initDefaults
+overrideDefaults
+provisionOpenShiftOAuthUser
+initStableTemplates "openshift" "stable"
+runTests

.gitignore

@@ -118,6 +118,7 @@ bundle/nightly/eclipse-che-preview-kubernetes/generated
 bundle/nightly/eclipse-che-preview-openshift/generated
 bundle/stable/eclipse-che-preview-kubernetes/generated
 bundle/stable/eclipse-che-preview-openshift/generated
+bundle/stable-all-namespaces/eclipse-che-preview-openshift/generated
 
 testbin/setup-envtest.sh
 

README.md

@@ -133,10 +133,31 @@ spec:
 
 5. Deploy Che operator:
 
+
 ```bash
 $ chectl server:deploy --installer=olm --platform=<CHECTL_SUPPORTED_PLATFORM> --catalog-source-yaml <PATH_TO_CUSTOM_CATALOG_SOURCE_YAML> --olm-channel=nightly --package-manifest-name=eclipse-che-preview-<openshift|kubernetes>
 ```
 
+### Deploy stable Che operator in Cluster Wide Availability
+
+Eclipse Che introduced a new channel which installs Eclipse Che in AllNamespace mode with Devworkspace Operator like an OLM dependency.
+More info about DevWorkspace Operator can be found [here](https://github.com/devfile/devworkspace-operator).
+
+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
+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).
+* `stable-all-namespaces` channel is supported only in OpenShift.
+
+If the OpenShift Cluster already have all these considerations done you can proceed to install the Eclipse Che using stable-all-namespaces channel from OperatorHub or using the new channel you need to perform the following chectl command:
+
+```bash
+chectl server:deploy --installer=olm --platform=openshift --olm-channel=stable-all-namespaces
+```
+
 ### Deploy Che operator using operator-sdk
 
 > WARNING: Cluster Admin privileges are required

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

@@ -0,0 +1,21 @@
+FROM scratch
+
+# Core bundle labels.
+LABEL operators.operatorframework.io.bundle.mediatype.v1=registry+v1
+LABEL operators.operatorframework.io.bundle.manifests.v1=manifests/
+LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
+LABEL operators.operatorframework.io.bundle.package.v1=eclipse-che-preview-openshift
+LABEL operators.operatorframework.io.bundle.channels.v1=stable-all-namespaces
+LABEL operators.operatorframework.io.bundle.channel.default.v1=stable-all-namespaces
+LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.7.1+git
+LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
+LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
+
+# Labels for testing.
+LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1
+LABEL operators.operatorframework.io.test.config.v1=tests/scorecard/
+
+# Copy files to locations specified by labels.
+COPY manifests /manifests/
+COPY metadata /metadata/
+COPY tests/scorecard /tests/scorecard/

bundle/stable-all-namespaces/eclipse-che-preview-openshift/manifests/org.eclipse.che_chebackupserverconfigurations_crd.yaml

@@ -0,0 +1,125 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.4.1
+  creationTimestamp: null
+  name: chebackupserverconfigurations.org.eclipse.che
+spec:
+  group: org.eclipse.che
+  names:
+    kind: CheBackupServerConfiguration
+    listKind: CheBackupServerConfigurationList
+    plural: chebackupserverconfigurations
+    singular: chebackupserverconfiguration
+  scope: Namespaced
+  versions:
+  - name: v1
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: CheBackupServerConfigurationSpec defines the desired state of CheBackupServerConfiguration Only one type of backup server is allowed to be configured per CR.
+            properties:
+              awss3:
+                description: Amazon S3 or compatible alternatives.
+                properties:
+                  awsAccessKeySecretRef:
+                    description: Reference to secret that contains awsAccessKeyId and awsSecretAccessKey keys.
+                    type: string
+                  hostname:
+                    description: Server hostname, defaults to 's3.amazonaws.com'. Might be customized in case of alternative server.
+                    type: string
+                  port:
+                    description: Backup server port. Usually default value is used. Might be customized in case of alternative server.
+                    type: integer
+                  protocol:
+                    description: Protocol to use when connection to the server. Might be customized in case of alternative server.
+                    type: string
+                  repositoryPasswordSecretRef:
+                    description: Holds reference to a secret with restic repository password under 'repo-password' field to encrypt / decrypt its content.
+                    type: string
+                  repositoryPath:
+                    description: Bucket name and repository, e.g. bucket/repo
+                    type: string
+                required:
+                - awsAccessKeySecretRef
+                - repositoryPasswordSecretRef
+                - repositoryPath
+                type: object
+              rest:
+                description: Rest backup server configuration.
+                properties:
+                  credentialsSecretRef:
+                    description: Secret that contains username and password fields to login into restic server. Note, each repository is encrypted with own password. See ResticRepoPasswordSecretRef field.
+                    type: string
+                  hostname:
+                    description: Backup server host
+                    type: string
+                  port:
+                    description: Backup server port
+                    type: integer
+                  protocol:
+                    description: Protocol to use when connection to the server Defaults to https.
+                    type: string
+                  repositoryPasswordSecretRef:
+                    description: Holds reference to a secret with restic repository password under 'repo-password' field to encrypt / decrypt its content.
+                    type: string
+                  repositoryPath:
+                    description: Restic repository path
+                    type: string
+                required:
+                - hostname
+                - repositoryPasswordSecretRef
+                type: object
+              sftp:
+                description: Sftp backup server configuration.
+                properties:
+                  hostname:
+                    description: Backup server host
+                    type: string
+                  port:
+                    description: Backup server port
+                    type: integer
+                  repositoryPasswordSecretRef:
+                    description: Holds reference to a secret with restic repository password under 'repo-password' field to encrypt / decrypt its content.
+                    type: string
+                  repositoryPath:
+                    description: Restic repository path, relative or absolute, e.g. /srv/repo
+                    type: string
+                  sshKeySecretRef:
+                    description: Private ssh key under 'ssh-privatekey' field for passwordless login
+                    type: string
+                  username:
+                    description: User login on the remote server
+                    type: string
+                required:
+                - hostname
+                - repositoryPasswordSecretRef
+                - repositoryPath
+                - sshKeySecretRef
+                - username
+                type: object
+            type: object
+          status:
+            description: CheBackupServerConfigurationStatus defines the observed state of CheBackupServerConfiguration
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []

bundle/stable-all-namespaces/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusterbackups_crd.yaml

@@ -0,0 +1,65 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.4.1
+  creationTimestamp: null
+  name: checlusterbackups.org.eclipse.che
+spec:
+  group: org.eclipse.che
+  names:
+    kind: CheClusterBackup
+    listKind: CheClusterBackupList
+    plural: checlusterbackups
+    singular: checlusterbackup
+  scope: Namespaced
+  versions:
+  - name: v1
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: CheClusterBackupSpec defines the desired state of CheClusterBackup
+            properties:
+              backupServerConfigRef:
+                description: Name of custom resource with a backup server configuration to use for this backup. Note, UseInternalBackupServer field can configure internal backup server automatically.
+                type: string
+              useInternalBackupServer:
+                description: Automatically setup pod with REST backup server and use the server in this configuration. Note, this flag takes precedence and will overwrite existing backup server configuration.
+                type: boolean
+            type: object
+          status:
+            description: CheClusterBackupStatus defines the observed state of CheClusterBackup
+            properties:
+              message:
+                description: Message explaining the state of the backup or an error message
+                type: string
+              snapshotId:
+                description: Last backup snapshot ID
+                type: string
+              stage:
+                description: Describes backup progress
+                type: string
+              state:
+                description: 'Backup progress state: InProgress, Failed, Succeeded'
+                type: string
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []

bundle/stable-all-namespaces/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusterrestores_crd.yaml

@@ -0,0 +1,62 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.4.1
+  creationTimestamp: null
+  name: checlusterrestores.org.eclipse.che
+spec:
+  group: org.eclipse.che
+  names:
+    kind: CheClusterRestore
+    listKind: CheClusterRestoreList
+    plural: checlusterrestores
+    singular: checlusterrestore
+  scope: Namespaced
+  versions:
+  - name: v1
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: CheClusterRestoreSpec defines the desired state of CheClusterRestore
+            properties:
+              backupServerConfigRef:
+                description: Name of custom resource with a backup server configuration to use for this restore. Can be omitted if only one server configuration object exists within the namespace.
+                type: string
+              snapshotId:
+                description: If omitted, latest snapshot will be used.
+                type: string
+            type: object
+          status:
+            description: CheClusterRestoreStatus defines the observed state of CheClusterRestore
+            properties:
+              message:
+                description: Restore result or error message
+                type: string
+              stage:
+                description: Describes phase of restore progress
+                type: string
+              state:
+                description: 'Restore progress state: InProgress, Failed, Succeeded'
+                type: string
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []