IBM block storage CSI Integration with IBM Cloud Satellite Storage #83

ArbelNathan · 2021-03-03T08:48:27Z

GHE issue: #26

prgavali · 2021-03-03T09:59:04Z

config-templates/ibm/ibm-csi-block/1.4.0/metadata.json

+    {
+      "key": "support-description",
+      "value": "For support contact IBM: https://www.ibm.com/support/home/"
+    }


make it . This will enable UI to display URL as a hyperlink

{ "key": "support_URL", "value": "https://www.ibm.com/support/home/" }

prgavali · 2021-03-03T09:59:54Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"displayname": "Secret name",
+	"name": "secret-name",
+	"required": "true",
+	"category": "text"


Replace "category": "text" to "category": "config"

We have 2 categories config and secret

in every "category": "text" in file?

in custom_parameters.json too?

prgavali

added comments

derekpoindexter

left comments & commit suggestions - also had a few questions about the parameters and where to find them/examples

derekpoindexter · 2021-03-03T14:09:31Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+
+IBM block storage CSI driver is based on an open-source IBM project, included as a part of IBM Storage orchestration for containers. IBM Storage orchestration for containers enables enterprises to implement a modern container-driven hybrid multicloud environment that can reduce IT costs and enhance business agility, while continuing to derive value from existing systems.
+
+For full release notes, compatiblity, installation, and user information, see the IBM block storage CSI driver documentation: https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/


Suggested change

For full release notes, compatiblity, installation, and user information, see the IBM block storage CSI driver documentation: https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/

For full release notes, compatiblity, installation, and user information, see the [IBM block storage CSI driver](documentation: https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/).

derekpoindexter · 2021-03-03T14:10:48Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+
+## Prerequisites
+
+For full prerequisite instructions, see the following documentation, referred to in the introductory paragraph. 


Suggested change

For full prerequisite instructions, see the following documentation, referred to in the introductory paragraph.

- Review the [compatibility and requirements documentation](https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/csi_ug_requirements.html).

Which steps do they need to complete on this page or others? It would be good to have a list of prereqs with links like

- Review the compatibility and requirements - [Install the required packages](link) - etc

done
I think the documentation is good enough, if we will right it again here we could miss or change things that will cause issues.
they need to go over all of it.

derekpoindexter · 2021-03-03T14:13:15Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+## Prerequisites
+
+For full prerequisite instructions, see the following documentation, referred to in the introductory paragraph. 
+**Installation** > **Compatibility and requirements**.


Suggested change

**Installation** > **Compatibility and requirements**.

derekpoindexter · 2021-03-03T14:15:15Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+
+
+


Suggested change

derekpoindexter · 2021-03-03T14:19:36Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+| Parameter | Required? | Description | Default value if not provided |
+| --- | --- | --- | --- |
+| `namespace` | Optional | Deployment namespace. | `default` |
+| `sc-name` | Required | Storage class name to be created | N/A |
+| `space-efficiency` | Optional | Space efficiency of volume to be created | N/A |
+| `pool` | Required | Pool ID of volume to be created in | N/A |
+| `secret-name` | Required | Existing secret name | N/A |
+| `secret-namespace` | Required | Existing secret name namespace | N/A |
+| `fstype` | Optional | File system type | `ext4` |
+| `prefix` | Optional | Prefix name of volume to be created | N/A |
+| `VolumeExpansion` | Optional | Is volume expansion allowed? | `false` |


Suggested change

| Parameter | Required? | Description | Default value if not provided |

| --- | --- | --- | --- |

| `namespace` | Optional | Deployment namespace. | `default` |

| `sc-name` | Required | Storage class name to be created | N/A |

| `space-efficiency` | Optional | Space efficiency of volume to be created | N/A |

| `pool` | Required | Pool ID of volume to be created in | N/A |

| `secret-name` | Required | Existing secret name | N/A |

| `secret-namespace` | Required | Existing secret name namespace | N/A |

