Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

handle all fields of repository che-editor.yaml file #20715

Closed
benoitf opened this issue Nov 2, 2021 · 0 comments · Fixed by eclipse-che/che-dashboard#396
Closed

handle all fields of repository che-editor.yaml file #20715

benoitf opened this issue Nov 2, 2021 · 0 comments · Fixed by eclipse-che/che-dashboard#396
Assignees
Labels
area/factory/dashboard Issues related to factories frontend (che user dashboard side) engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.

Comments

@benoitf
Copy link
Contributor

benoitf commented Nov 2, 2021

Is your task related to a problem? Please describe

For now, we can have a .che/che-editor.yaml file but it's not following the expected syntax

We should have override capabilities and allow to specify id, registryUrl etc

This is defined by issue #18668

che-editor.yaml
# Contains the spec of just ONE editor. 
# Here I am providing 3 examples separted with ---
---
# EXAMPLE 1 - registry reference
id: eclipse/che-theia/nigthly         # mandatory
registryUrl: https://my-registry.com  # optional
override:                             # optional
  containers:
    - name: theia-ide
      memoryLimit: 1280Mi
---
# EXAMPLE 2 - web reference
reference: https://gist.github.com/.../che-editor.yaml # mandatory
override:                                              # optional
  containers:
      - name: theia-ide
        memoryLimit: 1280Mi 
---
# EXAMPLE 3 - inline
inline:        # <--- that's current syntax of https://github.com/eclipse/che-plugin-registry/blob/master/che-editors.yaml
               #      but we should use devfile v2 instead 
  endpoints:
    - name: "theia"
      public: true
      targetPort: 3100
      attributes:
        protocol: http
        type: ide
        secure: true
        cookiesAuthEnabled: true
        discoverable: false
    (...)
  containers:
    - name: theia-ide
      image: "quay.io/eclipse/che-theia:next"
      env:
        - name: THEIA_PLUGINS
          value: local-dir:///plugins
      volumeMounts:
        - name: plugins
          path: "/plugins"
        - name: theia-local
          path: "/home/theia/.theia"
      mountSources: true
      ports:
        - exposedPort: 3100
      memoryLimit: "512M"
      cpuLimit: 1000m
      cpuRequest: 100m
  initContainers:
    - name: remote-runtime-injector
      image: "quay.io/eclipse/che-theia-endpoint-runtime-binary:next"
      volumeMounts:
        - name: remote-endpoint
          path: "/remote-endpoint"
          ephemeral: true
      env:
        - name: PLUGIN_REMOTE_ENDPOINT_EXECUTABLE
          value: /remote-endpoint/plugin-remote-endpoint
        - name: REMOTE_ENDPOINT_VOLUME_NAME
          value: remote-endpoint

Describe the solution you'd like

Override capabilities, id or reference support

Describe alternatives you've considered

No response

Additional context

No response

@benoitf benoitf added kind/task Internal things, technical debt, and to-do tasks to be performed. engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. area/factory/dashboard Issues related to factories frontend (che user dashboard side) labels Nov 2, 2021
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Nov 2, 2021
@azatsarynnyy azatsarynnyy added severity/P2 Has a minor but important impact to the usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Nov 2, 2021
benoitf added a commit to eclipse-che/che-dashboard that referenced this issue Nov 8, 2021
Handle id, reference and inline and override properties
Fixes eclipse-che/che#20715
@benoitf benoitf self-assigned this Nov 8, 2021
benoitf added a commit to eclipse-che/che-dashboard that referenced this issue Nov 10, 2021
Handle id, reference and inline and override properties
Fixes eclipse-che/che#20715
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/factory/dashboard Issues related to factories frontend (che user dashboard side) engine/devworkspace Issues related to Che configured to use the devworkspace controller as workspace engine. kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants