refact(upgrade): added newline to comments to make the yaml readable (o…

…penebs#2726) Signed-off-by: shubham <shubham.bajpai@mayadata.io>
Hardeep18 · Aug 29, 2019 · 22f6562 · 22f6562
1 parent 7b69180
commit 22f6562
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 35 deletions.
diff --git a/k8s/upgrades/1.0.0-1.1.0/example-cstor-spc-upgrade-job.yaml b/k8s/upgrades/1.0.0-1.1.0/example-cstor-spc-upgrade-job.yaml
@@ -1,40 +1,48 @@
-#This is an example YAML for upgrading cstor SPC. 
-#Some of the values below needs to be changed to
-#match your openebs installation. The fields are
-#indicated with VERIFY
+# This is an example YAML for upgrading cstor SPC. 
+# Some of the values below needs to be changed to
+# match your openebs installation. The fields are
+# indicated with VERIFY
 ---
 apiVersion: batch/v1
 kind: Job
 metadata:
-  #VERIFY that you have provided a unique name for this upgrade job.
-  #The name can be any valid K8s string for name. This example uses
-  #the following convention: cstor-spc-<flattened-from-to-versions>-<spc-name>
+
+  # VERIFY that you have provided a unique name for this upgrade job.
+  # The name can be any valid K8s string for name. This example uses
+  # the following convention: cstor-spc-<flattened-from-to-versions>-<spc-name>
   name: cstor-spc-100110-cstor-sparse-pool
-  #VERIFY the value of namespace is same as the namespace where openebs components
+
+  # VERIFY the value of namespace is same as the namespace where openebs components
   # are installed. You can verify using the command:
   # `kubectl get pods -n <openebs-namespace> -l openebs.io/component-name=maya-apiserver`
   # The above command should return status of the openebs-apiserver.
   namespace: openebs
+
 spec:
   backoffLimit: 4
   template:
     spec:
-      #VERIFY the value of serviceAccountName is pointing to service account
+
+      # VERIFY the value of serviceAccountName is pointing to service account
       # created within openebs namespace. Use the non-default account.
       # by running `kubectl get sa -n <openebs-namespace>`
       serviceAccountName: openebs-maya-operator
+
       containers:
       - name:  upgrade
         args:
         - "cstor-spc"
         - "--from-version=1.0.0"
         - "--to-version=1.1.0"
-        #VERIFY that you have provided the correct SPC Name
+
+        # VERIFY that you have provided the correct SPC Name
         - "--spc-name=sparse-claim-auto"
-        #Following are optional parameters
-        #Log Level
+
+        # Following are optional parameters
+        # Log Level
         - "--v=4"
-        #DO NOT CHANGE BELOW PARAMETERS
+
+        # DO NOT CHANGE BELOW PARAMETERS
         env:
         - name: OPENEBS_NAMESPACE
           valueFrom:

diff --git a/k8s/upgrades/1.0.0-1.1.0/example-cstor-volume-upgrade-job.yaml b/k8s/upgrades/1.0.0-1.1.0/example-cstor-volume-upgrade-job.yaml
@@ -1,39 +1,47 @@
-#This is an example YAML for upgrading cstor volume. 
-#Some of the values below needs to be changed to
-#match your openebs installation. The fields are
-#indicated with VERIFY
+# This is an example YAML for upgrading cstor volume. 
+# Some of the values below needs to be changed to
+# match your openebs installation. The fields are
+# indicated with VERIFY
 ---
 apiVersion: batch/v1
 kind: Job
 metadata:
-  #VERIFY that you have provided a unique name for this upgrade job.
-  #The name can be any valid K8s string for name. This example uses
-  #the following convention: cstor-vol-<flattened-from-to-versions>-<pv-name>
+
+  # VERIFY that you have provided a unique name for this upgrade job.
+  # The name can be any valid K8s string for name. This example uses
+  # the following convention: cstor-vol-<flattened-from-to-versions>-<pv-name>
   name: cstor-vol-100110-pvc-c630f6d5-afd2-11e9-8e79-42010a800065
-  #VERIFY the value of namespace is same as the namespace where openebs components
+
+  # VERIFY the value of namespace is same as the namespace where openebs components
   # are installed. You can verify using the command:
   # `kubectl get pods -n <openebs-namespace> -l openebs.io/component-name=maya-apiserver`
   # The above command should return status of the openebs-apiserver.
   namespace: openebs
+
 spec:
   backoffLimit: 4
   template:
     spec:
-      #VERIFY the value of serviceAccountName is pointing to service account
+
+      # VERIFY the value of serviceAccountName is pointing to service account
       # created within openebs namespace. Use the non-default account.
       # by running `kubectl get sa -n <openebs-namespace>`
       serviceAccountName: openebs-maya-operator
+
       containers:
       - name:  upgrade
         args:
         - "cstor-volume"
         - "--from-version=1.0.0"
         - "--to-version=1.1.0"
+
         #VERIFY that you have provided the correct cStor PV Name
         - "--pv-name=pvc-c630f6d5-afd2-11e9-8e79-42010a800065"
+
         #Following are optional parameters
         #Log Level
         - "--v=4"
+
         #DO NOT CHANGE BELOW PARAMETERS
         env:
         - name: OPENEBS_NAMESPACE

diff --git a/k8s/upgrades/1.0.0-1.1.0/example-jiva-vol-upgrade-job.yaml b/k8s/upgrades/1.0.0-1.1.0/example-jiva-vol-upgrade-job.yaml
@@ -1,40 +1,48 @@
-#This is an example YAML for upgrading jiva volume. 
-#Some of the values below needs to be changed to
-#match your openebs installation. The fields are
-#indicated with VERIFY
+# This is an example YAML for upgrading jiva volume. 
+# Some of the values below needs to be changed to
+# match your openebs installation. The fields are
+# indicated with VERIFY
 ---
 apiVersion: batch/v1
 kind: Job
 metadata:
-  #VERIFY that you have provided a unique name for this upgrade job.
-  #The name can be any valid K8s string for name. This example uses
-  #the following convention: jiva-vol-<flattened-from-to-versions>-<pv-name>
+
+  # VERIFY that you have provided a unique name for this upgrade job.
+  # The name can be any valid K8s string for name. This example uses
+  # the following convention: jiva-vol-<flattened-from-to-versions>-<pv-name>
   name: jiva-vol-100110-pvc-713e3bb6-afd2-11e9-8e79-42010a800065
-  #VERIFY the value of namespace is same as the namespace where openebs components
+
+  # VERIFY the value of namespace is same as the namespace where openebs components
   # are installed. You can verify using the command:
   # `kubectl get pods -n <openebs-namespace> -l openebs.io/component-name=maya-apiserver`
   # The above command should return status of the openebs-apiserver.
   namespace: openebs
+
 spec:
   backoffLimit: 4
   template:
     spec:
-      #VERIFY the value of serviceAccountName is pointing to service account
+
+      # VERIFY the value of serviceAccountName is pointing to service account
       # created within openebs namespace. Use the non-default account.
       # by running `kubectl get sa -n <openebs-namespace>`
       serviceAccountName: openebs-maya-operator
+
       containers:
       - name:  upgrade
         args: 
         - "jiva-volume"
         - "--from-version=1.0.0"
         - "--to-version=1.1.0"
-        #VERIFY that you have provided the correct cStor PV Name
+
+        # VERIFY that you have provided the correct jiva PV Name
         - "--pv-name=pvc-713e3bb6-afd2-11e9-8e79-42010a800065"
-        #Following are optional parameters
-        #Log Level
+
+        # Following are optional parameters
+        # Log Level
         - "--v=4"
-        #DO NOT CHANGE BELOW PARAMETERS
+
+        # DO NOT CHANGE BELOW PARAMETERS
         env:
         - name: OPENEBS_NAMESPACE
           valueFrom: