Skip to content

Commit

Permalink
[full-ci] enhancement: allow ocis to provide custom web applications (#…
Browse files Browse the repository at this point in the history
…8523)

* enhancement: allow ocis to provide custom web applications

* enhancement: add an option to disable web apps

* test: add default logger tests

* test: add app loading tests

* test: add asset server tests

* enhancement: make use of dedicated app conf file and app asset paths

* enhancement: adjust asset locations and deprecate WEB_ASSET_PATH

* enhancement: get rid of default logger and use the service level logger instead

* Apply suggestions from code review

Co-authored-by: Benedikt Kulmann <[email protected]>
Co-authored-by: kobergj <[email protected]>

* enhancement: use basename as app id

* Apply suggestions from code review

Co-authored-by: Martin <[email protected]>

* enhancement: use afero as fs abstraction

* enhancement: simplify logo upload

* enhancement: make use of introductionVersion field annotations

---------

Co-authored-by: Benedikt Kulmann <[email protected]>
Co-authored-by: kobergj <[email protected]>
Co-authored-by: Martin <[email protected]>
  • Loading branch information
4 people committed Mar 5, 2024
1 parent 4d193f7 commit 9f104f0
Show file tree
Hide file tree
Showing 90 changed files with 351 additions and 148 deletions.
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/eventhistory/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.eventhistory.v0"
url: /apis/grpc_apis/ocis_messages_eventhistory_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/policies/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.policies.v0"
url: /apis/grpc_apis/ocis_messages_policies_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/search/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.search.v0"
url: /apis/grpc_apis/ocis_messages_search_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/settings/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.settings.v0"
url: /apis/grpc_apis/ocis_messages_settings_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/store/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.store.v0"
url: /apis/grpc_apis/ocis_messages_store_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/messages/thumbnails/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.thumbnails.v0"
url: /apis/grpc_apis/ocis_messages_thumbnails_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/eventhistory/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.eventhistory.v0"
url: /apis/grpc_apis/ocis_services_eventhistory_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/policies/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.policies.v0"
url: /apis/grpc_apis/ocis_services_policies_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/search/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.search.v0"
url: /apis/grpc_apis/ocis_services_search_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/settings/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.settings.v0"
url: /apis/grpc_apis/ocis_services_settings_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/store/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.store.v0"
url: /apis/grpc_apis/ocis_services_store_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc_apis/ocis/services/thumbnails/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.thumbnails.v0"
url: /apis/grpc_apis/ocis_services_thumbnails_v0
date: 2024-03-05T10:33:54Z
date: 2024-03-05T13:13:17Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
44 changes: 34 additions & 10 deletions helpers/extended_vars.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,38 @@ variables:
description: ""
do_ignore: true
- rawname: MICRO_LOG_LEVEL
path: ocis-pkg/log/log.go:31
path: ocis-pkg/log/log.go:32
foundincode: true
name: MICRO_LOG_LEVEL
type: ""
default_value: ""
description: ""
do_ignore: false
- rawname: MICRO_LOG_LEVEL
path: ocis-pkg/log/log.go:31
foundincode: false
name: MICRO_LOG_LEVEL
type: string
default_value: Error
description: Set the log level for the internal go micro framework. Only change
on supervision of ownCloud Support.
do_ignore: false
- rawname: MICRO_LOG_LEVEL
path: ocis-pkg/log/log.go:35
foundincode: true
foundincode: false
name: MICRO_LOG_LEVEL
type: ""
default_value: ""
description: ""
do_ignore: true
- rawname: MICRO_LOG_LEVEL
path: ocis-pkg/log/log.go:36
foundincode: true
name: MICRO_LOG_LEVEL
type: ""
default_value: ""
description: ""
do_ignore: false
- rawname: _registryEnv
path: ocis-pkg/registry/registry.go:114
foundincode: true
Expand All @@ -43,6 +59,14 @@ variables:
and ''mdns'' are deprecated and will be removed in a later version. Only change
on supervision of ownCloud Support.'
do_ignore: false
- rawname: _registryAddressEnv
path: ocis-pkg/registry/registry.go:118
foundincode: true
name: MICRO_REGISTRY_ADDRESS
type: ""
default_value: ""
description: ""
do_ignore: true
- rawname: _registryAddressEnv
path: ocis-pkg/natsjsregistry/registry.go:145
foundincode: true
Expand All @@ -52,14 +76,6 @@ variables:
description: The bind address of the internal go micro framework. Only change on
supervision of ownCloud Support.
do_ignore: false
- rawname: _registryAddressEnv
path: ocis-pkg/registry/registry.go:118
foundincode: true
name: MICRO_REGISTRY_ADDRESS
type: ""
default_value: ""
description: ""
do_ignore: true
- rawname: _registryPasswordEnv
path: ocis-pkg/natsjsregistry/registry.go:163
foundincode: true
Expand Down Expand Up @@ -96,6 +112,14 @@ variables:
description: The default directory location for config files. See the General Info
section in the documentation for more details on defaults.
do_ignore: false
- rawname: RUN_CMD_TEST
path: internal/testenv/test.go:33
foundincode: true
name: RUN_CMD_TEST
type: ""
default_value: ""
description: ""
do_ignore: false
- rawname: parts[0]
path: ocis-pkg/config/envdecode/envdecode.go:382
foundincode: true
Expand Down
4 changes: 2 additions & 2 deletions 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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the antivirus service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down Expand Up @@ -245,7 +245,7 @@ a| [subs=-attributes]
The socket clamav is running on. Note the default value is an example which needs adaption according your OS.

