Prepare environment for async storage of project sources #16972

vparfonov · 2020-05-19T12:44:58Z

Signed-off-by: Vitalii Parfonov [email protected]

What does this PR do?

This PR will introduce a new experimental feature which should provide fast I/O and give ability to persist your changes. In other words this is new kind of storage with fast I/O like in Ephemeral Mode but with saving changes like in traditional Persistent Mode.

For this we introduce special plugin which will be automatically added to workspace configuration in case user select this type of storage. Plugin will initiate restore command on workspace startup and backup all sources on workspace stop, also changes will be periodically backup during workspace is running (e.g. each 5 or 10 minutes).

During restore procedure events with information about restore process sent via WebScoket connection and client (like Che Theia) can show this information in UI.

For backup/restore procedure used rsync (https://rsync.samba.org/) via SSH connection.

The special pod will start in OpenShift environment in user namespace, it will respond for storing files. In other words plugin it’s rsync client, storage pod - rsync server.

Here initial for plugin and storage: Initial contribution for workspace sync feature #2

For establishing secure connection special pair of SSH keys will be generated if they don't exist and mount to the plugin container (private part) and to the storage pod (public part).

IMPORTANT: This feature at the moment will work only with common PVC strategy.

If other (or current workspace) configured to the to use the traditional persistent mode,
to prevent getting 'Multi-Attach error for volume' asynchronous storage pod will be shutdown. After deleting asynchronous storage pod procedure of starting workspace will be continued as usual.

To try this PR you can use this devfile:

metadata:
  name: jerry-second-ws
attributes:
  persistVolumes: 'false'
  asyncPersist: 'true'
components:
  - id: che-incubator/typescript/latest
    type: chePlugin
  - mountSources: true
    endpoints:
      - name: angular
        port: 4200
    memoryLimit: 1Gi
    type: dockerimage
    alias: nodejs
    image: 'quay.io/eclipse/che-nodejs10-community:7.12.1'
apiVersion: 1.0.0

Ready to use images:
che-server: vparfonov/che-server:0708
che-plugin-registry: vparfonov/che-plugin-registry:0708

What issues does this PR fix or reference?

Release Notes

Docs PR

che-bot · 2020-05-19T12:51:28Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "crw-ci-test" to rerun happy path E2E test.

che-bot · 2020-05-26T12:12:49Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot · 2020-05-26T15:39:10Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot · 2020-05-27T09:01:06Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties

...java/org/eclipse/che/workspace/infrastructure/openshift/OpenShiftEnvironmentProvisioner.java

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java

...st/java/org/eclipse/che/workspace/infrastructure/openshift/OpenShiftInternalRuntimeTest.java

che-bot · 2020-05-28T10:56:18Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot · 2020-05-28T13:07:27Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "crw-ci-test" to rerun happy path E2E test.

che-bot · 2020-06-30T10:13:06Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "[crw-ci-test]" to rerun happy path E2E test.

che-bot · 2020-07-07T10:47:01Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "[crw-ci-test]" to rerun happy path E2E test.

che-bot · 2020-07-07T11:52:18Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot · 2020-07-07T21:04:40Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

Signed-off-by: Vitalii Parfonov <[email protected]>

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java

sparkoo · 2020-07-15T06:40:15Z

Does it work only on OpenShift?

vparfonov · 2020-07-15T06:46:17Z

Does it work only on OpenShift?

Yes, at the moment

…at() Signed-off-by: Vitalii Parfonov <[email protected]>

ibuziuk · 2020-07-15T07:39:46Z

@vparfonov could you please create an issue for the k8s support

sparkoo · 2020-07-15T07:50:22Z

Does it work only on OpenShift?

Yes, at the moment

Is there any hard technical reason? Like are you using some OpenShift only stuff? I would assume to go k8s first.

che-bot · 2020-07-15T07:56:59Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "[crw-ci-test]" to rerun happy path E2E test.

vparfonov · 2020-07-15T09:02:15Z

Does it work only on OpenShift?

Yes, at the moment

Is there any hard technical reason? Like are you using some OpenShift only stuff? I would assume to go k8s first.

Any technical reason, we want to try it this on che.openshift.io firstly

vparfonov · 2020-07-15T09:10:42Z

@vparfonov could you please create an issue for the k8s support

#17408

vparfonov · 2020-07-15T09:11:17Z

[crw-ci-test]

che-bot · 2020-07-15T09:30:32Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:16972

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

sparkoo · 2020-07-15T10:25:32Z

Does it work only on OpenShift?

Yes, at the moment

Is there any hard technical reason? Like are you using some OpenShift only stuff? I would assume to go k8s first.

Any technical reason, we want to try it this on che.openshift.io firstly

yes, but usually, the base code implements k8s and only places where there are any OpenShift specifics we extend k8s class with OpenShift stuff. This looks like #17408 will be fixed by moving OpenShift classes into kubernetes module and bind them in KubernetesInfraModule. It's not a blocker, it just look like unnecessary complication and does not follow usual procedure.

vparfonov · 2020-07-15T13:52:30Z

@metlos @skabashnyuk @sparkoo @mshaposhnik any other comments ?

sparkoo

I don't like that documentation is moved to another issue. It violates the "definition of done" what we're trying to define and honor. But let's move this forward.

metlos

Just a few nitpicks in the validator + guarding against NPEs in map lookups. Otherwise LGTM.

.../main/java/org/eclipse/che/workspace/infrastructure/openshift/AsyncStorageModeValidator.java

metlos · 2020-07-15T14:41:59Z

.../main/java/org/eclipse/che/workspace/infrastructure/openshift/AsyncStorageModeValidator.java

+  }
+
+  private void runtimesPerUserValidation() throws ValidationException {
+    if (runtimesPerUser > 1) {


This can be evaluated in the constructor just once.

.../main/java/org/eclipse/che/workspace/infrastructure/openshift/AsyncStorageModeValidator.java

metlos · 2020-07-15T14:42:48Z

.../main/java/org/eclipse/che/workspace/infrastructure/openshift/AsyncStorageModeValidator.java

+  }
+
+  private void pvcStrategyValidation() throws ValidationException {
+    if (!COMMON_STRATEGY.equals(pvcStrategy)) {


This can be evaluated in the constructor just once.

.../main/java/org/eclipse/che/workspace/infrastructure/openshift/AsyncStorageModeValidator.java

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java

vparfonov · 2020-07-15T15:30:37Z

Just a few nitpicks in the validator + guarding against NPEs in map lookups. Otherwise LGTM.

Create issue for these changes #17420

Signed-off-by: Vitalii Parfonov <[email protected]>

* Various fixes after meging PR #16972 * Improving condition for che.limits.user.workspaces.run.count checking Signed-off-by: Vitalii Parfonov <[email protected]>

che-bot added the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label May 19, 2020

vparfonov removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label May 19, 2020

che-bot added the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label May 26, 2020

vparfonov force-pushed the rsync_ssh branch from 67084f0 to 1405511 Compare May 26, 2020 15:18

vparfonov marked this pull request as ready for review May 27, 2020 08:37

vparfonov requested review from amisevsk, ibuziuk, l0rd, metlos, mshaposhnik, nickboldt, skabashnyuk and sleshchenko as code owners May 27, 2020 08:37

vparfonov changed the title ~~Prepare environment for async storage of project sources~~ [WIP] 🚧 Prepare environment for async storage of project sources May 27, 2020

ibuziuk reviewed May 27, 2020

View reviewed changes

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties Outdated Show resolved Hide resolved

ibuziuk reviewed May 27, 2020

View reviewed changes

...java/org/eclipse/che/workspace/infrastructure/openshift/OpenShiftEnvironmentProvisioner.java Outdated Show resolved Hide resolved

ibuziuk reviewed May 27, 2020

View reviewed changes

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java Outdated Show resolved Hide resolved

ibuziuk reviewed May 27, 2020

View reviewed changes

...st/java/org/eclipse/che/workspace/infrastructure/openshift/OpenShiftInternalRuntimeTest.java Outdated Show resolved Hide resolved

vparfonov force-pushed the rsync_ssh branch from 6200ff4 to 3875489 Compare July 7, 2020 21:21

Prepare environment for async storage of project sources

ae23e81

Signed-off-by: Vitalii Parfonov <[email protected]>

sparkoo reviewed Jul 15, 2020

View reviewed changes

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java Outdated Show resolved Hide resolved

sparkoo reviewed Jul 15, 2020

View reviewed changes

...va/org/eclipse/che/workspace/infrastructure/openshift/provision/AsyncStorageProvisioner.java Show resolved Hide resolved

Fix typos. Use better name for variable. Remove redundant String.form…

bf6d626

…at() Signed-off-by: Vitalii Parfonov <[email protected]>

vparfonov mentioned this pull request Jul 15, 2020

Enable Asynchronous Storage feature for K8s environment #17408

Closed

apupier mentioned this pull request Jul 15, 2020

Include Java Language Support in Camel K stack #16018

Closed

This was referenced Jul 15, 2020

[documentation] Add documentation about Asynchronous Storage feature #17409

Closed

Adapt Asynchronous Storage feature to 'unique' and 'per-workspace' PVC strategies #17410

Closed

ibuziuk mentioned this pull request Jul 15, 2020

Async PV for workspace: enabling feature (toggle) #15960

Closed

sparkoo approved these changes Jul 15, 2020

View reviewed changes

metlos reviewed Jul 15, 2020

View reviewed changes

vparfonov mentioned this pull request Jul 15, 2020

Improvements in AsyncStorageModeValidator: move all possible checks to the constructor in this case they will be evaluated just once. #17420

Closed

vparfonov merged commit 3dd86e8 into master Jul 15, 2020

vparfonov deleted the rsync_ssh branch July 15, 2020 15:50

che-bot removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Jul 15, 2020

l0rd added the new&noteworthy For new and/or noteworthy issues that deserve a blog post, new docs, or emphasis in release notes label Jul 19, 2020

vparfonov added a commit that referenced this pull request Jul 20, 2020

Various fixes after meging PR #16972

aa7cacf

Signed-off-by: Vitalii Parfonov <[email protected]>

vparfonov mentioned this pull request Jul 20, 2020

Various fixes after merging PR #16972 #17447

Merged

vparfonov added a commit that referenced this pull request Jul 21, 2020

Various fixes after merging PR #16972 (#17447)

4a86e07

* Various fixes after meging PR #16972 * Improving condition for che.limits.user.workspaces.run.count checking Signed-off-by: Vitalii Parfonov <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare environment for async storage of project sources #16972

Prepare environment for async storage of project sources #16972

vparfonov commented May 19, 2020 •

edited

Loading

che-bot commented May 19, 2020

che-bot commented May 26, 2020

che-bot commented May 26, 2020

che-bot commented May 27, 2020

che-bot commented May 28, 2020

che-bot commented May 28, 2020

che-bot commented Jun 30, 2020

che-bot commented Jul 7, 2020

che-bot commented Jul 7, 2020

che-bot commented Jul 7, 2020

sparkoo commented Jul 15, 2020

vparfonov commented Jul 15, 2020

ibuziuk commented Jul 15, 2020

sparkoo commented Jul 15, 2020

che-bot commented Jul 15, 2020

vparfonov commented Jul 15, 2020

vparfonov commented Jul 15, 2020

vparfonov commented Jul 15, 2020

che-bot commented Jul 15, 2020

sparkoo commented Jul 15, 2020

vparfonov commented Jul 15, 2020

sparkoo left a comment

metlos left a comment

metlos Jul 15, 2020

metlos Jul 15, 2020

vparfonov Jul 15, 2020

vparfonov commented Jul 15, 2020

Prepare environment for async storage of project sources #16972

Prepare environment for async storage of project sources #16972

Conversation

vparfonov commented May 19, 2020 • edited Loading

What does this PR do?

IMPORTANT: This feature at the moment will work only with common PVC strategy.

What issues does this PR fix or reference?

Release Notes

Docs PR

che-bot commented May 19, 2020

che-bot commented May 26, 2020

che-bot commented May 26, 2020

che-bot commented May 27, 2020

che-bot commented May 28, 2020

che-bot commented May 28, 2020

che-bot commented Jun 30, 2020

che-bot commented Jul 7, 2020

che-bot commented Jul 7, 2020

che-bot commented Jul 7, 2020

sparkoo commented Jul 15, 2020

vparfonov commented Jul 15, 2020

ibuziuk commented Jul 15, 2020

sparkoo commented Jul 15, 2020

che-bot commented Jul 15, 2020

vparfonov commented Jul 15, 2020

vparfonov commented Jul 15, 2020

vparfonov commented Jul 15, 2020

che-bot commented Jul 15, 2020

sparkoo commented Jul 15, 2020

vparfonov commented Jul 15, 2020

sparkoo left a comment

Choose a reason for hiding this comment

metlos left a comment

Choose a reason for hiding this comment

metlos Jul 15, 2020

Choose a reason for hiding this comment

metlos Jul 15, 2020

Choose a reason for hiding this comment

vparfonov Jul 15, 2020

Choose a reason for hiding this comment

vparfonov commented Jul 15, 2020

vparfonov commented May 19, 2020 •

edited

Loading