OSDOCS-13287: adds RHOAI to MicroShift

Author: ShaunaDiaz

_attributes/attributes-microshift.adoc

@@ -6,23 +6,28 @@
 :OCP: OpenShift Container Platform
 :ocp-version: 4.19
 :oc-first: pass:quotes[OpenShift CLI (`oc`)]
+:ai-first: artificial intelligence (AI)
 //OpenShift Kubernetes Engine
 :oke: OpenShift Kubernetes Engine
-:product-title-first: Red Hat build of MicroShift (MicroShift)
+:product-title-first: Red{nbsp}Hat build of MicroShift (MicroShift)
 :microshift-short: MicroShift
 :product-registry: OpenShift image registry
 :product-version: 4.19
 :rhel-major: rhel-9
-:op-system-base-full: Red Hat Enterprise Linux (RHEL)
+:rhoai-full: Red{nbsp}Hat OpenShift AI
+:rhoai: RHOAI
+:op-system-base-full: Red{nbsp}Hat Enterprise Linux (RHEL)
 :op-system-base: RHEL
-:op-system-ostree-first: Red Hat Enterprise Linux for Edge (RHEL for Edge)
+:op-system-ostree-first: Red{nbsp}Hat Enterprise Linux for Edge (RHEL for Edge)
 :op-system-ostree: RHEL for Edge
-:op-system-rt-kernel: Red Hat Enterprise Linux for Real Time (real-time kernel)
+:op-system-rt-kernel: Red{nbsp}Hat Enterprise Linux for Real Time (real-time kernel)
 :op-system-rtk: real-time kernel
 :op-system-image: image mode for RHEL
 :op-system-version: 9.6
 :op-system-version-major: 9
-:op-system-bundle: Red Hat Device Edge
+:op-system-bundle: Red{nbsp}Hat Device Edge
+:ovms: OpenVINO Model Server
+:ov: OVMS
 :rpm-repo-version: rhocp-4.19
 :rhde-version: 4
 :VirtProductName: OpenShift Virtualization

_attributes/common-attributes.adoc

@@ -14,13 +14,14 @@
 :ocp-nminus1: 4.17
 :ocp-nplus1: 4.19
 // Operating system attributes
-:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
+:op-system-first: Red{nbsp}Hat Enterprise Linux CoreOS (RHCOS)
 :op-system: RHCOS
 :op-system-lowercase: rhcos
 :op-system-base: RHEL
-:op-system-base-full: Red Hat Enterprise Linux (RHEL)
+:op-system-base-full: Red{nbsp}Hat Enterprise Linux (RHEL)
 :op-system-version: 9.x
 :op-system-version-9: 9
+:op-system-ai: Red{nbsp}Hat Enterprise Linux AI
 ifdef::openshift-origin[]
 :op-system-first: Fedora CoreOS (FCOS)
 :op-system: FCOS
@@ -37,7 +38,7 @@ endif::[]
 :cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
 :cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from Red Hat OpenShift Cluster Manager]
 :insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
-:hybrid-console: Red Hat Hybrid Cloud Console
+:hybrid-console: Red{nbsp}Hat Hybrid Cloud Console
 :hybrid-console-second: Hybrid Cloud Console
 :hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
 // OADP attributes
@@ -53,8 +54,8 @@ endif::[]
 :product-mirror-registry: Mirror registry for Red Hat OpenShift
 :rh-storage-first: Red Hat OpenShift Data Foundation
 :rh-storage: OpenShift Data Foundation
-:rh-rhacm-title: Red Hat Advanced Cluster Management
-:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
+:rh-rhacm-title: Red{nbsp}Hat Advanced Cluster Management
+:rh-rhacm-first: Red{nbsp}Hat Advanced Cluster Management (RHACM)
 :rh-rhacm: RHACM
 :rh-rhacm-version: 2.13
 :osc: OpenShift sandboxed containers
@@ -87,12 +88,12 @@ ifdef::openshift-origin[]
 :builds-v1shortname: Builds v1
 endif::[]
 //gitops
-:gitops-title: Red Hat OpenShift GitOps
+:gitops-title: Red{nbsp}Hat OpenShift GitOps
 :gitops-shortname: GitOps
 :gitops-ver: 1.1
 :rh-app-icon: image:red-hat-applications-menu-icon.jpg[title="Red Hat applications"]
 //pipelines
