Merge branch 'main' into csm1.12-version

.github/CODEOWNERS

@@ -1,31 +1,19 @@
 # CODEOWNERS
 #
-# documentation for this file can be found at:
+# Documentation for this file can be found at:
 # https://help.github.com/en/articles/about-code-owners
+
 # These are the default owners for the code and will
 # be requested for review when someone opens a pull request.
-# order is alphabetical for easier maintenance.
+# Order is alphabetical for easier maintenance.
 #
-# Abhilash (abhi16394)
+# Abhilash Muralidhara (abhi16394)
 # Adarsh Kumar Yadav (adarsh-dell)
 # Akshay Saini (AkshaySainiDell)
-# Aaron Tye (atye)
-# Ashley Joy (ashleyvjoy)
-# Bharath Sreekanth (bharathsreekanth)
-# Deepak Ghivari (Deepak-Ghivari)
-# Emily Kinuthia (EmilyKatdell)
-# Jacob Grosner (JacobGros)
-# Jooseppi Luna (jooseppi-luna)
-# Rajshree Khare (khareRajshree)
-# Kshitija Kakde (KshitijaKakde)
-# Kumar Karthik Gosa (kumarkgosa)
-# Abrar Basha (mbasha-dell)
-# Matt Schmaelzle (mjsdell)
-# Prabhu Revur (prabhu-dell)
-# Rishabh Raj (rishabhatdell)
-# Sakshi Garg (sakshi-garg1)
-# Shayna Finocchiaro (shaynafinocchiaro)
-# Surya Prakash Gupta (suryagupta4)
+# Bahubali Jain (bpjain2004)
+# Don Khan (donatwork)
+# Trevor Dawe (tdawe)
 
+# for all files
+* @abhi16394 @adarsh-dell @AkshaySainiDell @bpjain2004 @donatwork @tdawe
 
-* @abhi16394 @adarsh-dell @AkshaySainiDell @atye @ashleyvjoy @bharathsreekanth @Deepak-Ghivari @EmilyKatdell @JacobGros @jooseppi-luna @khareRajshree @KshitijaKakde @kumarkgosa @mbasha-dell @mjsdell @prabhu-dell  @rishabhatdell @sakshi-garg1 @shaynafinocchiaro @suryagupta4

.github/workflows/actions.yaml

@@ -1,20 +1,10 @@
 name: Workflow
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
 jobs:
-  code-check:
-    name: Check Go formatting, linting, vetting
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v2
-      - name: Run the formatter, linter, and vetter
-        uses: dell/common-github-actions/go-code-formatter-linter-vetter@main
-        with:
-          directories: ./...
   test:
     name: Run Go unit tests and check package coverage
     runs-on: ubuntu-latest
@@ -26,25 +16,3 @@ jobs:
         with:
           threshold: 90
           test-folder: "./service"
-  gosec:
-    name: Run gosec
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout csi-powerflex
-        uses: actions/checkout@v2
-      - name: Run gosec to check for security vulnerabilities
-        uses: dell/common-github-actions/gosec-runner@main
-        with:
-          directories: "./..."
-          excludes: "G304"
-  malware_security_scan:
-    name: Malware Scanner
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v2
-      - name: Run malware scan
-        uses: dell/common-github-actions/malware-scanner@main
-        with:
-          directories: .
-          options: -ri

.github/workflows/common-workflows.yaml

@@ -0,0 +1,13 @@
+name: Golang Static Analysis
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+
+  # golang static analysis checks
+  go-static-analysis:
+    uses: dell/common-github-actions/.github/workflows/go-static-analysis.yaml@main
+    name: Golang Validation

Makefile

@@ -9,6 +9,8 @@ help:
 	@echo
 	@echo "The following targets are commonly used:"
 	@echo
+	@echo "action-help      - Displays instructions on how to run a single github workflow locally"
+	@echo "actions          - Run all workflows locally, requires https://github.com/nektos/act"
 	@echo "build            - Builds the code locally"
 	@echo "check            - Runs the suite of code checking tools: lint, format, etc"
 	@echo "clean            - Cleans the local build"
@@ -52,5 +54,18 @@ integration-test:
 
 check:
 	@scripts/check.sh ./provider/ ./service/
-
+
+.PHONY: actions
+actions: ## Run all the github action checks that run on a pull_request creation
+	act -l | grep -v ^Stage | grep pull_request | grep -v image_security_scan | awk '{print $$2}' | while read WF; do act pull_request --no-cache-server --platform ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest --job "$${WF}"; done
+
+.PHONY: action-help
+action-help: ## Echo instructions to run one specific workflow locally
+	@echo "GitHub Workflows can be run locally with the following command:"
+	@echo "act pull_request --no-cache-server --platform ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest --job <jobid>"
+	@echo
+	@echo "Where '<jobid>' is a Job ID returned by the command:"
+	@echo "act -l"
+	@echo
+	@echo "NOTE: if act if not installed, it can be from https://github.com/nektos/act"
 

