Skip to content

Commit 1f3238e

Browse files
authored
updating docs.openshift links (#510)
1 parent 436c3d5 commit 1f3238e

29 files changed

+53
-54
lines changed

modules/about-the-single-model-serving-platform.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ The single-model serving platform consists of the following components:
1111
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{os-latest-version}/html/about_openshift_serverless/index[{org-name} OpenShift Serverless^]: A cloud-native development model that allows for serverless deployments of models. OpenShift Serverless is based on the open source link:https://knative.dev/docs/[Knative^] project.
1212

1313
ifdef::self-managed[]
14-
* link:https://docs.openshift.com/container-platform/{ocp-latest-version}/service_mesh/v2x/ossm-architecture.html[{org-name} OpenShift Service Mesh^]: A service mesh networking layer that manages traffic flows and enforces access policies. OpenShift Service Mesh is based on the open source link:https://istio.io/[Istio^] project.
14+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/service_mesh/index[{org-name} OpenShift Service Mesh^]: A service mesh networking layer that manages traffic flows and enforces access policies. OpenShift Service Mesh is based on the open source link:https://istio.io/[Istio^] project.
1515
endif::[]
1616

1717
ifdef::cloud-service[]
18-
* link:https://docs.openshift.com/rosa/service_mesh/v2x/ossm-architecture.html[{org-name} OpenShift Service Mesh^]: Service mesh networking layer that manages traffic flows and enforces access policies. OpenShift Service Mesh is based on the open source link:https://istio.io/[Istio^] project.
18+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/{rosa-latest-version}/html/service_mesh/index[{org-name} OpenShift Service Mesh^]: Service mesh networking layer that manages traffic flows and enforces access policies. OpenShift Service Mesh is based on the open source link:https://istio.io/[Istio^] project.
1919
endif::[]
2020

2121
To install the single-model serving platform, you have the following options:

modules/adding-a-ca-bundle-after-upgrading.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ endif::[]
4242

4343
.Prerequisites
4444
* You have admin access to the `DSCInitialization` resources in the {openshift-platform} cluster.
45-
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.openshift.com/container-platform/{ocp-latest-version}/cli_reference/openshift_cli/getting-started-cli.html[Get Started with the CLI].
45+
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^].
46+
4647
ifdef::upstream[]
4748
* You upgraded {productname-long}. If you are working in a new installation of {productname-long}, see link:{odhdocshome}/installing-open-data-hub/#adding-a-ca-bundle_certs[Understanding certificates in {productname-short}].
4849
endif::[]
@@ -78,7 +79,7 @@ spec:
7879
managementState: Managed
7980
customCABundle: ""
8081
----
81-
. If you want to use self-signed certificates added to a cluster-wide CA bundle, log in to the {openshift-platform} as a cluster administrator and follow the steps as described in https://docs.openshift.com/container-platform/{ocp-latest-version}/networking/configuring-a-custom-pki.html#installation-configure-proxy_configuring-a-custom-pki[Configuring the cluster-wide proxy during installation].
82+
. If you want to use self-signed certificates added to a cluster-wide CA bundle, log in to the {openshift-platform} as a cluster administrator and follow the steps as described in link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/networking/configuring-a-custom-pki#installation-configure-proxy_configuring-a-custom-pki[Configuring the cluster-wide proxy during installation^].
8283
. If you want to use self-signed certificates in a custom CA bundle that is separate from the cluster-wide bundle, follow these steps:
8384
.. Add the custom certificate to the `customCABundle` field of the `default-dsci` object, as shown in the following example:
8485
+

modules/adding-a-ca-bundle.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
[role='_abstract']
77
There are two ways to add a Certificate Authority (CA) bundle to {productname-short}. You can use one or both of these methods:
88

