Skip to content

Commit ffdebaf

Browse files
ShaunaDiazShaunaDiaz
committed
OSDOCS-13287: adds RHOAI to MicroShift
1 parent 49668e1 commit ffdebaf

28 files changed

+1149
-52
lines changed

Diff for: ‎_attributes/attributes-microshift.adoc

+10-5
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,28 @@
66
:OCP: OpenShift Container Platform
77
:ocp-version: 4.19
88
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
9+
:ai-first: artificial intelligence (AI)
910
//OpenShift Kubernetes Engine
1011
:oke: OpenShift Kubernetes Engine
11-
:product-title-first: Red Hat build of MicroShift (MicroShift)
12+
:product-title-first: Red{nbsp}Hat build of MicroShift (MicroShift)
1213
:microshift-short: MicroShift
1314
:product-registry: OpenShift image registry
1415
:product-version: 4.19
1516
:rhel-major: rhel-9
16-
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
17+
:rhoai-full: Red{nbsp}Hat OpenShift AI
18+
:rhoai: RHOAI
19+
:op-system-base-full: Red{nbsp}Hat Enterprise Linux (RHEL)
1720
:op-system-base: RHEL
18-
:op-system-ostree-first: Red Hat Enterprise Linux for Edge (RHEL for Edge)
21+
:op-system-ostree-first: Red{nbsp}Hat Enterprise Linux for Edge (RHEL for Edge)
1922
:op-system-ostree: RHEL for Edge
20-
:op-system-rt-kernel: Red Hat Enterprise Linux for Real Time (real-time kernel)
23+
:op-system-rt-kernel: Red{nbsp}Hat Enterprise Linux for Real Time (real-time kernel)
2124
:op-system-rtk: real-time kernel
2225
:op-system-image: image mode for RHEL
2326
:op-system-version: 9.6
2427
:op-system-version-major: 9
25-
:op-system-bundle: Red Hat Device Edge
28+
:op-system-bundle: Red{nbsp}Hat Device Edge
29+
:ovms: OpenVINO Model Server
30+
:ov: OVMS
2631
:rpm-repo-version: rhocp-4.19
2732
:rhde-version: 4
2833
:VirtProductName: OpenShift Virtualization

Diff for: ‎_attributes/common-attributes.adoc

