Clarify storage driver env vars

Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>

.drone.star

@@ -1347,11 +1347,11 @@ def ocisServer(storage):
         #'OCIS_LOG_LEVEL': 'debug',
         'STORAGE_HOME_DRIVER': '%s' % (storage),
         'STORAGE_USERS_DRIVER': '%s' % (storage),
-        'STORAGE_STORAGE_OCIS_ROOT': '/srv/app/tmp/ocis/storage/users',
-        'STORAGE_STORAGE_LOCAL_ROOT': '/srv/app/tmp/ocis/local/root',
-        'STORAGE_STORAGE_OWNCLOUD_DATADIR': '/srv/app/tmp/ocis/owncloud/data',
+        'STORAGE_DRIVER_OCIS_ROOT': '/srv/app/tmp/ocis/storage/users',
+        'STORAGE_DRIVER_LOCAL_ROOT': '/srv/app/tmp/ocis/local/root',
         'STORAGE_METADATA_ROOT': '/srv/app/tmp/ocis/metadata',
-        'STORAGE_STORAGE_OWNCLOUD_REDIS_ADDR': 'redis:6379',
+        'STORAGE_DRIVER_OWNCLOUD_DATADIR': '/srv/app/tmp/ocis/owncloud/data',
+        'STORAGE_DRIVER_OWNCLOUD_REDIS_ADDR': 'redis:6379',
         'STORAGE_LDAP_IDP': 'https://ocis-server:9200',
         'STORAGE_OIDC_ISSUER': 'https://ocis-server:9200',
         'PROXY_OIDC_ISSUER': 'https://ocis-server:9200',

changelog/unreleased/update-storage-env-vars.md

@@ -0,0 +1,5 @@
+Change: Clarify storage driver env vars
+
+After renaming ocsi-reva to storage and combining the storage and data providers some env vars were confusingly named `STORAGE_STORAGE_...`. We are changing the prefix for driver related env vars to `STORAGE_DRIVER_...`. This makes changing the storage driver using eg.: `STORAGE_HOME_DRIVER=eos` and setting driver options using `STORAGE_DRIVER_EOS_LAYOUT=...` less confusing.
+
+https://github.com/owncloud/ocis/pull/729

docs/extensions/storage/storages.md

