Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCS Installation UI flow #211

Merged
merged 20 commits into from Aug 21, 2019
Merged

Conversation

shirimordechay
Copy link

Designs of OCS 4.2 install workflow for converged mode.
Includes Operator hub view, OCS Service Installation and after installation designs.

@openshift/team-ux-leads

@openshift-ci-robot openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 23, 2019
@shirimordechay
Copy link
Author

@lizsurette @yuvalgalanti

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@julienlim julienlim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay

Please also add an entry for OpenShift Container Storage into https://github.com/openshift/openshift-origin-design/readme.md, with an entry for the OCS install workflow.

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
Copy link
Contributor

@lizsurette lizsurette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay - Awesome first PR! Well done. I've added some inline comments.

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
@openshift-ci-robot openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 26, 2019
@lizsurette lizsurette requested a review from tlwu2013 June 26, 2019 13:29
@lizsurette
Copy link
Contributor

@tlwu2013 - It would be great to hear your thoughts on whether this is in line with the current OLM design or not. I know you are continuously working on updates so it would be great to hear if this flow works with the latest and greatest.

Copy link

@tlwu2013 tlwu2013 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flow wise is looking good! I've left a comment for "Installation Mode" on Create Operator Subscription view. Another minor nit, could you help replace "Operator Hub" to "OperatorHub" in this doc to match up with UI? Also, there seem to be some updated mocks in the Google doc, wondering if we need to update the images here too.

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
Copy link
Contributor

