Docs: add upgrade from v2.0/2.1 to v2.2 with API changes #196

zdtsw · 2023-09-25T11:33:41Z

Description

add example of default instance config
fix wrong namespace/project from "opendatahub-system" to "opendatahub"

How Has This Been Tested?

local https://github.com/zdtsw-forking/opendatahub.io/blob/issue/191/src/content/docs/quick-installation-new-operator.md

Merge criteria:

The commits are squashed in a cohesive manner and have meaningful messages.
Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
The developer has manually tested the changes and verified that the changes work

src/content/docs/quick-installation-new-operator.md

adelton

Overall, should this be more clearly marked as waiting for 2.2 availability, to avoid getting merge prematurely?

adelton · 2023-09-26T05:27:19Z

src/content/docs/quick-installation-new-operator.md

@@ -22,7 +22,60 @@ For the purposes of this quick start, we used [try.openshift.com](https://try.op

 Tutorials will require an OpenShift cluster with a minimum of 16 CPUS and 32GB of memory across all OpenShift worker nodes.

-### Installing the New Open Data Hub Operator
+### Upgrade from v2.0/v2.1 to v2.2 and forth release


I'm not fond of having the Upgrade instructions at the top of the installation instructions page -- a new person comes to this page to read about a brand new installation.

For v1 the upgrade instructions (to 2.x) at https://opendatahub.io/docs/quick-installation/ are at the bottom of the page.

Alternatively, maybe the upgrade instructions (both 1.X -> 2.X and 2.[01] -> 2.2) should be on a completely separate page, and the main pages should just have a quick "If you are upgrading your existing installation, check ...".

adelton · 2023-09-26T05:28:42Z

src/content/docs/quick-installation-new-operator.md

+  - Under `Latest version` column, if shows `v1alpha1`, click "Edit" button(3 dots) on the right, and `Delete CustomResourceDefinition`
+  - Repeat the same procedure on `DataScienceCluster`
+
+All of the above steps can be performed either through the console UI or via the `oc`/`kubectl` CLI.


Shouldn't the exact oc commands be shown, if we suggest people use CLI?

i think the main approach is to go thro console UI which aligns with other instructions in the same document.

the reason here to mention CLI is as an alternative for those who prefer CLI that can be achieved as well.

But if this is confusion, i can remove it.

adelton · 2023-09-26T05:37:36Z

src/content/docs/quick-installation-new-operator.md

@@ -47,6 +100,8 @@ The Open Data Hub operator is available for deployment in the OpenShift Operator

 1. Click on the `Open Data Hub Operator` from `Installed Operators` page to bring up the details for the version that is currently installed.
   ![Open Data Hub Operator](../assets/img/pages/docs/quick-installation-new-operator/odh-operator.png "Open Data Hub Operator")
+   start from v2.2 release, we do not include odh-dashboard CRD in operator, you should see this instead:


Judging by the snapshot of the new version, there are additional APIs that are missing, so why single out odh-dashboard in the instructions?

What is the general plan for 2.1 vs. 2.2? Once 2.2 is released and available on the OperatorHub, will it still be possible to install 2.1 from some channel? If not, then the instructions should just be updated to talk about 2.2, not confuse people with screenshots of 2.1 version that they can no longer get.

once 2.2 is out to "fast" channel, users wont be able to install 2.0 or 2.1 from console UI.
But they can opt in that from CLI. In this case, "Create a DataScienceCluster instance" will have different screenshots to refer to.
Changes to exclude CRD of "odh-dashboard" is not part of the API upgrade. That's why made another screenshot here.

Do you feel it is better to:

keep the current upgrade page as-is for v2.0/2.1

create another new page only for v2.2/+ upgrade

or we use the current page, scrap anything for v2.0/2.1 but only for v2.2/+

But we don't document the CLI steps to install different versions than those easily obtainable via the console WebUI. So the only people who would install the 2.0/2.1 version would be developers and in general people who know what they are doing. Not the audience of this Quick Installation document. :-)

I would go with having separate page for upgrades, both for 1.X -> 2.X and 2.0,2.1 -> 2.2 cases.

And I'd prepare this page to have 2.2-only content, and ready to be pushed once 2.2 is available via OperatorHub through the OpenShift console UI.

But we don't document the CLI steps to install different versions than those easily obtainable via the console WebUI. So the only people who would install the 2.0/2.1 version would be developers and in general people who know what they are doing. Not the audience of this Quick Installation document. :-)

this is removed from the PR

adelton · 2023-09-26T05:38:24Z

src/content/docs/quick-installation-new-operator.md

@@ -59,17 +114,21 @@ The Open Data Hub operator is available for deployment in the OpenShift Operator
      1. fill in `Name` field
      2. in the `components` section, by clicking `>` it expands currently supported core components. Check the set of components enabled by default and tick/untick the box in each component section to tailor the selection.
      ![Create DSC2](../assets/img/pages/docs/quick-installation-new-operator/create-dsc-component1.png "Create DSC2")
+      start from v2.2.0 refer to below screenshot instead:


Similar to my comment above. If after 2.2 release it won't be possible to install the 2.1 operator, let's update the screenshots altogether.

adelton · 2023-09-26T05:38:38Z

src/content/docs/quick-installation-new-operator.md


   - Configure via "YAML view":
      1. write config in YAML format
      2. get detail schema by expanding righthand sidebar ![Create DSC1](../assets/img/pages/docs/quick-installation-new-operator/create-dsc-component2.png "Create DSC1")
+      start from v2.2.0 refer to below screenshot instead:


Similar to my comment above. If after 2.2 release it won't be possible to install the 2.1 operator, let's update the screenshots altogether.

src/content/docs/quick-installation-new-operator.md

zdtsw · 2023-09-26T07:35:30Z

Overall, should this be more clearly marked as waiting for 2.2 availability, to avoid getting merge prematurely?

this PR will be merged once 2.2 is released and available from opendatahub

- add example of default instance config - update channel image - add new images for api changes - add limitation resource cleanup when switch namespace Signed-off-by: Wen Zhou <[email protected]>

Signed-off-by: Wen Zhou <[email protected]>

VaishnaviHire · 2023-09-26T12:47:25Z

src/content/docs/upgrade-install-new-operator.md

+## disclaimer
+
+Version 2.2 represents an alpha release, exclusively accessible via the "fast" channel.
+Subsequent releases will transition to the "fast" channel once the new operator attains greater stability.


Should this be rolling or stable channels?

for the current v1, we release on rolling and stable, v2 on fast.
i am not sure when we stop releasing v1, are we going to use rolling or stable or both for v2

@LaVLaS can you confirm this? ^

We still release on fast channel. The question was more regarding Subsequent releases will transition to the "fast" channel once the new operator attains greater stability .

I think the transition should be the rolling channel for subsequent releases

I thought we were going to deprecate the rolling channel in line with the v1.x operator?

Also, has the v2.x operator matured beyond an alpha release to beta? I would classify alpha releases as having known bugs and not having the same level of support to deploy the ODH Core components?

VaishnaviHire · 2023-09-27T11:46:35Z

src/content/docs/upgrade-install-new-operator.md

+5. To view the status of the Open Data Hub operator installation, find the Open Data Hub Operator under `Operators` -> `Installed Operators`. It might take a couple of minutes to show, but once the `Status` field displays `Succeeded`, you can proceed to create a DataScienceCluster instance
+   ![Installed Operators](../assets/img/pages/docs/quick-installation-new-operator/operator-installed.png "Installed Operators")
+
+### Create a DataScienceCluster instance


Before this can we add a section called

[Optional] Configure applications Namespace and just add a step to access DSCInitialization with a screenshot of configured namespace

Signed-off-by: Wen Zhou <[email protected]>

zdtsw force-pushed the issue/191 branch from d66c2f4 to e31a048 Compare September 25, 2023 14:19

VaishnaviHire requested a review from adelton September 26, 2023 03:54

VaishnaviHire reviewed Sep 26, 2023

View reviewed changes

src/content/docs/quick-installation-new-operator.md Outdated Show resolved Hide resolved

src/content/docs/quick-installation-new-operator.md Outdated Show resolved Hide resolved

adelton reviewed Sep 26, 2023

View reviewed changes

zdtsw force-pushed the issue/191 branch from d73419a to f43ace2 Compare September 26, 2023 07:50

zdtsw mentioned this pull request Sep 26, 2023

[feature-tracker] Move dashboard CRD away from operator opendatahub-io/opendatahub-operator#534

Closed

5 tasks

Docs: add upgrade from v2.0/2.1 to v2.2 with API changes

98fbc92

- add example of default instance config - update channel image - add new images for api changes - add limitation resource cleanup when switch namespace Signed-off-by: Wen Zhou <[email protected]>

zdtsw force-pushed the issue/191 branch from f43ace2 to 98fbc92 Compare September 26, 2023 09:33

Docs: revert quick-installation-new-opreator create upgrade for 2.2

8c569d3

Signed-off-by: Wen Zhou <[email protected]>

zdtsw force-pushed the issue/191 branch from ca7379e to 8c569d3 Compare September 26, 2023 12:08

VaishnaviHire reviewed Sep 26, 2023

View reviewed changes

This was referenced Sep 26, 2023

Test Upgrade path for api update to v1 opendatahub-io/opendatahub-operator#546

Closed

ODH 1.10 Release Tracker opendatahub-io/opendatahub-community#104

Closed

VaishnaviHire reviewed Sep 27, 2023

View reviewed changes

zdtsw force-pushed the issue/191 branch from d5779fe to c473539 Compare September 27, 2023 12:36

Update config applicationNamespace section

9e00f31

Signed-off-by: Wen Zhou <[email protected]>

zdtsw force-pushed the issue/191 branch from c473539 to 9e00f31 Compare September 27, 2023 12:38

VaishnaviHire merged commit 24c11ac into opendatahub-io:main Sep 27, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: add upgrade from v2.0/2.1 to v2.2 with API changes #196

Docs: add upgrade from v2.0/2.1 to v2.2 with API changes #196

zdtsw commented Sep 25, 2023 •

edited

Loading

adelton left a comment

adelton Sep 26, 2023

adelton Sep 26, 2023

zdtsw Sep 26, 2023

adelton Sep 26, 2023

zdtsw Sep 26, 2023

adelton Sep 26, 2023

adelton Sep 26, 2023

zdtsw Sep 26, 2023

adelton Sep 26, 2023

adelton Sep 26, 2023

zdtsw commented Sep 26, 2023

VaishnaviHire Sep 26, 2023

zdtsw Sep 26, 2023

VaishnaviHire Sep 26, 2023

LaVLaS Sep 27, 2023

VaishnaviHire Sep 27, 2023

zdtsw Sep 27, 2023

Docs: add upgrade from v2.0/2.1 to v2.2 with API changes #196

Docs: add upgrade from v2.0/2.1 to v2.2 with API changes #196

Conversation

zdtsw commented Sep 25, 2023 • edited Loading

Description

How Has This Been Tested?

Merge criteria:

adelton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zdtsw commented Sep 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zdtsw commented Sep 25, 2023 •

edited

Loading