a|`ANTIVIRUS_ICAP_TIMEOUT` +
xref:deprecation-note-2024-03-05-10-34-10[Deprecation Note]
xref:deprecation-note-2024-03-05-13-13-38[Deprecation Note]
a| [subs=-attributes]
++int64 ++
a| [subs=-attributes]
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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the auth-machine service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-service_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

[#deprecation-note-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the auth-service service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/clientlog_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

[#deprecation-note-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the clientlog 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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the eventhistory service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
26 changes: 25 additions & 1 deletion services/_includes/adoc/extended_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@


a| `MICRO_LOG_LEVEL` +
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++

a| `MICRO_LOG_LEVEL` +
a| [subs=-attributes]
++string ++
Expand All @@ -20,13 +28,22 @@ a| [subs=-attributes]
++Set the log level for the internal go micro framework. Only change on supervision of ownCloud Support. ++


a| `MICRO_LOG_LEVEL` +
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++

a| `MICRO_REGISTRY` +
a| [subs=-attributes]
++string ++
a| [subs=-attributes]
++nats-js-kv ++
a| [subs=-attributes]
++The Go micro registry type to use. Supported types are: 'memory', 'nats-js-kv' (default) and 'kubernetes'. Note that 'nats', 'etcd', 'consul' and 'mdns' are deprecated and will be removed in a later version. Only change on supervision of ownCloud Support. ++


a| `MICRO_REGISTRY_ADDRESS` +
a| [subs=-attributes]
Expand All @@ -35,7 +52,6 @@ a| [subs=-attributes]
++127.0.0.1:9233 ++
a| [subs=-attributes]
++The bind address of the internal go micro framework. Only change on supervision of ownCloud Support. ++


a| `MICRO_REGISTRY_AUTH_PASSWORD` +
a| [subs=-attributes]
Expand Down Expand Up @@ -68,5 +84,13 @@ a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++The default directory location for config files. See the General Info section in the documentation for more details on defaults. ++

a| `RUN_CMD_TEST` +
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++
a| [subs=-attributes]
++ ++

|===
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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[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-2024-03-05-10-34-10]
[#deprecation-note-2024-03-05-13-13-38]
[caption=]
.Deprecation notes for the gateway service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
Loading

0 comments on commit 9f104f0

Please sign in to comment.