diff --git a/README.md b/README.md index d5ac6303b..e6030e9f4 100644 --- a/README.md +++ b/README.md @@ -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) +- [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) @@ -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) \ No newline at end of file diff --git a/web-console/Storage/OCS/OCS _Installation_Workflow.md b/web-console/Storage/OCS/OCS _Installation_Workflow.md new file mode 100644 index 000000000..5b08af3c0 --- /dev/null +++ b/web-console/Storage/OCS/OCS _Installation_Workflow.md @@ -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) + +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 +![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) + * 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. +* 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) \ No newline at end of file diff --git a/web-console/Storage/OCS/img/Create_new_OCS_00.png b/web-console/Storage/OCS/img/Create_new_OCS_00.png new file mode 100644 index 000000000..6a604ee62 Binary files /dev/null and b/web-console/Storage/OCS/img/Create_new_OCS_00.png differ diff --git a/web-console/Storage/OCS/img/Create_new_OCS_01.png b/web-console/Storage/OCS/img/Create_new_OCS_01.png new file mode 100644 index 000000000..4d3900c65 Binary files /dev/null and b/web-console/Storage/OCS/img/Create_new_OCS_01.png differ diff --git a/web-console/Storage/OCS/img/Create_new_OCS_01_Additional_nodes.png b/web-console/Storage/OCS/img/Create_new_OCS_01_Additional_nodes.png new file mode 100644 index 000000000..a3f7419af Binary files /dev/null and b/web-console/Storage/OCS/img/Create_new_OCS_01_Additional_nodes.png differ diff --git a/web-console/Storage/OCS/img/Create_new_OCS_01_error.png b/web-console/Storage/OCS/img/Create_new_OCS_01_error.png new file mode 100644 index 000000000..ab5d452fa Binary files /dev/null and b/web-console/Storage/OCS/img/Create_new_OCS_01_error.png differ diff --git a/web-console/Storage/OCS/img/Installed_MCG_Tab_healthy.png b/web-console/Storage/OCS/img/Installed_MCG_Tab_healthy.png new file mode 100644 index 000000000..6a5cee769 Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_MCG_Tab_healthy.png differ diff --git a/web-console/Storage/OCS/img/Installed_OCS_MCG_Overview.png b/web-console/Storage/OCS/img/Installed_OCS_MCG_Overview.png new file mode 100644 index 000000000..7c84e3b31 Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_OCS_MCG_Overview.png differ diff --git a/web-console/Storage/OCS/img/Installed_OCS_OCS_Overview.png b/web-console/Storage/OCS/img/Installed_OCS_OCS_Overview.png new file mode 100644 index 000000000..6a8ba893b Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_OCS_OCS_Overview.png differ diff --git a/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_deploy.png b/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_deploy.png new file mode 100644 index 000000000..007fef4de Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_deploy.png differ diff --git a/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_healthy.png b/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_healthy.png new file mode 100644 index 000000000..c62cd9533 Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_OCS_OCS_Tab_healthy.png differ diff --git a/web-console/Storage/OCS/img/Installed_OCS_Overview.png b/web-console/Storage/OCS/img/Installed_OCS_Overview.png new file mode 100644 index 000000000..3d54bff3e Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_OCS_Overview.png differ diff --git a/web-console/Storage/OCS/img/Installed_operators_list.png b/web-console/Storage/OCS/img/Installed_operators_list.png new file mode 100644 index 000000000..a8db79289 Binary files /dev/null and b/web-console/Storage/OCS/img/Installed_operators_list.png differ diff --git a/web-console/Storage/OCS/img/MCG_resource_page_details.png b/web-console/Storage/OCS/img/MCG_resource_page_details.png new file mode 100644 index 000000000..beb3323ef Binary files /dev/null and b/web-console/Storage/OCS/img/MCG_resource_page_details.png differ diff --git a/web-console/Storage/OCS/img/OCS-Install-step1.png b/web-console/Storage/OCS/img/OCS-Install-step1.png new file mode 100644 index 000000000..44016e1dd Binary files /dev/null and b/web-console/Storage/OCS/img/OCS-Install-step1.png differ diff --git a/web-console/Storage/OCS/img/OCS-Install-step2.png b/web-console/Storage/OCS/img/OCS-Install-step2.png new file mode 100644 index 000000000..7854e0adf Binary files /dev/null and b/web-console/Storage/OCS/img/OCS-Install-step2.png differ diff --git a/web-console/Storage/OCS/img/OCS-View.png b/web-console/Storage/OCS/img/OCS-View.png new file mode 100644 index 000000000..0ea7a2d03 Binary files /dev/null and b/web-console/Storage/OCS/img/OCS-View.png differ diff --git a/web-console/Storage/OCS/img/OCS-operator-view.png b/web-console/Storage/OCS/img/OCS-operator-view.png new file mode 100644 index 000000000..c52bb6b8a Binary files /dev/null and b/web-console/Storage/OCS/img/OCS-operator-view.png differ diff --git a/web-console/Storage/OCS/img/OCS_Subscription_page.png b/web-console/Storage/OCS/img/OCS_Subscription_page.png new file mode 100644 index 000000000..b5926ed84 Binary files /dev/null and b/web-console/Storage/OCS/img/OCS_Subscription_page.png differ diff --git a/web-console/Storage/OCS/img/Operator_Catalog_list.png b/web-console/Storage/OCS/img/Operator_Catalog_list.png new file mode 100644 index 000000000..f476dcb09 Binary files /dev/null and b/web-console/Storage/OCS/img/Operator_Catalog_list.png differ diff --git a/web-console/Storage/OCS/img/info.png b/web-console/Storage/OCS/img/info.png new file mode 100644 index 000000000..b15f736b2 Binary files /dev/null and b/web-console/Storage/OCS/img/info.png differ