From 6d7b13c7a58c1fa66c7e05882cbead336c938deb Mon Sep 17 00:00:00 2001 From: Edith Parzefall Date: Mon, 24 Apr 2023 12:33:37 +0200 Subject: [PATCH] Apply suggestions from code review language review --- services/frontend/README.md | 8 ++++---- services/gateway/README.md | 6 +++--- services/storage-users/README.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/services/frontend/README.md b/services/frontend/README.md index e020941db2..c74ba3faea 100644 --- a/services/frontend/README.md +++ b/services/frontend/README.md @@ -45,13 +45,13 @@ You can find more details regarding available attributes at the [libre-graph-api The `frontend` service can use a configured store via `FRONTEND_OCS_RESOURCE_INFO_CACHE_STORE`. Possible stores are: - `memory`: Basic in-memory store and the default. - `ocmem`: Advanced in-memory store allowing max size. - - `redis`: Stores data in a configured redis cluster. - - `redis-sentinel`: Stores data in a configured redis sentinel cluster. + - `redis`: Stores data in a configured Redis cluster. + - `redis-sentinel`: Stores data in a configured Redis Sentinel cluster. - `etcd`: Stores data in a configured etcd cluster. - `nats-js`: Stores data using key-value-store feature of [nats jetstream](https://docs.nats.io/nats-concepts/jetstream/key-value-store) - `noop`: Stores nothing. Useful for testing. Not recommended in production environments. -1. Note that in-memory stores are by nature not reboot persistent. -2. Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`. These settings are blank by default which means that the standard settings of the configured store applies. +1. Note that in-memory stores are by nature not reboot-persistent. +2. Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`. These settings are blank by default which means that the standard settings of the configured store apply. 3. The frontend service can be scaled if not using `in-memory` stores and the stores are configured identically over all instances. 4. When using `redis-sentinel`, the Redis master to use is configured via `FRONTEND_OCS_RESOURCE_INFO_CACHE_STORE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. diff --git a/services/gateway/README.md b/services/gateway/README.md index 8a4e581178..a2db7d3119 100644 --- a/services/gateway/README.md +++ b/services/gateway/README.md @@ -7,13 +7,13 @@ The gateway service is an ... The `gateway` service can use a configured store via `GATEWAY_CACHE_STORE`. Possible stores are: - `memory`: Basic in-memory store and the default. - `ocmem`: Advanced in-memory store allowing max size. - - `redis`: Stores data in a configured redis cluster. - - `redis-sentinel`: Stores data in a configured redis sentinel cluster. + - `redis`: Stores data in a configured Redis cluster. + - `redis-sentinel`: Stores data in a configured Redis Sentinel cluster. - `etcd`: Stores data in a configured etcd cluster. - `nats-js`: Stores data using key-value-store feature of [nats jetstream](https://docs.nats.io/nats-concepts/jetstream/key-value-store) - `noop`: Stores nothing. Useful for testing. Not recommended in production environments. 1. Note that in-memory stores are by nature not reboot persistent. -2. Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`. These settings are blank by default which means that the standard settings of the configured store applies. +2. Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`. These settings are blank by default which means that the standard settings of the configured store apply. 3. The gateway service can be scaled if not using `in-memory` stores and the stores are configured identically over all instances. 4. When using `redis-sentinel`, the Redis master to use is configured via `GATEWAY_CACHE_STORE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`. diff --git a/services/storage-users/README.md b/services/storage-users/README.md index f99445fad1..e5aac82e72 100644 --- a/services/storage-users/README.md +++ b/services/storage-users/README.md @@ -92,6 +92,6 @@ The `storage-users` service caches stat and metadata via the configured store in - `noop`: Stores nothing. Useful for testing. Not recommended in production environments. 1. Note that in-memory stores are by nature not reboot persistent. -2. Though usually not necessary, a database name can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`, `redis` and `redis-sentinel`. These settings are blank by default which means that the standard settings of the configured store applies. +2. Though usually not necessary, a database name can be configured for event stores if the event store supports this. Generally not applicable for stores of type `in-memory`, `redis` and `redis-sentinel`. These settings are blank by default which means that the standard settings of the configured store apply. 3. The `storage-users` service can be scaled if not using `in-memory` stores and the stores are configured identically over all instances. 4. When using `redis-sentinel`, the Redis master to use is configured via `STORAGE_USERS_STAT_CACHE_STORE_NODES` and `STORAGE_USERS_FILEMETADATA_CACHE_STORE_NODES` in the form of `:/` like `10.10.0.200:26379/mymaster`.