Jtesar/chapter1 web console install #1
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| = Section 1 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,62 @@ | ||
| = Installation using the Web Console | ||
|
|
||
| *Red{nbsp}Hat Openshift Data Science* is installed as an operator. As a dependecy it requires the *Red{nbsp}Hat Openshift Pipelines* operator to be installed as well. | ||
|
|
||
| == Installation of the Red{nbsp}Hat Openshift Pipelines operator | ||
|
|
||
| 1. Login to Red{nbsp}Hat Openshift using a user which has the cluster-admin role assigned. | ||
| 2. Navigate to **Operators** -> **OperatorHub** and seach for *Red{nbsp}Hat Openshift Pipelines* | ||
| + | ||
| image::pipeline_search.png[width=800] | ||
|
|
||
| 3. Click on the Red{nbsp}Hat Openshift Pipelines operator and in the pop up window click on **Install** to open the operator's installation view. | ||
| + | ||
| image::pipeline_install1.png[width=800] | ||
|
|
||
|
|
||
| 4. In the installation view some installation parameters can be tuned. Administrator can set the *Update{nbsp}channel* parameter to a specific version and the *Update{nbsp}approval* parameter to either *Automatic* or *Manual*. The *Installation{nbsp}mode* and the *Installed{nbsp}namespace* parameters are fixed. | ||
| + | ||
| image::pipeline_install2.png[width=800] | ||
| + | ||
| Click on the **Install** button at the bottom of to view the to proceed with the installation. A window showing the installation progress will pop up. | ||
| + | ||
| image::pipeline_install3.png[width=800] | ||
| + | ||
| When the operator is installed you can view it's details by clicking on **View{nbsp}Operator** button. | ||
| + | ||
| image::pipeline_install4.png[width=800] | ||
|
|
||
| == Installation of the Red{nbsp}Hat Openshift Data Science operator | ||
|
|
||
| The process of the Red{nbsp}Hat Openshift Data Science operator installation is very similar to the Red{nbsp}Hat Openshift Pipelines operator. | ||
|
|
||
| 1. Login to Red Hat Openshift using a user which has the cluster-admin role assigned. | ||
|
|
||
| 2. Navigate to **Operators** -> **OperatorHub** and seach for *Red{nbsp}Hat Openshift Data Science*. | ||
| + | ||
| image::rhods_install1.png[width=800] | ||
|
|
||
| 3. Click on the Red{nbsp}Hat Openshift Data Science operator and in the pop up window click on **Install** to open the operator's installation view. | ||
| + | ||
| image::rhods_install2.png[width=800] | ||
|
|
||
| 4. In the installation view window choose the **Update Channel**, **Installed{nbsp}Namespace** and *Update approval** or accept default values and click on **Install* the button. The *Installation{nbsp}mode* parameter is fixed. | ||
|
There was a problem hiding this comment. The default channel today installs the v1 operator which will be depreciated in the near future. The last version of v1 operator should be released in the next week or two and v2 will be the default moving forward. V2 is available in the alpha channel today but we be made available in stable before the end of the year. There was a problem hiding this comment. Yes, I know that. I asked specifically about whether we create the module for v1 or v2, because installation for v2 would look quite differently. The workshop is in November and v1 will still be the stable version then I guess . So I think we should finish the initial version of the modeule using v1 and update it when v2 becomes stable. There was a problem hiding this comment. Yeah, the current state of the transition of the operator does leave us in a bit of an awkward position. Personally I still think the docs should be oriented towards the v2 operator. The goal of the workshop is to enable internal resources to help deliver RHODS for customers. By the time the people attending the workshop are actively working on an engagement with RHODS, v2 will be stable. It doesn't seem like the best strategy to try to enable people with material and knowledge that will be out of data a month later. At a minimum, for the workshop we should at least be discussing v2 and letting people know that it is coming. If the workshop is going to focus on v1 for the hands on stuff that is fine. I would probably defer to Noel on what he thinks on this topic of how to handle this for the workshop. Just as a general update around v2, it is very usable today. The biggest piece that is missing that is holding it back from stable is the automation intended to handle the v1 to v2 migration. There was a problem hiding this comment. Yeah, that's a fair point, I agree. I'll somehow include the v2 as well :-) |
||
| + | ||
| image::rhods_install3.png[width=800] | ||
| + | ||
| Operator Installation progress window will pup up. The installation may take a couple of minutes. | ||
|
There was a problem hiding this comment. With the v1 operator as part of the install the operator pod automatically installs all of the components in the background as part of the operator install which is why it takes so long. With v2, only the operator is installed and a new object called a DataScienceCluster is a new required object that must be setup. The "installing operator" screen will be a little bit different because of this required object and the user will have to take additional steps to create the DSC after the operator is installed. The DSC will allow users to enable and disable specific components and have better control over what is installed on each cluster. There was a problem hiding this comment. I'd reply the same thing as to the previous comment. We should finalize the first version using v1 and then update to v2 once it becomes stable. |
||
| + | ||
| image::rhods_install4.png[width=800] | ||
| + | ||
| When the operator is installed open the applications window in the right upper corner and *Red{nbsp}Hat Openshift Data Science* dashboard should be available. | ||
| + | ||
| image::rhods_verify1.png[width=800] | ||
| + | ||
| When you click on the *Red{nbsp}Hat Openshift Data Science* dashboard button a login window should appear. | ||
| + | ||
| image::rhods_verify2.png[width=800] | ||
|
|
||
| IMPORTANT: It may take a while to start all the service pods hence the dashboard may not be accessible immediately. You can check the status of the pods in the project *redhat-ods-applications*. | ||
| Navigate to *Workloads* -> *pods* and select project *redhat-ods-applications*. All pods must be running and be ready in order the dashboard to be accessible. | ||
|
|
||
| image::rhods_verify_pods.png[width=800] | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OpenShift Pipelines is only required if you plan to install the Data Science Pipelines component.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True, but the v1 operator installs the Data Science Pipelines component automatically so I see the pipelines operator as a dependency for v1. What do you think?