feat: Add a predefined configmap to store theia preferences

[vinokurig]

Signed-off-by: Igor Vinokur ivinokur@redhat.com

What does this PR do?

• Create a predefined K8s secret per nemaespace to store theia preferences.
• Include the preference secret to the workspcae-secrets role, to be able to manage it outside.

See #172 (comment)

Screenshot/screencast of this PR

What issues does this PR fix or reference?

eclipse-che/che#20622

How to test this PR?

1. Start a workspace and open a terminal from the ide container.
2. Send an HTTP request to the kubernetes API to edit user-preferences secret: curl -X POST <kubernetes API url>/api/v1/namespaces/<namespace name>/secrets/workspace-theia-secret --header "Content-Type: application/json-patch+json" -d '[{ "op": "add", "path": "/data", "value": { "key": "" } }]'

PR Checklist

As the author of this Pull Request I made sure that:

• The Eclipse Contributor Agreement is valid
• Code produced is complete
• Code builds without errors
• Tests are covering the bugfix
• The repository devfile is up to date and works
• Sections What issues does this PR fix or reference and How to test this PR completed
• Relevant user documentation updated
• Relevant contributing documentation updated
• CI/CD changes implemented, documented and communicated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

[che-bot]

✅ E2E Happy path tests succeed 🎉

See Details

• Jenkins job

• test report

• logs and configs

• Happy path tests DevFile

• image: quay.io/crw_pr/che-server:174

Test product:

• tested with Eclipse Che on K8S (minikube v1.22.0)
• E2E test scenario
• E2E test pipeline source code

• Use comment "[crw-ci-test]" to rerun happy path E2E test.
• Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Eclipse Che QE channel: https://mattermost.eclipse.org/eclipse/channels/eclipse-che-qe

[metlos]

Is this secret bound to a workspace or to a namespace/user? Would it make sense to label or annotate these secrets?

[che-bot]

✅ E2E Happy path tests succeed 🎉

See Details

• Jenkins job

• test report

• logs and configs

• Happy path tests DevFile

• image: quay.io/crw_pr/che-server:174

Test product:

• tested with Eclipse Che on K8S (minikube v1.22.0)
• E2E test scenario
• E2E test pipeline source code

• Use comment "[crw-ci-test]" to rerun happy path E2E test.
• Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Eclipse Che QE channel: https://mattermost.eclipse.org/eclipse/channels/eclipse-che-qe

[vinokurig]

@metlos

Is this secret bound to a workspace or to a namespace/user?

The secret is bound to a namespace/user.

Would it make sense to label or annotate these secrets?

There is no label in the current workspace-credentials-secret which has similar purpose. Please propose one, if it is really needed.

[skabashnyuk]

Are we going to have a separate secret for each ide? Should we make the name of it ide-neutral? For example editor-preferences?

[svor]

@vinokurig would it be a problem to save preferences of all editors in one secret?

[benoitf]

Are we going to have a separate secret for each ide? Should we make the name of it ide-neutral? For example editor-preferences?

I think it's what @l0rd wanted (preferences per ide)

[skabashnyuk]

Are we going to have a separate secret for each ide? Should we make the name of it ide-neutral? For example editor-preferences?

I think it's what @l0rd wanted (preferences per ide)

Can we do that in a way that we don't need to adjust che-server's source code for each?
For example one-secret with prefixed properties?

[benoitf]

I would say for sure it makes sense that as there are multiple editors and we don't know all editors in advance, it should be generic enough

[vinokurig]

@svor @skabashnyuk @benoitf @l0rd Renamed the secret to workspace-preferences-secret so that we can use it as a single secret for all editors

[che-bot]

✅ E2E Happy path tests succeed 🎉

See Details

• Jenkins job

• test report

• logs and configs

• Happy path tests DevFile

• image: quay.io/crw_pr/che-server:174

Test product:

• tested with Eclipse Che on K8S (minikube v1.22.0)
• E2E test scenario
• E2E test pipeline source code

• Use comment "[crw-ci-test]" to rerun happy path E2E test.
• Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Eclipse Che QE channel: https://mattermost.eclipse.org/eclipse/channels/eclipse-che-qe

[l0rd]

I am ok with this approach

[vinokurig]

I am going to merge it after the che-theia part is finished.

[vinokurig]

@skabashnyuk @l0rd From the discussion here it was decided to use config-map for storing preferences. My last commit reworks the PR to use config-map instead of secret, could you please take a look?

[vinokurig]

depends on eclipse-che/che-operator#1180

[che-bot]

❌ E2E Happy path tests failed ❗

See Details

• Jenkins job

• test report

• logs and configs

• Happy path tests DevFile

• image: quay.io/crw_pr/che-server:174

Test product:

• tested with Eclipse Che on K8S (minikube v1.22.0)
• E2E test scenario
• E2E test pipeline source code

• Use comment "[crw-ci-test]" to rerun happy path E2E test.
• Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Eclipse Che QE channel: https://mattermost.eclipse.org/eclipse/channels/eclipse-che-qe

[che-bot]

✅ E2E Happy path tests succeed 🎉

See Details

• Jenkins job

• test report

• logs and configs

• Happy path tests DevFile

• image: quay.io/crw_pr/che-server:174

Test product:

• tested with Eclipse Che on K8S (minikube v1.22.0)
• E2E test scenario
• E2E test pipeline source code

• Use comment "[crw-ci-test]" to rerun happy path E2E test.
• Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Eclipse Che QE channel: https://mattermost.eclipse.org/eclipse/channels/eclipse-che-qe

[svor]

@skabashnyuk ok to merge?