public_git
/
democratic-csi
mirror of https://github.com/democratic-csi/democratic-csi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

markup fixes

This commit is contained in:
D1StrX 2022-01-12 20:47:59 +01:00
parent cc8223de6d
commit a3ab293d60
1 changed files with 34 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -2,13 +2,16 @@
![Image](https://img.shields.io/github/workflow/status/democratic-csi/democratic-csi/CI?style=flat-square) ![Image](https://img.shields.io/github/workflow/status/democratic-csi/democratic-csi/CI?style=flat-square)
# Introduction # Introduction
## What is Democratic-CSI? ## What is Democratic-CSI?
`Democratic-CSI` implements the `csi` (Container Storage Interface) specifications providing storage for various container orchestration systems (*ie: Kubernetes, Nomad, OpenShift*).
`Democratic-CSI` implements the `CSI` (Container Storage Interface) specifications providing storage for various container orchestration systems (*ie: Kubernetes, Nomad, OpenShift*).
The current *focus* is providing storage via iSCSI or NFS from ZFS-based storage systems, predominantly `TrueNAS / FreeNAS` and `ZoL on Ubuntu`. The current *focus* is providing storage via iSCSI or NFS from ZFS-based storage systems, predominantly `TrueNAS / FreeNAS` and `ZoL on Ubuntu`.
The current *drivers* implement the depth and breadth of the `csi` specifications, so you have access to resizing, snapshots, clones, etc functionality. The current *drivers* implement the depth and breadth of the `csi` specifications, so you have access to resizing, snapshots, clones, etc functionality.
## What can Democratic-CSI offer? ## What can Democratic-CSI offer?
**Several implementations of `CSI` drivers** **Several implementations of `CSI` drivers**
:arrow_forward: `freenas-nfs` (manages zfs datasets to share over nfs) :arrow_forward: `freenas-nfs` (manages zfs datasets to share over nfs)
:arrow_forward: `freenas-iscsi` (manages zfs zvols to share over iscsi) :arrow_forward: `freenas-iscsi` (manages zfs zvols to share over iscsi)
@ -46,51 +49,63 @@ Predominantly 3 prerequisites are needed:
- Deployment of the driver into the cluster (`helm` chart provided with sample - Deployment of the driver into the cluster (`helm` chart provided with sample
`values.yaml`) `values.yaml`)
## Node preperation
## **Node preperation**
Alright, you have chosen your driver. Let's start by configuring the prerequisites for your Node. Alright, you have chosen your driver. Let's start by configuring the prerequisites for your Node.
You can choose to use either **NFS** or **iSCSI** or **both**. You can choose to use either **NFS** or **iSCSI** or **both**.
### **NFS configuration** ### **NFS configuration**
___
**RHEL / CentOS** ___
```
#### RHEL / CentOS
```bash
sudo yum install -y nfs-utils sudo yum install -y nfs-utils
``` ```
**Ubuntu / Debian** #### Ubuntu / Debian
```
```bash
sudo apt-get install -y nfs-common sudo apt-get install -y nfs-common
``` ```
<br/>
### **iSCSI configuration** ### iSCSI configuration
___
**RHEL / CentOS** ___
#### RHEL / CentOS
Install the following system packages: Install the following system packages:
```
```bash
sudo yum install -y lsscsi iscsi-initiator-utils sg3_utils device-mapper-multipath sudo yum install -y lsscsi iscsi-initiator-utils sg3_utils device-mapper-multipath
``` ```
Enable multipathing: Enable multipathing:
```
```bash
sudo mpathconf --enable --with_multipathd y sudo mpathconf --enable --with_multipathd y
``` ```
Ensure that `iscsid` and `multipathd` are running: Ensure that `iscsid` and `multipathd` are running:
```
```bash
sudo systemctl enable iscsid multipathd && sudo systemctl start iscsid multipathd sudo systemctl enable iscsid multipathd && sudo systemctl start iscsid multipathd
``` ```
Start and enable iSCSI: Start and enable iSCSI:
```
```bash
sudo systemctl enable iscsi && sudo systemctl start iscsi sudo systemctl enable iscsi && sudo systemctl start iscsi
``` ```
<br/>
**Ubuntu / Debian** **Ubuntu / Debian**
Install the following system packages: Install the following system packages:
```
```bash
sudo apt-get install -y open-iscsi lsscsi sg3-utils multipath-tools scsitools sudo apt-get install -y open-iscsi lsscsi sg3-utils multipath-tools scsitools
``` ```
**Multipathing** **Multipathing**
`Multipath` is supported for the `iSCSI`-based drivers. Simply setup multipath to your liking and set multiple portals in the config as appropriate. `Multipath` is supported for the `iSCSI`-based drivers. Simply setup multipath to your liking and set multiple portals in the config as appropriate.
*NOTE:* If you are running Kubernetes with Rancher/RKE please see the following: *NOTE:* If you are running Kubernetes with Rancher/RKE please see the following: