Merge branch 'master' into update-quickstart

Author: anvithks

.gitignore

@@ -0,0 +1 @@
+.idea

config.toml

@@ -1,4 +1,4 @@
-baseURL = "https://soda-docs.netlify.com/"
+baseURL = "https://soda-docs.netlify.app/"
 languageCode = "en-US"
 defaultContentLanguage = "en"
 googleAnalytics = "UA-138679091-1"
@@ -25,6 +25,9 @@ defaultContentLanguageInSubdir= true
 [outputs]
 home = [ "HTML", "RSS", "JSON"]
 
+[markup.goldmark.renderer]
+  unsafe = true
+
 [Languages]
 [Languages.en]
 title = "Documentation for SODA Project"

content/community/_index.md

@@ -44,18 +44,18 @@ You can find the meeting details [here](https://bit.ly/sodaglobalcommunitymeetin
   - Ensure you have the slack account of SODA Workspace (Join [here](https://sodafoundation.io/slack/))
    - Try the latest soda foundation release
 	  - Go to the latest stable release from [here](https://github.com/sodafoundation/releases/releases)
-	  - Follow the instruction for how to use the release
-	  - Make the setup and test (using the quick start steps)
+	  - Follow the instructions for how to use the release
+	  - Make the setup and test (using the quick-start steps)
 	  - Once you are able to do, try developer method of installation from the release notes.
-	  - Any point, if yo is you are facing any issues: 
+	  - At any point, if you are facing any issue: 
 		  - Raise issue in the [release repo](https://github.com/sodafoundation/releases/issues)
 		  - Clarify / Seek help in the soda slack #general channel
   - Other Contribution Channels
 	  - Check the open issues in [Documentation](https://github.com/sodafoundation/documentation/issues)
 	  - If you can fix any of them, just add a comment in the issue saying you want to work on it
 	  - You can do @ to any members or author of the issues to notify them specifically
-	  - Raise the PR to fix the documentaion
-	  - This procedure you can follow for any other project repository in the [SODA github](https://github.com/sodafoundation)
+	  - Raise the PR to fix the documentation
+	  - This procedure you can follow for any other project's repository in the [SODA github](https://github.com/sodafoundation)
 	  - Complete SODA Documentation is available [here](https://docs.sodafoundation.io/)
-  - If you are think, we can add more inputs to this document or additional documentation links for developers including setup etc, please raise issue under [SODA Documentation](https://github.com/sodafoundation/documentation/issues)
+  - If you think, we can add more inputs to this document or additional documentation links for developers including setup etc, please raise issue under [SODA Documentation](https://github.com/sodafoundation/documentation/issues)
   - Any other support please request at soda slack #general channel

content/guides/integration-guides/_index.md

@@ -1,7 +1,7 @@
 ---
 title: Integration Guides
 description: "All the integration guides and documentation"
-weight: 15
+weight: 30
 disableToc: true
 ---
 

content/guides/integration-guides/csi-integration/_index.md

@@ -0,0 +1,10 @@
+---
+title: CSI Integration Guides
+menuTitle: Kubernetes-CSI
+description: "All the Container Storage Interface(CSI) Integration guides for different Soda CSI solutions"
+weight: 1
+disableToc: true
+---
+
+{{%children style="h3" description="true" %}}  
+

…des/kubernetes-csi-integration/_index.md …si-integration/soda-csi-plugin/_index.mdcontent/guides/integration-guides/kubernetes-csi-integration/_index.md renamed to content/guides/integration-guides/csi-integration/soda-csi-plugin/_index.md content/guides/integration-guides/kubernetes-csi-integration/_index.md renamed to content/guides/integration-guides/csi-integration/soda-csi-plugin/_index.md

@@ -1,8 +1,8 @@
 ---
-title: OpenSDS Integration with Kubernetes CSI
-menuTitle: "With Kubernetes CSI"
-description: "A guide for integrating OpenSDS with Kubernetes CSI."
-weight: 1
+title: SODA Integration with Kubernetes via SODA CSI Plugin
+menuTitle: "SODA CSI plugin"
+description: "A guide for integrating SODA with Kubernetes CSI."
+weight: 10
 disableToc: false
 tags: ["integration guide", "kubernetes csi"] 
 ---

content/guides/integration-guides/csi-integration/soda-csi-pnp/_index.md

@@ -0,0 +1,75 @@
+---
+title: SODA Integration with Vendor CSI Drivers via SODA CSI Plug-N-Play
+menuTitle: "SODA CSI Plug-N-Play"
+description: "A guide for integrating SODA with Vendor CSI Driver via unified Plugin."
+weight: 10
+disableToc: false
+tags: ["integration guide", "kubernetes csi", "plug-n-play", "unified plugin"] 
+---
+
+SODA CSI Plug-N-Play is a mechanism by which users can use the heterogeneous storage vendors in a unified way, 
+Users need to define the requirements while creating SODA Profile, 
+Users need to use this profile ID while creating the PVC's in the Kubernetes, 
+the soda-csi-provisioner will automatically select the vendor csi-driver and help in 
+provisioning the Volumes for Pods.
+  
+## Prerequisite
+ - An installation of Kubernetes (V1.17+)  
+ - SODA installation (you can refer to quick start guide over [here](https://docs.sodafoundation.io/soda-gettingstarted/installation-using-ansible/)), you need to change the ports of etcd in osdb.yaml while installing SODA on an existing K8s environment as the ports cause conflict with k8s etcd.
+
+## Selecting the vendor CSI driver
+You can select the CSI driver supported by SODA Plug-N-Play from [here](https://docs.sodafoundation.io/guides/user-guides/nbp/csi-pnp/) Once selected follow the instruction 
+given in the document to deploy the CSI driver in K8s.  
+
+##### For this example we are selecting the [OpenEBS LVM CSI Driver](https://github.com/openebs/lvm-localpv).
+
+```go
+kubectl create -f https://raw.githubusercontent.com/asifdxtreme/soda-ucp/main/examples/openebs/driver/lvm-operator.yaml
+```
+We need to do the additional step to make the lvm group for this plugin
+```go
+truncate -s 1024G /tmp/disk.img
+sudo losetup -f /tmp/disk.img --show
+```
+Create the Volume group on all the nodes, which will be used by the LVM Driver for provisioning the volumes
+
+```go
+sudo pvcreate /dev/loop0
+sudo vgcreate lvmvg /dev/loop0
+```
+
+
+## Creating Profile in SODA
+We need to create a Profile in SODA which will have the information of csi driver which needs to be used(eventually this step will be automatically done by SODA).
+
+```go
+osdsctl profile create '{"name": "openebs-profile-soda","storageType": "block","description": "string","provisioningProperties": {"dataStorage": {"recoveryTimeObjective": 10,"provisioningPolicy": "Thick","compression": false,"deduplication": false,"characterCodeSet": "ASCII","maxFileNameLengthBytes": 255,"storageAccessCapability": ["Read"] },"ioConnectivity": {"accessProtocol": "iscsi","maxIOPS": 150,"minIOPS": 50,"maxBWS": 5,"minBWS": 1,"latency": 1}},"replicationProperties": {},"snapshotProperties": {},"dataProtectionProperties": { },"customProperties": {"driver": "local.csi.openebs.io"}}'
+
+```
+
+## Attach information of ProfileID in Storage Class
+Once the Profile ID is created then we need to create a Storage Class in K8s.
+```go
+
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: openebs-lvmsc-soda
+allowVolumeExpansion: true
+parameters:
+  volgroup: "lvmvg"
+  profile: a82980d3-1030-41e5-95f0-b2db5a0c065d     ## SODA PROFILE ID
+provisioner: soda-csi
+allowedTopologies:
+- matchLabelExpressions:
+  - key: kubernetes.io/hostname
+    values:
+      - node-12340                                  ## NODE NAME ON WHICH PROVISIONING NEEDS TO BE DONE
+```
+
+## Deploy an App with pvc
+
+```go
+kubectl create -f https://raw.githubusercontent.com/asifdxtreme/soda-ucp/main/examples/openebs/app/app.yaml
+```
+

content/guides/user-guides/multi-cloud/object-archival-restore/_index.md

@@ -19,7 +19,7 @@ This guide shows how to archive objects into Cloud object storage and restore th
 To refer the API specs, please check [Cloud Object Archival API Specs](https://github.com/sodafoundation/multi-cloud/blob/master/openapi-spec/swagger.yaml)
 
 {{% notice note %}}
- Currently this feature is available only for AWS cloud
+ Currently this feature is available only for AWS, Azure and GCP cloud as backend and SONY-ODA as on-premise Cold storage
 {{% /notice %}}
 
 ## Installing SODA multi-cloud
@@ -33,8 +33,9 @@ Or Check the developer guide [multi-cloud local cluster installation through rep
 	admin/opensds@123 
 
 ## Pre-requisite
-* Cloud Backend is registered. [How to register a cloud backend](#How to register a Cloud backend)
-* multi-cloud Bucket is created. [How to create a multi-cloud bucket](#How to create a multi-cloud bucket)
+* Cloud Backend is registered. [How to register a cloud backend](/guides/user-guides/multi-cloud/object-archival-restore/#how-to-register-a-cloud-backend)
+* multi-cloud Bucket is created. [How to create a multi-cloud bucket](/guides/user-guides/multi-cloud/object-archival-restore/#how-to-create-a-multi-cloud-bucket)
+
 <a name="How to register a Cloud backend"></a>
 #### How to register a Cloud backend
 ![multi-cloud U	I image  ](soda_home.png?raw=true)

content/guides/user-guides/multi-cloud/object-archival-restore/soda_backend.png

@@ -20,14 +20,14 @@ By following this guide you will be able to install SODA multi-cloud with creati
 ```cassandraql
 git clone https://github.com/sodafoundation/installer.git
 cd installer
-# Checkout the latest release, give master by default or specify the branch 
+# Checkout the latest release, give master by default or specify the branch
 git checkout master
 ```
 
 ### How to enable multi-cloud installation
-  
+
 Install docker container to run multi-cloud in container environment.
- 
+
 Update the file : opensds-installer/ansible/group_vars/gelato.yml to install multi-cloud.
 ```cassandraql
 # repository branch
@@ -47,7 +47,7 @@ export OS_AUTH_URL=http://{{ authchecker_cluster_ip }}/identity
 #### Run SODA multi-cloud in docker container
 ```
 docker-compose up -d
-docker ps 
+docker ps
    ```
 Note: check if multi-cloud services are running in the docker container.
 ```cassandraql
@@ -68,13 +68,24 @@ SODA Object lifecycle management feature specific UI can be accessed via
 
 `http://{your_host_ip}:8088/#/home`
 
-login  using the default admin credentials: `admin/opensds@123`. 
+login  using the default admin credentials: `admin/opensds@123`.
 
-![multi-cloud UI image  ](opensds_home.PNG?raw=true)
+![multi-cloud UI image  ](soda_login_page.png?raw=true)
 
 ### Create  new backend  using remote cloud bucket
 Click on (+) for registering a storage backend
 
+![multi-cloud backend image  ](register-backend-0.png?raw=true)
+
+and then provide valid region, endpoint, Access and Secret Key parameters
+
+##### Note:
+For cloud vendors like AWS, Azure, Huawei and GCP remote cloud buckets need not be created manually by user prior to backend registration. Remote cloud buckets can be created from SODA for these cloud vendors
+
+![multi-cloud backend image  ](register-backend.png?raw=true)
+
+For other cloud vendors like IBM, Ceph, YIG and Alibaba, register backend using remote cloud bucket
+
 ![multi-cloud backend image  ](opensds_backend.PNG?raw=true)
 
 ### Create bucket and upload the object
@@ -102,5 +113,5 @@ After configuring lifecycle in dashboard, a routine scheduler will run and it wi
 ### FAQ
 1. How to check if the lifecycle rule is applied on bucket/object ?
 
-Ans: 
+Ans:
 SODA does not create the rule in the cloud backend (CSP). Once the bucket/object satisfies the rule, SODA will automatically call cloud API and the action will be performed. If there are any errors or issues in rule, user will know at the time of lifecycle action.