-
Notifications
You must be signed in to change notification settings - Fork 64
OCS Installation UI flow #211
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
Changes from all commits
e179037
5501a57
ed7ce2c
5fc4019
6c7b6bd
ca9c246
faefcf3
4d6b70c
cba4b51
0dbd4c3
26d806b
863c016
0bc27cb
743d44a
ab43455
1b79583
58a707e
2507173
93b564b
d495cb4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # OCS Install Workflow | ||
|
|
||
| ### OperatorHub | ||
|
|
||
| There will be 2 OCS operator entries in OperatorHub covering each of the following modes. | ||
| * Converged Mode -- Local Cluster / Hyperconverged | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Independent Mode -- External Cluster (OCS Cluster is deployed externally) | ||
|
|
||
| ### Converged Mode Design | ||
|
|
||
| OperatorHub | ||
|  | ||
|
|
||
| Installation | ||
|  | ||
|
|
||
|  | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
|
||
| In the installed operator view the user can see the OCS operator installed. | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| # The OCS installation process | ||
| OCS Overview page | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Which mockups are missing in this flow?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @julienlim Open question for you here ^
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. :-) |
||
|  | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Clicking on "create new" (OCS Service) Will start the following installation flow: | ||
|
|
||
| Same flow will be available by clicking on the OCS tab and "Create new" button. | ||
|
|
||
| ### Select Nodes | ||
| Admin needs to select at least 3 nodes (depends on the requested capacity input) to label with “cluster.ocs.openshift.io/openshift-storage=""” (note label is subject to change as this will be automatically configured by the OCS installer) 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) | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? |
||
| * Non-master nodes of a certain flavor (CPU and memory) | ||
| * Nodes with a certain name prefix or string within the node name | ||
|
|
||
| ### Defer from 4.2: | ||
| * 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. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Delete. |
||
| * Number of nodes depends on the requested capacity input. If requested capacity is > 5 TiB, then Additional nodes must be added. | ||
| * Storage class will default to the default storage class, but user can overwrite the selection. Note: The storage classes shown will be pre-filtered to the storage classes backed by the infrastructure supported provisioner(s). | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Storage Class “Info tip” -- The Storage Class will be used to request storage from the underlying infrastructure to create the backing persistent volumes that will be used to provide the OpenShift Container Storage (OCS) service. | ||
|
|
||
|  | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|  | ||
|
|
||
|
|
||
| For AWS deployment: A new bucket will be created automatically in AWS S3 connected cloud, in the same region as the OpenShift. | ||
|
|
||
| This info note should be added in cloud deployment: | ||
|
|
||
|  | ||
| The provider name should be modified according to the Cloud Credentials operator. | ||
|
|
||
| At any point, Admin can switch to YAML by clicking on the “Edit YAML” link in the top right corner. | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| After switching to YAML, the Admin cannot switch back to the form entry. | ||
|
|
||
| The "Create" button is only enabled once all mandatory fields have been filled with valid input. | ||
|
|
||
| ## For Non-Cloud Deployments, e.g. VMware or Baremetal | ||
| In The case of on-premise the flow remains the same, the info message for creating a bucket in the cloud would be omitted. | ||
|
|
||
| # After Installation | ||
| * OCS Overview | ||
|  | ||
|
|
||
| When the creation process starts new rows for “OCS” and “MCG” will be presented in each of the instances tabs. If the deployment process runs for a while, the status “deploying” will be presented (the link is not linkable during the process). | ||
|  | ||
shirimordechay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|  | ||
|  | ||
|
|
||
| * Clicking on the “Multi Cloud Object Gateway” name will take you to the MCG Overview: | ||
|  | ||
| * Clicking on the “OCS-service-1” name will take you to the details: | ||
|  | ||
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.
@shirimordechay Clicking the ocs install worklfow link is giving 404 error to me. Is there something I am doing wrong here?
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.
It's not merged yet, try this for now: https://github.com/shirimordechay/openshift-origin-design/blob/OCS-Install-workflow/web-console/Storage/OCS/OCS%20_Installation_Workflow.md