-:pipelines-title: Red Hat OpenShift Pipelines
+:pipelines-title: Red{nbsp}Hat OpenShift Pipelines
 :pipelines-shortname: OpenShift Pipelines
 :pipelines-ver: pipelines-1.18
 :pipelines-version-number: 1.18
@@ -123,22 +124,22 @@ ifdef::openshift-origin[]
 :CNVSubscriptionSpecName: community-kubevirt-hyperconverged
 endif::[]
 // openshift virtualization engine (ove)
-:ove-first: Red Hat OpenShift Virtualization Engine
+:ove-first: Red{nbsp}Hat OpenShift Virtualization Engine
 :ove: OpenShift Virtualization Engine
 //distributed tracing
-:DTProductName: Red Hat OpenShift distributed tracing platform
+:DTProductName: Red{nbsp}Hat OpenShift distributed tracing platform
 :DTShortName: distributed tracing platform
 :DTProductVersion: 3.1
-:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
-:JaegerOperator: Red Hat OpenShift distributed tracing platform
+:JaegerName: Red{nbsp}Hat OpenShift distributed tracing platform (Jaeger)
+:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
 :JaegerShortName: distributed tracing platform (Jaeger)
-:JaegerOperator: Red Hat OpenShift distributed tracing platform
+:JaegerOperator: Red{nbsp}Hat OpenShift distributed tracing platform
 :JaegerVersion: 1.53.0
-:OTELName: Red Hat build of OpenTelemetry
-:OTELShortName: Red Hat build of OpenTelemetry
-:OTELOperator: Red Hat build of OpenTelemetry Operator
+:OTELName: Red{nbsp}Hat build of OpenTelemetry
+:OTELShortName: Red{nbsp}Hat build of OpenTelemetry
+:OTELOperator: Red{nbsp}Hat build of OpenTelemetry Operator
 :OTELVersion: 0.93.0
-:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
+:TempoName: Red{nbsp}Hat OpenShift distributed tracing platform (Tempo)
 :TempoShortName: distributed tracing platform (Tempo)
 :TempoOperator: Tempo Operator
 :TempoVersion: 2.3.1
@@ -153,18 +154,18 @@ ifdef::telco-core[]
 :rds-caps: Telco core
 endif::[]
 //lightspeed
-:ols-official: Red Hat OpenShift Lightspeed
+:ols-official: Red{nbsp}Hat OpenShift Lightspeed
 :ols: OpenShift Lightspeed
 //logging
 :logging: logging
 :logging-uc: Logging
-:for: for Red Hat OpenShift
-:clo: Red Hat OpenShift Logging Operator
+:for: for Red{nbsp}Hat OpenShift
+:clo: Red{nbsp}Hat OpenShift Logging Operator
 :loki-op: Loki Operator
 :es-op: OpenShift Elasticsearch Operator
 :log-plug: logging Console plugin
 //observability
-:ObservabilityLongName: Red Hat OpenShift Observability
+:ObservabilityLongName: Red{nbsp}Hat OpenShift Observability
 :ObservabilityShortName: Observability
 // Cluster Monitoring Operator
 :cmo-first: Cluster Monitoring Operator (CMO)
@@ -183,9 +184,9 @@ endif::[]
 :ServerlessOperatorName: OpenShift Serverless Operator
 :FunctionsProductName: OpenShift Serverless Functions
 //service mesh v2
-:product-dedicated: Red Hat OpenShift Dedicated
-:product-rosa: Red Hat OpenShift Service on AWS
-:SMProductName: Red Hat OpenShift Service Mesh
+:product-dedicated: Red{nbsp}Hat OpenShift Dedicated
+:product-rosa: Red{nbsp}Hat OpenShift Service on AWS
+:SMProductName: Red{nbsp}Hat OpenShift Service Mesh
 :SMProductShortName: Service Mesh
 :SMProductVersion: 2.6.7
 :MaistraVersion: 2.6
@@ -195,11 +196,11 @@ endif::[]
 //Service Mesh v1
 :SMProductVersion1x: 1.1.18.2
 //Windows containers
