feat: support workspace defaults #1395

olexii4 · 2022-06-02T15:24:00Z

Signed-off-by: Oleksii Orel oorel@redhat.com

What does this PR do?

Add support for workspace default editor and workspace default components.

Example:

spec:
  server:
    workspaceDefaultComponents:
      - name: universal-developer-image
        container:
            image: quay.io/devfile/universal-developer-image:ubi8-latest
    workspaceDefaultEditor: eclipse/che-theia/next

Screenshot/screencast of this PR

What issues does this PR fix or reference?

It needs for eclipse-che/che#21353

How to test this PR?

cat EOF << > /tmp/patch.yaml
<PATCH_CONTENT>
EOF

chectl server:deploy \
     --installer operator \
     --platform <PLATFORM_TO_DEPLOY> \
     --che-operator-image <CUSTOM_OPERATOR_IMAGE> \
     --che-operator-cr-patch-yaml /tmp/patch.yaml

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.

api/v1/checluster_types.go

codecov · 2022-06-03T08:38:26Z

Codecov Report

Merging #1395 (3bfa497) into main (08de5aa) will not change coverage.
The diff coverage is n/a.

❗ Current head 3bfa497 differs from pull request most recent head b657f2d. Consider uploading reports for the commit b657f2d to get more accurate results

@@           Coverage Diff           @@
##             main    #1395   +/-   ##
=======================================
  Coverage   63.27%   63.27%           
=======================================
  Files          70       70           
  Lines        5827     5827           
=======================================
  Hits         3687     3687           
  Misses       1777     1777           
  Partials      363      363

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 08de5aa...b657f2d. Read the comment docs.

ibuziuk

@amisevsk @l0rd could you please review in conjunction with devfile/devworkspace-operator#844
are we good with the format described in the eclipse-che/che#21353

As I recall last time we discussed more explicit definition - defaultContainer and defaultEditor

ibuziuk · 2022-06-03T09:21:06Z

@tolusha maybe to avoid confusion lets merge #1324 first ?
Basically, the resulting definition should be smth like this:

devEnvironments:
  (...)
  defaultContainer: |
    name: universal-developer-image
    image: quay.io/devfile/universal-developer-image:ubi8-latest
    memoryRequest: 256M
    memoryLimit: 1536M
    cpuRequest: 0.1
    cpuLimit: 0.5
  defaultEditor: eclipse/che-theia/next

tolusha · 2022-06-03T12:55:01Z

Agree. let's wait for #1324

amisevsk

Generally LGTM, but could use some improved docs. I also wonder how this will interplay with #1324, I suspect it'll cause merge conflicts.

Edit: should have read the existing discussion -- apologies there.

api/v1/checluster_types.go

amisevsk

At this point it will also be necessary to add these fields to the v2 spec and implement conversion between the two -- I can help with that if you like.

api/v2/checluster_types.go

amisevsk

LGTM 👍

Thanks @olexii4

api/v2/checluster_types.go

ibuziuk · 2022-06-20T10:13:21Z

api/v2/checluster_types.go

+	DefaultEditor string `json:"defaultEditor,omitempty"`
+	// Default components applied to DevWorkspaces.
+	// These default components are meant to be used when a Devfile, that does not contain any components.
+	// +optional
+	DefaultComponents []devfile.Component `json:"defaultComponents,omitempty"`


@l0rd please, take a look at the final structure we are planning to have in place:

devEnvironments: (...) defaultComponents [ ] defaultEditor: ""

Any concerns?

ibuziuk

@olexii4 LGTM
could you please update the description with the new v2 format. Currently it still shows an old CR format with obsolete server instead of devEnvironments

openshift-ci · 2022-06-20T10:15:02Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: amisevsk, ibuziuk, olexii4

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 · 2022-06-20T10:17:11Z

New changes are detected. LGTM label has been removed.

tolusha · 2022-06-20T10:40:06Z

