Added requirements analysis and design proposal for Helm deployment for eSDK #38

anvithks · 2021-08-24T08:06:39Z

Added the requirements analysis and design for Helm deployment of eSDK plugins.

Added sample chart
Added sample values
Added design for supporting snapshot and resize

The implementation can be checked using #35

…or eSDK

AmitRoushan · 2021-08-24T08:18:13Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+- ClusterRoleBinding
+
+Sample:
+```text


cosmetic: text --> yaml

AmitRoushan · 2021-08-24T08:18:50Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+High availability support of controller plugin will be part of future work.
+
+Sample:
+```text


cosmetic: text --> yaml

AmitRoushan · 2021-08-24T08:20:13Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+- Keep username and password secure
+
+##### Other Non Functional Requirements (Scalability, HA etc…)
+- Image size should be be large.


typo: "be" -> "not"

AmitRoushan · 2021-08-24T08:22:59Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+- This folder contains samples with some examples of basic deployments
+
+### Helm repository
+<!-- - If time permits and required -->


IMO, If helm repository is not planned to support, Remove the section

AmitRoushan · 2021-08-24T08:25:18Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+### Configuration Management
+Helm uses a packaging format called charts. A chart is a collection of files that describe a related set of Kubernetes 
+resources. Charts are created as files laid out in a particular directory tree. They can be packaged into versioned 
+archives to be deployed.


cosmetic comment: "They can be packaged into versioned archives to be deployed." --> "The same directory tree can be archived and used for deployment"

AmitRoushan · 2021-08-24T08:25:49Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+
+#### Charts.yaml
+
+```text


cosmetic: text --> yaml

AmitRoushan · 2021-08-24T08:26:09Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+#### values.yaml
+The file maintains default values of different configurable attributes in templates files.
+
+```text


cosmetic: text --> yaml

AmitRoushan · 2021-08-24T08:27:20Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+              mountPath: /registration
+
+        - name: huawei-csi-driver
+          image: {{ required "Must provide the CSI controller service node image." .Values.images.huaweiCsiNodeService }}


typo: "Must provide the CSI controller service node image." --> ""Must provide the CSI node service image.""

AmitRoushan · 2021-08-24T08:29:11Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+```
+
+##### huawei.csi.configmap.yaml
+```text


cosmetic: text --> yaml

AmitRoushan · 2021-08-24T08:31:49Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+https://rafay.co/the-kubernetes-current/helm-chart-hooks-tutorial/
+
+
+**Open Points**


IMO, open points can be discussed and resolved

This is the scratchpad section. The open points do need to be discussed and resolved.

Removed sections which are not relevant.

AmitRoushan · 2021-08-24T08:33:58Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+//All raw inputs or discussion points or etc can be added here
+https://github.com/jsafrane/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md#recommended-mechanism-for-deploying-csi-drivers-on-kubernetes
+
+#### Multiarchitecture images with docker


Please remove the section

Will remove. this is the scratchpad though.

AmitRoushan · 2021-08-24T08:34:35Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+
+https://medium.com/@artur.klauser/building-multi-architecture-docker-images-with-buildx-27d80f7e2408
+
+#### Dell powermax CSI Helm deployment


IMO, The section can be removed

itsbasabee

Please address the comments.

itsbasabee · 2021-08-24T11:33:25Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+
+- This document assumes Kubernetes as the orchestrator.
+- For the intitial design of the Helm deployment, the current state of the eSDK plugin will be considered.
+- Adapting the deployments of new features should be taken care by the feature owners.


Please change :
"should be taken care" -> "should be taken care of"

itsbasabee · 2021-08-24T11:35:47Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+- This document assumes Kubernetes as the orchestrator.
+- For the intitial design of the Helm deployment, the current state of the eSDK plugin will be considered.
+- Adapting the deployments of new features should be taken care by the feature owners.
+- eSDK container images should be made available through image repository (local or remote) or should be available locally on the node.


Please change :
"or should be available locally on the node" -> "locally on the node"

kumarashit · 2021-08-26T05:35:54Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+    - In this release no support for HA of controller plugin.
+    - The design for the same will be proposed in a different design document.
+- Secret configuration management of backend storage
+    - Currently the username and password are sensitive information for storage backend and are visible in plain text.


Where is it stored as of now in plain text?

This was incorrect. The username and password are stored using the Kubernetes secret resource.
This has been fixed.

kumarashit · 2021-08-26T05:39:02Z

design-proposals/helm-deployment/helmDeploymentRequirements.md

+home: https://github.com/Huawei/eSDK_K8S_Plugin
+sources:
+  - https://github.com/Huawei/eSDK_K8S_Plugin
+appVersion: "2.2.13"# The version of the app that this contains (optional). Quotes recommended.


This will be configurable basically taken from ENV or input, right?

At the moment we have considered this input manually. Every time there is a new release we need to updated the chart with the latest release number of the application, in this case eSDK release version.

tongpu · 2021-10-25T12:44:35Z

We've already developed a Helm chart for deploying the Huawei CSI plugin in the past: https://github.com/adfinis-sygroup/helm-charts/tree/master/charts/huawei-csi-plugin

Feel free to take whatever is required to improve your chart from there. I'll look into the current proposal in this PR and provide some feedback from our experience up to now.

anvithks · 2021-10-25T13:59:11Z

Thank you @tongpu .I will check it out.

Added requirements analysis and design proposal for Helm deployment f…

d34c97b

…or eSDK

AmitRoushan suggested changes Aug 24, 2021

View reviewed changes

Addressed review comments. Fixed typos, changed code block formatting.

ab67758

itsbasabee reviewed Aug 24, 2021

View reviewed changes

Addressed review comments. Updated assumptions and constraints

5a90920

kumarashit reviewed Aug 26, 2021

View reviewed changes

handled review comments. Added use case views.

b6ebffc

		https://rafay.co/the-kubernetes-current/helm-chart-hooks-tutorial/


		Open Points


		https://medium.com/@artur.klauser/building-multi-architecture-docker-images-with-buildx-27d80f7e2408

		#### Dell powermax CSI Helm deployment

Added requirements analysis and design proposal for Helm deployment for eSDK #38

Are you sure you want to change the base?

Added requirements analysis and design proposal for Helm deployment for eSDK #38

Conversation

anvithks commented Aug 24, 2021

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

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

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

itsbasabee 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

tongpu commented Oct 25, 2021 • edited Loading

anvithks commented Oct 25, 2021

tongpu commented Oct 25, 2021 •

edited

Loading