-:productwinc: Red Hat OpenShift support for Windows Containers
+:productwinc: Red{nbsp}Hat OpenShift support for Windows Containers
 // Red Hat Quay Container Security Operator
 :rhq-cso: Red Hat Quay Container Security Operator
 // Red Hat Quay
-:quay: Red Hat Quay
+:quay: Red{nbsp}Hat Quay
 :sno: single-node OpenShift
 :sno-caps: Single-node OpenShift
 :sno-okd: single-node OKD
@@ -210,8 +211,8 @@ endif::[]
 :cgu-operator: TALM
 :redfish-operator: Bare Metal Event Relay
 //Formerly known as CodeReady Containers and CodeReady Workspaces
-:openshift-local-productname: Red Hat OpenShift Local
-:openshift-dev-spaces-productname: Red Hat OpenShift Dev Spaces
+:openshift-local-productname: Red{nbsp}Hat OpenShift Local
+:openshift-dev-spaces-productname: Red{nbsp}Hat OpenShift Dev Spaces
 :factory-prestaging-tool: factory-precaching-cli tool
 :factory-prestaging-tool-caps: Factory-precaching-cli tool
 :openshift-networking: Red Hat OpenShift Networking
@@ -253,8 +254,8 @@ endif::[]
 :coo-full: Cluster Observability Operator
 :coo-short: COO
 // ODF
-:odf-first: Red Hat OpenShift Data Foundation (ODF)
-:odf-full: Red Hat OpenShift Data Foundation
+:odf-first: Red{nbsp}Hat OpenShift Data Foundation (ODF)
+:odf-full: Red{nbsp}Hat OpenShift Data Foundation
 :odf-short: ODF
 :rh-dev-hub: Red Hat Developer Hub
 // IBU
@@ -315,14 +316,14 @@ endif::[]
 :oci-pca-short: Private Cloud Appliance
 // Red Hat OpenStack Platform (RHOSP)/OpenStack
 ifndef::openshift-origin[]
-:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
+:rh-openstack-first: Red{nbsp}Hat OpenStack Platform (RHOSP)
 :rh-openstack: RHOSP
 endif::openshift-origin[]
 ifdef::openshift-origin[]
 :rh-openstack-first: OpenStack
 :rh-openstack: OpenStack
 endif::openshift-origin[]
-:rhoso-first: Red Hat OpenStack Services on OpenShift (RHOSO)
+:rhoso-first: Red{nbsp}Hat OpenStack Services on OpenShift (RHOSO)
 :rhoso: RHOSO
 // VMware vSphere
 :vmw-first: VMware vSphere
@@ -374,3 +375,10 @@ endif::openshift-origin[]
 :hcp: hosted control planes
 :mce: multicluster engine for Kubernetes Operator
 :mce-short: multicluster engine Operator
+//AI names; OpenShift AI can be used as the family name
+:rhoai-full: Red{nbsp}Hat OpenShift AI
+:rhoai: RHOAI
+:rhoai-diy: Red{nbsp}Hat OpenShift AI Self-Managed
+:rhoai-cloud: Red{nbsp}Hat OpenShift AI Cloud Service
+:ai-first: artificial intelligence (AI)
+//RHEL AI attribute listed with RHEL family

_topic_maps/_topic_map_ms.yml

@@ -103,21 +103,6 @@ Topics:
 - Name: Listing update package contents
   File: microshift-list-update-contents
 ---
-Name: Support
-Dir: microshift_support
-Distros: microshift
-Topics:
-- Name: The etcd service
-  File: microshift-etcd
-- Name: The sos report tool
-  File: microshift-sos-report
-- Name: Getting your cluster ID
-  File: microshift-getting-cluster-id
-- Name: Getting support
-  File: microshift-getting-support
-- Name: Remote health monitoring with a connected cluster
-  File: microshift-remote-cluster-monitoring
----
 Name: Configuring
 Dir: microshift_configuring
 Distros: microshift
@@ -209,6 +194,13 @@ Topics:
 - Name: Understanding storage migration
   File: microshift-storage-migration
 ---
+Name: Using AI models
+Dir: microshift_ai
+Distros: microshift
+Topics:
+- Name: Using artificial intelligence with MicroShift
+  File: microshift-rhoai
+---
 Name: Running applications
 Dir: microshift_running_apps
 Distros: microshift