| `fstype` | Optional | File system type | `ext4` |

| `prefix` | Optional | Prefix name of volume to be created | N/A |

| `VolumeExpansion` | Optional | Is volume expansion allowed? | `false` |

| Parameter | Required? | Description | Default value if not provided |

| --- | --- | --- | --- |

| `namespace` | Optional | The namespace where you want to create the deployment. | `default` |

| `sc-name` | Required | The name of the storage class name that is created. | N/A |

| `space-efficiency` | Optional | The space efficiency of the volume that is created. Example: | N/A |

| `pool` | Required | The ID of the worker pool where you want to create the volume. Example: | N/A |

| `secret-name` | Required | The name of your existing Kubernetes secret. | N/A |

| `secret-namespace` | Required | The namespace that your Kubernetes secret is in. | N/A |

| `fstype` | Optional | The file system type. Specify... | `ext4` |

| `prefix` | Optional | The prefix name of the volume that is created. Example: | N/A |

| `VolumeExpansion` | Optional | Specify `true` to allow volume expansion or `false` to disallow volume expansion. | `false` |

Do the secret & deployment namespace need to be the same?

What are some examples of the space-effeciency parameter? Or a link to review examples.

Is pool the worker pool id?

What are possible fstypes

What are possible prefixes or examples

done
instead of adding examples (that eventually mislead due to other options that will not be included in them) I added a link for this step in our documentation that include explanation on all fields.

