mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-31 01:10:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

rebrand ocm

Browse Source
This commit is contained in:
Ralf Haferkamp
2025-01-16 17:46:01 +01:00
parent c99cf22a10
commit 71e65cb9e7
2 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
services/ocm/README.md
View File

@@ -25,80 +25,80 @@ OC_ENABLE_OCM=true
The `ocm` services implements an invitation workflow which needs to be followed before creating federated shares. Invitations are limited to trusted instances, however.
The list of trusted instances is managed by the `ocmproviderauthorizer` service. The only supported backend currently is `json` which stores the list in a json file on disk. Note that the `ocmproviders.json` file, which holds that configuration, is expected to be located in the root of the ocis config directory if not otherwise defined. See the `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` envvar for more details.
The list of trusted instances is managed by the `ocmproviderauthorizer` service. The only supported backend currently is `json` which stores the list in a json file on disk. Note that the `ocmproviders.json` file, which holds that configuration, is expected to be located in the root of the OpenCloud config directory if not otherwise defined. See the `OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE` envvar for more details.
When all instances of a federation should trust each other, an `ocmproviders.json` file like this can be used for all instances:
```json
[
{
"name": "oCIS Test",
"full_name": "oCIS Test provider",
"organization": "oCIS",
"domain": "cloud.ocis.test",
"homepage": "https://ocis.test",
"description": "oCIS Example cloud storage",
"name": "OpenCloud Test 1",
"full_name": "OpenCloud Test provider 1",
"organization": "OpenCloud One",
"domain": "cloud1.opencloud.test",
"homepage": "https://cloud1.opencloud.test",
"description": "First OpenCloud Example cloud storage",
"services": [
{
"endpoint": {
"type": {
"name": "OCM",
"description": "cloud.ocis.test Open Cloud Mesh API"
"description": "cloud1.opencloud.test Open Cloud Mesh API"
},
"name": "cloud.ocis.test - OCM API",
"path": "https://cloud.ocis.test/ocm/",
"name": "cloud1.opencloud.test - OCM API",
"path": "https://cloud1.opencloud.test/ocm/",
"is_monitored": true
},
"api_version": "0.0.1",
"host": "http://cloud.ocis.test"
"host": "http://cloud1.opencloud.test"
},
{
"endpoint": {
"type": {
"name": "Webdav",
"description": "cloud.ocis.test Webdav API"
"description": "cloud1.opencloud.test Webdav API"
},
"name": "cloud.ocis.test Example - Webdav API",
"path": "https://cloud.ocis.test/dav/",
"name": "cloud1.opencloud.test Example - Webdav API",
"path": "https://cloud1.opencloud.test/dav/",
"is_monitored": true
},
"api_version": "0.0.1",
"host": "https://cloud.ocis.test/"
"host": "https://cloud1.opencloud.test/"
}
]
},
{
"name": "ownCloud Test",
"full_name": "ownCloud Test provider",
"organization": "ownCloud",
"domain": "cloud.owncloud.test",
"homepage": "https://owncloud.test",
"description": "ownCloud Example cloud storage",
"name": "OpenCloud Test 2",
"full_name": "OpenCloud Test provider 2",
"organization": "OpenCloud Two",
"domain": "cloud2.opencloud.test",
"homepage": "https://cloud2.opencloud.test",
"description": "Second OpenCloud Example cloud storage",
"services": [
{
"endpoint": {
"type": {
"name": "OCM",
"description": "cloud.owncloud.test Open Cloud Mesh API"
"description": "cloud2.opencloud.test Open Cloud Mesh API"
},
"name": "cloud.owncloud.test - OCM API",
"path": "https://cloud.owncloud.test/ocm/",
"name": "cloud2.opencloud.test - OCM API",
"path": "https://cloud2.opencloud.test/ocm/",
"is_monitored": true
},
"api_version": "0.0.1",
"host": "http://cloud.owncloud.test"
"host": "http://cloud2.opencloud.test"
},
{
"endpoint": {
"type": {
"name": "Webdav",
"description": "cloud.owncloud.test Webdav API"
"description": "cloud2.opencloud.test Webdav API"
},
"name": "cloud.owncloud.test Example - Webdav API",
"path": "https://cloud.owncloud.test/dav/",
"name": "cloud2.opencloud.test Example - Webdav API",
"path": "https://cloud2.opencloud.test/dav/",
"is_monitored": true
},
"api_version": "0.0.1",
"host": "https://cloud.owncloud.test/"
"host": "https://cloud2.opencloud.test/"
}
]
}
@@ -109,7 +109,7 @@ When all instances of a federation should trust each other, an `ocmproviders.jso
Note: the `domain` must not contain the protocol as it has to match the [GOCDB site object domain](https://developer.sciencemesh.io/docs/technical-documentation/central-database/#site-object).
{{< /hint >}}
The above federation consists of two instances: `cloud.owncloud.test` and `cloud.ocis.test` that can use the Invitation workflow described below to generate, send and accept invitations.
The above federation consists of two instances: `cloud1.opencloud.test` and `cloud2.opencloud.test` that can use the Invitation workflow described below to generate, send and accept invitations.
## Invitation Workflow

10
services/ocm/pkg/revaconfig/config.go
View File

@@ -8,17 +8,17 @@ import (
"github.com/opencloud-eu/opencloud/services/ocm/pkg/config"
)
// OCMConfigFromStruct will adapt an oCIS config struct into a reva mapstructure to start a reva service.
// OCMConfigFromStruct will adapt an OpenCloud config struct into a reva mapstructure to start a reva service.
func OCMConfigFromStruct(cfg *config.Config, logger log.Logger) map[string]interface{} {
// Construct the ocm provider domain from the oCIS URL
// Construct the ocm provider domain from the OpenCloud URL
providerDomain := ""
u, err := url.Parse(cfg.Commons.OpenCloudURL)
switch {
case err != nil:
logger.Error().Err(err).Msg("could not parse oCIS URL")
case u.Host == "":
logger.Error().Msg("oCIS URL has no host")
logger.Error().Err(err).Msg("could not parse OpenCloud URL")
case u.Host == "OpenCloud":
logger.Error().Msg("OpenCloud URL has no host")
default:
providerDomain = u.Host
}