Add documentation for the ocm service

2023-11-06 08:29:52 +01:00
parent 418e13517d
commit 1c703763ea
4 changed files with 197 additions and 1 deletions
@@ -0,0 +1,15 @@
+---
+title: Service Configuration
+date: 2018-05-02T00:00:00+00:00
+weight: 20
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/services/ocm
+geekdocFilePath: configuration.md
+geekdocCollapseSection: true
+---
+
+## Example YAML Config
+
+{{< include file="services/_includes/ocm-config-example.yaml"  language="yaml" >}}
+
+{{< include file="services/_includes/ocm.md" >}}
@@ -0,0 +1,65 @@
+---
+title: Create share flow
+date: 2018-05-02T00:00:00+00:00
+weight: 40
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/services/ocm
+geekdocFilePath: create_share_flow.md
+geekdocCollapseSection: true
+---
+
+## OCM Create Share Flow
+
+{{< mermaid class="text-center">}}
+sequenceDiagram
+    box Instance A
+        participant osp as ocmsharesprovider
+        participant gwa as Gateway A
+        participant httpa as ocs
+    end
+    actor usera as User A
+    box Instance B
+        participant httpb as ocmd
+        participant gwb as Gateway B
+        participant ocmc as OCMCore
+    end
+
+    Note over usera: A shares a resource with B
+    usera->>+httpa: CreateShare
+        httpa->>+gwa: GetInfoByDomain
+        Note left of gwa: GetInfoByDomain<br/>(ocmproviderauthorizer)
+        gwa-->>-httpa: return
+
+        httpa->>+gwa: GetAcceptedUser
+        Note left of gwa: GetAcceptedUser<br/>(ocminvitemanager)
+        gwa-->>-httpa: return
+
+        httpa->>+gwa: CreateOCMShare
+            gwa->>+osp: CreateOCMShare
+                osp->>+gwa: Stat
+                gwa-->>-osp: return
+
+                Note left of osp: store share in repo
+                
+                osp->>+httpb: POST /shares
+                    httpb->>+gwb: IsProviderAllowed
+                    Note right of gwb: IsProviderAllowed<br/>(ocmproviderauthorizer)
+                    gwb-->>-httpb: return
+
+                    httpb->>+gwb: GetUser
+                    Note right of gwb: GetUser<br/>(userprovider)
+                    gwb-->>-httpb: return
+
+                    httpb->>+gwb: CreateOCMCoreShare
+                        gwb->>+ocmc: CreateOCMCoreShare
+                        Note right of ocmc: StoreReceivedShare
+                        ocmc-->>-gwb: return
+                    gwb-->>-httpb: return
+                httpb-->>-osp: return
+            osp-->>-gwa: return
+        gwa-->>-httpa: return
+        httpa->>+gwa: Stat
+            Note left of gwa: Stat<br/>(storageprovider)
+        gwa-->>-httpa: return
+    httpa-->>-usera: return
+{{< /mermaid >}}
@@ -0,0 +1,55 @@
+---
+title: Invitation flow
+date: 2018-05-02T00:00:00+00:00
+weight: 30
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/services/ocm
+geekdocFilePath: invitation_flow.md
+geekdocCollapseSection: true
+---
+
+## OCM Invitation Flow
+
+{{< mermaid class="text-center">}}
+sequenceDiagram
+    box Instance A
+        participant ima as InviteManager A
+        participant gwa as Gateway A
+        participant httpa as HTTP Api A (ocm, sm)
+    end
+    actor usera as User A
+    actor userb as User B
+    box Instance B
+        participant httpb as HTTP Api B (ocm, sm)
+        participant gwb as Gateway B
+        participant imb as InviteManager B
+    end
+
+    Note over usera: A creates invitation token
+    usera->>+httpa: POST /generate-invite (sciencemesh)
+        httpa->>+gwa: GenerateInviteToken
+            gwa->>+ima: GenerateInviteToken
+                Note left of ima: store token in repo
+            ima-->>-gwa: return token
+        gwa-->>-httpa: return token
+    httpa-->>-usera: return token
+    
+    Note over usera,userb: A passes token to B
+
+    Note over userb: B accepts invitation
+    userb->>+httpb: POST /accept-invite (sciencemesh)
+        httpb->>+gwb: ForwardInvite
+            gwb->>+imb: ForwardInvite
+                imb->>+httpa: POST /invite-accepted (ocm)
+                    httpa->>+gwa: AcceptInvite
+                        gwa->>+ima: AcceptInvite
+                             Note left of ima: get token from repo
+                             Note left of ima: add remote user
+                        ima-->>-gwa: return
+                    gwa-->>-httpa: return remote user
+                httpa->>-imb: return remote user
+                Note right of imb: add remote user
+            imb-->>-gwb: return
+        gwb-->>-httpb: return
+    httpb-->>-userb: return
+{{< /mermaid >}}