Proposal 25 - variant 1 - define stacks

[davidfestal]

What does this PR do?

This PR includes, into the DevWorkspace API / Devfile 2.0 schema, the required syntax that was agreed on in order to allow to define stacks by introducing the concept of parent.

Examples

• To use a parent devfile in a devfile 2.0 and add a command:

name: with-parent
schemaVersion: 2.0.0
parent:
  uri: https://raw.githubusercontent.com/che-incubator/devworkspace-api/proposal-25-variant-1-define-stacks/devfile-support/samples/nodejs-stack.devfile.yaml
commands:
  - exec:
      label: Say Hello
      commandLine: echo "hello"
      component: nodejs

• To use a parent devfile in a DevWorkspace Custom resource and add a command:

apiVersion: "workspaces.ecd.eclipse.org/v1alpha1"
kind: "DevWorkspace"
metadata:
  "name": "with-nodejs-devfile-parent"
spec:
  started: true
  template:
    parent:
      uri: https://raw.githubusercontent.com/che-incubator/devworkspace-api/proposal-25-variant-1-define-stacks/devfile-support/samples/nodejs-stack.devfile.yaml
    commands:
      - exec:
          label: Say Hello
          commandLine: echo "hello"
          component: nodejs

• To use a DevWorkspaceTemplate Custom Resource as a parent in a DevWorkspace Custom resource and add a command:

apiVersion: "workspaces.ecd.eclipse.org/v1alpha1"
kind: "DevWorkspace"
metadata:
  "name": "with-nodejs-template-parent"
spec:
  started: true
  template:
    parent:
      kubernetes:
        name: nodejs-stack
        namespace: stacks
    commands:
      - exec:
          label: Say Hello
          commandLine: echo "hello"
          component: nodejs

What issues does this PR fix or reference?

Related syntax proposal is in issue #25

Is your PR tested? Consider putting some instruction how to test your changes

Yes, it has been tested in POCs on both the Odo side and the Che Workspace Operator side.

[che-osio-probot-app]

Open Developer Workspace:

[sleshchenko]

I saw that there is convention in go related to abbreviatures, like userId must be userID. VSCode seems the right writing

Suggested change

	VscodeConfigurationCommandLocation `json:",inline"`
	VSCodeConfigurationCommandLocation `json:",inline"`

[davidfestal]

Afaik this general GO convention isn't very consistent with K8S APIs practices (and bube-builder requirements): in many cases, the GO Struct field name should be consistent (apart from the 1st letter) with the json / yaml field name specified in the related tag.

Maybe we'd rather disable this GO linting rule since it seems it will not be possible to apply it everywhere, at least in the K8S API packages

[davidfestal]

BTW if we think it is something that should still be done (though I don't know how due to kube-builder constraints), I'd rather do it globally in a distinct PR, as a distinct issue.

[amisevsk]

In general, I've seen

VSCodeConfigurationCommandLocation `json:vscodeConfigurationCommandLocation",inline"`

e.g. https://github.com/kubernetes/api/blob/b1350b9e3bc2ae69d6ea049ce1a637799a916e7d/auditregistration/v1alpha1/types.go#L175,

but I also don't know all the details and requirements.

[sleshchenko]

I wonder what if the parent already contains command, component, project with such identifier(name, alias)...
Is it a valid configuration? If yes - then how we merge objects, do we merge them or just override?

[davidfestal]

We replace (override) them when they have the same key (component alias, command name, project name, etc ...), and add them if not.
It's a simple rule that has been agreed on in a first round of this.
Future iterations might come later with the ability to:

• remove a top-level element of a parent (project, command, component),
• even provide more complete json-patch directives.

However the goal is to make this simple and fully validated for the typical use-case tackled by this PR.

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[che-osio-probot-app]

Open Developer Workspace:

[amisevsk]

+1 with additional improvements in a future issue.

[che-osio-probot-app]

Open Developer Workspace: