Merge pull request #349 from butonic/add-compose

initial docker-compose.yml for developers
2020-07-08 22:31:32 +02:00
parent 6588ec0e03 56112b4893
commit 89f187c6fc
4 changed files with 380 additions and 32 deletions
@@ -0,0 +1,12 @@
+EOS_MQ_URL=mq-master.testnet
+EOS_MGM_ALIAS=mgm-master.testnet
+EOS_QDB_NODES=quark-1.testnet:7777 quark-2.testnet:7777 quark-3.testnet:7777
+EOS_LDAP_HOST=ocis.testnet:9125
+EOS_GEOTAG=test
+EOS_INSTANCE_NAME=eostest
+EOS_MAIL_CC=eos@localhost
+EOS_USE_QDB=1
+EOS_USE_QDB_MASTER=1
+EOS_NS_ACCOUNTING=1
+EOS_SYNCTIME_ACCOUNTING=1
+EOS_UTF8=1
@@ -0,0 +1,159 @@
+---
+version: '3.5'
+
+networks:
+  testnet:
+    name: testnet
+
+services:
+  ocis:
+    container_name: ocis
+    image: owncloud/eos-ocis-dev:latest
+    tty: true
+    privileged: true
+    stdin_open: true
+    ports:
+      - 9200:9200
+    env_file:
+      - ./config/eos-docker.env
+    hostname: ocis
+    networks:
+      - testnet
+    volumes:
+      - .:/ocis
+      - ../ocis-reva:/ocis-reva
+      - ../reva:/reva
+    environment:
+      EOS_MGM_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
+      OCIS_DOMAIN: ${OCIS_DOMAIN:-localhost}
+      KONNECTD_ISS: https://${OCIS_DOMAIN:-localhost}:9200
+      KONNECTD_LOG_LEVEL: debug
+      KONNECTD_TLS: '0'
+      PHOENIX_OIDC_AUTHORITY: https://${OCIS_DOMAIN:-localhost}:9200
+      PHOENIX_OIDC_METADATA_URL: https://${OCIS_DOMAIN:-localhost}:9200/.well-known/openid-configuration
+      PHOENIX_WEB_CONFIG_SERVER: https://${OCIS_DOMAIN:-localhost}:9200
+      PROXY_HTTP_ADDR: 0.0.0.0:9200
+      REVA_OIDC_ISSUER: https://${OCIS_DOMAIN:-localhost}:9200
+      OCIS_LOG_LEVEL: debug
+      REVA_TRANSFER_EXPIRES: 86400
+      REVA_STORAGE_EOS_DRIVER: eoshome
+      REVA_STORAGE_EOS_DATA_DRIVER: eoshome
+      REVA_STORAGE_EOS_NAMESPACE: "/eos/dockertest/reva/users"
+      REVA_STORAGE_EOS_MASTER_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
+      REVA_STORAGE_EOS_SLAVE_URL: ${EOS_MGM_URL:-root://mgm-master.testnet:1094}
+      REVA_STORAGE_EOS_LAYOUT: "{{substr 0 1 .Username}}"
+
+  mgm-master:
+    container_name: mgm-master
+    image: owncloud/eos-mgm:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: mgm-master.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/master/var/log/eos:/var/log/eos
+    - ./e/master/var/eos/config:/var/eos/config
+    - ./e/master/var/eos/ns-queue:/var/eos/ns-queue
+    # this volume kills mgm-master during startup
+    # - ./e/master/var/eos/md:/var/eos/md
+    environment:
+      EOS_SET_MASTER: 1
+
+  mq-master:
+    container_name: mq-master
+    image: owncloud/eos-mq:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: mq-master.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/master/var/log/eos:/var/log/eos
+    - ./e/master/var/eos/config:/var/eos/config
+    - ./e/master/var/eos/ns-queue:/var/eos/ns-queue
+    environment:
+      EOS_SET_MASTER: 1
+
+  fst:
+    container_name: fst
+    image: owncloud/eos-fst:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: fst.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/master/var/log/eos:/var/log/eos
+    - ./e/disks:/disks
+    environment:
+      EOS_MGM_URL: "root://mgm-master.testnet"
+
+  quark-1:
+    container_name: quark-1
+    image: owncloud/eos-qdb:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: quark-1.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/quark-1/var/lib/quarkdb:/var/lib/quarkdb
+    environment:
+      EOS_QDB_DIR: "/var/lib/quarkdb/eosns"
+      EOS_QDB_PORT: "7777"
+      EOS_QDB_MODE: "raft"
+      EOS_QDB_CLUSTER_ID: "3d659c1a-e70f-43f0-bed4-941a2ca0765b"
+      EOS_QDB_NODES: "quark-1.testnet:7777,quark-2.testnet:7777,quark-3.testnet:7777"
+
+  quark-2:
+    container_name: quark-2
+    image: owncloud/eos-qdb:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: quark-2.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/quark-2/var/lib/quarkdb:/var/lib/quarkdb
+    environment:
+      EOS_QDB_DIR: "/var/lib/quarkdb/eosns"
+      EOS_QDB_PORT: "7777"
+      EOS_QDB_MODE: "raft"
+      EOS_QDB_CLUSTER_ID: "3d659c1a-e70f-43f0-bed4-941a2ca0765b"
+      EOS_QDB_NODES: "quark-1.testnet:7777,quark-2.testnet:7777,quark-3.testnet:7777"
+
+  quark-3:
+    container_name: quark-3
+    image: owncloud/eos-qdb:4.6.5
+    tty: true
+    privileged: true
+    stdin_open: true
+    env_file:
+    - ./config/eos-docker.env
+    hostname: quark-3.testnet
+    networks:
+    - testnet
+    volumes:
+    - ./e/quark-3/var/lib/quarkdb:/var/lib/quarkdb
+    environment:
+      EOS_QDB_DIR: "/var/lib/quarkdb/eosns"
+      EOS_QDB_PORT: "7777"
+      EOS_QDB_MODE: "raft"
+      EOS_QDB_CLUSTER_ID: "3d659c1a-e70f-43f0-bed4-941a2ca0765b"
+      EOS_QDB_NODES: "quark-1.testnet:7777,quark-2.testnet:7777,quark-3.testnet:7777"
@@ -0,0 +1,80 @@
+---
+title: "Getting Started with Development"
+date: 2020-07-07T20:35:00+01:00
+weight: 15
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs
+geekdocFilePath: development.md
+---
+
+{{< toc >}}
+
+## Docker dev environment
+
+### Option 1: Plain docker
+
+To build and run your local ocis code with default storage driver
+
+```
+docker run --rm -ti --name ocis -v $PWD:/ocis -p 9200:9200 owncloud/eos-ocis-dev
+```
+
+The eos-ocis-dev container will build and run ocis using the owncloud storage driver and store files in the container at `/var/tmp/reva/data/<username>/files`
+
+To check the uploaded files start digging with: `docker exec -it ocis ls -l /var/tmp/reva/`
+
+{{< hint info >}}
+On MacOS do not mount a local folder to the `/var/tmp/reva/` path. The fuse driver used by docker [does not support extended attributes](https://docs.docker.com/v18.09/docker-for-mac/osxfs/). See [#182](https://github.com/owncloud/ocis/issues/182) for more details.
+{{< /hint >}}
+
+
+### Option 2: Docker compose
+
+With the `docker-compose.yml` file in ocis repo you can also start ocis via compose:
+
+```
+docker-compose up -d ocis
+```
+
+{{< hint info >}}
+We are only starting the `ocis` container here.
+{{< /hint >}}
+
+## Verification
+
+Check the services are running
+
+```
+$ docker-compose exec ocis ./bin/ocis list
+--------------------------+-----+
+|        EXTENSION         | PID |
+--------------------------+-----+
+| accounts                 | 172 |
+| api                      | 204 |
+| glauth                   | 187 |
+| graph                    |  41 |
+| graph-explorer           |  55 |
+| konnectd                 | 196 |
+| ocs                      |  59 |
+| phoenix                  |  29 |
+| proxy                    |  22 |
+| registry                 | 226 |
+| reva-auth-basic          |  96 |
+| reva-auth-bearer         | 104 |
+| reva-frontend            | 485 |
+| reva-gateway             |  78 |
+| reva-sharing             | 286 |
+| reva-storage-eos         | 129 |
+| reva-storage-eos-data    | 134 |
+| reva-storage-home        | 442 |
+| reva-storage-home-data   | 464 |
+| reva-storage-oc          | 149 |
+| reva-storage-oc-data     | 155 |
+| reva-storage-public-link | 168 |
+| reva-users               | 420 |
+| settings                 |  23 |
+| thumbnails               | 201 |
+| web                      | 218 |
+| webdav                   |  63 |
+--------------------------+-----+
+```
@@ -13,65 +13,162 @@ OCIS can be configured to run on top of [eos](https://eos.web.cern.ch/). While t

 This document is a work in progress of the current setup.

-## Current status
+## Docker dev environment for eos storage

-Using ocis and eos it is possible today to manage folders. Sharing is [heavily](https://github.com/cs3org/reva/pull/523) [under](https://github.com/cs3org/reva/pull/585) [development](https://github.com/cs3org/reva/pull/482). File up and download needs proper configuration of the dataprovider to also use eos.
+### 1. Start eos & ocis containers

-## How to do it
-
-### Grab it!
+Start the eos cluster and ocis via the compose stack

 ```
-$ git clone git@github.com:owncloud/ocis.git
-$ cd ocis
+docker-compose up -d
 ```

+### 2. LDAP support

-### Run it!
-
-Preconditions
-* `go` (from golang.org/dl) and `gcc` (via e.g. `apt install build-essential`) are installed
-* No eos components are running. If in doubt, begin with `make eos-stop`
-
-We poured the nitty gritty details of setting up ocis into Makefile targets. After running
+Configure the os to resolve users and groups using ldap

 ```
-$ make eos-start
+docker-compose exec -d ocis /start-ldap
 ```

-the eos related docker containers will be created, started and setup to authenticate against the ocis-glauth service.
+Check that the os in the ocis container can now resolve einstein or the other demo users

-It will also copy the ocis binary to the `eos-cli1` container and start `ocis reva-storage-home` with the necessary environment variables to use the eos storage driver.
+```
+$ docker-compose exec ocis id einstein
+uid=20000(einstein) gid=30000(users) groups=30000(users),30001(sailing-lovers),30002(violin-haters),30007(physics-lovers)
+```

-For details have a look at the `Makefile`.
+We also need to restart the reva-users 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 reva-users
+docker-compose exec ocis ./bin/ocis run reva-users
+```

+### 3. Home storage

-### Test it!
+Kill the home storage. By default it uses the `owncloud` storage driver. We need to switch it to the `eoshome` driver and a new layout:

-You should now be able to point your browser to https://localhost:9200 and login using the demo user credentials, eg `einstein:relativity`.
+```
+docker-compose exec ocis ./bin/ocis kill reva-storage-home
+docker-compose exec -e REVA_STORAGE_EOS_LAYOUT="{{substr 0 1 .Username}}/{{.Username}}" -e REVA_STORAGE_HOME_DRIVER=eoshome ocis ./bin/ocis run reva-storage-home
+```
+
+### 4. Home data provider
+
+Kill the home data provider. By default it uses the `owncloud` storage driver. We need to switch it to the `eoshome` driver and a new layout:
+
+```
+docker-compose exec ocis ./bin/ocis kill reva-storage-home-data
+docker-compose exec -e REVA_STORAGE_EOS_LAYOUT="{{substr 0 1 .Username}}/{{.Username}}" -e REVA_STORAGE_HOME_DATA_DRIVER=eoshome ocis ./bin/ocis run reva-storage-home-data
+```

 {{< hint info >}}
-If you encounter an error when the IdP redirects you back to phoenix, just reload the page and it should be gone ... or debug it. PR welcome!
+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.
 {{< /hint >}}

-Create a folder in the ui. Then check it was created in eos:
+### 4. Frontend files namespace
+
+Restart the reva frontend with a new namespace (pointing to the eos storage provider) for the dav files endpoint

 ```
-$ docker exec -it eos-mgm1 eos ls -l /eos/dockertest/reva/users/e/einstein
+docker-compose exec ocis ./bin/ocis kill reva-frontend
+docker-compose exec -e DAV_FILES_NAMESPACE="/eos/" ocis ./bin/ocis run reva-frontend
 ```

-Now create a new folder in eos (using eos-mgm1 you will be logged in as admin, see the `whoami`, which is why we `chown` the folder to the uid and gid of einstein afterwards):
+## Verification
+
+Login with `einstein / relativity`, upload a file to einsteins home and verify the file is there using

 ```
-$ docker exec -it eos-mgm1 eos whoami
-$ docker exec -it eos-mgm1 eos mkdir /eos/dockertest/reva/users/e/einstein/rocks
-$ docker exec -it eos-mgm1 eos chown 20000:30000 /eos/dockertest/reva/users/e/einstein/rocks
+docker-compose exec ocis eos ls -l /eos/dockertest/reva/users/e/einstein/
+-rw-r--r--   1 einstein users              10 Jul  1 15:24 newfile.txt
 ```

-Check that the folder exists in the web ui.
+## Further exploration

-## Next steps
+EOS has a built in shell that you can enter using
+```
+$ docker-compose exec mgm-master eos
+# ---------------------------------------------------------------------------
+# EOS  Copyright (C) 2011-2019 CERN/Switzerland
+# This program comes with ABSOLUTELY NO WARRANTY; for details type `license'.
+# This is free software, and you are welcome to redistribute it
+# under certain conditions; type `license' for details.
+# ---------------------------------------------------------------------------
+EOS_INSTANCE=eostest
+EOS_SERVER_VERSION=4.6.5 EOS_SERVER_RELEASE=1
+EOS_CLIENT_VERSION=4.6.5 EOS_CLIENT_RELEASE=1
+EOS Console [root://localhost] |/> help
+access               Access Interface
+accounting           Accounting Interface
+acl                  Acl Interface
+archive              Archive Interface
+attr                 Attribute Interface
+backup               Backup Interface
+clear                Clear the terminal
+cd                   Change directory
+chmod                Mode Interface
+chown                Chown Interface
+config               Configuration System
+console              Run Error Console
+cp                   Cp command
+debug                Set debug level
+exit                 Exit from EOS console
+file                 File Handling
+fileinfo             File Information
+find                 Find files/directories
+newfind              Find files/directories (new implementation)
+fs                   File System configuration
+fsck                 File System Consistency Checking
+fuse                 Fuse Mounting
+fusex                Fuse(x) Administration
+geosched             Geoscheduler Interface
+group                Group configuration
+health               Health information about system
+help                 Display this text
+info                 Retrieve file or directory information
+inspector            Interact with File Inspector
+io                   IO Interface
+json                 Toggle JSON output flag for stdout
+license              Display Software License
+ls                   List a directory
+ln                   Create a symbolic link
+map                  Path mapping interface
+member               Check Egroup membership
+mkdir                Create a directory
+motd                 Message of the day
+mv                   Rename file or directory
+node                 Node configuration
+ns                   Namespace Interface
+pwd                  Print working directory
+quit                 Exit from EOS console
+quota                Quota System configuration
+reconnect            Forces a re-authentication of the shell
+recycle              Recycle Bin Functionality
+rmdir                Remove a directory
+rm                   Remove a file
+role                 Set the client role
+route                Routing interface
+rtlog                Get realtime log output from mgm & fst servers
+silent               Toggle silent flag for stdout
+space                Space configuration
+stagerrm             Remove disk replicas of a file if it has tape replicas
+stat                 Run 'stat' on a file or directory
+squash               Run 'squashfs' utility function
+test                 Run performance test
+timing               Toggle timing flag for execution time measurement
+touch                Touch a file
+token                Token interface
+tracker              Interact with File Tracker
+transfer             Transfer Interface
+version              Verbose client/server version
+vid                  Virtual ID System Configuration
+whoami               Determine how we are mapped on server side
+who                  Statistics about connected users
+?                    Synonym for 'help'
+.q                   Exit from EOS console
+EOS Console [root://localhost] |/>
+```
+
+But this is a different adventure. See the links at the top of this page for other sources of information on eos.

- configure storage-home-data to enable file upload, PRs against `ocis-reva` welcome
- get sharing implemented, PRs against `reva` welcome
- simplify home logic, see https://github.com/cs3org/reva/issues/601 and https://github.com/cs3org/reva/issues/578