Merge pull request #6009 from 2403905/introduceGlobalVariables

Introduced global OCIS_EVENTS_ENDPOINT and OCIS_EVENTS_CLUSTER #5901

services/_includes/adoc/antivirus_configvars.adoc

@@ -111,7 +111,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 Defines the behaviour when a virus has been found. Supported options are: 'delete', 'continue' and 'abort '. Delete will delete the file. Continue will mark the file as infected but continues further processing. Abort will keep the file in the uploads folder for further admin inspection and will not move it to its final destination.
 
-a|`ANTIVIRUS_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`ANTIVIRUS_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -120,7 +121,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`ANTIVIRUS_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`ANTIVIRUS_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/audit_configvars.adoc

@@ -102,7 +102,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 Enables zpages, which can be used for collecting and viewing in-memory traces.
 
-a|`AUDIT_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`AUDIT_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -111,7 +112,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`AUDIT_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`AUDIT_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/eventhistory_configvars.adoc

@@ -116,7 +116,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The bind address of the GRPC service.
 
-a|`EVENTHISTORY_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`EVENTHISTORY_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -125,7 +126,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`EVENTHISTORY_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`EVENTHISTORY_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/global_configvars.adoc

@@ -26,7 +26,7 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Flag to enable or disable the creation of the demo users.
+The default role assignments the demo users should be setup.
 
 a| `LDAP_BIND_DN`
 
@@ -109,10 +109,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++attribute ++
+++none ++
 
 a| [subs=-attributes]
-An option to control the behavior for disabling users. Supported options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. Default is 'attribute'.
+An option to control the behavior for disabling users. Valid options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed.
 
 a| `LDAP_GROUP_BASE_DN`
 
@@ -349,7 +349,7 @@ a| [subs=-attributes]
 ++ownCloudUserEnabled ++
 
 a| [subs=-attributes]
-LDAP Attribute to use as a flag telling if the user is enabled or disabled.
+LDAP attribute to use as a flag telling if the user is enabled or disabled.
 
 a| `LDAP_USER_FILTER`
 
@@ -536,10 +536,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++memory ++
+++ ++
 
 a| [subs=-attributes]
-Store implementation for the cache. Supported values are 'memory' (default), 'redis', and 'etcd'.
+The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
 
 a| `OCIS_CACHE_STORE_ADDRESS`
 
@@ -555,7 +555,7 @@ a| [subs=-attributes]
 ++[] ++
 
 a| [subs=-attributes]
-Nodes to use for the cache store.
+A comma separated list of nodes to access the configured store. This has no effect when the 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store.
 
 a| `OCIS_CACHE_STORE_ADDRESSES`
 
@@ -590,7 +590,7 @@ a| [subs=-attributes]
 ++[] ++
 
 a| [subs=-attributes]
-Nodes to use for the cache store.
+A comma separated list of nodes to access the configured store. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store.
 
 a| `OCIS_CACHE_STORE_SIZE`
 
@@ -619,13 +619,13 @@ a| [subs=attributes+]
 * xref:{s-path}/proxy.adoc[proxy] +
 
 a| [subs=-attributes]
-++int ++
+++Duration ++
 
 a| [subs=-attributes]
-++300 ++
+++0s ++
 
 a| [subs=-attributes]
-Max TTL in seconds for the gateway's stat cache.
+Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
 
 a| `OCIS_CACHE_STORE_TYPE`
 
@@ -640,10 +640,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++memory ++
+++ ++
 
 a| [subs=-attributes]
-Store implementation for the cache. Supported values are 'memory' (default), 'redis', and 'etcd'.
+The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
 
 a| `OCIS_CORS_ALLOW_CREDENTIALS`
 
@@ -748,6 +748,30 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The backend to use for storing metadata. Supported values are 'xattrs' and 'ini'. The setting 'xattrs' uses extended attributes to store file metadata while 'ini' uses a dedicated file to store file metadata. Defaults to 'xattrs'.
 
+a| `OCIS_EVENTS_CLUSTER`
+
+a| [subs=attributes+]
+* xref:{s-path}/antivirus.adoc[antivirus] +
+* xref:{s-path}/audit.adoc[audit] +
+* xref:{s-path}/eventhistory.adoc[eventhistory] +
+* xref:{s-path}/graph.adoc[graph] +
+* xref:{s-path}/notifications.adoc[notifications] +
+* xref:{s-path}/policies.adoc[policies] +
+* xref:{s-path}/postprocessing.adoc[postprocessing] +
+* xref:{s-path}/search.adoc[search] +
+* xref:{s-path}/sharing.adoc[sharing] +
+* xref:{s-path}/storage-users.adoc[storage-users] +
+* xref:{s-path}/userlog.adoc[userlog] +
+
+a| [subs=-attributes]
+++string ++
+
+a| [subs=-attributes]
+++ocis-cluster ++
+
+a| [subs=-attributes]
+The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system.
+
 a| `OCIS_EVENTS_ENABLE_TLS`
 
 a| [subs=attributes+]
