Skip to content

Commit ae2b83f

Browse files
authored
docs: Adding 'Troubleshooting' to the 'Migrating to devfile v2' docs (#153)
1 parent 1e767c3 commit ae2b83f

File tree

4 files changed

+33
-0
lines changed

4 files changed

+33
-0
lines changed

docs/modules/user-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
*** xref:migrating-commands.adoc[]
3636
*** xref:adding-event-bindings.adoc[]
3737
*** xref:referring-to-a-parent-devfile-in-a-devfile.adoc[]
38+
*** xref:troubleshooting.adoc[]
3839
3940
** xref:devfile-library.adoc[]
4041
*** xref:using-the-devfile-library.adoc[]
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
:description: Troubleshooting
2+
:navtitle: Troubleshooting
3+
:keywords: migrating, devfile
4+
:page-aliases:
5+
6+
include::partial$proc_troubleshooting.adoc[]

docs/modules/user-guide/partials/assembly_migrating-to-devfile-v2.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ To migrate a devfile from version 1.x to 2.x, see the following documents:
2020
* xref:migrating-commands.adoc[]
2121
* xref:referring-to-a-parent-devfile-in-a-devfile.adoc[]
2222
* xref:adding-event-bindings.adoc[]
23+
* xref:troubleshooting.adoc[]
2324
2425
[role="_additional-resources"]
2526
.Additional resources
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[id="troubleshooting_{context}"]
2+
= Troubleshooting
3+
4+
This section describes common problems during the devfile migration and potential solutions.
5+
6+
.{che-prod} workspace startup failures after the migration to devfile v2
7+
8+
Workspace fails to start after the conversion:: Try referencing the link:https://quay.io/repository/devfile/universal-developer-image[Universal Developer Image] as the only component in the devfile:
9+
+
10+
[source,yaml]
11+
----
12+
components:
13+
- name: tools
14+
container:
15+
image: quay.io/devfile/universal-developer-image:ubi8-latest
16+
memoryLimit: 3Gi
17+
----
18+
+
19+
NOTE: link:https://quay.io/repository/devfile/universal-developer-image[Universal Developer Image] provides runtimes for various languages (including Java, Node.js, Python, PHP, Golang) and tools (including `curl`, `jq`, `git`) for development.
20+
21+
.Conversion failures
22+
23+
Conversion fails with `Error processing devfile: failed to merge DevWorkspace volumes: duplicate volume found in devfile: volume_name`:: This means there are multiple volumes defined in the original devfile with the same name. Remove the duplicate volumes and proceed with the conversion.
24+
25+
Conversion fails with `Error provisioning storage: Could not rewrite container volume mounts: volume component 'volume_name' is defined multiple times`:: This means the volume defined in the original devfile conflicts with a `volumeMount` propagated by an editor or a plug-in. Rename the volume in the defvile to be the same as the name of the `volumeMount` it conflicts with, and proceed with the conversion.

0 commit comments

Comments
 (0)