Skip to content

Commit

Permalink
feat: Adding a note with UBI recommendation / Devfile.io (#2727)
Browse files Browse the repository at this point in the history
* feat: Adding a note with UBI recommendation

Signed-off-by: Ilya Buziuk <[email protected]>

* feat: Updating Devfile registry to devfile.io

Signed-off-by: Ilya Buziuk <[email protected]>

* fixup

Signed-off-by: Ilya Buziuk <[email protected]>

* fixup! update devfile version

Signed-off-by: Ilya Buziuk <[email protected]>

* Update devfile-introduction.adoc

* Update devfile-introduction.adoc

---------

Signed-off-by: Ilya Buziuk <[email protected]>
  • Loading branch information
ibuziuk authored May 9, 2024
1 parent 4de59fa commit e1e13ce
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions modules/end-user-guide/pages/devfile-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,29 @@ link:https://devfile.io/[Devfiles] are `yaml` text files used for development en

.{prod}-specific devfile features

[NOTE]
====
{prod} is expected to work with most of the popular images defined in the `components` section of devfile. For production purposes, it is recommended to use one of the link:https://catalog.redhat.com/software/containers/search?gs&q=ubi[Universal Base Images] as a base image for defining the Cloud Development Environment.
====

[WARNING]
====
Some images can not be used as-is for defining Cloud Development Environment since Visual Studio Code - Open Source ("Code - OSS") can not be started in the containers with missing `openssl` and `libbrotli`. Missing libraries should be explicitly installed on the Dockerfile level e.g. `RUN yum install compat-openssl11 libbrotli`
====

.Devfile and Universal Developer Image

You do not need a devfile to start a workspace. If you do not include a devfile in your project repository, {prod} automatically loads a default devfile with a Universal Developer Image (UDI).

.{prod-short} devfile registry
.Devfile Registry

link:https://registry.devfile.io/viewer[{Devfile Registry] contains ready-to-use community-supported devfiles for different languages and technologies. Devfiles included in the registry should be treated as samples rather than templates.

link:https://github.com/eclipse-che/che-devfile-registry[{prod-short} devfile registry] contains ready-to-use devfiles for different languages and technologies.

[NOTE]
====
Devfiles included in the registry are specific to {prod} and should be treated as samples rather than templates. They might require updates to work with other versions of the components featured in the samples.
====

.Additional resources

* link:https://devfile.io/docs/2.1.0/what-is-a-devfile[What is a devfile]
* link:https://devfile.io/docs/2.1.0/benefits-of-devfile[Benefits of devfile]
* link:https://devfile.io/docs/2.1.0/overview[Devfile customization overview]
* link:https://devfile.io/docs/2.2.2/what-is-a-devfile[What is a devfile]
* link:https://devfile.io/docs/2.2.0/benefits-of-devfile[Benefits of devfile]
* link:https://devfile.io/docs/2.2.2/overview[Devfile customization overview]
* link:https://devfile.io/[Devfile.io]
* link:https://che.eclipseprojects.io/2024/02/05/@mario.loriedo-cde-customization.html[Customizing Cloud Development Environments]

0 comments on commit e1e13ce

Please sign in to comment.