[10:22:59] → CustomResourceDefinition.apiextensions.k8s.io "checlusters.org.eclipse.che" is invalid: [spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[container].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[container].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[commands].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[commands].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[container].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[container].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[0].schema.openAPIV3Schema.properties[spec].properties[server].properties[workspaceDefaultComponents].items.properties[plugin].properties[components].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[container].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[container].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[commands].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[commands].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[container].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[container].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[kubernetes].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[0].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural, spec.versions[1].schema.openAPIV3Schema.properties[spec].properties[devEnvironments].properties[defaultComponents].items.properties[plugin].properties[components].items.properties[openshift].properties[endpoints].items.properties[attributes].allOf[1].x-kubernetes-preserve-unknown-fields: Forbidden: must be false to be structural]

tolusha · 2022-06-20T14:33:00Z

@amisevsk Did you face such kind the problem?

amisevsk · 2022-06-20T18:15:05Z

@tolusha Hmmm, I remember there being some issues with preserveUnknownFields in the devfile/api but I don't remember what was done to fix it.

tolusha · 2022-06-22T10:38:48Z

I see difference in CRD generation

devfile:

                                  attributes:
                                    description: "Map of implementation-dependant
                                      string-based free-form attributes. \n Examples
                                      of Che-specific attributes: \n - cookiesAuthEnabled:
                                      \"true\" / \"false\", \n - type: \"terminal\"
                                      / \"ide\" / \"ide-dev\","
                                    type: object
                                    x-kubernetes-preserve-unknown-fields: true

operator:

                                attributes:
                                    additionalProperties:
                                      x-kubernetes-preserve-unknown-fields: true
                                    allOf:
                                    - x-kubernetes-preserve-unknown-fields: true
                                    - x-kubernetes-preserve-unknown-fields: true
                                    description: "Map of implementation-dependant
                                      string-based free-form attributes. \n Examples
                                      of Che-specific attributes: \n - cookiesAuthEnabled:
                                      \"true\" / \"false\", \n - type: \"terminal\"
                                      / \"ide\" / \"ide-dev\","
                                    type: object

Signed-off-by: Oleksii Orel <oorel@redhat.com>

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha · 2022-06-22T11:27:49Z

Switched to a new controller-gen version (v0.4.1 -> v0.7.0)
It seems v0.4.1 has a bug

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha · 2022-06-22T12:35:24Z

/retest

openshift-ci · 2022-06-22T13:24:51Z

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

Test name	Commit	Details	Required	Rerun command
ci/prow/v9-devworkspace-happy-path	`5a051a3`	link	true	`/test v9-devworkspace-happy-path`
ci/prow/v8-operator-test	`5a051a3`	link	true	`/test v8-operator-test`

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.

olexii4 requested review from nickboldt, tolusha, AndrienkoAleksandr and flacatus as code owners June 2, 2022 15:24

olexii4 force-pushed the CHE-21353 branch from 50bbdb2 to 7b6ba4a Compare June 2, 2022 15:28

tolusha reviewed Jun 3, 2022

View reviewed changes

api/v1/checluster_types.go Outdated Show resolved Hide resolved

ibuziuk requested a review from amisevsk June 3, 2022 09:10

ibuziuk reviewed Jun 3, 2022

View reviewed changes

amisevsk approved these changes Jun 3, 2022

View reviewed changes

api/v1/checluster_types.go Outdated Show resolved Hide resolved

api/v1/checluster_types.go Outdated Show resolved Hide resolved

api/v1/checluster_types.go Outdated Show resolved Hide resolved

openshift-ci bot assigned amisevsk Jun 3, 2022

openshift-ci bot added lgtm needs-rebase and removed lgtm labels Jun 3, 2022

olexii4 force-pushed the CHE-21353 branch from 2c7f3da to 949d66d Compare June 15, 2022 13:43

openshift-ci bot removed the needs-rebase label Jun 15, 2022

olexii4 force-pushed the CHE-21353 branch from 949d66d to b26b943 Compare June 15, 2022 13:46

amisevsk reviewed Jun 16, 2022

View reviewed changes

olexii4 force-pushed the CHE-21353 branch from b2f6b46 to 3bfa497 Compare June 17, 2022 13:26

olexii4 commented Jun 17, 2022

View reviewed changes

api/v2/checluster_types.go Show resolved Hide resolved

amisevsk approved these changes Jun 17, 2022

View reviewed changes

api/v2/checluster_types.go Show resolved Hide resolved