+39-31
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@
1414
:ocp-nminus1: 4.17
1515
:ocp-nplus1: 4.19
1616
// Operating system attributes
17-
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
17+
:op-system-first: Red{nbsp}Hat Enterprise Linux CoreOS (RHCOS)
1818
:op-system: RHCOS
1919
:op-system-lowercase: rhcos
2020
:op-system-base: RHEL
21-
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
21+
:op-system-base-full: Red{nbsp}Hat Enterprise Linux (RHEL)
2222
:op-system-version: 9.x
2323
:op-system-version-9: 9
24+
:op-system-ai: Red{nbsp}Hat Enterprise Linux AI
2425
ifdef::openshift-origin[]
2526
:op-system-first: Fedora CoreOS (FCOS)
2627
:op-system: FCOS
@@ -37,7 +38,7 @@ endif::[]
3738
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
3839
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from Red Hat OpenShift Cluster Manager]
3940
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
40-
:hybrid-console: Red Hat Hybrid Cloud Console
41+
:hybrid-console: Red{nbsp}Hat Hybrid Cloud Console
4142
:hybrid-console-second: Hybrid Cloud Console
4243
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
4344
// OADP attributes
@@ -53,8 +54,8 @@ endif::[]
5354
:product-mirror-registry: Mirror registry for Red Hat OpenShift
5455
:rh-storage-first: Red Hat OpenShift Data Foundation
5556
:rh-storage: OpenShift Data Foundation
56-
:rh-rhacm-title: Red Hat Advanced Cluster Management
57-
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
57+
:rh-rhacm-title: Red{nbsp}Hat Advanced Cluster Management
58+
:rh-rhacm-first: Red{nbsp}Hat Advanced Cluster Management (RHACM)
5859
:rh-rhacm: RHACM
5960
:rh-rhacm-version: 2.13
6061
:osc: OpenShift sandboxed containers
@@ -87,12 +88,12 @@ ifdef::openshift-origin[]
8788
:builds-v1shortname: Builds v1
8889
endif::[]
8990
//gitops
90-
:gitops-title: Red Hat OpenShift GitOps
91+
:gitops-title: Red{nbsp}Hat OpenShift GitOps
9192
:gitops-shortname: GitOps
9293
:gitops-ver: 1.1
9394
:rh-app-icon: image:red-hat-applications-menu-icon.jpg[title="Red Hat applications"]
9495
//pipelines
95-
:pipelines-title: Red Hat OpenShift Pipelines
96+
:pipelines-title: Red{nbsp}Hat OpenShift Pipelines
9697
:pipelines-shortname: OpenShift Pipelines
9798
:pipelines-ver: pipelines-1.18
9899
:pipelines-version-number: 1.18
@@ -123,22 +124,22 @@ ifdef::openshift-origin[]
123124
:CNVSubscriptionSpecName: community-kubevirt-hyperconverged
124125
endif::[]
125126
// openshift virtualization engine (ove)
126-
:ove-first: Red Hat OpenShift Virtualization Engine
127+
:ove-first: Red{nbsp}Hat OpenShift Virtualization Engine
127128
:ove: OpenShift Virtualization Engine
128129
//distributed tracing
129-
:DTProductName: Red Hat OpenShift distributed tracing platform
130+
:DTProductName: Red{nbsp}Hat OpenShift distributed tracing platform
130131
:DTShortName: distributed tracing platform
131132
:DTProductVersion: 3.1
132-
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
133-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
133+
:JaegerName: Red{nbsp}Hat OpenShift distributed tracing platform (Jaeger)
134+
:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
134135
:JaegerShortName: distributed tracing platform (Jaeger)
135-
:JaegerOperator: Red Hat OpenShift distributed tracing platform
136+
:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
136137
:JaegerVersion: 1.53.0
137-
:OTELName: Red Hat build of OpenTelemetry
138-
:OTELShortName: Red Hat build of OpenTelemetry
139-
:OTELOperator: Red Hat build of OpenTelemetry Operator
138+
:OTELName: Red{nbsp}Hat build of OpenTelemetry
139+
:OTELShortName: Red{nbsp}Hat build of OpenTelemetry
140+
:OTELOperator: Red{nbsp}Hat build of OpenTelemetry Operator
140141
:OTELVersion: 0.93.0
141-
:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
142+
:TempoName: Red{nbsp}Hat OpenShift distributed tracing platform (Tempo)
142143
:TempoShortName: distributed tracing platform (Tempo)
143144
:TempoOperator: Tempo Operator
144145
:TempoVersion: 2.3.1
@@ -153,18 +154,18 @@ ifdef::telco-core[]
153154
:rds-caps: Telco core
154155
endif::[]
155156
//lightspeed
156-
:ols-official: Red Hat OpenShift Lightspeed
157+
:ols-official: Red{nbsp}Hat OpenShift Lightspeed
157158
:ols: OpenShift Lightspeed
158159
//logging
159160
:logging: logging
160161
:logging-uc: Logging
161-
:for: for Red Hat OpenShift
162-
:clo: Red Hat OpenShift Logging Operator
162+
:for: for Red{nbsp}Hat OpenShift
163+
:clo: Red{nbsp}Hat OpenShift Logging Operator
163164
:loki-op: Loki Operator
164165
:es-op: OpenShift Elasticsearch Operator
165166
:log-plug: logging Console plugin
166167
//observability
167-
:ObservabilityLongName: Red Hat OpenShift Observability
168+
:ObservabilityLongName: Red{nbsp}Hat OpenShift Observability
168169
:ObservabilityShortName: Observability
169170
// Cluster Monitoring Operator
170171
:cmo-first: Cluster Monitoring Operator (CMO)
@@ -183,9 +184,9 @@ endif::[]
183184
:ServerlessOperatorName: OpenShift Serverless Operator
184185
:FunctionsProductName: OpenShift Serverless Functions
185186
//service mesh v2
186-
:product-dedicated: Red Hat OpenShift Dedicated
187-
:product-rosa: Red Hat OpenShift Service on AWS
188-
:SMProductName: Red Hat OpenShift Service Mesh
187+
:product-dedicated: Red{nbsp}Hat OpenShift Dedicated
188+
:product-rosa: Red{nbsp}Hat OpenShift Service on AWS
189+
:SMProductName: Red{nbsp}Hat OpenShift Service Mesh
189190
:SMProductShortName: Service Mesh
190191
:SMProductVersion: 2.6.7
191192
:MaistraVersion: 2.6
@@ -195,11 +196,11 @@ endif::[]
195196
//Service Mesh v1
196197
:SMProductVersion1x: 1.1.18.2
197198
//Windows containers
198-
:productwinc: Red Hat OpenShift support for Windows Containers
199+
:productwinc: Red{nbsp}Hat OpenShift support for Windows Containers
199200
// Red Hat Quay Container Security Operator
200201
:rhq-cso: Red Hat Quay Container Security Operator
201202
// Red Hat Quay
202-
:quay: Red Hat Quay
203+
:quay: Red{nbsp}Hat Quay
203204
:sno: single-node OpenShift
204205
:sno-caps: Single-node OpenShift
205206
:sno-okd: single-node OKD
@@ -210,8 +211,8 @@ endif::[]
210211
:cgu-operator: TALM
211212
:redfish-operator: Bare Metal Event Relay
212213
//Formerly known as CodeReady Containers and CodeReady Workspaces
213-
:openshift-local-productname: Red Hat OpenShift Local
214-
:openshift-dev-spaces-productname: Red Hat OpenShift Dev Spaces
214+
:openshift-local-productname: Red{nbsp}Hat OpenShift Local
215+
:openshift-dev-spaces-productname: Red{nbsp}Hat OpenShift Dev Spaces
215216
:factory-prestaging-tool: factory-precaching-cli tool
216217
:factory-prestaging-tool-caps: Factory-precaching-cli tool
217218
:openshift-networking: Red Hat OpenShift Networking
@@ -253,8 +254,8 @@ endif::[]
253254
:coo-full: Cluster Observability Operator
254255
:coo-short: COO
255256
// ODF
256-
:odf-first: Red Hat OpenShift Data Foundation (ODF)
257-
:odf-full: Red Hat OpenShift Data Foundation
257+
:odf-first: Red{nbsp}Hat OpenShift Data Foundation (ODF)
258+
:odf-full: Red{nbsp}Hat OpenShift Data Foundation
258259
:odf-short: ODF
259260
:rh-dev-hub: Red Hat Developer Hub
260261
// IBU
@@ -315,14 +316,14 @@ endif::[]
315316
:oci-pca-short: Private Cloud Appliance
316317
// Red Hat OpenStack Platform (RHOSP)/OpenStack
317318
ifndef::openshift-origin[]
318-
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
319+
:rh-openstack-first: Red{nbsp}Hat OpenStack Platform (RHOSP)
319320
:rh-openstack: RHOSP
320321
endif::openshift-origin[]
321322
ifdef::openshift-origin[]
322323
:rh-openstack-first: OpenStack
323324
:rh-openstack: OpenStack
324325
endif::openshift-origin[]
325-
:rhoso-first: Red Hat OpenStack Services on OpenShift (RHOSO)
326+
:rhoso-first: Red{nbsp}Hat OpenStack Services on OpenShift (RHOSO)
326327
:rhoso: RHOSO
327328
// VMware vSphere
328329
:vmw-first: VMware vSphere
@@ -374,3 +375,10 @@ endif::openshift-origin[]
374375
:hcp: hosted control planes
375376
:mce: multicluster engine for Kubernetes Operator
376377
:mce-short: multicluster engine Operator
378+
//AI names; OpenShift AI can be used as the family name
379+
:rhoai-full: Red{nbsp}Hat OpenShift AI
380+
:rhoai: RHOAI
381+
:rhoai-diy: Red{nbsp}Hat OpenShift AI Self-Managed
382+
:rhoai-cloud: Red{nbsp}Hat OpenShift AI Cloud Service
383+
:ai-first: artificial intelligence (AI)
384+
//RHEL AI attribute listed with RHEL family

