Fix PR 4798 comments

Author: gqiu-sycomp-com

community/examples/sycomp/sycomp-storage-ece.yaml

@@ -46,24 +46,24 @@ deployment_groups:
     settings:
       security:
         ssh:
-          ssh_user_name: ""      ## Set user name to ssh mgmt node, for example: "sycompacct"
-          private_key: ""        ## Set private key file, for example: ~/.ssh/id_rsa
-          public_key: ""         ## Set public key file, for example: ~/.ssh/id_rsa.pub
+          ssh_user_name: ""      ## Set user name to ssh mgmt node, for example: "sycompacct".
+          private_key: ""        ## Set private key file, for example: ~/.ssh/id_rsa.
+          public_key: ""         ## Set public key file, for example: ~/.ssh/id_rsa.pub.
         customer_token:
-          token: ""              ## Set Your Customer Token
+          token: ""              ## Set Your Customer Token.
       ece:
-        use_ece: true            ## Set deploy mode to ECE
-        ece_node_per_rg: 7       ## Set the number of nodes for each Recovery Group
-        ece_raid_code: "4+2p"    ## Set the raid code
-        ece_block_size: "1m"     ## Set block size
+        use_ece: true            ## Set deploy mode to ECE.
+        ece_node_per_rg: 7       ## The number of nodes for each Recovery Group, When using ece_raid_code "4+2p" the recommended number of nodes per recovery group is 7.
+        ece_raid_code: ""        ## The raid code, for example: "4+2p".
+        ece_block_size: ""       ## Set block size, for example: "1m".
 
       scale_config:
-        scale_node_count: 7                   ## Number of storage nodes to deploy
-        scale_machine_type: "c3-standard-44"  ## Instance type of the storage nodes
+        scale_node_count: 7                   ## Number of storage nodes to deploy, its value must be equal to or a multiple of ece_node_per_rg.
+        scale_machine_type: "c3-standard-44"  ## Instance type of the storage nodes, "c3-standard-44" is recommended value.
         scale_volumes:
           data-storage:
-            count: 3                          ## Number of disks to configure on each storage node
-            size_in_gb: 250                   ## Size of each disk
-            type: "hyperdisk-balanced"        ## Type of persistent disk to use
-            provisioned_iops: 30000           ## Provisioned IOPS per disk, required for Hyperdisk
-            provisioned_throughput: 500       ## Provisioned Throughput in MiB/sec per disk, required for Hyperdisk
+            count: 3                          ## Number of disks to configure on each storage node. This value is configurable.
+            size_in_gb: 250                   ## Size of each disk in GB. Change '250' to your desired size.
+            type: "hyperdisk-balanced"        ## Type of persistent disk to use. This value is configurable.
+            provisioned_iops: 30000           ## Provisioned IOPS per disk, required for Hyperdisk.
+            provisioned_throughput: 500       ## Provisioned Throughput in MiB/sec per disk, required for Hyperdisk.

community/examples/sycomp/sycomp-storage-expansion.yaml

@@ -34,4 +34,4 @@ deployment_groups:
     source: "git::https://gitlab.com/sycomp/cluster-toolkit.git//sycomp-scale-expansion?ref=v1.0.0"
     settings:
       name_prefix: "<name_prefix_of_existing_cluster>" ## Set to the name_prefix of the cluster to expand. See the README for details on how this value is determined.
-      add_scale_nodes: 1                               ## Number of storage nodes to add
+      add_scale_nodes: 1                               ## Number of storage nodes to add, This value is configurable.

community/examples/sycomp/sycomp-storage-slurm.yaml

@@ -53,15 +53,15 @@ deployment_groups:
         customer_token:
           token: ""                           ## Set Your Customer Token
       scale_config:
-        scale_node_count: 3                   ## Number of storage nodes to deploy
-        scale_machine_type: "c3-standard-44"  ## Instance type of the storage nodes
+        scale_node_count: 3                   ## Number of storage nodes to deploy. This value is configurable.
+        scale_machine_type: "c3-standard-44"  ## Instance type of the storage nodes. This value is configurable.
         scale_volumes:
           data-storage:
-            count: 4                          ## Number of disks to configure on each storage node
-            size_in_gb: 250                   ## Size of each disk
-            type: "hyperdisk-balanced"        ## Type of persistent disk to use
-            provisioned_iops: 30000           ## Provisioned IOPS per disk, required for Hyperdisk
-            provisioned_throughput: 500       ## Provisioned Throughput in MiB/sec per disk, required for Hyperdisk
+            count: 4                          ## Number of disks to configure on each storage node. This value is configurable.
+            size_in_gb: 250                   ## Size of each disk in GB. Change '250' to your desired size.
+            type: "hyperdisk-balanced"        ## Type of persistent disk to use. This value is configurable.
+            provisioned_iops: 30000           ## Provisioned IOPS per disk, required for Hyperdisk.
+            provisioned_throughput: 500       ## Provisioned Throughput in MiB/sec per disk, required for Hyperdisk.
 
       ces_config:
         enabled: true                         ## A value of true enables NFS service

community/examples/sycomp/sycomp-storage.yaml

@@ -61,6 +61,6 @@ deployment_groups:
             type: "hyperdisk-balanced"       ## Type of persistent disk to use
             provisioned_iops: 30000          ## Provisioned IOPS per disk, required for Hyperdisk
             provisioned_throughput: 500      ## Provisioned Throughput in MiB/sec per disk, required for Hyperdisk
-        afm_config:
-          afm_node_count: 1                  ## Number of AFM nodes to deploy
-          afm_machine_type: "c3-standard-44" ## Instance type of the AFM nodes
+      afm_config:
+        afm_node_count: 1                    ## Number of AFM nodes to deploy
+        afm_machine_type: "c3-standard-44"   ## Instance type of the AFM nodes