9-
* For {openshift-platform} clusters that rely on self-signed certificates, you can add those self-signed certificates to a cluster-wide Certificate Authority (CA) bundle (`ca-bundle.crt`) and use the CA bundle in {productname-long}. To use this method, log in to the {openshift-platform} as a cluster administrator and follow the steps as described in https://docs.openshift.com/container-platform/{ocp-latest-version}/networking/configuring-a-custom-pki.html#installation-configure-proxy_configuring-a-custom-pki[Configuring the cluster-wide proxy during installation].
9+
* For {openshift-platform} clusters that rely on self-signed certificates, you can add those self-signed certificates to a cluster-wide Certificate Authority (CA) bundle (`ca-bundle.crt`) and use the CA bundle in {productname-long}. To use this method, log in to the {openshift-platform} as a cluster administrator and follow the steps as described in https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/networking/configuring-a-custom-pki#installation-configure-proxy_configuring-a-custom-pki[Configuring the cluster-wide proxy during installation^].
1010

1111
* You can use self-signed certificates in a custom CA bundle (`odh-ca-bundle.crt`) that is separate from the cluster-wide bundle. To use this method, follow the steps in this section.
1212

1313
.Prerequisites
1414
* You have admin access to the `DSCInitialization` resources in the {openshift-platform} cluster.
15-
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.openshift.com/container-platform/{ocp-latest-version}/cli_reference/openshift_cli/getting-started-cli.html[Get Started with the CLI].
15+
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^].
1616
ifdef::upstream[]
1717
* You are working in a new installation of {productname-long}. If you upgraded {productname-long}, see link:{odhdocshome}/upgrading-open-data-hub/#adding-a-ca-bundle-after-upgrading_certs[Adding a CA bundle after upgrading].
1818
endif::[]

modules/adding-notebook-pod-tolerations.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
= Adding notebook pod tolerations
55

66
[role='_abstract']
7-
If you want to dedicate certain machine pools to only running notebook pods, you can allow notebook pods to be scheduled on specific nodes by adding a toleration. Taints and tolerations allow a node to control which pods should (or should not) be scheduled on them. For more information, see link:https://docs.openshift.com/container-platform/{ocp-latest-version}/nodes/scheduling/nodes-scheduler-taints-tolerations.html#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations].
7+
If you want to dedicate certain machine pools to only running notebook pods, you can allow notebook pods to be scheduled on specific nodes by adding a toleration. Taints and tolerations allow a node to control which pods should (or should not) be scheduled on them. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations].
88

99
This capability is useful if you want to make sure that notebook servers are placed on nodes that can handle their needs. By preventing other workloads from running on these specific nodes, you can ensure that the necessary resources are available to users who need to work with large notebook sizes.
1010

1111
.Prerequisites
1212
* You have logged in to {productname-long}.
1313
* You are part of the administrator group for {productname-short} in {openshift-platform}.
14-
* You are familiar with {openshift-platform} taints and tolerations, as described in link:https://docs.openshift.com/container-platform/{ocp-latest-version}/nodes/scheduling/nodes-scheduler-taints-tolerations.html#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations].
14+
* You are familiar with {openshift-platform} taints and tolerations, as described in link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations].
1515

1616
.Procedure
1717
. From the {productname-short} dashboard, click *Settings* -> *Cluster settings*.
@@ -31,7 +31,7 @@ If you are using a workbench in a data science project, see link:{rhoaidocshome}
3131
endif::[]
3232

3333
.Next step
34-
In {openshift-platform}, add a matching taint key (with any value) to the machine pools that you want to dedicate to notebooks. For more information, see link:https://docs.openshift.com/container-platform/{ocp-latest-version}/nodes/scheduling/nodes-scheduler-taints-tolerations.html[Controlling pod placement using node taints].
34+
In {openshift-platform}, add a matching taint key (with any value) to the machine pools that you want to dedicate to notebooks. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints].
3535

3636
ifdef::self-managed[]
3737
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/{rosa-latest-version}/html/cluster_administration/manage-nodes-using-machine-pools#rosa-adding-taints_rosa-managing-worker-nodes[Adding taints to a machine pool].

modules/allocating-additional-resources-to-data-science-users.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
As a cluster administrator, you can allocate additional resources to a cluster to support compute-intensive data science work. This support includes increasing the number of nodes in the cluster and changing the cluster's allocated machine pool.
88

99
ifdef::upstream,self-managed[]
10-
For more information about allocating additional resources to an {openshift-platform} cluster, see link:https://docs.openshift.com/container-platform/{ocp-latest-version}/machine_management/manually-scaling-machineset.html[Manually scaling a compute machine set].
10+
For more information about allocating additional resources to an {openshift-platform} cluster, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/machine_management/manually-scaling-machineset[Manually scaling a compute machine set].
1111
endif::[]
1212

