Skip to content

Commit 28db0ea

Browse files
authored
reorder versions to put most recent version on top (#87)
1 parent 8bb8dd4 commit 28db0ea

File tree

6 files changed

+59
-54
lines changed

6 files changed

+59
-54
lines changed

SETUP.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ defines a `mlbatch-edit` role which enforces these restrictions and
1010
will be used in the setup process for each team of MLBatch users that
1111
is onboarded.
1212

13-
This setup has been developed on OpenShift 4.14 and Kubernetes 1.27 and
14-
is intended to support OpenShift 4.14 and up and/or Kubernetes 1.27 and up.
13+
This setup has been developed on Red Hat OpenShift 4.14 and Kubernetes 1.27 and
14+
is intended to support Red Hat OpenShift 4.14 and up and/or Kubernetes 1.27 and up.
1515

1616
To start with, recursively clone and enter this repository:
1717
```sh
@@ -24,41 +24,46 @@ one for each base platform.
2424

2525
## OpenShift AI
2626

27+
We recommend using the most recent ***stable*** release of
28+
Red Hat OpenShift AI as the base platform for MLBatch. Please see
29+
[Red Hat OpenShift AI Self-Managed Life Cycle](https://access.redhat.com/support/policy/updates/rhoai-sm/lifecycle)
30+
for the life cycle dates of currently supported ***stable*** and ***fast*** releases.
31+
2732
Instructions are provided for the following OpenShift AI ***stable*** releases:
28-
+ OpenShift AI 2.10
29-
+ [RHOAI 2.10 Cluster Setup](./setup.RHOAI-v2.10/CLUSTER-SETUP.md)
30-
+ [RHOAI 2.10 Team Setup](./setup.RHOAI-v2.10/TEAM-SETUP.md)
31-
+ [RHOAI 2.10 Uninstall](./setup.RHOAI-v2.10/UNINSTALL.md)
32-
+ OpenShift AI 2.13
33+
+ Red Hat OpenShift AI 2.13
3334
+ [RHOAI 2.13 Cluster Setup](./setup.RHOAI-v2.13/CLUSTER-SETUP.md)
3435
+ [RHOAI 2.13 Team Setup](./setup.RHOAI-v2.13/TEAM-SETUP.md)
3536
+ [UPGRADING from RHOAI 2.10](./setup.RHOAI-v2.13/UPGRADE-STABLE.md)
3637
+ [UPGRADING from RHOAI 2.12](./setup.RHOAI-v2.13/UPGRADE-FAST.md)
3738
+ [RHOAI 2.13 Uninstall](./setup.RHOAI-v2.13/UNINSTALL.md)
39+
+ Red Hat OpenShift AI 2.10
40+
+ [RHOAI 2.10 Cluster Setup](./setup.RHOAI-v2.10/CLUSTER-SETUP.md)
41+
+ [RHOAI 2.10 Team Setup](./setup.RHOAI-v2.10/TEAM-SETUP.md)
42+
+ [RHOAI 2.10 Uninstall](./setup.RHOAI-v2.10/UNINSTALL.md)
3843

3944
Instructions are provided for the following OpenShift AI ***fast*** releases:
40-
+ OpenShift AI 2.11
41-
+ [RHOAI 2.11 Cluster Setup](./setup.RHOAI-v2.11/CLUSTER-SETUP.md)
42-
+ [RHOAI 2.11 Team Setup](./setup.RHOAI-v2.11/TEAM-SETUP.md)
43-
+ [UPGRADING from RHOAI 2.10](./setup.RHOAI-v2.11/UPGRADE.md)
44-
+ [RHOAI 2.11 Uninstall](./setup.RHOAI-v2.11/UNINSTALL.md)
45-
+ OpenShift AI 2.12
45+
+ Red Hat OpenShift AI 2.12
4646
+ [RHOAI 2.12 Cluster Setup](./setup.RHOAI-v2.12/CLUSTER-SETUP.md)
4747
+ [RHOAI 2.12 Team Setup](./setup.RHOAI-v2.12/TEAM-SETUP.md)
4848
+ [UPGRADING from RHOAI 2.11](./setup.RHOAI-v2.12/UPGRADE.md)
4949
+ [RHOAI 2.12 Uninstall](./setup.RHOAI-v2.12/UNINSTALL.md)
50+
+ Red Hat OpenShift AI 2.11
51+
+ [RHOAI 2.11 Cluster Setup](./setup.RHOAI-v2.11/CLUSTER-SETUP.md)
52+
+ [RHOAI 2.11 Team Setup](./setup.RHOAI-v2.11/TEAM-SETUP.md)
53+
+ [UPGRADING from RHOAI 2.10](./setup.RHOAI-v2.11/UPGRADE.md)
54+
+ [RHOAI 2.11 Uninstall](./setup.RHOAI-v2.11/UNINSTALL.md)
5055

5156
## Kubernetes
5257

53-
MLBatch can be installed on any Kubernetes cluster version 1.27 or later
54-
by following these instructions:
55-
+ [Kubernetes Cluster Setup](./setup.k8s-v1.27/CLUSTER-SETUP.md)
56-
+ [Kubternets Team Setup](./setup.k8s-v1.27/TEAM-SETUP.md)
57-
+ [Kubernetes Uninstall](setup.k8s-v1.27/UNINSTALL.md)
58-
5958
On Kubernetes version 1.30 and later, an enhanced user experience is
6059
available by using ValidatingAdmissionPolicies to streamline quota
6160
enforcement. Follow these instructions when installing on 1.30+ clusters:
6261
+ [Kubernetes 1.30+ Cluster Setup](./setup.k8s-v1.30/CLUSTER-SETUP.md)
6362
+ [Kubernetes 1.30+ Team Setup](./setup.k8s-v1.30/TEAM-SETUP.md)
6463
+ [Kubernetes 1.30+ Uninstall](setup.k8s-v1.30/UNINSTALL.md)
64+
65+
MLBatch can be installed on any Kubernetes cluster version 1.27 or later
66+
by following these instructions:
67+
+ [Kubernetes Cluster Setup](./setup.k8s-v1.27/CLUSTER-SETUP.md)
68+
+ [Kubternets Team Setup](./setup.k8s-v1.27/TEAM-SETUP.md)
69+
+ [Kubernetes Uninstall](setup.k8s-v1.27/UNINSTALL.md)

setup.RHOAI-v2.10/CLUSTER-SETUP.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cluster Setup
22

3-
The cluster setup installs OpenShift AI and Coscheduler, configures Kueue,
3+
The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
44
cluster roles, and priority classes.
55

66
If MLBatch is deployed on a cluster that used to run earlier versions of ODH,
7-
[MCAD](https://github.com/project-codeflare/mcad), OpenShift AI, or Coscheduler,
7+
[MCAD](https://github.com/project-codeflare/mcad), Red Hat OpenShift AI, or Coscheduler,
88
make sure to scrub traces of these installations. In particular, make sure to
99
delete the following custom resource definitions (CRD) if present on the
1010
cluster. Make sure to delete all instances prior to deleting the CRDs:
@@ -39,9 +39,9 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
3939
oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.10/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
4040
```
4141

42-
## OpenShift AI
42+
## Red Hat OpenShift AI
4343

44-
Create the OpenShift AI subscription:
44+
Create the Red Hat OpenShift AI subscription:
4545
```sh
4646
oc apply -f setup.RHOAI-v2.10/mlbatch-subscription.yaml
4747
````
@@ -66,11 +66,11 @@ Create Data Science Cluster:
6666
```sh
6767
oc apply -f setup.RHOAI-v2.10/mlbatch-dsc.yaml
6868
```
69-
The provided DSCI and DSC are intended to install a minimal set of OpenShift
69+
The provided DSCI and DSC are intended to install a minimal set of Red Hat OpenShift
7070
AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
7171
remaining components such as `dashboard` can be optionally enabled.
7272

73-
The configuration of the managed components differs from the default OpenShift
73+
The configuration of the managed components differs from the default Red Hat OpenShift
7474
AI configuration as follows:
7575
- Kubeflow Training Operator:
7676
- `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
@@ -88,7 +88,7 @@ AI configuration as follows:
8888
- pod priorities, resource requests and limits have been adjusted.
8989

9090
To work around https://issues.redhat.com/browse/RHOAIENG-7887 (a race condition
91-
in OpenShift AI installation), do a rolling restart of the Kueue manager.
91+
in Red Hat OpenShift AI installation), do a rolling restart of the Kueue manager.
9292
```sh
9393
oc rollout restart deployment/kueue-controller-manager -n redhat-ods-applications
9494
```

setup.RHOAI-v2.11/CLUSTER-SETUP.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cluster Setup
22

3-
The cluster setup installs OpenShift AI and Coscheduler, configures Kueue,
3+
The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
44
cluster roles, and priority classes.
55

66
If MLBatch is deployed on a cluster that used to run earlier versions of ODH,
7-
[MCAD](https://github.com/project-codeflare/mcad), OpenShift AI, or Coscheduler,
7+
[MCAD](https://github.com/project-codeflare/mcad), Red Hat OpenShift AI, or Coscheduler,
88
make sure to scrub traces of these installations. In particular, make sure to
99
delete the following custom resource definitions (CRD) if present on the
1010
cluster. Make sure to delete all instances prior to deleting the CRDs:
@@ -39,9 +39,9 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
3939
oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.11/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
4040
```
4141

42-
## OpenShift AI
42+
## Red Hat OpenShift AI
4343

44-
Create the OpenShift AI subscription:
44+
Create the Red Hat OpenShift AI subscription:
4545
```sh
4646
oc apply -f setup.RHOAI-v2.11/mlbatch-subscription.yaml
4747
````
@@ -66,11 +66,11 @@ Create Data Science Cluster:
6666
```sh
6767
oc apply -f setup.RHOAI-v2.11/mlbatch-dsc.yaml
6868
```
69-
The provided DSCI and DSC are intended to install a minimal set of OpenShift
69+
The provided DSCI and DSC are intended to install a minimal set of Red Hat OpenShift
7070
AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
7171
remaining components such as `dashboard` can be optionally enabled.
7272

73-
The configuration of the managed components differs from the default OpenShift
73+
The configuration of the managed components differs from the default Red Hat OpenShift
7474
AI configuration as follows:
7575
- Kubeflow Training Operator:
7676
- `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
@@ -88,7 +88,7 @@ AI configuration as follows:
8888
- pod priorities, resource requests and limits have been adjusted.
8989

9090
To work around https://issues.redhat.com/browse/RHOAIENG-7887 (a race condition
91-
in OpenShift AI installation), do a rolling restart of the Kueue manager.
91+
in Red Hat OpenShift AI installation), do a rolling restart of the Kueue manager.
9292
```sh
9393
oc rollout restart deployment/kueue-controller-manager -n redhat-ods-applications
9494
```

setup.RHOAI-v2.12/CLUSTER-SETUP.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cluster Setup
22

3-
The cluster setup installs OpenShift AI and Coscheduler, configures Kueue,
3+
The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
44
cluster roles, and priority classes.
55

66
If MLBatch is deployed on a cluster that used to run earlier versions of ODH,
7-
[MCAD](https://github.com/project-codeflare/mcad), OpenShift AI, or Coscheduler,
7+
[MCAD](https://github.com/project-codeflare/mcad), Red Hat OpenShift AI, or Coscheduler,
88
make sure to scrub traces of these installations. In particular, make sure to
99
delete the following custom resource definitions (CRD) if present on the
1010
cluster. Make sure to delete all instances prior to deleting the CRDs:
@@ -39,9 +39,9 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
3939
oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.12/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
4040
```
4141

42-
## OpenShift AI
42+
## Red Hat OpenShift AI
4343

44-
Create the OpenShift AI subscription:
44+
Create the Red Hat OpenShift AI subscription:
4545
```sh
4646
oc apply -f setup.RHOAI-v2.12/mlbatch-subscription.yaml
4747
````
@@ -66,11 +66,11 @@ Create Data Science Cluster:
6666
```sh
6767
oc apply -f setup.RHOAI-v2.12/mlbatch-dsc.yaml
6868
```
69-
The provided DSCI and DSC are intended to install a minimal set of OpenShift
69+
The provided DSCI and DSC are intended to install a minimal set of Red Hat OpenShift
7070
AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
7171
remaining components such as `dashboard` can be optionally enabled.
7272

73-
The configuration of the managed components differs from the default OpenShift
73+
The configuration of the managed components differs from the default Red Hat OpenShift
7474
AI configuration as follows:
7575
- Kubeflow Training Operator:
7676
- `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
@@ -88,7 +88,7 @@ AI configuration as follows:
8888
- pod priorities, resource requests and limits have been adjusted.
8989

9090
To work around https://issues.redhat.com/browse/RHOAIENG-7887 (a race condition
91-
in OpenShift AI installation), do a rolling restart of the Kueue manager.
91+
in Red Hat OpenShift AI installation), do a rolling restart of the Kueue manager.
9292
```sh
9393
oc rollout restart deployment/kueue-controller-manager -n redhat-ods-applications
9494
```

setup.RHOAI-v2.13/CLUSTER-SETUP.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cluster Setup
22

3-
The cluster setup installs OpenShift AI and Coscheduler, configures Kueue,
3+
The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
44
cluster roles, and priority classes.
55

66
If MLBatch is deployed on a cluster that used to run earlier versions of ODH,
7-
[MCAD](https://github.com/project-codeflare/mcad), OpenShift AI, or Coscheduler,
7+
[MCAD](https://github.com/project-codeflare/mcad), Red Hat OpenShift AI, or Coscheduler,
88
make sure to scrub traces of these installations. In particular, make sure to
99
delete the following custom resource definitions (CRD) if present on the
1010
cluster. Make sure to delete all instances prior to deleting the CRDs:
@@ -39,9 +39,9 @@ oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2
3939
oc patch deployment -n scheduler-plugins --type=json --patch-file setup.RHOAI-v2.13/coscheduler-priority-patch.yaml scheduler-plugins-scheduler
4040
```
4141

42-
## OpenShift AI
42+
## Red Hat OpenShift AI
4343

44-
Create the OpenShift AI subscription:
44+
Create the Red Hat OpenShift AI subscription:
4545
```sh
4646
oc apply -f setup.RHOAI-v2.13/mlbatch-subscription.yaml
4747
````
@@ -66,11 +66,11 @@ Create Data Science Cluster:
6666
```sh
6767
oc apply -f setup.RHOAI-v2.13/mlbatch-dsc.yaml
6868
```
69-
The provided DSCI and DSC are intended to install a minimal set of OpenShift
69+
The provided DSCI and DSC are intended to install a minimal set of Red Hat OpenShift
7070
AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
7171
remaining components such as `dashboard` can be optionally enabled.
7272

73-
The configuration of the managed components differs from the default OpenShift
73+
The configuration of the managed components differs from the default Red Hat OpenShift
7474
AI configuration as follows:
7575
- Kubeflow Training Operator:
7676
- `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
@@ -88,7 +88,7 @@ AI configuration as follows:
8888
- pod priorities, resource requests and limits have been adjusted.
8989

9090
To work around https://issues.redhat.com/browse/RHOAIENG-7887 (a race condition
91-
in OpenShift AI installation), do a rolling restart of the Kueue manager.
91+
in Red Hat OpenShift AI installation), do a rolling restart of the Kueue manager.
9292
```sh
9393
oc rollout restart deployment/kueue-controller-manager -n redhat-ods-applications
9494
```

setup.tmpl/CLUSTER-SETUP.md.tmpl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Cluster Setup
22

33
{{ if .OPENSHIFT -}}
4-
The cluster setup installs OpenShift AI and Coscheduler, configures Kueue,
4+
The cluster setup installs Red Hat OpenShift AI and Coscheduler, configures Kueue,
55
cluster roles, and priority classes.
66

77
If MLBatch is deployed on a cluster that used to run earlier versions of ODH,
8-
[MCAD](https://github.com/project-codeflare/mcad), OpenShift AI, or Coscheduler,
8+
[MCAD](https://github.com/project-codeflare/mcad), Red Hat OpenShift AI, or Coscheduler,
99
make sure to scrub traces of these installations. In particular, make sure to
1010
delete the following custom resource definitions (CRD) if present on the
1111
cluster. Make sure to delete all instances prior to deleting the CRDs:
@@ -65,9 +65,9 @@ Patch Coscheduler pod priorities:
6565
```
6666

6767
{{ if .OPENSHIFT -}}
68-
## OpenShift AI
68+
## Red Hat OpenShift AI
6969

70-
Create the OpenShift AI subscription:
70+
Create the Red Hat OpenShift AI subscription:
7171
```sh
7272
{{ .KUBECTL }} apply -f setup.{{ .VERSION }}/mlbatch-subscription.yaml
7373
````
@@ -92,11 +92,11 @@ Create Data Science Cluster:
9292
```sh
9393
{{ .KUBECTL }} apply -f setup.{{ .VERSION }}/mlbatch-dsc.yaml
9494
```
95-
The provided DSCI and DSC are intended to install a minimal set of OpenShift
95+
The provided DSCI and DSC are intended to install a minimal set of Red Hat OpenShift
9696
AI managed components: `codeflare`, `kueue`, `ray`, and `trainingoperator`. The
9797
remaining components such as `dashboard` can be optionally enabled.
9898

99-
The configuration of the managed components differs from the default OpenShift
99+
The configuration of the managed components differs from the default Red Hat OpenShift
100100
AI configuration as follows:
101101
- Kubeflow Training Operator:
102102
- `gang-scheduler-name` is set to `scheduler-plugins-scheduler`,
@@ -114,7 +114,7 @@ AI configuration as follows:
114114
- pod priorities, resource requests and limits have been adjusted.
115115

116116
To work around https://issues.redhat.com/browse/RHOAIENG-7887 (a race condition
117-
in OpenShift AI installation), do a rolling restart of the Kueue manager.
117+
in Red Hat OpenShift AI installation), do a rolling restart of the Kueue manager.
118118
```sh
119119
{{ .KUBECTL }} rollout restart deployment/kueue-controller-manager -n redhat-ods-applications
120120
```

0 commit comments

Comments
 (0)