Diff for: ‎_topic_maps/_topic_map_ms.yml

+22-15
Original file line numberDiff line numberDiff line change
@@ -103,21 +103,6 @@ Topics:
103103
- Name: Listing update package contents
104104
File: microshift-list-update-contents
105105
---
106-
Name: Support
107-
Dir: microshift_support
108-
Distros: microshift
109-
Topics:
110-
- Name: The etcd service
111-
File: microshift-etcd
112-
- Name: The sos report tool
113-
File: microshift-sos-report
114-
- Name: Getting your cluster ID
115-
File: microshift-getting-cluster-id
116-
- Name: Getting support
117-
File: microshift-getting-support
118-
- Name: Remote health monitoring with a connected cluster
119-
File: microshift-remote-cluster-monitoring
120-
---
121106
Name: Configuring
122107
Dir: microshift_configuring
123108
Distros: microshift
@@ -209,6 +194,13 @@ Topics:
209194
- Name: Understanding storage migration
210195
File: microshift-storage-migration
211196
---
197+
Name: Using AI models
198+
Dir: microshift_ai
199+
Distros: microshift
200+
Topics:
201+
- Name: Using artificial intelligence with MicroShift
202+
File: microshift-rhoai
203+
---
212204
Name: Running applications
213205
Dir: microshift_running_apps
214206
Distros: microshift
@@ -250,6 +242,21 @@ Topics:
250242
- Name: Automated recovery from manual backups
251243
File: microshift-auto-recover-manual-backup
252244
---
245+
Name: Support
246+
Dir: microshift_support
247+
Distros: microshift
248+
Topics:
249+
- Name: The etcd service
250+
File: microshift-etcd
251+
- Name: The sos report tool
252+
File: microshift-sos-report
253+
- Name: Getting your cluster ID
254+
File: microshift-getting-cluster-id
255+
- Name: Getting support
256+
File: microshift-getting-support
257+
- Name: Remote health monitoring with a connected cluster
258+
File: microshift-remote-cluster-monitoring
259+
---
253260
Name: Troubleshooting
254261
Dir: microshift_troubleshooting
255262
Distros: microshift

Diff for: ‎microshift_ai/_attributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

Diff for: ‎microshift_ai/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

Diff for: ‎microshift_ai/microshift-rhoai.adoc

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="microshift-rh-openshift-ai"]
3+
include::_attributes/attributes-microshift.adoc[]
4+
= Using {rhoai-full} with {microshift-short}
5+
:context: microshift-rh-openshift-ai
6+
7+
toc::[]
8+
9+
Learn how to serve artificial intelligence and machine learning (AI/ML) models with {ai-first} on your {microshift-short} edge deployments.
10+
11+
:FeatureName: {rhoai-full}
12+
include::snippets/technology-preview.adoc[leveloffset=+1]
13+
14+
include::modules/microshift-rhoai-con.adoc[leveloffset=+1]
15+
16+
include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1]
17+
18+
//additional resources for rhoai-workflow module
19+
[role="_additional-resources"]
20+
.Additional resources
21+
22+
* xref:../microshift_networking/microshift-configuring-routes.adoc#microshift-configuring-routes[Configuring routes]
23+
24+
include::modules/microshift-rhoai-install.adoc[leveloffset=+1]
25+
26+
include::modules/microshift-rhoai-create-ns.adoc[leveloffset=+1]
27+
28+
include::modules/microshift-rhoai-model-package-oci.adoc[leveloffset=+1]
29+
30+
//additional resources for rhoai-oci module
31+
[role="_additional-resources"]
32+
.Additional resources
33+
34+
* link:https://kserve.github.io/website/latest/modelserving/storage/oci/[Serving models with OCI images] (KServe documentation)
35+
36+
include::modules/microshift-rhoai-serving-ai-models-con.adoc[leveloffset=+1]
37+
38+
include::modules/microshift-rhoai-supported-crds.adoc[leveloffset=+2]
39+
40+
include::modules/microshift-rhoai-supported-mserv-runtimes.adoc[leveloffset=+2]
41+
42+
include::modules/microshift-rhoai-servingruntimes-ex.adoc[leveloffset=+1]
43+
44+
//additional resources for serving runtimes procedure module
45+
[role="_additional-resources"]
46+
.Additional resources
47+
48+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/serving_models/about-model-serving_about-model-serving#about-model-serving_about-model-serving[About model serving] ({rhoai-full} documentation)
49+
50+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/serving_models/serving-large-models_serving-large-models#servingruntime[Model-serving runtimes] ({rhoai-full} documentation)
51+
52+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/serving_models/serving-large-models_serving-large-models[Serving models on the single-model serving platform] ({rhoai-full} documentation)
53+
54+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/latest/html/serving_models/serving-large-models_serving-large-models#tested-verified-runtimes_serving-large-models[Tested and verified model-serving runtimes] ({rhoai-full} documentation)
55+
//the `2-latest` link is not working (2-latest in place of `1`)
56+
57+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/serving_models/serving-large-models_serving-large-models#adding-a-tested-and-verified-model-serving-runtime-for-the-single-model-serving-platform_serving-large-models[Adding a tested and verified model-serving runtime for the single-model serving platform] ({rhoai-full} documentation)
58+
59+
* link:https://kserve.github.io/website/0.8/modelserving/servingruntimes/[Serving Runtimes] (KServe documentation)
60+
61+
* link:https://kserve.github.io/website/latest/modelserving/data_plane/v1_protocol/[V1 Inference Protocol] (KServe documentation)
62+
63+
* link:https://kserve.github.io/website/latest/modelserving/data_plane/v2_protocol/[Open Inference Protocol (V2)] (KServe documentation)
64+
65+
include::modules/microshift-rhoai-inferenceservice-ex.adoc[leveloffset=+1]
66+
67+
include::modules/microshift-inferenceservice-more-options.adoc[leveloffset=+2]
68+
69+
include::modules/microshift-rhoai-model-serving-rt-verify.adoc[leveloffset=+1]
70+
71+
//additional resources for inferenceservice modules
72+
.Additional resources
73+
74+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/serving_models/serving-large-models_serving-large-models#inferenceservice[InferenceService] ({rhoai-full} documentation)
75+
76+
include::modules/microshift-rhoai-create-route.adoc[leveloffset=+1]
77+
78+
//additional resources for creating a route
79+
.Additional resources
80+
81+
* xref:../microshift_networking/microshift-configuring-routes.adoc#microshift-configuring-routes[Configuring routes]
82+
83+
include::modules/microshift-rhoai-query-model-con.adoc[leveloffset=+1]
84+
85+
include::modules/microshift-rhoai-verify-model-connected.adoc[leveloffset=+2]
86+
87+
include::modules/microshift-rhoai-get-model-ready-inference.adoc[leveloffset=+2]
88+
89+
include::modules/microshift-rhoai-query-model.adoc[leveloffset=+2]
90+
91+
include::modules/microshift-rhoai-get-model-server-metrics.adoc[leveloffset=+2]
92+
93+
include::modules/microshift-rhoai-override-kserve-config.adoc[leveloffset=+1]

Diff for: ‎microshift_ai/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

Diff for: ‎microshift_ai/snippets

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

Diff for: ‎microshift_networking/microshift-configuring-routes.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
66

77
toc::[]
88

9-
You can configure routes for {microshift-short} for clusters.
9+
You can configure routes for services to have {microshift-short} cluster access.
1010

1111
//OCP module, edit with care; Creating an insecure/http route
1212
include::modules/microshift-nw-create-http-based-route.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)