1313
ifdef::cloud-service[]

modules/authenticating-trustyai-service.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ To access TrustyAI service external endpoints, you must provide OAuth proxy (oau
88

99
.Prerequisites
1010
ifdef::upstream,self-managed[]
11-
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.openshift.com/container-platform/{ocp-latest-version}/cli_reference/openshift_cli/getting-started-cli.html[Get Started with the CLI].
11+
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^].
1212
endif::[]
1313
ifdef::cloud-service[]
14-
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.openshift.com/dedicated/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the CLI] (OpenShift Dedicated) or link:https://docs.openshift.com/rosa/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the CLI] (Red Hat OpenShift Service on AWS)
14+
* You installed the OpenShift command line interface (`oc`) as described in link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI (OpenShift Dedicated)^] or link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/{rosa-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI (Red Hat OpenShift Service on AWS)^].
1515
endif::[]
1616
* Your OpenShift cluster administrator added you as a user to the {openshift-platform} cluster and has installed the TrustyAI service for the data science project that contains the deployed models.
1717

modules/backing-up-storage-data.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ See the documentation for your cluster platform for more information about backi
1212

1313
[role="_additional-resources"]
1414
.Additional resources
15-
* link:https://docs.openshift.com/container-platform/{ocp-latest-version}/storage/understanding-persistent-storage.html[Understanding persistent storage]
15+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/storage/understanding-persistent-storage[Understanding persistent storage]

modules/configuring-monitoring-for-the-multi-model-serving-platform.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ After you have configured monitoring, you can view metrics for the ModelMesh com
1010

1111
.Prerequisites
1212
* You have cluster administrator privileges for your {openshift-platform} cluster.
13-
* You have downloaded and installed the OpenShift command-line interface (CLI). See link:https://docs.openshift.com/container-platform/{ocp-latest-version}/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli[Installing the OpenShift CLI].
14-
* You are familiar with link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/configuring-the-monitoring-stack.html#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
15-
* You are familiar with link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
16-
* You have link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/enabling-monitoring-for-user-defined-projects.html#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[assigned] the `monitoring-rules-view` role to users that will monitor metrics.
13+
* You have downloaded and installed the OpenShift command-line interface (CLI). See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^].
14+
* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/configuring-the-monitoring-stack#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
15+
* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/enabling-monitoring-for-user-defined-projects[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
16+
* You have link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/enabling-monitoring-for-user-defined-projects#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[assigned] the `monitoring-rules-view` role to users that will monitor metrics.
1717

1818
.Procedure
1919
. In a terminal window, if you are not already logged in to your OpenShift cluster as a cluster administrator, log in to the OpenShift CLI as shown in the following example:

modules/configuring-monitoring-for-the-single-model-serving-platform.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ endif::[]
1919
.Prerequisites
2020
* You have cluster administrator privileges for your {openshift-platform} cluster.
2121
* You have created OpenShift Service Mesh and Knative Serving instances and installed KServe.
22-
* You have downloaded and installed the OpenShift command-line interface (CLI). See link:https://docs.openshift.com/container-platform/{ocp-latest-version}/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli[Installing the OpenShift CLI].
23-
* You are familiar with link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/configuring-the-monitoring-stack.html#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
24-
* You are familiar with link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
25-
* You have link:https://docs.openshift.com/container-platform/{ocp-latest-version}/observability/monitoring/enabling-monitoring-for-user-defined-projects.html#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[assigned] the `monitoring-rules-view` role to users that will monitor metrics.
22+
* You have downloaded and installed the OpenShift command-line interface (CLI). See link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^].
23+
* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/configuring-the-monitoring-stack#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
24+
* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/enabling-monitoring-for-user-defined-projects[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
25+
* You have link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/enabling-monitoring-for-user-defined-projects#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[assigned] the `monitoring-rules-view` role to users that will monitor metrics.
2626

2727
.Procedure
2828
. In a terminal window, if you are not already logged in to your OpenShift cluster as a cluster administrator, log in to the OpenShift CLI as shown in the following example:

0 commit comments

Comments
 (0)