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.

Sign up for GitHub

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

Jump to bottom

feat: Adding a note with UBI recommendation / Devfile.io #2727

Merged
merged 6 commits into from May 9, 2024
Merged

feat: Adding a note with UBI recommendation / Devfile.io #2727

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9a632dd
feat: Adding a note with UBI recommendation
ibuziuk Apr 25, 2024
665cf31
feat: Updating Devfile registry to devfile.io
ibuziuk Apr 25, 2024
098166f
fixup
ibuziuk Apr 25, 2024
e5745af
fixup! update devfile version
ibuziuk Apr 25, 2024
0a0795e
Update devfile-introduction.adoc
ibuziuk May 9, 2024
19e2723
Update devfile-introduction.adoc
ibuziuk May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 18 additions & 10 deletions modules/end-user-guide/pages/devfile-introduction.adoc
View file
Open in desktop
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.
RomanNikitenko marked this conversation as resolved.
Show resolved Hide resolved
====

[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]