From 559c670ec6900f07a9a05c2cd7f66996ae83be46 Mon Sep 17 00:00:00 2001 From: minottic Date: Tue, 25 Jun 2024 10:24:03 +0200 Subject: [PATCH 1/2] Change empty override files to symlinks --- services/.empty.yaml | 1 + services/backend/.compose.dev.yaml | 2 +- services/backend/.compose.ldap.yaml | 2 +- services/backend/.compose.oidc.yaml | 2 +- services/backend/services/v3/.compose.dev.yaml | 2 +- services/backend/services/v3/.compose.jobs.yaml | 2 +- .../backend/services/v3/services/archivemock/.compose.dev.yaml | 2 +- services/backend/services/v4/.compose.dev.yaml | 2 +- services/backend/services/v4/.compose.elastic.yaml | 2 +- services/frontend/.compose.dev.yaml | 2 +- services/searchapi/.compose.dev.yaml | 2 +- 11 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 services/.empty.yaml mode change 100644 => 120000 services/backend/.compose.dev.yaml mode change 100644 => 120000 services/backend/.compose.ldap.yaml mode change 100644 => 120000 services/backend/.compose.oidc.yaml mode change 100644 => 120000 services/backend/services/v3/.compose.dev.yaml mode change 100644 => 120000 services/backend/services/v3/.compose.jobs.yaml mode change 100644 => 120000 services/backend/services/v3/services/archivemock/.compose.dev.yaml mode change 100644 => 120000 services/backend/services/v4/.compose.dev.yaml mode change 100644 => 120000 services/backend/services/v4/.compose.elastic.yaml mode change 100644 => 120000 services/frontend/.compose.dev.yaml mode change 100644 => 120000 services/searchapi/.compose.dev.yaml diff --git a/services/.empty.yaml b/services/.empty.yaml new file mode 100644 index 00000000..1d826e5c --- /dev/null +++ b/services/.empty.yaml @@ -0,0 +1 @@ +## empty file used when override configs are not enabled diff --git a/services/backend/.compose.dev.yaml b/services/backend/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/.compose.dev.yaml b/services/backend/.compose.dev.yaml new file mode 120000 index 00000000..ad51ac20 --- /dev/null +++ b/services/backend/.compose.dev.yaml @@ -0,0 +1 @@ +../.empty.yaml \ No newline at end of file diff --git a/services/backend/.compose.ldap.yaml b/services/backend/.compose.ldap.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/.compose.ldap.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/.compose.ldap.yaml b/services/backend/.compose.ldap.yaml new file mode 120000 index 00000000..ad51ac20 --- /dev/null +++ b/services/backend/.compose.ldap.yaml @@ -0,0 +1 @@ +../.empty.yaml \ No newline at end of file diff --git a/services/backend/.compose.oidc.yaml b/services/backend/.compose.oidc.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/.compose.oidc.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/.compose.oidc.yaml b/services/backend/.compose.oidc.yaml new file mode 120000 index 00000000..ad51ac20 --- /dev/null +++ b/services/backend/.compose.oidc.yaml @@ -0,0 +1 @@ +../.empty.yaml \ No newline at end of file diff --git a/services/backend/services/v3/.compose.dev.yaml b/services/backend/services/v3/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/services/v3/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/services/v3/.compose.dev.yaml b/services/backend/services/v3/.compose.dev.yaml new file mode 120000 index 00000000..8aa7b1cc --- /dev/null +++ b/services/backend/services/v3/.compose.dev.yaml @@ -0,0 +1 @@ +../../../.empty.yaml \ No newline at end of file diff --git a/services/backend/services/v3/.compose.jobs.yaml b/services/backend/services/v3/.compose.jobs.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/services/v3/.compose.jobs.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/services/v3/.compose.jobs.yaml b/services/backend/services/v3/.compose.jobs.yaml new file mode 120000 index 00000000..8aa7b1cc --- /dev/null +++ b/services/backend/services/v3/.compose.jobs.yaml @@ -0,0 +1 @@ +../../../.empty.yaml \ No newline at end of file diff --git a/services/backend/services/v3/services/archivemock/.compose.dev.yaml b/services/backend/services/v3/services/archivemock/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/services/v3/services/archivemock/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/services/v3/services/archivemock/.compose.dev.yaml b/services/backend/services/v3/services/archivemock/.compose.dev.yaml new file mode 120000 index 00000000..8713181c --- /dev/null +++ b/services/backend/services/v3/services/archivemock/.compose.dev.yaml @@ -0,0 +1 @@ +../../../../../.empty.yaml \ No newline at end of file diff --git a/services/backend/services/v4/.compose.dev.yaml b/services/backend/services/v4/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/services/v4/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/services/v4/.compose.dev.yaml b/services/backend/services/v4/.compose.dev.yaml new file mode 120000 index 00000000..8aa7b1cc --- /dev/null +++ b/services/backend/services/v4/.compose.dev.yaml @@ -0,0 +1 @@ +../../../.empty.yaml \ No newline at end of file diff --git a/services/backend/services/v4/.compose.elastic.yaml b/services/backend/services/v4/.compose.elastic.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/backend/services/v4/.compose.elastic.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/backend/services/v4/.compose.elastic.yaml b/services/backend/services/v4/.compose.elastic.yaml new file mode 120000 index 00000000..8aa7b1cc --- /dev/null +++ b/services/backend/services/v4/.compose.elastic.yaml @@ -0,0 +1 @@ +../../../.empty.yaml \ No newline at end of file diff --git a/services/frontend/.compose.dev.yaml b/services/frontend/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/frontend/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/frontend/.compose.dev.yaml b/services/frontend/.compose.dev.yaml new file mode 120000 index 00000000..ad51ac20 --- /dev/null +++ b/services/frontend/.compose.dev.yaml @@ -0,0 +1 @@ +../.empty.yaml \ No newline at end of file diff --git a/services/searchapi/.compose.dev.yaml b/services/searchapi/.compose.dev.yaml deleted file mode 100644 index 1d826e5c..00000000 --- a/services/searchapi/.compose.dev.yaml +++ /dev/null @@ -1 +0,0 @@ -## empty file used when override configs are not enabled diff --git a/services/searchapi/.compose.dev.yaml b/services/searchapi/.compose.dev.yaml new file mode 120000 index 00000000..ad51ac20 --- /dev/null +++ b/services/searchapi/.compose.dev.yaml @@ -0,0 +1 @@ +../.empty.yaml \ No newline at end of file From e45c54cc8f2c0ea048b8a5eaa34090939a6d1880 Mon Sep 17 00:00:00 2001 From: minottic Date: Tue, 25 Jun 2024 10:24:46 +0200 Subject: [PATCH 2/2] Update readme with symlink --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba8b9ae4..bd5c806c 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,7 @@ To add a new service (see the [backend v4](./services/backend/services/v4/) for 2. name it as the service 3. create the `compose.yaml` file with the required dependencies (if any) 4. eventually, include any service in (2) and (3) which is specific to the service and not shared across the global setup -5. eventually, add additional configurable logic (e.g. [BE_VERSION dependency](./services/frontend/compose.yaml#L14) and [ELASTIC_ENABLED dependency](./services/backend/services/v4/compose.yaml)). Remember to add an empty `.compose..yaml` (e.g. [here](./services/backend/services/v4/.compose.elastic.yaml)) if the service supports on/off. This also include DEV configurations, e.g. [here](./services/searchapi/compose.dev.yaml) +5. eventually, add additional configurable logic (e.g. [BE_VERSION dependency](./services/frontend/compose.yaml#L14) and [ELASTIC_ENABLED dependency](./services/backend/services/v4/compose.yaml)). Remember to add a `.compose..yaml` symlink to [.empty.yaml](./services/.empty.yaml) (e.g. [here](./services/backend/services/v4/.compose.elastic.yaml)) if the service supports on/off. This also includes DEV configurations, e.g. [here](./services/searchapi/compose.dev.yaml) 6. eventually, add entrypoints for init logics, as described [here](#if-the-service-does-not-support-entrypoints-yet-one-needs-to) 7. eventually, add the platform field, as described [here](#supported-os-architectures) 8. eventually, create a `config` folder if it requires configuration