Skip to content

Commit

Permalink
commit b7dc410
Browse files Browse the repository at this point in the history
Merge: da799d8 0ebfb89
Author: Christian Richter <1058116+dragonchaser@users.noreply.github.com>
Date:   Tue Jun 28 09:35:38 2022 +0200

    Merge pull request #3980 from owncloud/rename-extensions-to-services

    Refactor extensions to services.
  • Loading branch information
dragonchaser committed Jun 28, 2022
1 parent 320936d commit bcbd4b3
Show file tree
Hide file tree
Showing 193 changed files with 297 additions and 297 deletions.
15 changes: 0 additions & 15 deletions extensions/gateway/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/graph-explorer/configuration.md

This file was deleted.

14 changes: 0 additions & 14 deletions extensions/graph/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/groups/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/notifications/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/proxy/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/sharing/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/storage-publiclink/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/storage-shares/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/storage-system/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/storage-users/configuration.md

This file was deleted.

15 changes: 0 additions & 15 deletions extensions/store/configuration.md

This file was deleted.

2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_messages_search_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_messages_settings_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_messages_store_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_messages_thumbnails_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_services_search_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_services_settings_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_services_store_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion 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: /grpc_apis/ocis_services_thumbnails_v0
date: 2022-06-28T07:34:15Z
date: 2022-06-28T07:37:19Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
4 changes: 2 additions & 2 deletions helpers/adoc-generator.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ if err != nil {
log.Fatal(err)
}
replacer := strings.NewReplacer(
"github.com/owncloud/ocis/v2/extensions/", "",
"github.com/owncloud/ocis/v2/services/", "",
"/pkg/config/defaults", "",
)
var fields []ConfigField
Expand All @@ -48,7 +48,7 @@ m := map[string]interface{}{
{{- end }}
}

targetFolder := "../../docs/extensions/_includes/adoc/"
targetFolder := "../../docs/services/_includes/adoc/"
for pkg, conf := range m {
fields = GetAnnotatedVariables(conf)
if len(fields) > 0 {
Expand Down
2 changes: 1 addition & 1 deletion helpers/configenvextractor.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ var targets = map[string]string{

func main() {
fmt.Println("Getting relevant packages")
paths, err := filepath.Glob("../../extensions/*/pkg/config/defaults/defaultconfig.go")
paths, err := filepath.Glob("../../services/*/pkg/config/defaults/defaultconfig.go")
if err != nil {
log.Fatal(err)
}
Expand Down
4 changes: 2 additions & 2 deletions helpers/environment-variable-docs-generator.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if err != nil {
log.Fatal(err)
}
replacer := strings.NewReplacer(
"github.com/owncloud/ocis/v2/extensions/", "",
"github.com/owncloud/ocis/v2/services/", "",
"/pkg/config/defaults", "",
)
var fields []ConfigField
Expand All @@ -42,7 +42,7 @@ m := map[string]interface{}{
{{- end }}
}

targetFolder := "../../docs/extensions/_includes/"
targetFolder := "../../docs/services/_includes/"
for pkg, conf := range m {
fields = GetAnnotatedVariables(conf)
if len(fields) > 0 {
Expand Down
4 changes: 2 additions & 2 deletions helpers/example-config-generator.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

func main() {
replacer := strings.NewReplacer(
"github.com/owncloud/ocis/v2/extensions/", "",
"github.com/owncloud/ocis/v2/services/", "",
"/pkg/config/defaults", "",
)
cfg := map[string]string{
Expand All @@ -35,7 +35,7 @@ func main() {
targetFolders := []string{
// TODO: comment in when it is clear how to commit this to the structure of the master|main branch
// filepath.Join("../../", pkg, "/config"),
"../../docs/extensions/_includes/",
"../../docs/services/_includes/",
}
for _, targetFolder := range targetFolders {
os.MkdirAll(targetFolder, 0700)
Expand Down
4 changes: 2 additions & 2 deletions ocis/deployment/ocis_individual_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ geekdocFilePath: ocis_individual_services.md

The docker stack consists of at least 24 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.

The other containers are oCIS extensions, running each one in a separate container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}}). You also can start more than one container of each service by setting `OCIS_SCALE` to a number greater than 1. Currently this won't scale all services, but we are working on making all service easily scalable.
The other containers are oCIS services, running each one in a separate container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}}). You also can start more than one container of each service by setting `OCIS_SCALE` to a number greater than 1. Currently this won't scale all services, but we are working on making all service easily scalable.

## Server Deployment

Expand Down Expand Up @@ -76,7 +76,7 @@ See also [example server setup]({{< ref "preparing_server" >}})
STORAGE_TRANSFER_SECRET=
# Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please"
OCIS_MACHINE_AUTH_API_KEY=
# Number of services to run for extensions, that currently can be easily scaled. Defaults to 1.
# Number of services to run for services, that currently can be easily scaled. Defaults to 1.
OCIS_SCALE=
```

Expand Down
4 changes: 2 additions & 2 deletions ocis/deployment/ocis_keycloak.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ geekdocFilePath: ocis_keycloak.md
The docker stack consists 4 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network. It
is also responsible for redirecting requests on the OIDC discovery endpoints (e.g. `.well-known/openid-configuration`) to the correct destination in Keycloak.

Keycloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}})
Keycloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}})

The other container is oCIS itself, running all extensions in one container. In this example oCIS uses the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
The other container is oCIS itself, running all services in one container. In this example oCIS uses the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})

## Server Deployment

Expand Down
2 changes: 1 addition & 1 deletion ocis/deployment/ocis_traefik.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ geekdocFilePath: ocis_traefik.md

The docker stack consists of two containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.

The other one is oCIS itself running all extensions in one container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
The other one is oCIS itself running all extensions in one container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})

## Server Deployment

Expand Down
2 changes: 1 addition & 1 deletion ocis/development/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ For a consistent look and feel, ownCloud Web uses an external design library, th

### Settings

An extension likely has some behaviour which the user can configure. Fundamental configuration will often be done by administrators during deployment, via configuration files or by setting environment variables. But for other settings, which are supposed to change more often or which are even user specific, this is not a viable way. Therefore you need to offer the users a UI where they can configure your extension to their liking. Because implementing something like this is a repetitive task among extensions, oCIS already offers the settings extensions which does that for your extension. Your extension just needs to register settings bundles, respective permissions and finally read the current values from the settings service. You can read more on that on the [settings extension]({{< ref "../../extensions/settings" >}}) and see how [oCIS Hello uses these settings](https://owncloud.dev/extensions/ocis_hello/settings/).
An extension likely has some behaviour which the user can configure. Fundamental configuration will often be done by administrators during deployment, via configuration files or by setting environment variables. But for other settings, which are supposed to change more often or which are even user specific, this is not a viable way. Therefore you need to offer the users a UI where they can configure your extension to their liking. Because implementing something like this is a repetitive task among extensions, oCIS already offers the settings extensions which does that for your extension. Your extension just needs to register settings bundles, respective permissions and finally read the current values from the settings service. You can read more on that on the [settings extension]({{< ref "../../services/settings" >}}) and see how [oCIS Hello uses these settings](https://owncloud.dev/extensions/ocis_hello/settings/).

### Proxy

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: App-Provider
date: 2022-03-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/app-provider
geekdocEditPath: edit/master/docs/services/app-provider
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
Expand Down
Loading

0 comments on commit bcbd4b3

Please sign in to comment.