@julienlim julienlim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think it looks good except for some minor things that should be addressed (I've left comments below).

Also, we just need to make sure the node list (how we show devices selection) and device list are synchronized between Install and Expand cluster workflows.

@shirimordechay @yuvalgalanti

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
that capacity is missing.
![Installation page](img/Installed_OCS_OCS_Tab_error_mode.png)
In the OCS service details page- show a static error message.
![Installation page](img/Installed_OCS_Overview_error.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning message has typos and also not quite right (as you can't add nodes in a AWS on OCP+RHCOS to get more capacity). You can only add capacity.

I suggest the following wording instead:
OCS-Service-1 has no capacity. Click Add Capacity to add capacity to the OCS service.

If we can have Add Capacity bring up the modal (Add Capacity modal from the Expand Cluster design), that would be good.

@shirimordechay @yuvalgalanti

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yuvalgalanti Do we have an updated modal design for "Add capacity"? if not, we should wait until the Expand cluster design is fully baked before adding it here.



# The OCS installation process
OCS Overview page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay Between the OCS_Subscription_page.png and OCS-View.png, it's missing a couple other mockups of what that workflow now looks like in OperatorHub.

Also for OCS-View.png, the "OCS" and "MCG" tabs should also exist before user creates the OCS service based on the latest OCP 4.1 OperatorHub deployment workflow.

Please update accordingly. Thanks.

@yuvalgalanti FYI.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which mockups are missing in this flow?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@julienlim Open question for you here ^

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay @lizsurette @tlwu2013

Overall it LGTM. Just the operator install/subscription didn't quite seem to match what @tlwu2013 had shared recently (https://projects.invisionapp.com/share/7TRU0EYHJNM#/screens/361317773) with me but does match closer to what's in OCP currently.

As long as @tlwu2013 is ok with it, we should be fine. :-)

@openshift-ci-robot openshift-ci-robot removed the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 18, 2019
Copy link
Contributor

@lizsurette lizsurette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great @shirimordechay ! I added a few nit picks, but am going to approve since I think everything else looks great.

@julienlim
Copy link
Contributor

Latest changes LGTM!

@lizsurette
Copy link
Contributor

I think this PR is in a good spot to merge barring an approval from @tlwu2013 on the OLM side and @beanh66 or @rileyhuston on the console side.

FYI @alimobrem @spadgett

@julienlim
Copy link
Contributor

julienlim commented Jul 22, 2019

+1 This PR LGTM barring an exceptions from @tlwu2013 on the OLM side.

Just mentioned the implementation is in progress at openshift/console#1982.

Copy link
Contributor

@rileyhuston rileyhuston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

Copy link
Contributor

@julienlim julienlim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting a small change request regarding capacity starting at 1 TiB and in 1 TiB increments only.

Copy link
Member

@beanh66 beanh66 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay @lizsurette LGTM, I left some minor comments around changes that were made to the Installed Operator detail pages for 4.2. Let me know if you have questions and we can pull @tlwu2013 in as well.

README.md Outdated Show resolved Hide resolved
Installation
![OperatorHub operators view](img/OCS-Install-step1.png)

![OperatorHub operators view](img/OCS-Install-step2.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tlwu2013 Don't we need to specify the installation mode here as well? Typically the first item in this form.

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
Shiri added 13 commits July 30, 2019 12:22
- Terminology fixes
- Removed PVCs column
- Added a pointer to show where the user is clicking throughout the screens.
- Some minor changes
remove PVCs column
Change vCPU --> CPU
Some changes in the installation flow form in select devices.

Also added an example for no capacity in OCS use case.
- Added a radio button in the OCS installation flow for IPI/ UPI selection
- Added Select devices different modes examples
Added a subscribed operator page
- Text changes
- Capacity was changed to "Selected Capacity" and now presenting the selected of available
- Error message changed
- Both tabs will show under OCS
- Design changes in installation page
- Minor changes
- IPI is removed, UPI for AWS and VMware only.
- Removed devices list and selection
- Added capacity and storage class fields
Changed to cluster.ocs.openshift.io/openshift-storage=""
- Default of 1 TiB (and no longer 4 TiB)
- Unit is not longer changeable
- Moved subscription page to new tab
- Changed Overview layout
- Re-order README.md
@openshift-ci-robot openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 30, 2019
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
### Select Nodes
Admin needs to select 3 nodes to label with “cluster.ocs.openshift.io/openshift-storage=""” (note label is subject to change as this will be automatically configured by the OCS operator) to be used for the OCS cluster.
* Admin may need to filter the list of nodes in order to make the selection (i.e. nodes that contain storage already), e.g.
Select/unselect all nodes, and exclude master nodes (e.g. based on roles)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can exclude the masters, but what if all we have are the masters?

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
* Non-master nodes’ capacity n TiB or greater (e.g. >= 10 TiB)
* Nodes with a certain name prefix or string within the node name
Admin will also specify the capacity for the cluster and the storage class to use.
* Capacity will default to 1 TiB, and user cannot modify value to be less than 1 TiB. Only TiB, PiB, and units above TiB supported. GiB and MiB are not permitted.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete.

web-console/Storage/OCS/OCS _Installation_Workflow.md Outdated Show resolved Hide resolved
Shiri added 2 commits July 31, 2019 16:03
- Install screens order was switched
- a new 5 OSD per OCS node limitation was added
- some minor changes
Copy link
Contributor

@rileyhuston rileyhuston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just added a question but overall LGTM

@lizsurette
Copy link
Contributor

Thanks for all of the hard work here @shirimordechay ! IMO we can merge once @tlwu2013 is okay with the design.

FYI @beanh66

@@ -15,6 +15,10 @@ Access design documentation for features slotted in the 4.2 release of OpenShift
- [Operators Overview](http://openshift.github.io/openshift-origin-design/web-console/future-openshift/operators-overview/operators-overview)
- [Taints and Tolerations](http://openshift.github.io/openshift-origin-design/web-console/future-openshift/taints-tolerations/taints-tolerations)

## OpenShift Container Storage
- [OCS Install workflow](./web-console/Storage/OCS/OCS_Installation_Workflow.md)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirimordechay Clicking the ocs install worklfow link is giving 404 error to me. Is there something I am doing wrong here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@julienlim
Copy link
Contributor

Just noting that the implementation can be seen at openshift/console#2359.

Shiri added 2 commits August 21, 2019 14:10
Removed capacity and storage class fields for 4.2 implementation.
@beanh66 beanh66 merged commit 8922a66 into openshift:master Aug 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet