Document DSCI and DSC changes compared to defaults (#28)

project-codeflare · Jul 26, 2024 · 7df04a5 · 7df04a5
1 parent 20f64c0
commit 7df04a5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/setup.RHOAI-v2.10/CLUSTER-SETUP.md b/setup.RHOAI-v2.10/CLUSTER-SETUP.md
@@ -66,8 +66,12 @@ Create Data Science Cluster:
 ```sh
 oc apply -f setup.RHOAI-v2.10/mlbatch-dsc.yaml
 ```
-The provided configuration differs from the default OpenShift AI configuration
-as follows:
+The provided DSCI and DSC are intended to install a minimal set of OpenShift
+AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
+remaining components such as `dashboard` can be optionally enabled.
+
+The configuration of the managed components differs from the default OpenShift
+AI configuration as follows:
 - Kubeflow Training Operator:
   - `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
 - Kueue:

diff --git a/setup.RHOAI-v2.11/CLUSTER-SETUP.md b/setup.RHOAI-v2.11/CLUSTER-SETUP.md
@@ -66,8 +66,12 @@ Create Data Science Cluster:
 ```sh
 oc apply -f setup.RHOAI-v2.11/mlbatch-dsc.yaml
 ```
-The provided configuration differs from the default OpenShift AI configuration
-as follows:
+The provided DSCI and DSC are intended to install a minimal set of OpenShift
+AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
+remaining components such as `dashboard` can be optionally enabled.
+
+The configuration of the managed components differs from the default OpenShift
+AI configuration as follows:
 - Kubeflow Training Operator:
   - `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
 - Kueue:

diff --git a/setup.tmpl/CLUSTER-SETUP.md.tmpl b/setup.tmpl/CLUSTER-SETUP.md.tmpl
@@ -92,8 +92,12 @@ Create Data Science Cluster:
 ```sh
 {{ .KUBECTL }} apply -f setup.{{ .VERSION }}/mlbatch-dsc.yaml
 ```
-The provided configuration differs from the default OpenShift AI configuration
-as follows:
+The provided DSCI and DSC are intended to install a minimal set of OpenShift
+AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
+remaining components such as `dashboard` can be optionally enabled.
+
+The configuration of the managed components differs from the default OpenShift
+AI configuration as follows:
 - Kubeflow Training Operator:
   - `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
 - Kueue: