Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- [OB-OB-Lifecycle-Management ](./web-console/Storage/OB-OB-Lifecycle-Management/OB-OBC-Lifecycle.md)

### KNI and KubeVirt Designs
[Access design documentation specific to the KNI and Kubevirt features in the OpenShift Console.](http://openshift.github.io/openshift-origin-design/web-console/knikubevirt/knikubevirt)

Expand Down Expand Up @@ -106,7 +110,3 @@ The following designs are under consideration for use in future releases of Open
- [CNV Integration](./web-console/old/conceptual-designs/cnv.md)
- [Create Pull Secret](./web-console/old/conceptual-designs/pull-secret.md)
- [Topology View](./web-console/old/conceptual-designs/topology.md)

## OpenShift Container Storage
- [OCS Install workflow](./web-console/Storage/OCS/OCS_Installation_Workflow.md)
- [OB-OB-Lifecycle-Management ](./web-console/Storage/OB-OB-Lifecycle-Management/OB-OBC-Lifecycle.md)
76 changes: 76 additions & 0 deletions web-console/Storage/OCS/OCS _Installation_Workflow.md
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
* Independent Mode -- External Cluster (OCS Cluster is deployed externally)

### Converged Mode Design

OperatorHub
![OperatorHub operators view](img/OCS-operator-view.png)

Installation
![OperatorHub operators view](img/OCS-Install-step1.png)

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

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.


In the installed operator view the user can see the OCS operator installed.
![OperatorHub operators view](img/Installed_operators_list.png)

![subscription operators page](img/OCS_Subscription_page.png)

# 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. :-)

![OCS-View](img/OCS-View.png)

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)
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?

* 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.
Copy link

Choose a reason for hiding this comment

The 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).
* 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.

![create new](img/Create_new_OCS_00.png)
![use existing](img/Create_new_OCS_01.png)


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:

![Info note](img/info.png)
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.
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
![Installation page](img/Installed_OCS_OCS_Overview.png)

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).
![OCS Tab](img/Installed_OCS_OCS_Tab_deploy.png)
![OCS Tab](img/Installed_OCS_OCS_Tab_healthy.png)
![MCG Tab](img/Installed_MCG_Tab_healthy.png)

* Clicking on the “Multi Cloud Object Gateway” name will take you to the MCG Overview:
![mcg overview](img/Installed_OCS_MCG_Overview.png)
* Clicking on the “OCS-service-1” name will take you to the details:
![mcg overview](img/Installed_OCS_Overview.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web-console/Storage/OCS/img/OCS-View.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web-console/Storage/OCS/img/info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.