Skip to content

Commit

Permalink
Merge pull request #6992 from fschade/sse-service
Browse files Browse the repository at this point in the history
enhancement: add sse service skeleton
  • Loading branch information
kobergj committed Aug 30, 2023
1 parent 61087ba commit 2120b0f
Show file tree
Hide file tree
Showing 73 changed files with 520 additions and 86 deletions.
2 changes: 1 addition & 1 deletion services/_includes/adoc/antivirus_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the antivirus service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/app-provider_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the app-provider service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/app-registry_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the app-registry service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/audit_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the audit service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-basic_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the auth-basic service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-bearer_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the auth-bearer service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-machine_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the auth-machine service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/eventhistory_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the eventhistory service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/frontend_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the frontend service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/gateway_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the gateway service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
51 changes: 36 additions & 15 deletions services/_includes/adoc/global_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ a| [subs=-attributes]
++0 ++

a| [subs=-attributes]
The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512.
The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512.

a| `OCIS_CACHE_STORE`

Expand All @@ -150,7 +150,7 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++memory ++
++noop ++

a| [subs=-attributes]
The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
Expand Down Expand Up @@ -198,10 +198,10 @@ a| [subs=-attributes]
++Duration ++

a| [subs=-attributes]
++24m0s ++
++5m0s ++

a| [subs=-attributes]
Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '10s' (10 seconds).
Default time to live for user info in the cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '300s' (300 seconds).

a| `OCIS_CORS_ALLOW_CREDENTIALS`

Expand All @@ -212,6 +212,7 @@ a| [subs=attributes+]
* xref:{s-path}/ocdav.adoc[ocdav] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
* xref:{s-path}/webdav.adoc[webdav] +
Expand All @@ -235,6 +236,7 @@ a| [subs=attributes+]
* xref:{s-path}/ocdav.adoc[ocdav] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
* xref:{s-path}/webdav.adoc[webdav] +
Expand All @@ -258,6 +260,7 @@ a| [subs=attributes+]
* xref:{s-path}/ocdav.adoc[ocdav] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
* xref:{s-path}/webdav.adoc[webdav] +
Expand All @@ -281,6 +284,7 @@ a| [subs=attributes+]
* xref:{s-path}/ocdav.adoc[ocdav] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
* xref:{s-path}/webdav.adoc[webdav] +
Expand Down Expand Up @@ -367,6 +371,7 @@ a| [subs=attributes+]
* xref:{s-path}/postprocessing.adoc[postprocessing] +
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-users.adoc[storage-users] +
* xref:{s-path}/userlog.adoc[userlog] +

Expand All @@ -392,6 +397,7 @@ a| [subs=attributes+]
* xref:{s-path}/postprocessing.adoc[postprocessing] +
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-users.adoc[storage-users] +
* xref:{s-path}/userlog.adoc[userlog] +

Expand All @@ -402,7 +408,7 @@ 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`

Expand All @@ -416,6 +422,7 @@ a| [subs=attributes+]
* xref:{s-path}/postprocessing.adoc[postprocessing] +
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-users.adoc[storage-users] +
* xref:{s-path}/userlog.adoc[userlog] +

Expand All @@ -440,6 +447,7 @@ a| [subs=attributes+]
* xref:{s-path}/postprocessing.adoc[postprocessing] +
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-users.adoc[storage-users] +
* xref:{s-path}/userlog.adoc[userlog] +

Expand All @@ -450,7 +458,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
The root CA certificate used to validate the server's TLS certificate. If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false.

a| `OCIS_GRPC_CLIENT_TLS_CACERT`

Expand Down Expand Up @@ -527,6 +535,7 @@ a| [subs=attributes+]
* xref:{s-path}/invitations.adoc[invitations] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/thumbnails.adoc[thumbnails] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
Expand All @@ -549,6 +558,7 @@ a| [subs=attributes+]
* xref:{s-path}/invitations.adoc[invitations] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/thumbnails.adoc[thumbnails] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
Expand All @@ -571,6 +581,7 @@ a| [subs=attributes+]
* xref:{s-path}/invitations.adoc[invitations] +
* xref:{s-path}/ocs.adoc[ocs] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/thumbnails.adoc[thumbnails] +
* xref:{s-path}/userlog.adoc[userlog] +
* xref:{s-path}/web.adoc[web] +
Expand Down Expand Up @@ -605,6 +616,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-users.adoc[storage-users] +
* xref:{s-path}/thumbnails.adoc[thumbnails] +
* xref:{s-path}/thumbnails.adoc[thumbnails] +
Expand All @@ -618,7 +630,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Whether to verify the server TLS certificates.
Allow insecure connections to the frontend.

a| `OCIS_JWT_SECRET`

Expand All @@ -640,6 +652,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -685,7 +698,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
The client id to authenticate with keycloak.
The client ID to authenticate with keycloak.

a| `OCIS_KEYCLOAK_CLIENT_REALM`

Expand Down Expand Up @@ -1253,6 +1266,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1302,6 +1316,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1351,6 +1366,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1400,6 +1416,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1442,7 +1459,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`

Expand All @@ -1463,7 +1480,7 @@ a| [subs=-attributes]
++https://localhost:9200 ++

a| [subs=-attributes]
The identity provider href for the openid-discovery relation.
The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.

a| `OCIS_PERSISTENT_STORE`

Expand Down Expand Up @@ -1564,7 +1581,7 @@ a| [subs=-attributes]
++com.owncloud.api.gateway ++

a| [subs=-attributes]
CS3 gateway used to look up user metadata
The CS3 gateway endpoint.

a| `OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD`

Expand All @@ -1579,7 +1596,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
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.
Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares.

a| `OCIS_SPACES_MAX_QUOTA`

Expand All @@ -1594,7 +1611,7 @@ a| [subs=-attributes]
++0 ++

a| [subs=-attributes]
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.
Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities.

a| `OCIS_SYSTEM_USER_API_KEY`

Expand Down Expand Up @@ -1632,7 +1649,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`

Expand Down Expand Up @@ -1680,6 +1697,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1729,6 +1747,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1778,6 +1797,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1827,6 +1847,7 @@ a| [subs=attributes+]
* xref:{s-path}/search.adoc[search] +
* xref:{s-path}/settings.adoc[settings] +
* xref:{s-path}/sharing.adoc[sharing] +
* xref:{s-path}/sse.adoc[sse] +
* xref:{s-path}/storage-publiclink.adoc[storage-publiclink] +
* xref:{s-path}/storage-shares.adoc[storage-shares] +
* xref:{s-path}/storage-system.adoc[storage-system] +
Expand Down Expand Up @@ -1892,7 +1913,7 @@ a| [subs=-attributes]
++https://localhost:9200 ++

a| [subs=-attributes]
The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails
The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.

a| `STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY`

Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/graph_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-08-30-07-36-57]
[#deprecation-note-2023-08-30-07-39-20]
[caption=]
.Deprecation notes for the graph service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
Loading

0 comments on commit 2120b0f

Please sign in to comment.