From 78c6046cf7592febd1e03aa5a2f9ea15cb91b326 Mon Sep 17 00:00:00 2001 From: Martin Date: Mon, 26 Aug 2024 15:50:15 +0200 Subject: [PATCH] Update README.md References: #9490 (set the configured protocol transport for service metadata) As discussed with @butonic, adding that _configurable service endpoints_ are currently experimental. --- services/gateway/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/services/gateway/README.md b/services/gateway/README.md index 8d4598e6124..c167cb33dd8 100644 --- a/services/gateway/README.md +++ b/services/gateway/README.md @@ -31,7 +31,10 @@ Store specific notes: - When using `nats-js-kv` it is recommended to set `OCIS_CACHE_STORE_NODES` to the same value as `OCIS_EVENTS_ENDPOINT`. That way the cache uses the same nats instance as the event bus. - When using the `nats-js-kv` store, it is possible to set `OCIS_CACHE_DISABLE_PERSISTENCE` to instruct nats to not persist cache data on disc. -## Service endpoints +## Service Endpoints + +**IMPORTANT**\ +This functionality is currently experimental. The gateway acts as a proxy for other CS3 services. As such it has to forward requests to a lot of services and needs to establish connections by looking up the IP address using the service registry. Instead of using the service registry each endpoint can also be configured to use the grpc `dns://` or `kubernetes://` URLs, which might be useful when running in kubernetes. @@ -95,9 +98,7 @@ SHARING_PUBLIC_CS3_PROVIDER_ADDR="unix:/var/run/ocis/storage-system.sock" SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR="unix:/var/run/ocis/storage-system.sock" ``` - - -## Storage registry +## Storage Registry In order to add another storage provider the CS3 storage registry that is running as part of the CS3 gateway hes to be made aware of it. The easiest cleanest way to do it is to set `GATEWAY_STORAGE_REGISTRY_CONFIG_JSON=/path/to/storages.json` and list all storage providers like this: @@ -167,4 +168,4 @@ In order to add another storage provider the CS3 storage registry that is runnin } ``` -In the above replace `{storage-users-mount-uuid}` with the mount UUID that was generated for the storage-users service. You can find it in the `config.yaml` generated on by `ocis init`. The last entry `com.owncloud.api.storage-hello` and its `providerid` `"hello-storage-id"` are an example for in additional storage provider, in this case running `hellofs`, an example minimal storage driver. \ No newline at end of file +In the above replace `{storage-users-mount-uuid}` with the mount UUID that was generated for the storage-users service. You can find it in the `config.yaml` generated on by `ocis init`. The last entry `com.owncloud.api.storage-hello` and its `providerid` `"hello-storage-id"` are an example for in additional storage provider, in this case running `hellofs`, an example minimal storage driver.