@@ -771,7 +795,31 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..
+Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.
+
+a| `OCIS_EVENTS_ENDPOINT`
+
+a| [subs=attributes+]
+* xref:{s-path}/antivirus.adoc[antivirus] +
+* xref:{s-path}/audit.adoc[audit] +
+* xref:{s-path}/eventhistory.adoc[eventhistory] +
+* xref:{s-path}/graph.adoc[graph] +
+* xref:{s-path}/notifications.adoc[notifications] +
+* xref:{s-path}/policies.adoc[policies] +
+* xref:{s-path}/postprocessing.adoc[postprocessing] +
+* xref:{s-path}/search.adoc[search] +
+* xref:{s-path}/sharing.adoc[sharing] +
+* xref:{s-path}/storage-users.adoc[storage-users] +
+* xref:{s-path}/userlog.adoc[userlog] +
+
+a| [subs=-attributes]
+++string ++
+
+a| [subs=-attributes]
+++127.0.0.1:9233 ++
+
+a| [subs=-attributes]
+The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
 a| `OCIS_GRPC_CLIENT_TLS_CACERT`
 
@@ -936,7 +984,7 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Whether to verify the server TLS certificates.
+Allow insecure connections to the GATEWAY service.
 
 a| `OCIS_JWT_SECRET`
 
@@ -1191,7 +1239,7 @@ a| [subs=-attributes]
 ++ ++
 
 a| [subs=-attributes]
-Machine auth API key used to validate internal requests necessary to access resources from other services.
+Machine auth API key used to validate internal requests necessary for the access to resources from other services.
 
 a| `OCIS_OIDC_ISSUER`
 
@@ -1257,7 +1305,7 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares.
+Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in the frontend service.
 
 a| `OCIS_SPACES_MAX_QUOTA`
 
@@ -1272,7 +1320,7 @@ a| [subs=-attributes]
 ++0 ++
 
 a| [subs=-attributes]
-Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities.
+Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service.
 
 a| `OCIS_SYSTEM_USER_API_KEY`
 
@@ -1310,7 +1358,7 @@ a| [subs=-attributes]
 ++ ++
 
 a| [subs=-attributes]
-ID of the oCIS storage-system system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.
+ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.
 
 a| `OCIS_SYSTEM_USER_IDP`
 
@@ -1523,7 +1571,7 @@ a| [subs=-attributes]
 ++https://localhost:9200 ++
 
 a| [subs=-attributes]
-The public facing URL of the oCIS frontend.
+URL to load themes from. Will be prepended to the theme path.
 
 a| `REVA_GATEWAY`
 

services/_includes/adoc/graph_configvars.adoc

@@ -799,7 +799,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 LDAP Attribute to use as the unique id for schools. This should be a stable globally unique ID like a UUID.
 
-a|`GRAPH_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`GRAPH_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -808,7 +809,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Set to a empty string to disable emitting events.
 
-a|`GRAPH_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`GRAPH_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/notifications_configvars.adoc

@@ -184,7 +184,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 Encryption method for the SMTP communication. Possible values  are 'starttls', 'ssl', 'ssltls', 'tls'  and 'none'.
 
-a|`NOTIFICATIONS_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`NOTIFICATIONS_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -193,7 +194,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`NOTIFICATIONS_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`NOTIFICATIONS_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/policies_configvars.adoc

@@ -81,7 +81,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The secret to mint and validate jwt tokens.
 
-a|`POLICIES_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`POLICIES_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -90,7 +91,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`POLICIES_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`POLICIES_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/postprocessing_configvars.adoc

@@ -71,7 +71,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The path to the log file. Activates logging to this file if set.
 
-a|`POSTPROCESSING_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`POSTPROCESSING_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -80,7 +81,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`POSTPROCESSING_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`POSTPROCESSING_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/search_configvars.adoc

@@ -178,7 +178,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
 
-a|`SEARCH_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`SEARCH_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -187,7 +188,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`SEARCH_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`SEARCH_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++

services/_includes/adoc/sharing_configvars.adoc

@@ -197,7 +197,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
 
-a|`SHARING_EVENTS_ENDPOINT` +
+a|`OCIS_EVENTS_ENDPOINT` +
+`SHARING_EVENTS_ENDPOINT` +
 
 a| [subs=-attributes]
 ++string ++
@@ -206,7 +207,8 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
 
-a|`SHARING_EVENTS_CLUSTER` +
+a|`OCIS_EVENTS_CLUSTER` +
+`SHARING_EVENTS_CLUSTER` +
 
 a| [subs=-attributes]
 ++string ++