diff --git a/README.md b/README.md index 19cb06f..6d1526a 100644 --- a/README.md +++ b/README.md @@ -251,7 +251,7 @@ ___ ___ -- Bind the interface to the NFS service +- Bind the network interface to the NFS service - It is recommended to use NFS 3 #### iSCSI configuration @@ -275,30 +275,7 @@ Please read the scripts and set the variables appropriate for your server. ___ -- Bind the interface to the SMB service - -### YAML Values configuration - -___ -Instruct `Democratic-CSI` to use `sudo` by uncommenting the following in your configuration template: - - ```yaml - zfs: - cli: - sudoEnabled: true - ``` - -Starting with TrueNAS CORE 12 it is also possible to use an `apiKey` instead of -the user/root password for the HTTP connection. -The `apiKey` can be generated by clicking on the `Settings icon` -> `API Keys` -> `ADD` -![image](https://user-images.githubusercontent.com/40062371/147371451-ff712de3-cce0-448e-b59f-29269179d2d6.png) - -Issues to review: -[ixsystems NAS-108519](https://jira.ixsystems.com/browse/NAS-108519) -[ixsystems NAS-108520](https://jira.ixsystems.com/browse/NAS-108520) -[ixsystems NAS-108521](https://jira.ixsystems.com/browse/NAS-108521) -[ixsystems NAS-108522](https://jira.ixsystems.com/browse/NAS-108522) -[ixsystems NAS-107219](https://jira.ixsystems.com/browse/NAS-107219) +- Bind the network interface to the SMB service ### ZoL (zfs-generic-nfs, zfs-generic-iscsi) @@ -320,7 +297,30 @@ Ensure ssh and zfs is installed on the nfs/iscsi server and that you have instal ___ Ensure iSCSI Manager has been installed and is generally setup/configured. -## Helm Installation +### :wrench: YAML Values configuration + +___ +Instruct `Democratic-CSI` to use `sudo` by uncommenting the following in your configuration template: + + ```yaml + zfs: + cli: + sudoEnabled: true + ``` + +As you read at the [Storage server preperation](#Storage-server-preperation), YAML configuration comes in two flavours. With and without API configuration. + +Starting with TrueNAS CORE 12 it is also possible to use an `apiKey` instead of the user/root password for the HTTP connection. The `apiKey` can be generated by clicking on the `Settings icon` -> `API Keys` -> `ADD` +![image](https://user-images.githubusercontent.com/40062371/147371451-ff712de3-cce0-448e-b59f-29269179d2d6.png) + +Issues to review: +[ixsystems NAS-108519](https://jira.ixsystems.com/browse/NAS-108519) +[ixsystems NAS-108520](https://jira.ixsystems.com/browse/NAS-108520) +[ixsystems NAS-108521](https://jira.ixsystems.com/browse/NAS-108521) +[ixsystems NAS-108522](https://jira.ixsystems.com/browse/NAS-108522) +[ixsystems NAS-107219](https://jira.ixsystems.com/browse/NAS-107219) + +## :wrench: Helm Installation ___ Copy proper example Values file from the examples: @@ -409,7 +409,7 @@ need to be set with helm (support added in chart version `0.6.1`): `Democratic-CSI` works with Nomad in a functioning but limted capacity. See the [Nomad docs](docs/nomad.md) for details. -## **Multiple Deployments** +## :wrench: **Multiple Deployments** You may install multiple deployments of each/any driver. It requires the following: @@ -418,7 +418,7 @@ You may install multiple deployments of each/any driver. It requires the followi - Use unqiue names for your storage classes (per cluster) - Use a unique parent dataset (ie: don't try to use the same parent across deployments or clusters) -## **Snapshot Support** +## :wrench: **Snapshot Support** [**External-snapshotter CRD**](https://github.com/kubernetes-csi/external-snapshotter/tree/master/client/config/crd) Install beta (v1.17+) CRDs (one per cluster): @@ -453,7 +453,7 @@ Install `Democratic-CSI` with `volumeSnapshotClasses` appropriatly defined. [External-snapshotter Usage](https://github.com/kubernetes-csi/external-snapshotter#usage) [Democratic-CSI Issue](https://github.com/democratic-csi/democratic-csi/issues/129#issuecomment-961489810) -## Migrating from freenas-provisioner and freenas-iscsi-provisioner +## :wrench: Migrating from freenas-provisioner and freenas-iscsi-provisioner It is possible to migrate all volumes from the non-csi freenas provisioners to `Democratic-CSI`. @@ -461,7 +461,7 @@ to `Democratic-CSI`. Copy the `contrib/freenas-provisioner-to-democratic-csi.sh` script from the project to your workstation. Read the script in detail, and edit the variables to your needs to start migrating! -# **Sponsors** +# :trophy: **Sponsors** A special shout out to the wonderful sponsors of this project!