derekpoindexter · 2021-03-03T14:30:57Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"category": "config"
+  },
+  {
+	"description": "Existing secret name",


Suggested change

"description": "Existing secret name",

"description": "The name of your existing Kubernetes secret.",

derekpoindexter · 2021-03-03T14:31:16Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"category": "config"
+  },
+  {
+	"description": "Existing secret name namespace",


Suggested change

"description": "Existing secret name namespace",

"description": "The namespace that your Kubernetes secret is in.",

derekpoindexter · 2021-03-03T14:31:27Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"category": "config"
+  },
+  {
+	"description": "File system type",


Suggested change

"description": "File system type",

"description": "The file system type.",

derekpoindexter · 2021-03-03T14:31:52Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"category": "config"
+  },
+  {
+	"description": "Prefix name of volume to be created",


Suggested change

"description": "Prefix name of volume to be created",

"description": "The prefix name of the volume that is created.",

derekpoindexter · 2021-03-03T14:33:03Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+	"category": "config"
+  },
+  {
+	"description": "Is volume expansion allowed?",


Suggested change

"description": "Is volume expansion allowed?",

"description": "Specify 'true' to allow volume expansion or 'false' to disallow volume expansion.",

derekpoindexter · 2021-03-03T14:38:13Z

can you also provide example pvc / pv and app pods per the readme - https://github.com/IBM/ibm-satellite-storage/blob/develop/.github/README_TEMPLATE.md#deploying-an-app-that-uses-your-storage-configuration

derekpoindexter · 2021-03-03T14:48:58Z

config-templates/ibm/ibm-csi-block/1.4.0/README.md

+```
+
+ibmcloud sat storage template get --name ibm-csi-block --version 1.4.0
+
+```


Suggested change

```

ibmcloud sat storage template get --name ibm-csi-block --version 1.4.0

```

ibmcloud sat storage template get --name ibm-csi-block --version 1.4.0

what is the fix?

I changed, hope it what you meant

removing the extra linebreaks on L19 & 21

ArbelNathan · 2021-03-03T16:01:55Z

can you also provide example pvc / pv and app pods per the readme - https://github.com/IBM/ibm-satellite-storage/blob/develop/.github/README_TEMPLATE.md#deploying-an-app-that-uses-your-storage-configuration

All pvc / pv/ app pods/ storageclass/ secret/ snapshot ect. examples with commands and outputs can be found in our Documentation. objects examples, using examples

prgavali · 2021-03-16T06:28:06Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-parameters.json

+  {
+	"description": "The name of the storage class that is created.",
+	"displayname": "Storage Class name",
+	"name": "sc-name",


Change "sc-name" to "name" . we have some checks over it

Also add new variable for is-default-class

eg

"description": "Specify 'true' or 'false' to make the created storage class the default class.", "displayname": "Default", "name": "is-default-class", "default": "false", "required": "false", "category": "config", "type": "text" }, ```

prgavali · 2021-03-16T06:30:46Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-template.yaml

+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: "{{ sc-name }}"


Change "sc-name" to "name"
and add add new variable for is-default-class

. Please refer https://github.com/IBM/ibm-satellite-storage/blob/develop/config-templates/netapp/netapp-ontap-san/20.07/storage-class-template.yaml

prgavali

added couple of comments

storageclass name parameter and default sc

prgavali · 2021-03-16T15:04:40Z

config-templates/ibm/ibm-csi-block/1.4.0/storage-class-template.yaml

+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: "{{ name }}"


Can you add annotation for is-default-class in storageclass-template ?
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: "{{ name }}"
annotations:
storageclass.kubernetes.io/is-default-class: "{{ is-default-class }}"

prgavali

LGTM

ArbelNathan · 2021-03-18T08:10:52Z

tested (through API with storageclass) and working.
also works with CLI cmd (no storageclass)

nkkashyap

Looks good

* parameters (#79) * parameters * Update custom-parameters.json * Update custom-parameters.json * Update custom-parameters.json * Update custom-parameters.json * Update AWS EBS SC doc (#80) * Made changes to create the COS secret from the template * Added command to fetch endpoints from CLI * Addressed README review comments * Addressed review comments * Updated to get COS location and endpoint from UI * Update max volume limit for AWS EBS gold Storageclass (#81) * Update README.md * Added the ocs-remote template * Fix AWS template's metadata (#87) * Updated the readme according to review comments * Addressed review comments * Addressed review comments * Updated ocs-local template with disk path changes * Update README.md * fixed parameter mismatch for netapp (#88) * fixed parameter mismatch for netapp Signed-off-by: Neeraj K Kashyap <[email protected]> * fixed parameter mismatch for netapp Signed-off-by: Neeraj K Kashyap <[email protected]> * fixed parameter mismatch for netapp Signed-off-by: Neeraj K Kashyap <[email protected]> * update logo images (#90) Signed-off-by: Neeraj K Kashyap <[email protected]> * Added regex and placeholder (#89) * IBM block storage CSI Integration with IBM Cloud Satellite Storage (#83) * adding first testing files * add diver to template list * temp metadata.json * type -> category * add default ext4 to Fstype parameter in StorageClass * remove sc files * new README.md * 2 README.md * 3 README.md * remove line * add info from template and running deployment * new line * fixes * add sc * remove "" in boolean * add storageclass to README.md * refactoring * PR - support_URL, text to config * change order * PR fixes * pool parameter description change * minor fixes * PR storageclass name parameter and default sc * PR added annotations is-default-class * Added regex and placeholder- updated name (#94) * update netapp templates Signed-off-by: Neeraj K Kashyap <[email protected]> * PR added annotations is-default-class * Fix devicePath issue in local-volume-file template (#92) * Fix devicePath issue in local-volume-file template * Update deployment.yaml * add regex and update description (#97) * add regex and update description Signed-off-by: Neeraj K Kashyap <[email protected]> * add regex and update description Signed-off-by: Neeraj K Kashyap <[email protected]> * add regex and update description Signed-off-by: Neeraj K Kashyap <[email protected]> * disable a template for prod promotion (#99) Signed-off-by: Neeraj K Kashyap <[email protected]> Co-authored-by: derekpoindexter <[email protected]> Co-authored-by: Mayank Sachan <[email protected]> Co-authored-by: Shirisha.S.Rao1 <[email protected]> Co-authored-by: Shirisha-S-Rao-1 <[email protected]> Co-authored-by: Pramod Gavali <[email protected]> Co-authored-by: Arbel Nathan <[email protected]>

arbelnat added 17 commits January 26, 2021 13:41

adding first testing files

6b1ff90

add diver to template list

3db3d2f

temp metadata.json

315772a

type -> category

5b8cb42

add default ext4 to Fstype parameter in StorageClass

3cb18a0

remove sc files

433322c

new README.md

4d8f715

2 README.md

4b1ea08

3 README.md

29e4126

remove line

97ad519

add info from template and running deployment

70f5bd0

new line

0df4f4e

fixes

18895d3

add sc

088c2a0

remove "" in boolean

76d1ce3

add storageclass to README.md

23cd7c7

refactoring

e5bf855

nkkashyap requested review from nkkashyap, derekpoindexter and prgavali March 3, 2021 08:54

prgavali reviewed Mar 3, 2021

View reviewed changes

prgavali requested changes Mar 3, 2021

View reviewed changes

arbelnat added 2 commits March 3, 2021 16:07

PR - support_URL, text to config

f4bb4d4

change order

ea5c6e2

derekpoindexter requested changes Mar 3, 2021

View reviewed changes

derekpoindexter reviewed Mar 3, 2021

View reviewed changes

arbelnat added 2 commits March 3, 2021 17:44

PR fixes

fee1f81

pool parameter description change

152926b

minor fixes

e1df39d

prgavali reviewed Mar 16, 2021

View reviewed changes

prgavali requested changes Mar 16, 2021

View reviewed changes

PR

09663eb

storageclass name parameter and default sc

prgavali reviewed Mar 16, 2021

View reviewed changes

PR added annotations is-default-class

31fa73d

prgavali approved these changes Mar 17, 2021

View reviewed changes

nkkashyap approved these changes Mar 22, 2021

View reviewed changes

nkkashyap merged commit 8a99b7e into IBM:develop Mar 22, 2021


		IBM block storage CSI driver is based on an open-source IBM project, included as a part of IBM Storage orchestration for containers. IBM Storage orchestration for containers enables enterprises to implement a modern container-driven hybrid multicloud environment that can reduce IT costs and enhance business agility, while continuing to derive value from existing systems.

		For full release notes, compatiblity, installation, and user information, see the IBM block storage CSI driver documentation: https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/


		## Prerequisites

		For full prerequisite instructions, see the following documentation, referred to in the introductory paragraph.

	For full prerequisite instructions, see the following documentation, referred to in the introductory paragraph.
	- Review the [compatibility and requirements documentation](https://www.ibm.com/support/knowledgecenter/SSRQ8T_1.4.0/csi_ug_requirements.html).

	"description": "Existing secret name",
	"description": "The name of your existing Kubernetes secret.",

	"description": "Existing secret name namespace",
	"description": "The namespace that your Kubernetes secret is in.",

	"description": "File system type",
	"description": "The file system type.",

	"description": "Prefix name of volume to be created",
	"description": "The prefix name of the volume that is created.",

	"description": "Is volume expansion allowed?",
	"description": "Specify 'true' to allow volume expansion or 'false' to disallow volume expansion.",

IBM block storage CSI Integration with IBM Cloud Satellite Storage #83

IBM block storage CSI Integration with IBM Cloud Satellite Storage #83

Conversation

ArbelNathan commented Mar 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prgavali Mar 3, 2021 • edited Loading

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

prgavali left a comment

Choose a reason for hiding this comment

derekpoindexter 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

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

derekpoindexter commented Mar 3, 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

ArbelNathan commented Mar 3, 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

prgavali left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prgavali left a comment

Choose a reason for hiding this comment

ArbelNathan commented Mar 18, 2021 • edited Loading

nkkashyap left a comment

Choose a reason for hiding this comment

prgavali Mar 3, 2021 •

edited

Loading

ArbelNathan commented Mar 18, 2021 •

edited

Loading