openshift-ci bot added the lgtm label Jun 17, 2022

tolusha reviewed Jun 20, 2022

View reviewed changes

api/v2/checluster_types.go Outdated Show resolved Hide resolved

tolusha reviewed Jun 20, 2022

View reviewed changes

api/v2/checluster_types.go Outdated Show resolved Hide resolved

tolusha reviewed Jun 20, 2022

View reviewed changes

api/v2/checluster_types.go Outdated Show resolved Hide resolved

openshift-ci bot removed the lgtm label Jun 20, 2022

olexii4 force-pushed the CHE-21353 branch from b657f2d to 9328184 Compare June 20, 2022 09:44

ibuziuk reviewed Jun 20, 2022

View reviewed changes

ibuziuk approved these changes Jun 20, 2022

View reviewed changes

openshift-ci bot assigned ibuziuk Jun 20, 2022

openshift-ci bot added the lgtm label Jun 20, 2022

openshift-ci bot removed the lgtm label Jun 20, 2022

olexii4 and others added 5 commits June 22, 2022 14:25

feat: support workspace defaults

a07293f

Signed-off-by: Oleksii Orel <oorel@redhat.com>

fixup! feat: support workspace defaults

41edea3

Update dev resources

9450c03

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

Switch controller-gen from 0.4.1 to 0.7.0

c8b9af9

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

Update dev resources

d3ca300

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha force-pushed the CHE-21353 branch from bd97254 to d3ca300 Compare June 22, 2022 11:27

Update dev resources

5a051a3

Signed-off-by: Anatolii Bazko <abazko@redhat.com>

tolusha merged commit 3830ac4 into main Jun 22, 2022

tolusha deleted the CHE-21353 branch June 22, 2022 13:52

che-bot added this to the 7.50 milestone Jun 22, 2022

olexii4 mentioned this pull request Jun 23, 2022

Allow an admin to specify Che default editor and containers eclipse-che/che#21353

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support workspace defaults #1395

feat: support workspace defaults #1395

olexii4 commented Jun 2, 2022 •

edited

Loading

codecov bot commented Jun 3, 2022 •

edited

Loading

ibuziuk left a comment

ibuziuk commented Jun 3, 2022

tolusha commented Jun 3, 2022

amisevsk left a comment •

edited

Loading

amisevsk left a comment

amisevsk left a comment

ibuziuk Jun 20, 2022

ibuziuk left a comment

openshift-ci bot commented Jun 20, 2022

openshift-ci bot commented Jun 20, 2022

tolusha commented Jun 20, 2022 •

edited

Loading

tolusha commented Jun 20, 2022

amisevsk commented Jun 20, 2022

tolusha commented Jun 22, 2022

tolusha commented Jun 22, 2022 •

edited

Loading

tolusha commented Jun 22, 2022

openshift-ci bot commented Jun 22, 2022

feat: support workspace defaults #1395

feat: support workspace defaults #1395

Conversation

olexii4 commented Jun 2, 2022 • edited Loading

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

codecov bot commented Jun 3, 2022 • edited Loading

Codecov Report

ibuziuk left a comment

Choose a reason for hiding this comment

ibuziuk commented Jun 3, 2022

tolusha commented Jun 3, 2022

amisevsk left a comment • edited Loading

Choose a reason for hiding this comment

amisevsk left a comment

Choose a reason for hiding this comment

amisevsk left a comment

Choose a reason for hiding this comment

ibuziuk Jun 20, 2022

Choose a reason for hiding this comment

ibuziuk left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Jun 20, 2022

openshift-ci bot commented Jun 20, 2022

tolusha commented Jun 20, 2022 • edited Loading

tolusha commented Jun 20, 2022

amisevsk commented Jun 20, 2022

tolusha commented Jun 22, 2022

tolusha commented Jun 22, 2022 • edited Loading

tolusha commented Jun 22, 2022

openshift-ci bot commented Jun 22, 2022

olexii4 commented Jun 2, 2022 •

edited

Loading

codecov bot commented Jun 3, 2022 •

edited

Loading

amisevsk left a comment •

edited

Loading

tolusha commented Jun 20, 2022 •

edited

Loading

tolusha commented Jun 22, 2022 •

edited

Loading