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

docs: url parameter for workspace image (rhdevdocs-5255) #2612

Merged
merged 24 commits into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
28c925a
chore: update version to Che 7.65
deerskindoll May 29, 2023
ea80204
Merge remote-tracking branch 'upstream/main'
deerskindoll May 29, 2023
8d8e239
update
deerskindoll Jun 6, 2023
8df3139
update
deerskindoll Jun 6, 2023
5ac1aa9
update
deerskindoll Jun 6, 2023
57ee481
Update modules/end-user-guide/pages/url-parameter-for-workspace-image…
deerskindoll Jun 12, 2023
0f68817
Update modules/end-user-guide/pages/url-parameter-for-workspace-image…
deerskindoll Jun 16, 2023
65dadd3
Update nav.adoc
deerskindoll Jun 16, 2023
5c233a0
Update optional-parameters-for-the-urls-for-starting-a-new-workspace.…
deerskindoll Jun 16, 2023
ad6a4aa
Update url-parameter-for-workspace-image.adoc
deerskindoll Jun 16, 2023
848b01e
Rename url-parameter-for-workspace-image.adoc to url-parameter-for-co…
deerskindoll Jun 16, 2023
01b1467
Update url-parameter-for-container-image.adoc
deerskindoll Jun 16, 2023
9be4c15
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 17, 2023
59fb245
Update url-parameter-for-container-image.adoc
deerskindoll Jun 19, 2023
9e939eb
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 19, 2023
050c0f4
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 19, 2023
1b4c4e5
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 19, 2023
2da7675
Update url-parameter-for-container-image.adoc
deerskindoll Jun 19, 2023
ba92c18
Update url-parameter-for-container-image.adoc
deerskindoll Jun 19, 2023
4df70c0
Update url-parameter-for-container-image.adoc
deerskindoll Jun 19, 2023
78623c4
Update url-parameter-for-container-image.adoc
deerskindoll Jun 20, 2023
73a7825
Update url-parameter-for-container-image.adoc
deerskindoll Jun 20, 2023
d93f19e
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 20, 2023
b82d5f3
Update modules/end-user-guide/pages/url-parameter-for-container-image…
deerskindoll Jun 30, 2023
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
1 change: 1 addition & 0 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*** xref:url-parameter-for-the-devfile-file-path.adoc[]
*** xref:url-parameter-for-the-workspace-storage.adoc[]
*** xref:url-parameter-for-additional-remotes.adoc[]
*** xref:url-parameter-for-container-image.adoc[]
** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
* xref:customizing-workspace-components.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ When you start a new workspace, {prod-short} configures the workspace according
* xref:url-parameter-for-the-devfile-file-path.adoc[]
* xref:url-parameter-for-the-workspace-storage.adoc[]
* xref:url-parameter-for-additional-remotes.adoc[]
* xref:url-parameter-for-container-image.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_content-type: CONCEPT
:description: URL parameter for a container image
:keywords: parameter, URL, container, image
:navtitle: URL parameter for a container image
//:page-aliases:

[id="url-parameter-for-container-image"]
= URL parameter for a container image

You can use the `image` parameter to add a path to a container image in the following scenarios:
deerskindoll marked this conversation as resolved.
Show resolved Hide resolved

* The Git repository contains no devfile, and you want to start a new workspace with this container.
deerskindoll marked this conversation as resolved.
Show resolved Hide resolved

* The Git repository contains a devfile, and you want this container image to run instead of the first `container` `image` listed in the `components` section of the devfile.
deerskindoll marked this conversation as resolved.
Show resolved Hide resolved

The URL parameter for the path to a container image is `image=`:
deerskindoll marked this conversation as resolved.
Show resolved Hide resolved

[subs="+quotes"]
----
https://<che_fqdn>#<git_repository_url>?image=<container_image_url>
----
deerskindoll marked this conversation as resolved.
Show resolved Hide resolved