@@ -158,11 +158,11 @@ For a simple docker-compose setup, you can create a volume which will be used by
 The CERN eos storage has evolved with ownCloud and natively supports id based lookup, ETag propagation, subtree size accounting, sharing, trash and versions. To use it you need to change the default configuration of the `storage storage-home` command (or have a look at the Makefile ̀ eos-start` target):
 
 ```
-export STORAGE_STORAGE_HOME_DRIVER=eos
-export STORAGE_STORAGE_EOS_NAMESPACE=/eos
-export STORAGE_STORAGE_EOS_MASTER_URL="root://eos-mgm1.eoscluster.cern.ch:1094"
-export STORAGE_STORAGE_EOS_ENABLE_HOME=true
-export STORAGE_STORAGE_EOS_LAYOUT="dockertest/{{.Username}}"
+export STORAGE_HOME_DRIVER=eos
+export STORAGE_DRIVER_EOS_NAMESPACE=/eos
+export STORAGE_DRIVER_EOS_MASTER_URL="root://eos-mgm1.eoscluster.cern.ch:1094"
+export STORAGE_DRIVER_EOS_ENABLE_HOME=true
+export STORAGE_DRIVER_EOS_LAYOUT="dockertest/{{.Username}}"
 ```
 
 Running it locally also requires the `eos` and `xrootd` binaries. Running it using `make eos-start` will use CentOS based containers that already have the necessary packages installed.

docs/ocis/eos.md

@@ -49,34 +49,59 @@ uid=20000(einstein) gid=30000(users) groups=30000(users),30001(sailing-lovers),3
 If the user is not found at first you might need to wait a few more minutes in case the ocis container is still compiling.
 {{< /hint >}}
 
-We also need to restart the storage-users service, so it picks up the changed environment. Without a restart it is not able to resolve users from LDAP.
+We also need to restart the storage-userprovider service, so it picks up the changed environment. Without a restart it is not able to resolve users from LDAP.
 ```
-docker-compose exec ocis ./bin/ocis kill storage-users
-docker-compose exec ocis ./bin/ocis run storage-users
+docker-compose exec ocis ./bin/ocis kill storage-userprovider
+docker-compose exec ocis ./bin/ocis run storage-userprovider
 ```
 
 ### 3. Home storage
 
-Kill the home storage. By default it uses the `owncloud` storage driver. We need to switch it to the `eoshome` driver and make it use the storage id of the eos storage provider:
+Kill the home storage. By default it uses the `ocis` storage driver. We need to switch it to the `eoshome` driver:
 
 ```
-docker-compose exec ocis ./bin/ocis kill storage-storage-home
-docker-compose exec -e STORAGE_STORAGE_HOME_DRIVER=eoshome -e STORAGE_STORAGE_HOME_MOUNT_ID=1284d238-aa92-42ce-bdc4-0b0000009158 ocis ./bin/ocis run storage-storage-home
+docker-compose exec ocis ./bin/ocis kill storage-home
+docker-compose exec -e STORAGE_HOME_DRIVER=eoshome ocis ./bin/ocis run storage-home
 ```
 
-### 4. Home data provider
+### 4. Users storage
+
+Kill the users storage. By default it uses the `ocis` storage driver. We need to switch it to the `eos` driver:
+
+```
+docker-compose exec ocis ./bin/ocis kill storage-users
+docker-compose exec -e STORAGE_USERS_DRIVER=eos ocis ./bin/ocis run storage-users
+```
 
-Kill the home data provider. By default it uses the `owncloud` storage driver. We need to switch it to the `eoshome` driver and make it use the storage id of the eos storage provider:
+### 5. Metadata storage
 
+First we need to create the metadata root in eos and set an owner:
 ```
-docker-compose exec ocis ./bin/ocis kill storage-storage-home-data
-docker-compose exec -e STORAGE_STORAGE_HOME_DATA_DRIVER=eoshome ocis ./bin/ocis run storage-storage-home-data
+docker-compose exec ocis eos mkdir -p /eos/dockertest/ocis/metadata
+docker-compose exec ocis eos chown 2:2 /eos/dockertest/ocis/metadata
 ```
 
 {{< hint info >}}
-The difference between the *home storage* and the *home data provider* are that the former is responsible for metadata changes while the latter is responsible for actual data transfer. The *home storage* uses the cs3 api to manage a folder hierarchy, while the *home data provider* is responsible for moving bytes to and from the storage.
+The uid and gid `2` are referencing the user `daemon` inside the ocis container. That user is also configured when restarting the accounts service later. For production systems you should create a dedicated user for the metadata storage.
 {{< /hint >}}
 
+Kill the metadata storage. By default it uses the `ocis` storage driver. We need to switch it to the `eos` driver:
+
+```
+docker-compose exec ocis ./bin/ocis kill storage-metadata
+docker-compose exec -e STORAGE_METADATA_DRIVER=eos -e STORAGE_METADATA_ROOT=/eos/dockertest/ocis/metadata ocis ./bin/ocis run storage-metadata
+```
+
+
+### 6. Accounts service
+
+Kill the accounts service. By default it uses the `ocis` storage driver. We need to switch it to the `eos` driver:
+
+```
+docker-compose exec ocis ./bin/ocis kill accounts
+docker-compose exec -e ACCOUNTS_SERVICE_USER_USERNAME=daemon -e ACCOUNTS_SERVICE_USER_UID=2 -e ACCOUNTS_SERVICE_USER_GID=2 ocis ./bin/ocis run accounts
+```
+
 ## Verification
 
 Login with `einstein / relativity`, upload a file to einsteins home and verify the file is there using
@@ -199,7 +224,7 @@ The ocis logs can be accessed using `docker-compose logs ocis`. Add `-f` for fol
 1. `docker-compose exec ocis make clean build` to update the binary
 2. `docker-compose exec ocis ./bin/ocis kill <service>` to kill the service
 3. `docker-compose exec ocis ./bin/ocis run <service>` to start the service. Do not forget to set any env vars, eg.
-  `docker-compose exec -e STORAGE_STORAGE_EOS_LAYOUT="{{substr 0 1 .Id.OpaqueId}}/{{.Id.OpaqueId}}" -e STORAGE_STORAGE_HOME_DRIVER=eoshome ocis ./bin/ocis run storage-storage-home`
+  `docker-compose exec -e STORAGE_HOME_DRIVER=eoshome -e STORAGE_DRIVER_EOS_LAYOUT="{{substr 0 1 .Id.OpaqueId}}/{{.Id.OpaqueId}}"  ocis ./bin/ocis run storage-home`
 
 ### Creation and upload of files does not work
 

ocis/docker-compose.yml

@@ -47,13 +47,13 @@ services:
       STORAGE_OIDC_ISSUER: https://${OCIS_DOMAIN:-localhost}:9200
       STORAGE_LDAP_IDP: https://${OCIS_DOMAIN:-localhost}:9200
       # TODO make id the default in ocis-storage
-      STORAGE_STORAGE_EOS_LAYOUT: "{{substr 0 1 .Id.OpaqueId}}/{{.Id.OpaqueId}}"
+      STORAGE_DRIVER_EOS_LAYOUT: "{{substr 0 1 .Id.OpaqueId}}/{{.Id.OpaqueId}}"
       STORAGE_FRONTEND_URL: https://${OCIS_DOMAIN:-localhost}:9200
       STORAGE_DATAGATEWAY_URL: https://${OCIS_DOMAIN:-localhost}:9200/data
       # common eos settings used for both drivers: eos and eoshome
-      STORAGE_STORAGE_EOS_MASTER_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
-      STORAGE_STORAGE_EOS_SLAVE_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
-      STORAGE_STORAGE_EOS_NAMESPACE: "/eos/dockertest/reva/users"
+      STORAGE_DRIVER_EOS_MASTER_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
+      STORAGE_DRIVER_EOS_SLAVE_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
+      STORAGE_DRIVER_EOS_NAMESPACE: "/eos/dockertest/reva/users"
       # the eos end xrdcopy binaries use this env var to find the eos mgm
       EOS_MGM_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}