@@ -250,6 +242,21 @@ Topics:
 - Name: Automated recovery from manual backups
   File: microshift-auto-recover-manual-backup
 ---
+Name: Support
+Dir: microshift_support
+Distros: microshift
+Topics:
+- Name: The etcd service
+  File: microshift-etcd
+- Name: The sos report tool
+  File: microshift-sos-report
+- Name: Getting your cluster ID
+  File: microshift-getting-cluster-id
+- Name: Getting support
+  File: microshift-getting-support
+- Name: Remote health monitoring with a connected cluster
+  File: microshift-remote-cluster-monitoring
+---
 Name: Troubleshooting
 Dir: microshift_troubleshooting
 Distros: microshift

microshift_ai/_attributes

@@ -0,0 +1 @@
+../_attributes/

microshift_ai/images

@@ -0,0 +1 @@
+../images/

microshift_ai/microshift-rhoai.adoc

@@ -0,0 +1,93 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="microshift-rh-openshift-ai"]
+include::_attributes/attributes-microshift.adoc[]
+= Using {rhoai-full} with {microshift-short}
+:context: microshift-rh-openshift-ai
+
+toc::[]
+
+Learn how to serve artificial intelligence and machine learning (AI/ML) models with {ai-first} on your {microshift-short} edge deployments.
+
+:FeatureName: {rhoai-full}
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-con.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-workflow.adoc[leveloffset=+1]
+
+//additional resources for rhoai-workflow module
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../microshift_networking/microshift-configuring-routes.adoc#microshift-configuring-routes[Configuring routes]
+
+include::modules/microshift-rhoai-install.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-create-ns.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-model-package-oci.adoc[leveloffset=+1]
+
+//additional resources for rhoai-oci module
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://kserve.github.io/website/latest/modelserving/storage/oci/[Serving models with OCI images] (KServe documentation)
+
+include::modules/microshift-rhoai-serving-ai-models-con.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-supported-crds.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-supported-mserv-runtimes.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-servingruntimes-ex.adoc[leveloffset=+1]
+
+//additional resources for serving runtimes procedure module
+[role="_additional-resources"]
+.Additional resources
+
+* 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)
+
+* 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)
+
+* 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)
+
+* 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)
+//the `2-latest` link is not working (2-latest in place of `1`)
+
+* 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)
+
+* link:https://kserve.github.io/website/0.8/modelserving/servingruntimes/[Serving Runtimes] (KServe documentation)
+
+* link:https://kserve.github.io/website/latest/modelserving/data_plane/v1_protocol/[V1 Inference Protocol] (KServe documentation)
+
+* link:https://kserve.github.io/website/latest/modelserving/data_plane/v2_protocol/[Open Inference Protocol (V2)] (KServe documentation)
+
+include::modules/microshift-rhoai-inferenceservice-ex.adoc[leveloffset=+1]
+
+include::modules/microshift-inferenceservice-more-options.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-model-serving-rt-verify.adoc[leveloffset=+1]
+
+//additional resources for inferenceservice modules
+.Additional resources
+
+* 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)
+
+include::modules/microshift-rhoai-create-route.adoc[leveloffset=+1]
+
+//additional resources for creating a route
+.Additional resources
+
+* xref:../microshift_networking/microshift-configuring-routes.adoc#microshift-configuring-routes[Configuring routes]
+
+include::modules/microshift-rhoai-query-model-con.adoc[leveloffset=+1]
+
+include::modules/microshift-rhoai-verify-model-connected.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-get-model-ready-inference.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-query-model.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-get-model-server-metrics.adoc[leveloffset=+2]
+
+include::modules/microshift-rhoai-override-kserve-config.adoc[leveloffset=+1]

microshift_ai/modules

@@ -0,0 +1 @@
+../modules/

microshift_ai/snippets

@@ -0,0 +1 @@
+../snippets/

microshift_networking/microshift-configuring-routes.adoc

@@ -6,7 +6,7 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
-You can configure routes for {microshift-short} for clusters.
+You can configure routes for services to have {microshift-short} cluster access.
 
 //OCP module, edit with care; Creating an insecure/http route
 include::modules/microshift-nw-create-http-based-route.adoc[leveloffset=+1]