Skip to content

Commit

Permalink
odh-769-2 custom notebooks continued (#457)
Browse files Browse the repository at this point in the history
  • Loading branch information
MelissaFlinn authored Sep 19, 2024
1 parent 988e235 commit b3905e2
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 28 deletions.
26 changes: 0 additions & 26 deletions assemblies/creating-custom-workbench-images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ifdef::context[:parent-context: {context}]

[id="creating-custom-workbench-images"]
= Creating custom workbench images
:upstream:
//:preview:

{productname-long} includes a selection of default workbench images that a data scientist can select when they create or edit a workbench.
Expand All @@ -17,39 +16,14 @@ A custom workbench image is simply a container image. You build one as you would

You have the following options for creating a custom workbench image:

ifdef::upstream[]
* Start from one of the default images, as described in
link:{odhdocshome}/managing-resources/#creating-a-custom-image-from-default-image_custom-images[Creating a custom image from a default {productname-short} image]

* Create your own image by following the guidelines for making it compatible with OpenShift AI, as described in
link:{odhdocshome}/managing-resources/#creating-a-custom-image-from-your-own-image_custom-images[Creating a custom image from your own image]
endif::[]

ifndef::upstream[]
* Start from one of the default images, as described in
link:{rhoaidocshome}{default-format-url}/managing_resources/creating-custom-workbench-images#creating-a-custom-image-from-default-image_custom-images[Creating a custom image from a default {productname-short} image]

* Create your own image by following the guidelines for making it compatible with OpenShift AI, as described in
link:{rhoaidocshome}{default-format-url}/managing_resources/creating-custom-workbench-images#creating-a-custom-image-from-your-own-image_custom-images[Creating a custom image from your own image]
endif::[]


ifndef::upstream[]
[IMPORTANT]
====
{org-name} supports adding custom workbench images to your deployment of {productname-short}, ensuring that they are available for selection when creating a workbench. However, {org-name} does not support the contents of your custom workbench image. That is, if your custom workbench image is available for selection during workbench creation, but does not create a usable workbench, {org-name} does not provide support to fix your custom workbench image.
====
endif::[]

.Additional resources

ifndef::upstream[]
For a list of the {productname-short} default workbench images and their pre-installed packages, see link:https://access.redhat.com/articles/rhoai-supported-configs[Supported Configurations].
end
endif::[]

For more information about creating images, see the following resources:

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/images/creating-images[Red Hat OpenShift Container Platform - Creating Images]
Expand Down
2 changes: 2 additions & 0 deletions managing-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ include::assemblies/managing-cluster-resources.adoc[leveloffset=+1]

include::assemblies/customizing-component-deployment-resources.adoc[leveloffset=+1]

include::assemblies/creating-custom-workbench-images.adoc[leveloffset=+1]

include::assemblies/managing-notebook-servers.adoc[leveloffset=+1]

include::modules/backing-up-storage-data.adoc[leveloffset=+1]
2 changes: 1 addition & 1 deletion modules/about-workbench-images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ endif::[]

The following table lists the workbench images that are installed with {productname-long} by default.

If the pre-installed packages that are provided in these images are not sufficient for your use case, you have the following options:
If the preinstalled packages that are provided in these images are not sufficient for your use case, you have the following options:

* Install additional libraries after launching a default image. This option is good if you want to add libraries on an adhoc basis as you develop models. However, it can be challenging to manage the dependencies of installed libraries and your changes are not saved when the workbench restarts.

Expand Down
2 changes: 1 addition & 1 deletion modules/creating-a-custom-image-from-default-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can create a custom image by adding OS packages or applications to a default
* You know which default image you want to use as the base for your custom image.
ifndef::upstream[]
+
See link:https://access.redhat.com/articles/rhoai-supported-configs[Supported Configurations] for a list of the {productname-short} default workbench images and their pre-installed packages.
See link:https://access.redhat.com/articles/rhoai-supported-configs[Supported Configurations] for a list of the {productname-short} default workbench images and their preinstalled packages.
endif::[]

* You have `cluster-admin` access to the OpenShift console for the cluster where {productname-short} is installed.
Expand Down

0 comments on commit b3905e2

Please sign in to comment.