dell-csi-helm-installer/csi-offline-bundle.sh

@@ -67,6 +67,7 @@ run_command() {
 # build_image_manifest
 # builds a manifest of all the images referred to by the helm chart
 build_image_manifest() {
+  local REGEX_COMMENTS="(#.*)"
   local REGEX="([-_./:A-Za-z0-9]{3,}):([-_.A-Za-z0-9]{1,})"
 
   status "Building image manifest file"
@@ -86,7 +87,7 @@ build_image_manifest() {
       # - search all files in a diectory looking for strings that make $REGEX
       # - exclude anything with double '//'' as that is a URL and not an image name
       # - make sure at least one '/' is found
-      find "${D}" -type f -exec egrep -oh "${REGEX}" {} \; | egrep -v '//' | egrep '/' >> "${IMAGEMANIFEST}.tmp"
+      find "${D}" -type f -exec egrep -v "${REGEX_COMMENTS}" {} \; | egrep -oh "${REGEX}"| egrep -v '//' | egrep '/' >> "${IMAGEMANIFEST}.tmp"
     fi
   done
 

samples/secret.yaml

@@ -1,29 +1,29 @@
-  # Username for accessing PowerFlex system.
-  # If authorization is enabled, username will be ignored.
+# Username for accessing PowerFlex system.
+# If authorization is enabled, username will be ignored.
 - username: "admin"
   # Password for accessing PowerFlex system.
   # If authorization is enabled, password will be ignored.
   password: "password"
-  # System name/ID of PowerFlex system.	
+  # System name/ID of PowerFlex system.
   systemID: "1a99aa999999aa9a"
   # Previous names used in secret of PowerFlex system.
   allSystemNames: "pflex-1,pflex-2"
   # REST API gateway HTTPS endpoint for PowerFlex system.
-  # If authorization is enabled, endpoint should be the HTTPS localhost endpoint that 
+  # If authorization is enabled, endpoint should be the HTTPS localhost endpoint that
   # the authorization sidecar will listen on
   endpoint: "https://127.0.0.1"
   # Determines if the driver is going to validate certs while connecting to PowerFlex REST API interface.
   # Allowed values: true or false
   # Default value: true
-  skipCertificateValidation: true 
+  skipCertificateValidation: true
   # indicates if this array is the default array
   # needed for backwards compatibility
-  # only one array is allowed to have this set to true 
+  # only one array is allowed to have this set to true
   # Default value: false
   isDefault: true
   # defines the MDM(s) that SDC should register with on start.
   # Allowed values:  a list of IP addresses or hostnames separated by comma.
-  # Default value: none 
+  # Default value: none
   mdm: "10.0.0.1,10.0.0.2"
   # NFS is only supported on PowerFlex storage system >=4.0.x
   # If not specified, value from SC will be used.
@@ -33,11 +33,10 @@
   # Default value: ""
   # This is an optional field from v2.10.0 onwards for PowerFlex storage system >=4.0.x
   nasName: "nas-server"
-
 # # To add more PowerFlex systems, uncomment the following lines and provide the required values
 # - username: "admin"
 #   password: "password"
 #   systemID: "2b11bb111111bb1b"
 #   endpoint: "https://127.0.0.2"
-#   skipCertificateValidation: true 
+#   skipCertificateValidation: true
 #   mdm: "10.0.0.3,10.0.0.4"

samples/storageclass/powerflex-replication.yaml

@@ -121,6 +121,6 @@ volumeBindingMode: WaitForFirstConsumer
 # allowedTopologies helps scheduling pods on worker nodes which match all of below expressions.
 allowedTopologies:
   - matchLabelExpressions:
-      - key: csi-vxflexos.dellemc.com/<SYSTEM_ID> # Insert System ID
+      - key: csi-vxflexos.dellemc.com/<SYSTEM_ID>
         values:
           - csi-vxflexos.dellemc.com

samples/storageclass/storageclass-nfs.yaml

@@ -20,7 +20,7 @@ allowVolumeExpansion: true
 parameters:
   # Storage pool to use on system
   # Optional: false
-  storagepool: <STORAGE_POOL> # Insert Storage pool
+  storagepool: <STORAGE_POOL>
   # Protection domain that storage pool above belongs to
   # Needed if array has two storagepools that share the same name, but belong to different protection domains
   # Optional: true
@@ -29,7 +29,7 @@ parameters:
   # System you would like this storage class to use
   # Allowed values: one string for system ID
   # Optional: false
-  systemID: <SYSTEM_ID> # Insert System ID
+  systemID: <SYSTEM_ID>
   # format options to pass to mkfs
   # Allowed values: A string dictating the fs options you want passed
   # Optional: true
@@ -82,17 +82,17 @@ parameters:
   # Optional: true
   # Default value : 0
   # gracePeriod: "86400"
-  
+
 # volumeBindingMode determines how volume binding and dynamic provisioning should occur
 # Allowed values:
 #  Immediate: volume binding and dynamic provisioning occurs once PVC is created
 #  WaitForFirstConsumer: delay the binding and provisioning of PV until a pod using the PVC is created.
 # Optional: false
-# Default value: WaitForFirstConsumer (required for topology section below) 
+# Default value: WaitForFirstConsumer (required for topology section below)
 volumeBindingMode: WaitForFirstConsumer
 # allowedTopologies helps scheduling pods on worker nodes which match all of below expressions.
 allowedTopologies:
-- matchLabelExpressions:
-  - key: csi-vxflexos.dellemc.com/<SYSTEM_ID>-nfs # Insert System ID
-    values:
-    - "true"    
+  - matchLabelExpressions:
+      - key: csi-vxflexos.dellemc.com/<SYSTEM_ID>-nfs
+        values:
+          - "true"

samples/storageclass/storageclass-xfs.yaml

@@ -20,7 +20,7 @@ allowVolumeExpansion: true
 parameters:
   # Storage pool to use on system
   # Optional: false
-  storagepool: <STORAGE_POOL> # Insert Storage pool
+  storagepool: <STORAGE_POOL>
   # Protection domain that storage pool above belongs to
   # Needed if array has two storagepools that share the same name, but belong to different protection domains
   # Optional: true
@@ -29,7 +29,7 @@ parameters:
   # System you would like this storage class to use
   # Allowed values: one string for system ID
   # Optional: false
-  systemID: <SYSTEM_ID> # Insert System ID
+  systemID: <SYSTEM_ID>
   # format options to pass to mkfs
   # Allowed values: A string dictating the fs options you want passed
   # Optional: true
@@ -61,7 +61,7 @@ parameters:
 volumeBindingMode: WaitForFirstConsumer
 # allowedTopologies helps scheduling pods on worker nodes which match all of below expressions.
 allowedTopologies:
-- matchLabelExpressions:
-  - key: csi-vxflexos.dellemc.com/<SYSTEM_ID> # Insert System ID
-    values:
-    - csi-vxflexos.dellemc.com    
+  - matchLabelExpressions:
+      - key: csi-vxflexos.dellemc.com/<SYSTEM_ID>
+        values:
+          - csi-vxflexos.dellemc.com

samples/storageclass/storageclass.yaml

@@ -23,7 +23,7 @@ allowVolumeExpansion: true
 parameters:
   # Storage pool to use on system
   # Optional: false
-  storagepool: <STORAGE_POOL> # Insert Storage pool
+  storagepool: <STORAGE_POOL>
   # Protection domain that storage pool above belongs to
   # Needed if array has two storagepools that share the same name, but belong to different protection domains
   # Optional: true
@@ -32,7 +32,7 @@ parameters:
   # System you would like this storage class to use
   # Allowed values: one string for system ID
   # Optional: false
-  systemID: <SYSTEM_ID> # Insert System ID
+  systemID: <SYSTEM_ID>
   # format options to pass to mkfs
   # Allowed values: A string dictating the fs options you want passed
   # Optional: true
@@ -56,15 +56,15 @@ parameters:
   # Uncomment the line below if you want to use iopsLimit
   # iopsLimit: <IOPS_LIMIT> # Insert iops limit
 # volumeBindingMode determines how volume binding and dynamic provisioning should occur
-# Allowed values: 
+# Allowed values:
 #  Immediate: volume binding and dynamic provisioning occurs once PVC is created
 #  WaitForFirstConsumer: delay the binding and provisioning of PV until a pod using the PVC is created.
 #  Optional: false
-# Default value: WaitForFirstConsumer (required for topology section below) 
+# Default value: WaitForFirstConsumer (required for topology section below)
 volumeBindingMode: WaitForFirstConsumer
 # allowedTopologies helps scheduling pods on worker nodes which match all of below expressions.
 allowedTopologies:
-- matchLabelExpressions:
-  - key: csi-vxflexos.dellemc.com/<SYSTEM_ID> # Insert System ID
-    values:
-    - csi-vxflexos.dellemc.com
+  - matchLabelExpressions:
+      - key: csi-vxflexos.dellemc.com/<SYSTEM_ID>
+        values:
+          - csi-vxflexos.dellemc.com