home.md

@@ -2,23 +2,62 @@
 
 ![Service structure](services.png "Service structure")
 
+What does this Helm chat do:
+
+* Namespace embeddedoffice
+    * Install the deployment `connector`
+    * Create service `connector` for the deployment
+    * Create external service `api` that points to the `api` service off `yuuvis`
+    * Create external service `authentication` that points to the `authentication` service of `yuuvis`
+    * Create external service `configservice` that points to the `configservice` service of `yuuvis`
+    * Create external service `onlyoffice` that points to the `documentserver` service of `onlyoffice`
+* Namespace yuuvis
+    * Create external service `office` that points to the `connector` service of `embeddedoffice`
+    * Create external service `embeddedoffice` that points to the `connector` service of `embeddedoffice`
+
 ## Prerequisites
 
 * Installed Yuuvis Momentum instance on the same cluster: [Yuuvis Installation Instructions](https://github.com/OPTIMALSYSTEMS/yuuvis-api-helm-charts)
 * Installed ONLYOFFICE instance on the same cluster: [ONLYOFFICE Installation Instructions](https://github.com/ONLYOFFICE/Kubernetes-Docs)
 
 
-## Installation
+## Clone repository
 
-### Checkout repository
+Clone this repository via `git clone https://gitlab.ecmind.ch/open/embeddedofficeservice_momentum_helm.git`.
 
-Checkout this repository.
+## Configuration
 
 ### Request Access
 
 Request an access for the our container registry via mail to support@ecmind.ch.  
 
+### Configure Helm
+
+Copy and rename the file `values.yaml.template` to `values.yaml`.
+
+#### values.yml
+
+* `eo.jwt` Set a generated random string, for example a guid
+* `eo.image.credentials.username` Set the delivered username from ECMind
+* `eo.image.credentials.password` Set the delivered password from ECMind
+* *(Optional)* `eo.deployments.connector.replicaCount` Change the number of deployed pods
+
+## Installation
+
+* Create namespace via `kubectl create namespace embeddedoffice`
+* Deploy helm charts via `helm install .`
+
+* Create `embeddedoffice` App [schema](schema.xml) to yuuvis
 
-### Configuration
+### Per Tenant
 
-* Copy and rename the file `values.yaml.template` to `values.yaml`
+* Enable `embeddedoffice` App for tenant
+* Create technical account for `embeddedoffice`
+* Add technical account to `office-prod.yml` in the config service
+  ```
+  office:
+    tenants:
+        <tenant>:
+            username: <username>
+            password: <pwd>
+  ```