Release 1.7.0

.github/CODEOWNERS

@@ -7,6 +7,7 @@
 # order is alphabetical for easier maintenance.
 #
 # Bharath Sreekanth (bharathsreekanth)
+# Chiman Jain (chimanjain)
 # Deepak Ghivari (Deepak-Ghivari)
 # Matt Schmaelzle (mjsdell)
 # Mukesh Gandharva (mgandharva)
@@ -17,4 +18,4 @@
 # Sean Gallacher (gallacher)
 # Yamunadevi Shanmugam (shanmydell)
 
-* @bharathsreekanth @Deepak-Ghivari @gallacher @mgandharva @mjsdell @prablr79 @rajendraindukuri @rajkumar-palani @rsedlock1958 @shanmydell
+* @bharathsreekanth @chimanjain @Deepak-Ghivari @gallacher @mgandharva @mjsdell @prablr79 @rajendraindukuri @rajkumar-palani @rsedlock1958 @shanmydell

.github/workflows/linter.yaml

@@ -4,7 +4,7 @@ on:
  push:
  branches: [ main ]
  pull_request:
- branches: [ main ]
+ branches: [ main , release-* ]
 jobs:
  lint:
  name: Lint Code Base

.github/workflows/unit-test-reporter.yaml

@@ -0,0 +1,24 @@
+name: Unit Test Action
+
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+ branches: [ main, release-* ]
+jobs:
+ build-test:
+ name: Build & Run Unit Test
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ - name: Run Tests
+ working-directory: ./content/docs/deployment/csminstallationwizard/src/
+ run: |
+ npm install 
+ npm test
+ - name: Publish Test Results
+ uses: EnricoMi/publish-unit-test-result-action@v2
+ if: always()
+ with:
+ files: |
+ ./content/docs/deployment/csminstallationwizard/src/reports/*.xml

.gitignore

@@ -3,3 +3,4 @@ public/
 resources/
 .hugo_build.lock
 coverage/
+reports/

config.toml

@@ -106,6 +106,9 @@ algolia_docsearch = false
 # Enable Lunr.js offline search
 offlineSearch = true
 
+# Enable syntax highlighting and copy buttons on code blocks with Prism
+prism_syntax_highlighting = true
+
 # User interface configuration
 [params.ui]
 # Enable to show the side bar menu in its compact state.
@@ -169,19 +172,19 @@ enable = false
 # icon = "fa fa-envelope"
 # desc = "Discuss development issues around the project"
 [[params.versions]]
- version = "Current(v1.6.1)"
+ version = "Current(v1.7)"
  url = "https://dell.github.io/csm-docs/docs/"
 
 [[params.versions]]
- version = "v1.5.1"
+ version = "v1.6.1"
  url = "https://dell.github.io/csm-docs/v1"
 
 [[params.versions]]
- version = "v1.4"
+ version = "v1.5.1"
  url = "https://dell.github.io/csm-docs/v2"
 
 [[params.versions]]
- version = "1.3.1"
+ version = "v1.4"
  url = "https://dell.github.io/csm-docs/v3" 
 
 [[menu.main]]

content/docs/_index.md

@@ -64,11 +64,11 @@ CSM is made up of multiple components including modules (enterprise capabilities
 
 ## CSM Modules Support Matrix for Dell CSI Drivers 
 
-| CSM Module | CSI PowerFlex v2.6.0 | CSI PowerScale v2.6.1 | CSI PowerStore v2.6.0 | CSI PowerMax v2.6.0 | CSI Unity XT v2.6.0 |
+| CSM Module | CSI PowerFlex v2.7.0 | CSI PowerScale v2.7.0 | CSI PowerStore v2.7.0 | CSI PowerMax v2.7.0 | CSI Unity XT v2.7.0 |
 | ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
-| [**Authorization**](authorization/) v1.6.0 | ✔️ | ✔️ | ❌ | ✔️ | ❌ |
+| [**Authorization**](authorization/) v1.7.0 | ✔️ | ✔️ | ❌ | ✔️ | ❌ |
 | [**Observability**](observability/) v1.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
-| [**Replication**](replication/) v1.4.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
-| [**Resiliency**](resiliency/) v1.5.0 | ✔️ | ✔️ | ✔️ | ❌ | ✔️ |
-| [**Encryption**](secure/encryption) v0.3.0 | ❌ | ✔️ | ❌ | ❌ | ❌ |
-| [**Application Mobility**](applicationmobility/) v0.3.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
+| [**Replication**](replication/) v1.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
+| [**Resiliency**](resiliency/) v1.6.0 | ✔️ | ✔️ | ✔️ | ❌ | ✔️ |
+| [**Encryption**](secure/encryption) v0.4.0 | ❌ | ✔️ | ❌ | ❌ | ❌ |
+| [**Application Mobility**](applicationmobility/) v0.4.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |

content/docs/applicationmobility/deployment.md

@@ -12,21 +12,22 @@ Description: >
 
 ## Installation
 1. Create a namespace where Application Mobility will be installed.
- ```
+ ```bash
  kubectl create ns application-mobility
  ```
 2. Edit the license Secret file (see Pre-requisites above) and set the correct namespace (ex: `namespace: application-mobility`)
 3. Create the Secret containing a license file
- ```
+ ```bash
  kubectl apply -f license.yml
  ```
 4. Add the Dell Helm Charts repository
- ```
+ ```bash
  helm repo add dell https://dell.github.io/helm-charts
  ```
 5. Either create a values.yml file or provide the `--set` options to the `helm install` to override default values from the [Configuration](#configuration) section.
 6. Install the helm chart
- ```
+ ```bash
+
  helm install application-mobility -n application-mobility dell/csm-application-mobility
  ```
 

content/docs/applicationmobility/uninstallation.md

@@ -12,6 +12,7 @@ This section outlines the uninstallation steps for Application Mobility.
 
 This command removes all the Kubernetes components associated with the chart.
 
-```
-$ helm delete [APPLICATION_MOBILITY_NAME] --namespace [APPLICATION_MOBILITY_NAMESPACE]
+```bash 
+
+helm delete [APPLICATION_MOBILITY_NAME] --namespace [APPLICATION_MOBILITY_NAMESPACE]
 ```

content/docs/applicationmobility/use_cases.md

@@ -12,17 +12,18 @@ After Application Mobility is installed, the [dellctl CLI](../../references/cli/
 This example details the steps when an application in namespace `demo1` is being backed up and then later restored to either the same cluster or another cluster. In this sample, both Application Mobility and Velero are installed in the `application-mobility` namespace.
 
 1. If Velero is not installed in the default `velero` namespace and `dellctl` is being used, set this environment variable to the namespace where it is installed:
- ```
+ ```bash
  export VELERO_NAMESPACE=application-mobility 
  ```
 1. On the source cluster, create a Backup by providing a name and the included namespace where the application is installed. The application and its data will be available in the object store bucket and can be restored at a later time.
 
  Using dellctl:
- ```
+ ```bash
+
  dellctl backup create backup1 --include-namespaces demo1 --namespace application-mobility
  ```
  Using Backup Custom Resource:
- ```
+ ```yaml
  apiVersion: mobility.storage.dell.com/v1alpha1
  kind: Backup
  metadata:
@@ -36,26 +37,27 @@ This example details the steps when an application in namespace `demo1` is being
 1. Monitor the backup status until it is marked as Completed.
 
  Using dellctl:
- ```
+ ```bash
  dellctl backup get --namespace application-mobility
  ```
 
  Using kubectl:
- ```
+ ```bash
+
  kubectl describe backups.mobility.storage.dell.com/backup1 -n application-mobility
  ```
 
 1. If the Storage Class name on the target cluster is different than the Storage Class name on the source cluster where the backup was created, a mapping between source and target Storage Class names must be defined. See [Changing PV/PVC Storage Classes](#changing-pvpvc-storage-classes).
 1. The application and its data can be restored on either the same cluster or another cluster by referring to the backup name and providing an optional mapping of the original namespace to the target namespace.
 
  Using dellctl:
- ```
+ ```bash
  dellctl restore create restore1 --from-backup backup1 \
  --namespace-mappings "demo1:restorens1" --namespace application-mobility
  ```
 
  Using Restore Custom Resource:
- ```
+ ```yaml
  apiVersion: mobility.storage.dell.com/v1alpha1
  kind: Restore
  metadata:
@@ -69,12 +71,13 @@ This example details the steps when an application in namespace `demo1` is being
 1. Monitor the restore status until it is marked as Completed.
 
  Using dellctl:
- ```
+ ```bash
  dellctl restore get --namespace application-mobility
  ```
 
  Using kubectl:
- ```
+ ```bash
+
  kubectl describe restores.mobility.storage.dell.com/restore1 -n application-mobility
  ```
 
@@ -83,24 +86,26 @@ This example details the steps when an application in namespace `demo1` is being
 This example details the steps when an application in namespace `demo1` is cloned from a source cluster to a target cluster in a single operation. In this sample, both Application Mobility and Velero are installed in the `application-mobility` namespace.
 
 1. If Velero is not installed in the default `velero` namespace and `dellctl` is being used, set this environment variable to the namespace where it is installed:
- ```
+ ```bash
  export VELERO_NAMESPACE=application-mobility 
  ```
 1. Register the target cluster if using `dellctl`
- ```
+ ```bash
+
  dellctl cluster add -n targetcluster -u <kube-system-namespace-uuid> -f ~/kubeconfigs/target-cluster-kubeconfig
  ```
 1. If the Storage Class name on the target cluster is different than the Storage Class name on the source cluster where the backup was created, a mapping between source and target Storage Class names must be defined. See [Changing PV/PVC Storage Classes](#changing-pvpvc-storage-classes).
 1. Create a Backup by providing a name, the included namespace where the application is installed, and the target cluster and namespace mapping where the application will be restored.
 
  Using dellctl:
- ```
+ ```bash
+
  dellctl backup create backup1 --include-namespaces demo1 --clones "targetcluster/demo1:restore-ns2" \
  --namespace application-mobility
  ```
 
  Using Backup Custom Resource:
- ```
+ ```yaml
  apiVersion: mobility.storage.dell.com/v1alpha1
  kind: Backup
  metadata:
@@ -119,19 +124,20 @@ This example details the steps when an application in namespace `demo1` is clone
 1. Monitor the restore status on the target cluster until it is marked as Completed.
 
  Using dellctl:
- ```
+ ```bash
  dellctl restore get --namespace application-mobility
  ```
 
  Using kubectl:
- ```
+ ```bash
+
  kubectl get restores.mobility.storage.dell.com -n application-mobility
  kubectl describe restores.mobility.storage.dell.com/<restore-name> -n application-mobility
  ```
 
 ## Changing PV/PVC Storage Classes
 Create a ConfigMap on the target cluster in the same namespace where Application Mobility is installed. The data field must contain a mapping of source Storage Class name to target Storage Class name. See Velero's documentation for [Changing PV/PVC Storage Classes](https://velero.io/docs/v1.9/restore-reference/#changing-pvpvc-storage-classes) for additional details.
-```
+```yaml 
 apiVersion: v1
 kind: ConfigMap
 metadata:

content/docs/authorization/Backup and Restore/helm/_index.md

@@ -14,27 +14,27 @@ Role data is stored in the `common` Config Map.
 
 1. Save the role data by saving the `common` configMap to a file.
 
-```
+```bash
 kubectl -n <authorization-namespace> get configMap common -o yaml > roles.yaml
 ```
 
 ### Steps to execute in the Authorization deployment to restore
 
 1. Delete the existing `common` configMap.
 
-```
+```bash
 kubectl -n <authorization-namespace> delete configMap common
 ```
 
 2. Apply the file containing the backed-up role data.
 
-```
+```bash
 kubectl apply -f roles.yaml
 ```
 
 3. Restart the `proxy-server` deployment.
 
-```
+```bash
 kubectl -n <authorization-namespace> rollout restart deploy/proxy-server
 deployment.apps/proxy-server restarted
 ```
@@ -47,27 +47,28 @@ Storage data is stored in the `karavi-storage-secret` Secret.
 
 1. Save the storage data by saving the `karavi-storage-secret` Secret to a file.
 
-```
+```bash
+
 kubectl -n <authorization-namespace> get secret karavi-storage-secret -o yaml > storage.yaml
 ```
 
 ### Steps to execute in the Authorization deployment to restore
 
 1. Delete the existing `karavi-storage-secret` secret.
 
-```
+```bash
 kubectl -n <authorization-namespace> delete secret karavi-storage-secret
 ```
 
 2. Apply the file containing the storage data created in step 1.
 
-```
+```bash
 kubectl apply -f storage.yaml
 ```
 
 3. Restart the `proxy-server` deployment.
 
-```
+```bash
 kubectl -n <authorization-namespace> rollout restart deploy/proxy-server
 deployment.apps/proxy-server restarted
 ```
@@ -78,8 +79,10 @@ Redis is used to store application data regarding [tenants, quota, and volume ow
 
 The Persistent Volume for Redis is dynamically provisioned by this Storage Class with the `redis-primary-pv-claim` Persistent Volume Claim. See the example.
 
-```
+```bash
 kubectl get persistentvolume
+```
+```
 NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
 k8s-ab74921ab9 8Gi RWO Delete Bound authorization/redis-primary-pv-claim <storage-class> 112m
 ```
@@ -92,11 +95,13 @@ k8s-ab74921ab9 8Gi RWO Delete Bound author
 
 1. Edit the `redis-primary` Deployment to use the Persistent Volume Claim associated with the backup by running:
 
-`kubectl -n <authorization-namespace> edit deploy/redis-primary`
+```bash
+kubectl -n <authorization-namespace> edit deploy/redis-primary
+```
 
 The Deployment has a volumes field that should look like this: 
 
-```
+```yaml
 volumes:
 - name: redis-primary-volume
  persistentVolumeClaim:
@@ -105,11 +110,11 @@ volumes:
 
 Replace the value of `claimName` with the name of the Persisent Volume Claim associated with the backup. If the new Persisent Volume Claim name is `redis-backup`, you would edit the deployment to look like this:
 
-```
+```yaml
 volumes:
 - name: redis-primary-volume
  persistentVolumeClaim:
  claimName: redis-backup
 ```
 
-Once saved, Redis will now use the backup volume.
+Once saved, Redis will now use the backup volume.