New Che 7 Stacks

[l0rd]

Description

For Che 7 we want to release some new stacks that use the new ws.next based model and theia as editor.

Stacks guidelines

• User runtime components:
  • Use official images: instead of building and maintaining our own java, python, go etc...docker images we should rather leverage the official upstream ones (usually on the DockerHub). That has 2 advantages (1. we do not need to maintain them 2. we make sure that Che workspaces work with images built by the community and not only with images from che-dockerfiles) and one drawback (there may be some caveates like permissions and tools that we need to deal with).
  • Override entrypoint: usually the official images have a terminating entrypoint. To avoid that the container exits right away we have to override it:

    "containerCommand": "['sleep']",
    "containerArgs": "['infinity']"

  • Specify images versions and ideally we should use image SHA1 hash
• Memory settings. Workspaces are composed by an editor (usually Theia), one or more language servers and other plugins and a user runtime. We should provide enough memory for all of these components but we should avoid to require more than 4GB (3GB is current che.openshift.io limit):
  • Theia: 512MB should be enough ("sidecar.org.eclipse.che.editor.theia.memory_limit": "512Mi")
  • Language servers and other plugins: it depends on the particular plugin but every plugin should be tested to find the lower limit in the particular stack with the samples we provide. Once we have found the right value the memory limit should be set as a workspace configuration attribute: "sidecar.org.eclipse.che.vscode-redhat.java.memory_limit": "1024Mi"
  • User runtimes: same as language servers and other plugins but the memory should be set as a container attribute: "memoryLimitBytes": "512000000".
• Use Theia version next
• No default commands: it doesn't make sense to add default commands at the stack level. Commands should be defined at sample level.
• No servers: a Theia plugin is able to automatically figure out what ports need to be exposed, hence there is no need to spcify servers and preview urls anymore
• Tips to fix issues on OpenShift
  • Set HOME=/home/user: arbitrary users don't have a home folder defined in /etc/passwd hence we should define one and the convention is to set it to /home/user
  • Use volumes to bypass folders permissions: arbitrary users have restrictive access to some folders in runtime container. If the processes running in the container (e.g. mvn) need to access the folder a trick is to mount the folder as a volume:

  "volumes": {
    "m2": {
      "path": "/home/user/.m2"
  }}

  • define PS1: to have a nicer terminal we can configure PS1 environment variable
• Samples
  • Macro do not work on Theia (${current.project.path}): use environment variables instead and use the sample folder. For example: cd ${PROJECTS_PATH}/java-web-simple.
  • As for the user runtime components we should prefer samples that we do not need to maintain (i.e. vertx samples)

Current issues

Stacks list

Java

• Java Maven stack
  • the stack: maven official image + Java LS (@l0rd)
  • sample1: Console Java Simple (@l0rd)
  • sample2: Web Java Spring (@l0rd)
  • sample3: OpenShift.io vert.x booster (@l0rd)
  • sample4: The Game Of Life (@l0rd)
  • sample5: VertX Samples (@l0rd)
• Java Gradle stack (@l0rd)
  • the stack: gradle official image + Java LS @l0rd
  • sample1: Console Java Simple @l0rd
  • sample2: Web Java Spring @l0rd
• Java PostgreSQL stack (maven and postgres images as runtime and Java LS) @l0rd
  • the stack: maven official image + postgres official image + Java LS
  • sample1: Spring Boot Real World Example App @l0rd
  • sample2: PetClinic Multicontainers @l0rd
• Apache Camel stack Provide Camel stack for Che 7 #13182
  • the stack: maven official image + Camel LS + Java LS
  • the sample: Camel+SpringBoot
• Quarkus.io stack (quarkus.io image (TBD) as runtime and Java LS)
  • the stack: quarkus official image? + Java LS
  • the sample: Quarkus.io example

NodeJS

• Node 11 stack
  • the stack: node official image + Node Debug + TypeScript LS @l0rd
  • sample1: React real world example @l0rd
  • sample2: VueJS Real World Example App @l0rd
  • sample3: Angular Real World Example App @l0rd
• Node 11 Mongo stack
  • the stack: node official image + mongo official image + Node DBA + TypeScript LS @l0rd
  • the sample: Node/Express/Mongo Real World Example App @l0rd

Python

• Python 3 stack Python Stack #12944
  • the stack: python official image + Python LS @tolusha
  • sample1: Python Hello World @tolusha
  • sample2: Django real world example) @tolusha

.NET Core

• .NET Core stack @svor
  • the stack: .NET Core official image + OmniSharp
  • sample1: C# Hello World
  • sample2: ASP.NET Core real world example App

Go

• Go stack Go stack #13098
  • the stack: Golang official image + Go LS
  • sample1: Go Web Sample Application
  • sample2: Revel Chat samples seems to be broken, see Add Che7 Go stack and samples #13176
  • sample3: K8S Operator sample TBD
  • sample4: Go + Echo real world example app

PHP

• the stack: PHP official image + PHP LS
  • sample1: Hello World
  • sample2: Laravel Real World example App
  • sample3: [Symfony demo application](https://github.com/symfony/
  • sample4: Sample CRUD PHP+MySQL

Che Development

• Che-Theia Developer stack (c.f. sunix devfile)
  • the stack: che-theia-dev official image + Node DBA + TypeScript LS + YAML LS
  • the sample: Che-Theia + Theia + Theia Generator + Devfiles
• Che Server Developer stack (c.f. official devfile)
  • the stack: che-dev image + Java LS
  • the sample: Che
• VS Code Extension developer stack
  • the stack: TBD
  • vs code extension sample: TBD
• Theia Plugin developer stack
  • the stack: : TBD
  • theia plugin sample: : TBD
• Che plugin brokers
  • the stack: che-plugin-broker image + Go LS
  • the sample: Che Plugin broker
• Che documentation
  • the stack: TBD
  • the sample: Che documentation
• chectl (c.f. official devfile)
  • the stack: node official image + Node DBA + TypeScript LS
  • the sample: chectl
• che operator
  • the stack: che-plugin-broker image + Go LS
  • the sample: che-operator

Other misc

• Ansible stack Add an Ansible Stack #11877 (comment)
• Rails stack
  • Rails real world example app
• Rust stack
  • Rust real world example app

[l0rd]

cc @slemeur

[slemeur]

Updated with a more complete list to be targeted for GA

[tsmaeder]

@l0rd @slemeur no PHP stacks?

[tsmaeder]

@l0rd how can we have a camel stack if we don't have a camel plugin yet?

[tsmaeder]

About quarkus: if we are talking about building native programs, the target would be any image that has the necessary libraries. In the end, there is no "server" to be installed.

[tsmaeder]

Che server dev stack needs Golang, no?

[l0rd]

@l0rd how can we have a camel stack if we don't have a camel plugin yet?

A copy/paste issue. Fixed now. Thanks

About quarkus: if we are talking about building native programs, the target would be any image that has the necessary libraries. In the end, there is no "server" to be installed.

Agree. I was thinking about an image where the quickstart sample was pre-built so that the developer can get started quickly.

Che server dev stack needs Golang, no?

I don't think so. I think Golang was only used for the exec agent but in Che 7 that's a separate plugin.

[slemeur]

@l0rd + @tsmaeder : Added PHP.

[nickboldt]

So will we SUPPORT all these stacks, or will only a subset of these be Red Hat GA-level supported? Right now for CRW 1.x / Che 6 we only support Node8 and Java8, with the rest being community-supported. I've opened https://issues.jboss.org/browse/CRW-225 to track the downstream specs.

[nickboldt]

Che server dev stack needs Golang, no?

I don't think so. I think Golang was only used for the exec agent but in Che 7 that's a separate plugin."

Not sure if it's relevant but the Che 6 operator (and the CRW 1.x operator) both rely on golang too:

https://github.com/eclipse/che-operator/blob/master/Dockerfile#L13

[l0rd]

@nickboldt good point. I have added a Che operator stack, it should not be part of the che-server stack though.

[tsmaeder]

@l0rd @slemeur golang chag example is broken, see #13176. Ok to strike that one?

[l0rd]

@tsmaeder +1

[che-bot]

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.