From d01e966eca892ce0b95909bde014285f532964e2 Mon Sep 17 00:00:00 2001 From: Willi Date: Mon, 16 Dec 2024 15:21:19 +0100 Subject: [PATCH 1/5] Create mkdocs documentation for ARLAS Exploration Stack --- README.md | 208 ++------------------------- docs/docs/arlas_exploration_stack.md | 190 ++++++++++++++++++++++++ docs/docs/configuration.md | 70 +++++++++ docs/mkdocs.yml | 28 ++++ mkDocs.sh | 93 ++++++++++++ scripts/release.sh | 90 ++---------- 6 files changed, 398 insertions(+), 281 deletions(-) create mode 100644 docs/docs/arlas_exploration_stack.md create mode 100644 docs/docs/configuration.md create mode 100644 docs/mkdocs.yml create mode 100755 mkDocs.sh diff --git a/README.md b/README.md index 1d9a648..18dce63 100644 --- a/README.md +++ b/README.md @@ -1,211 +1,21 @@ # ARLAS Exploration Stack -This projects contains reference docker compose files for all the ARLAS microservices and third party services for running the ARLAS Stack. It also contains the script for starting the stack in different modes: -- simple : ARLAS without authentication, on HTTP -- with ARLAS Identity and Access Management (ARLAS IAM), on HTTPS -- with ARLAS IAM and ARLAS AIAS (ARLAS Item and Asset Services) for managing EO products for instance. +This projects contains reference docker compose files for all the ARLAS microservices and third party services for running the ARLAS Stack. -# ARLAS Simple deployment +It also contains the script for starting the stack in different modes: -The simple deployment has: -- [apisix](https://apisix.apache.org/) -- [arlas-wui](https://github.com/gisaia/ARLAS-wui) -- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) -- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) -- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) -- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) -- [arlas-server](https://github.com/gisaia/ARLAS-server) -- [elasticsearch](https://github.com/elastic/elasticsearch) -- [protomaps](https://protomaps.com/) +- **Simple**: ARLAS without authentication, on HTTP +- **IAM**: With ARLAS Identity and Access Management (ARLAS IAM), on HTTPS +- **AIAS**: With ARLAS IAM and ARLAS AIAS (ARLAS Item and Asset Services) for managing EO products for instance. *(WORK IN PROGRESS)* +See the [full documentation](https://gisaia.github.io/ARLAS-Exploration-stack) to run and deploy ARLAS Exploration stack. -## Start -To start the ARLAS stack in simple mode, run: -```shell -./start.sh -``` - -Once started, you can open ARLAS in your browser: [http://localhost/](http://localhost/). If you changed `ARLAS_HOST` in `conf/stack.env`, then open instead http://${ARLAS_HOST} . -You can add a sample data set and a configured dashboard by running: - -## Test - -```shell -pip3.10 install arlas-cli -./scripts/init_arlas_cli_confs.sh -./scripts/init_stack_with_data.sh local -``` - -A simple dashboard with AIS data is then available. - -## Stop - -Stop the stack with `./stop.sh`. - -Note: by default, data are persisted in docker volumes prefixed with `arlas-test- ...`. To reset the volumes, run: - -```shell -docker volume rm arlas-test-data-es arlas-test-persist arlas-test-postgres -``` - -# ARLAS IAM deployment - -The IAM deployment has: -- [apisix](https://apisix.apache.org/) -- [arlas-wui-iam](https://github.com/gisaia/ARLAS-wui-iam) -- [arlas-iam-server](https://github.com/gisaia/ARLAS-IAM) -- [postgres](https://www.postgresql.org/) -- [arlas-wui](https://github.com/gisaia/ARLAS-wui) -- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) -- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) -- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) -- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) -- [arlas-server](https://github.com/gisaia/ARLAS-server) -- [elasticsearch](https://github.com/elastic/elasticsearch) -- [protomaps](https://protomaps.com/) - -To start, run: -```shell -./start.sh iam -``` -Once started, you can open ARLAS in your browser: [https://localhost/](https://localhost/). If you changed `ARLAS_HOST` in `conf/stack.env`, then open instead https://${ARLAS_HOST} . -You can add a sample data set and a configured dashboard by running: - -```shell -pip3.10 install arlas-cli -./scripts/init_arlas_cli_confs.sh -./scripts/init_stack_with_data.sh local.iam.admin -``` - -A simple dashboard with AIS data is then available. You can login with: -- username: `user@org.com` -- password: `secret` -or as admin: -- username: `tech@gisaia.com` -- password: `admin` - -IMPORTANT: when using IAM, users can create collections only on indices prefixed with their organisation's name followed by `@`. For instance, a user in the organisation `gisaia.com`, who creates an index containing car gps data can name the index `gisaia.com@car_gps_locations`. - -# ARLAS AIAS deployment - -The AIAS (ARLAS Item and Asset Services) deployment has: -- [apisix](https://apisix.apache.org/) -- [arlas-wui-iam](https://github.com/gisaia/ARLAS-wui-iam) -- [arlas-iam-server](https://github.com/gisaia/ARLAS-IAM) -- [postgres](https://www.postgresql.org/) -- [arlas-wui](https://github.com/gisaia/ARLAS-wui) -- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) -- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) -- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) -- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) -- [arlas-server](https://github.com/gisaia/ARLAS-server) -- [agate](https://github.com/gisaia/aias) -- [fam](https://github.com/gisaia/aias) -- [fam-wui](https://github.com/gisaia/aias) -- [aproc-service](https://github.com/gisaia/aias) -- [aproc-proc](https://github.com/gisaia/aias) -- [elasticsearch](https://github.com/elastic/elasticsearch) -- [protomaps](https://protomaps.com/) -- [minio](https://min.io) -- [redis](https://redis.io) -- [rabbitmq](https://www.rabbitmq.com) - -To start, run: -```shell -./start.sh aias -``` - -You can access ARLAS just like the IAM deployement. You can also use the same script for initializing the stack with users and data. - -To setup an ARLAS EO catalog: -1) place some geotiff files in ${APROC_INPUT_DIR} configured in [conf/aias.env](conf/aias.env). -2) Go to the web page of ARLAS, then click the **Import** link (top right menu). This brings you to the import page. Add the geotiff file in the catalog by clicking on the + icon next to the tiff file. This will create and automatically feed an index named "org.com@airs_catalog" -3) once added, run : - -`./scripts/init_aias_catalog.sh local.iam.user catalog org.com` - -This will init the collection and the dashboard for the catalog. - -IMPORTANT: Naming convention: the index name has the form `org`@airs_`name` -For instance, the collection "geodes" for the organisation "org.com" has its index in "org.com@airs_geodes" - - -## Data from GEODES - -You can register data from GEODES: - -```shell -docker run --rm --network arlas-net gisaia/stac-geodes:latest add https://geodes-portal.cnes.fr/api/stac/items http://airs-server:8000/airs geodes S2L1C --start-date "2023-04-05T08:58:40.737+00:00" --max 1000 -``` - -This will register in the `org.com@airs_geodes` index the first 1000 `S2L1C` data that were acquired after 2023-04-05T08:58. Then, you can create the catalog: - -```shell -./scripts/init_aias_catalog.sh local.iam.user geodes org.com -``` - -# Configuration - -A significant number of parameters can be configured. Parameters are configured in the environement files located in the [conf/](conf/) directory. - -[Simple ARLAS Stack configuration](docker_compose_services_simple.md): -- conf/apisix.env: configuration of APISIX gateway -- conf/arlas.env: general parameters of ARLAS Server -- conf/elastic.env: configuration of elasticsearch -- conf/permissions.env: configurartion of the service delivering permission descriptions -- conf/persistence-file.env and conf/persistence-postgres.env: configuration of the persistence services -- conf/restart_strategy.env: configuration of the restart strategy for every service -- conf/stack.env: general parameters of the stack -- conf/versions.env: version of every single service (docker image) - - -[ARLAS with IAM configuration](docker_compose_services_iam.md): -- conf/arlas_iam.env: configuration of the IAM -- conf/arlas.env: general parameters of ARLAS Server -- conf/elastic.env: configuration of elasticsearch -- conf/permissions.env: configurartion of the service delivering permission descriptions -- conf/persistence-file.env and conf/persistence-postgres.env: configuration of the persistence services -- conf/restart_strategy.env: configuration of the restart strategy for every service -- conf/stack.env: general parameters of the stack -- conf/versions.env: version of every single service (docker image) - -[ARLAS Items and Assets Services (aias) configuration][]: -- same as ARLAS IAM and ... -- conf/aias.env: configuration of AIAS -- conf/minio.env: configuration of the minio object store - -## Host and domain - -By default, the stack is deployed on `http(s)://localhost/`. To deploy the ARLAS Stack on a different domain, simply change the `ARLAS_HOST` environement variable in [conf/stack.env](conf/stack.env): -```shell -ARLAS_HOST=localhost -```` - -If you are using `arlas_cli` you need to run `scripts/init_arlas_cli_confs.sh` to create again the `arlas_cli` configuration file. - -## Variables - -The current configurations are for tests only. These variables have to be changed for storing the data in reliable places: -- `ELASTIC_STORAGE` (`conf/elastic.env`) -- `ARLAS_PERSISTENCE_STORAGE` (`conf/persistence-file.env`) -- `POSTGRES_STORAGE` (`conf/postgres.env`) -- `POSTGRES_BACKUP_STORAGE` (`conf/postgres.env`) - -And for AIAS: -- `APROC_DOWNLOAD_DIR` (`conf/aias.env`) -- `APROC_INPUT_DIR` (`conf/aias.env`) -- `APROC_EMAIL_PATH_PREFIX_ADD` (`conf/aias.env`) - -## Developers +# Developers To release, run: ```shell ./scripts/release.sh X.Y ``` -where `X.Y` is the version of the stack. `X` must be aligned with the majar version ARLAS (WUI and Server) while `Y` is the increment of the stack. - -To update the version of the dependencies, such as ARLAS containers, edit `conf/versions.env`. - -## Basemap +where `X.Y` is the version of the stack. `X` must be aligned with the major version ARLAS (WUI and Server) while `Y` is the increment of the stack. -The basemap provided with the ARLAS Stack is the first zoom levels of protomaps. [Download](https://maps.protomaps.com/builds/) and replace [conf/protomaps/world.pmtiles](conf/protomaps/) to get all zoom levels. +To update the version of the dependencies, such as ARLAS containers, edit `conf/versions.env`. \ No newline at end of file diff --git a/docs/docs/arlas_exploration_stack.md b/docs/docs/arlas_exploration_stack.md new file mode 100644 index 0000000..7674aed --- /dev/null +++ b/docs/docs/arlas_exploration_stack.md @@ -0,0 +1,190 @@ +# ARLAS Exploration Stack + +This projects contains reference docker compose files for all the ARLAS microservices and third party services for running the ARLAS Stack. It also contains the script for starting the stack in different modes: + +- [Simple](#simple-deployment): ARLAS without authentication, on HTTP +- [IAM](#iam-deployment): With ARLAS Identity and Access Management (ARLAS IAM), on HTTPS +- [AIAS](#aias-deployment): With ARLAS IAM and ARLAS AIAS (ARLAS Item and Asset Services) for managing EO products for instance. *(WORK IN PROGRESS)* + +## Run ARLAS stack + +### Simple deployment + +The simple deployment has: + +- [apisix](https://apisix.apache.org/) +- [arlas-wui](https://github.com/gisaia/ARLAS-wui) +- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) +- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) +- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) +- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) +- [arlas-server](https://github.com/gisaia/ARLAS-server) +- [elasticsearch](https://github.com/elastic/elasticsearch) +- [protomaps](https://protomaps.com/) + + +**Start** + +To start the ARLAS stack in simple mode, run: +```shell +./start.sh +``` + +!!! success + Once started, you can open ARLAS in your browser: [http://localhost/](http://localhost/). + +!!! note + If you changed `ARLAS_HOST` in `conf/stack.env`, then open instead http://${ARLAS_HOST} . + +**Test** + +You can add a sample data set and a configured dashboard by running: + +```shell +pip3.10 install arlas-cli +./scripts/init_arlas_cli_confs.sh +./scripts/init_stack_with_data.sh local +``` + +!!! success + A simple dashboard with AIS data is then available. + + +### IAM deployment + +The IAM deployment has: + +- [apisix](https://apisix.apache.org/) +- [arlas-wui-iam](https://github.com/gisaia/ARLAS-wui-iam) +- [arlas-iam-server](https://github.com/gisaia/ARLAS-IAM) +- [postgres](https://www.postgresql.org/) +- [arlas-wui](https://github.com/gisaia/ARLAS-wui) +- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) +- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) +- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) +- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) +- [arlas-server](https://github.com/gisaia/ARLAS-server) +- [elasticsearch](https://github.com/elastic/elasticsearch) +- [protomaps](https://protomaps.com/) + +**Start** + +To start, run: +```shell +./start.sh iam +``` + +!!! success + Once started, you can open ARLAS in your browser: [https://localhost/](https://localhost/). + +!!! note + If you changed `ARLAS_HOST` in `conf/stack.env`, then open instead https://${ARLAS_HOST} . + +**Test** + +You can add a sample data set and a configured dashboard by running: + +```shell +pip3.10 install arlas-cli +./scripts/init_arlas_cli_confs.sh +./scripts/init_stack_with_data.sh local.iam.admin +``` + +!!! success + A simple dashboard with AIS data is then available. + +You can login with: + +- username: `user@org.com` +- password: `secret` + +or as admin: + +- username: `tech@gisaia.com` +- password: `admin` + +!!! warning + when using IAM, users can create collections only on indices prefixed with their organisation's name followed by `@`. + + For instance, a user in the organisation `gisaia.com`, who creates an index containing car gps data can name the index `gisaia.com@car_gps_locations`. + +### AIAS deployment + +The AIAS (ARLAS Item and Asset Services) deployment has: + +- [apisix](https://apisix.apache.org/) +- [arlas-wui-iam](https://github.com/gisaia/ARLAS-wui-iam) +- [arlas-iam-server](https://github.com/gisaia/ARLAS-IAM) +- [postgres](https://www.postgresql.org/) +- [arlas-wui](https://github.com/gisaia/ARLAS-wui) +- [arlas-hub](https://github.com/gisaia/ARLAS-wui-hub) +- [arlas-builder](https://github.com/gisaia/ARLAS-wui-builder) +- [arlas-persistence-server](https://github.com/gisaia/ARLAS-persistence) +- [arlas-permissions-server](https://github.com/gisaia/ARLAS-permissions) +- [arlas-server](https://github.com/gisaia/ARLAS-server) +- [agate](https://github.com/gisaia/aias) +- [fam](https://github.com/gisaia/aias) +- [fam-wui](https://github.com/gisaia/aias) +- [aproc-service](https://github.com/gisaia/aias) +- [aproc-proc](https://github.com/gisaia/aias) +- [elasticsearch](https://github.com/elastic/elasticsearch) +- [protomaps](https://protomaps.com/) +- [minio](https://min.io) +- [redis](https://redis.io) +- [rabbitmq](https://www.rabbitmq.com) + +To start, run: +```shell +./start.sh aias +``` + +You can access ARLAS just like the [IAM deployment](#iam-deployment). You can also use the same script for initializing the stack with users and data. + +#### EO Catalog + +To setup an ARLAS EO catalog: + +1. Place some geotiff files in `${APROC_INPUT_DIR}` configured in `conf/aias.env`. + +2. Go to the web page of ARLAS, then click the **Import** link (top right menu). This brings you to the import page. Add the geotiff file in the catalog by clicking on the + icon next to the tiff file. This will create and automatically feed an index named `org.com@airs_catalog`. +3. Once added, run : + +```shell +./scripts/init_aias_catalog.sh local.iam.user catalog org.com +``` + +This will init the collection and the dashboard for the catalog. + +!!! warning "Naming Convention" + The index name has the form `org`@airs_`name` + + For instance, the collection "geodes" for the organisation "org.com" has its index in "org.com@airs_geodes" + +#### Data from GEODES + +You can register data from GEODES: + +```shell +docker run --rm --network arlas-net gisaia/stac-geodes:latest add https://geodes-portal.cnes.fr/api/stac/items http://airs-server:8000/airs geodes S2L1C --start-date "2023-04-05T08:58:40.737+00:00" --max 1000 +``` + +This will register in the `org.com@airs_geodes` index the first 1000 `S2L1C` data that were acquired after 2023-04-05T08:58. + +Then, you can create the catalog: + +```shell +./scripts/init_aias_catalog.sh local.iam.user geodes org.com +``` + +## Stop ARLAS stack + +Stop the stack with `./stop.sh`. + +!!! note + By default, data are persisted in docker volumes prefixed with `arlas-test- ...` + + To reset the volumes, run: + + ```shell + docker volume rm arlas-test-data-es arlas-test-persist arlas-test-postgres + ``` \ No newline at end of file diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md new file mode 100644 index 0000000..4217912 --- /dev/null +++ b/docs/docs/configuration.md @@ -0,0 +1,70 @@ +# Configuration + +## Configuration files + +A significant number of parameters can be configured. Parameters are configured in the environment files located in the `conf/` directory. + +### Common files + +- `conf/arlas.env`: General parameters of ARLAS Server +- `conf/elastic.env`: Configuration of elasticsearch +- `conf/permissions.env`: Configuration of the service delivering permission descriptions +- `conf/persistence-file.env` and `conf/persistence-postgres.env`: Configuration of the persistence services +- `conf/restart_strategy.env`: Configuration of the restart strategy for every service +- `conf/stack.env`: General parameters of the stack +- `conf/versions.env`: Version of every single service (docker image) + + +### Simple deployment + +All [common files](#common-files) and: + +- `conf/apisix.env`: Configuration of APISIX gateway + +See [Simple ARLAS Stack configuration](../../docker_compose_services_simple.md) + +### IAM deployment + +All [common files](#common-files) and: + +- `conf/arlas_iam.env`: Configuration of the IAM + +See [ARLAS with IAM configuration](../../docker_compose_services_iam.md) + +### AIAS deployment + +Same as [IAM deployment](#iam-deployment) and: + +- `conf/aias.env`: Configuration of AIAS +- `conf/minio.env`: Configuration of the minio object store + +See [ARLAS Items and Assets Services (AIAS) configuration](../../docker_compose_services_aias.md) + +## Host and domain + +By default, the stack is deployed on `http(s)://localhost/`. To deploy the ARLAS Stack on a different domain, simply change the `ARLAS_HOST` environment variable in `conf/stack.env`: +```shell +ARLAS_HOST=localhost +``` + +If you are using `arlas_cli` you need to run `scripts/init_arlas_cli_confs.sh` to create again the `arlas_cli` configuration file. + +## Variables + +The current configurations are for tests only. These variables have to be changed for storing the data in reliable places: + +- `ELASTIC_STORAGE` (`conf/elastic.env`) +- `ARLAS_PERSISTENCE_STORAGE` (`conf/persistence-file.env`) +- `POSTGRES_STORAGE` (`conf/postgres.env`) +- `POSTGRES_BACKUP_STORAGE` (`conf/postgres.env`) + +And for AIAS: + +- `APROC_DOWNLOAD_DIR` (`conf/aias.env`) +- `APROC_INPUT_DIR` (`conf/aias.env`) +- `APROC_EMAIL_PATH_PREFIX_ADD` (`conf/aias.env`) + + +## Basemap + +The basemap provided with the ARLAS Stack is the first zoom levels of protomaps. [Download](https://maps.protomaps.com/builds/) and replace `conf/protomaps/world.pmtiles` to get all zoom levels. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..3ee203b --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,28 @@ +markdown_extensions: + - admonition + - codehilite + - pymdownx.superfences + - pymdownx.details + +site_name: Deploy ARLAS Exploration stack +repo_url: https://github.com/gisaia/ARLAS-Exploration-stack + +extra_css: + - css/styles.css +theme: + name: 'material' + palette: + primary: 'pink' + accent: 'light-blue' + +nav: +- Run ARLAS Stack: arlas_exploration_stack.md +- Configure ARLAS deployment: + - Configure ARLAS: configuration.md + - Docker-compose services: + - Simple deployment: dc_services/docker_compose_services_simple.md + - IAM deployment: dc_services/docker_compose_services_iam.md + - AIAS deployment: dc_services/docker_compose_services_aias.md + +plugins: + - search \ No newline at end of file diff --git a/mkDocs.sh b/mkDocs.sh new file mode 100755 index 0000000..8189d3f --- /dev/null +++ b/mkDocs.sh @@ -0,0 +1,93 @@ +#!/bin/sh -e + +# Generate documentation +pip install ruamel.yaml +mkdir -p docs/docs/dc_services + +python3.10 scripts/generate_dc_doc.py \ + dc/ref-dc-elastic.yaml \ + dc/ref-dc-arlas-server.yaml \ + dc/ref-dc-arlas-persistence-server.yaml \ + dc/ref-dc-arlas-permissions-server.yaml \ + dc/ref-dc-arlas-builder.yaml \ + dc/ref-dc-arlas-hub.yaml \ + dc/ref-dc-arlas-wui.yaml \ + dc/ref-dc-protomaps.yaml \ + dc/ref-dc-apisix.yaml \ + conf/versions.env \ + conf/elastic.env \ + conf/arlas.env \ + conf/persistence-file.env \ + conf/permissions.env \ + conf/apisix.env \ + conf/restart_strategy.env \ + conf/stack.env \ + > docs/docs/dc_services/docker_compose_services_simple.md + +python3.10 scripts/generate_dc_doc.py \ + dc/ref-dc-elastic.yaml \ + dc/ref-dc-arlas-server.yaml \ + dc/ref-dc-arlas-persistence-server.yaml \ + dc/ref-dc-arlas-permissions-server.yaml \ + dc/ref-dc-iam-server.yaml \ + dc/ref-dc-iam-wui.yaml \ + dc/ref-dc-arlas-builder.yaml \ + dc/ref-dc-arlas-hub.yaml \ + dc/ref-dc-arlas-wui.yaml \ + dc/ref-dc-protomaps.yaml \ + dc/ref-dc-apisix.yaml \ + dc/ref-dc-postgres.yaml \ + conf/versions.env \ + conf/elastic.env \ + conf/arlas.env \ + conf/persistence-file.env \ + conf/permissions.env \ + conf/apisix.env \ + conf/restart_strategy.env \ + conf/stack.env \ + conf/arlas_iam.env \ + conf/postgres.env \ + > docs/docs/dc_services/docker_compose_services_iam.md + +python3.10 scripts/generate_dc_doc.py \ + dc/ref-dc-elastic.yaml \ + dc/ref-dc-arlas-server.yaml \ + dc/ref-dc-arlas-persistence-server.yaml \ + dc/ref-dc-arlas-permissions-server.yaml \ + dc/ref-dc-iam-server.yaml \ + dc/ref-dc-iam-wui.yaml \ + dc/ref-dc-arlas-builder.yaml \ + dc/ref-dc-arlas-hub.yaml \ + dc/ref-dc-arlas-wui.yaml \ + dc/ref-dc-protomaps.yaml \ + dc/ref-dc-apisix.yaml \ + dc/ref-dc-postgres.yaml \ + dc/ref-dc-aias-airs.yaml \ + dc/ref-dc-aias-aproc-proc.yaml \ + dc/ref-dc-aias-aproc-service.yaml \ + dc/ref-dc-aias-fam-wui.yaml \ + dc/ref-dc-aias-fam.yaml \ + dc/ref-dc-aias-minio.yaml \ + dc/ref-dc-aias-rabbitmq.yaml \ + dc/ref-dc-aias-redis.yaml \ + dc/ref-dc-aias-volumes.yaml \ + dc/ref-dc-aias-agate.yaml \ + conf/aias.env \ + conf/minio.env \ + conf/versions.env \ + conf/elastic.env \ + conf/arlas.env \ + conf/persistence-file.env \ + conf/permissions.env \ + conf/apisix.env \ + conf/restart_strategy.env \ + conf/stack.env \ + conf/arlas_iam.env \ + conf/postgres.env \ + > docs/docs/dc_services/docker_compose_services_aias.md + +# Copy documentation to target +rm -rf target/generated-docs +mkdir -p target/generated-docs + +cp -r docs/docs/* target/generated-docs diff --git a/scripts/release.sh b/scripts/release.sh index 8e7f5aa..71cf81f 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -2,89 +2,15 @@ [ -z "$1" ] && echo "Please provide the version" && exit 1; VERSION=$1 -python3.10 scripts/generate_dc_doc.py \ - dc/ref-dc-elastic.yaml \ - dc/ref-dc-arlas-server.yaml \ - dc/ref-dc-arlas-persistence-server.yaml \ - dc/ref-dc-arlas-permissions-server.yaml \ - dc/ref-dc-arlas-builder.yaml \ - dc/ref-dc-arlas-hub.yaml \ - dc/ref-dc-arlas-wui.yaml \ - dc/ref-dc-protomaps.yaml \ - dc/ref-dc-apisix.yaml \ - conf/versions.env \ - conf/elastic.env \ - conf/arlas.env \ - conf/persistence-file.env \ - conf/permissions.env \ - conf/apisix.env \ - conf/restart_strategy.env \ - conf/stack.env \ - > docker_compose_services_simple.md +# Generate the md documentation +./mkDocs.sh -python3.10 scripts/generate_dc_doc.py \ - dc/ref-dc-elastic.yaml \ - dc/ref-dc-arlas-server.yaml \ - dc/ref-dc-arlas-persistence-server.yaml \ - dc/ref-dc-arlas-permissions-server.yaml \ - dc/ref-dc-iam-server.yaml \ - dc/ref-dc-iam-wui.yaml \ - dc/ref-dc-arlas-builder.yaml \ - dc/ref-dc-arlas-hub.yaml \ - dc/ref-dc-arlas-wui.yaml \ - dc/ref-dc-protomaps.yaml \ - dc/ref-dc-apisix.yaml \ - dc/ref-dc-postgres.yaml \ - conf/versions.env \ - conf/elastic.env \ - conf/arlas.env \ - conf/persistence-file.env \ - conf/permissions.env \ - conf/apisix.env \ - conf/restart_strategy.env \ - conf/stack.env \ - conf/arlas_iam.env \ - conf/postgres.env \ - > docker_compose_services_iam.md +# Publish documentation +pip3.10 install mkdocs-material termynal +mkdocs gh-deploy -f docs/mkdocs.yml -python3.10 scripts/generate_dc_doc.py \ - dc/ref-dc-elastic.yaml \ - dc/ref-dc-arlas-server.yaml \ - dc/ref-dc-arlas-persistence-server.yaml \ - dc/ref-dc-arlas-permissions-server.yaml \ - dc/ref-dc-iam-server.yaml \ - dc/ref-dc-iam-wui.yaml \ - dc/ref-dc-arlas-builder.yaml \ - dc/ref-dc-arlas-hub.yaml \ - dc/ref-dc-arlas-wui.yaml \ - dc/ref-dc-protomaps.yaml \ - dc/ref-dc-apisix.yaml \ - dc/ref-dc-postgres.yaml \ - dc/ref-dc-aias-airs.yaml \ - dc/ref-dc-aias-aproc-proc.yaml \ - dc/ref-dc-aias-aproc-service.yaml \ - dc/ref-dc-aias-fam-wui.yaml \ - dc/ref-dc-aias-fam.yaml \ - dc/ref-dc-aias-minio.yaml \ - dc/ref-dc-aias-rabbitmq.yaml \ - dc/ref-dc-aias-redis.yaml \ - dc/ref-dc-aias-volumes.yaml \ - dc/ref-dc-aias-agate.yaml \ - conf/aias.env \ - conf/minio.env \ - conf/versions.env \ - conf/elastic.env \ - conf/arlas.env \ - conf/persistence-file.env \ - conf/permissions.env \ - conf/apisix.env \ - conf/restart_strategy.env \ - conf/stack.env \ - conf/arlas_iam.env \ - conf/postgres.env \ - > docker_compose_services_aias.md - -git add docker_compose_services_*.md -git commit -m "update docker compose services documentation" +# Tag the version +git add docs/docs/dc_services/docker_compose_services_*.md +git commit -m "Update docker compose services documentation" git tag -a ${VERSION} -m "ARLAS Exploration stack ${VERSION}" git push origin ${VERSION} From a947143d41e631b4b32f77d9fa8996cb91a71b8c Mon Sep 17 00:00:00 2001 From: Willi Date: Mon, 16 Dec 2024 15:21:58 +0100 Subject: [PATCH 2/5] Update docker compose documentation generation --- .../docker_compose_services_aias.md | 110 +++++++++++------- .../docker_compose_services_iam.md | 46 +++++--- .../docker_compose_services_simple.md | 33 ++++-- scripts/generate_dc_doc.py | 25 ++-- 4 files changed, 130 insertions(+), 84 deletions(-) rename docker_compose_services_aias.md => docs/docs/dc_services/docker_compose_services_aias.md (93%) rename docker_compose_services_iam.md => docs/docs/dc_services/docker_compose_services_iam.md (95%) rename docker_compose_services_simple.md => docs/docs/dc_services/docker_compose_services_simple.md (95%) diff --git a/docker_compose_services_aias.md b/docs/docs/dc_services/docker_compose_services_aias.md similarity index 93% rename from docker_compose_services_aias.md rename to docs/docs/dc_services/docker_compose_services_aias.md index f03f5b9..8380e31 100644 --- a/docker_compose_services_aias.md +++ b/docs/docs/dc_services/docker_compose_services_aias.md @@ -38,7 +38,8 @@ Image: `ELASTIC_VERSION` with `docker.elastic.co/elasticsearch/elasticsearch:8.9 | `tracing.apm.enabled` | `false` | `` | | | List of volumes: -- ${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data + +- `${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data` ## File dc/ref-dc-arlas-server.yaml ### Service arlas-server Description: ARLAS Server is the geo-analytic engine of the ARLAS Exploration Stack @@ -73,6 +74,7 @@ Image: `ARLAS_SERVER_VERSION` with `gisaia/arlas-server:26.0.6` in `conf/version | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `` | | | | `ARLAS_AUTH_KEYCLOAK_SECRET` | `ARLAS_AUTH_KEYCLOAK_SECRET` | `` | | | | `ARLAS_AUTH_KEYCLOAK_URL` | `ARLAS_AUTH_KEYCLOAK_URL` | `` | | | + ## File dc/ref-dc-arlas-persistence-server.yaml ### Service arlas-persistence-server Description: ARLAS Persistence is a service for storing and retrieving small ojects, such as JSON documents or image previews. @@ -108,7 +110,8 @@ Image: `ARLAS_PERSISTENCE_VERSION` with `gisaia/arlas-persistence-server:26.0.0` | `JDK_JAVA_OPTIONS` | `ARLAS_PERSISTENCE_JDK_JAVA_OPTIONS` | `` | | | List of volumes: -- ${ARLAS_PERSISTENCE_STORAGE}:/persist/ + +- `${ARLAS_PERSISTENCE_STORAGE}:/persist/` ## File dc/ref-dc-arlas-permissions-server.yaml ### Service arlas-permissions-server Description: ARLAS Permissions is a service for listing user's permissions @@ -137,6 +140,7 @@ Image: `ARLAS_PERMISSIONS_VERSION` with `gisaia/arlas-permissions-server:26.0.0` | `ELASTIC_APM_TRANSACTION_IGNORE_USER_AGENTS` | `GoogleHC/*, kube-probe/*, curl*, GoogleStackdriver ...` | `` | | | | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `true` | | | | `JDK_JAVA_OPTIONS` | `ARLAS_PERMISSIONS_JDK_JAVA_OPTIONS` | `` | | empty value in `conf/permissions.env` | + ## File dc/ref-dc-iam-server.yaml ### Service arlas-iam-server Description: ARLAS IAM is the ARLAS Identity and Access Management service. @@ -173,11 +177,12 @@ Image: `ARLAS_IAM_SERVER_VERSION` with `gisaia/arlas-iam-server:26.0.2` in `conf | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `` | | | | `ARLAS_AUTH_KEYCLOAK_SECRET` | `ARLAS_AUTH_KEYCLOAK_SECRET` | `` | | | | `ARLAS_AUTH_KEYCLOAK_URL` | `ARLAS_AUTH_KEYCLOAK_URL` | `` | | | + ## File dc/ref-dc-iam-wui.yaml ### Service arlas-wui-iam Description: ARLAS IAM is the ARLAS Identity and Access Management web interface. -Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.0.2` in `conf/versions.env` +Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -189,11 +194,12 @@ Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.0.2` in `conf/versi | `ARLAS_WUI_IAM_APP_PATH` | `/iam` | `` | | | | `ARLAS_WUI_IAM_BASE_HREF` | `/iam` | `` | | | | `ARLAS_STATIC_LINKS` | `ARLAS_IAM_LINKS` | `` | | `'` in `conf/arlas_iam.env` | + ## File dc/ref-dc-arlas-builder.yaml ### Service arlas-builder Description: ARLAS Builder is the interface for elaborating ARLAS Dashboards. -Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/versions.env` +Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -225,15 +231,16 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env`
`https://${ARLAS_HOST}/persist` in `conf/arlas_iam.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-hub.yaml ### Service arlas-hub Description: ARLAS Hub is the interface for discovering all the available ARLAS Dashboards -Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions.env` +Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -264,11 +271,12 @@ Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions. | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_HUB_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-wui.yaml ### Service arlas-wui Description: ARLAS WUI is ARLAS Web interface for visualising an analytic ARLAS Dashboard. -Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in `conf/versions.env` +Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-no-analytics` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -314,17 +322,19 @@ Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in ` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `` | | `/aproc/jobs` in `conf/arlas.env` | List of volumes: -- ${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles -- ${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs -- ${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook -- ${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles + +- `${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles` +- `${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs` +- `${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook` +- `${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles` ## File dc/ref-dc-protomaps.yaml ### Service protomaps Image: `PROTOMAP_VERSION` with `protomaps/go-pmtiles:v1.19.0` in `conf/versions.env` List of volumes: -- ${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro + +- `${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro` ## File dc/ref-dc-apisix.yaml ### Service apisix Description: APISIX is ARLAS Stack gateway. It handles all the incoming trafic. @@ -336,7 +346,8 @@ Image: `APISIX_VERSION` with `apache/apisix:3.9.1-debian` in `conf/versions.env` | `APISIX_STAND_ALONE` | `APISIX_STAND_ALONE` | `true` | | `true` in `conf/apisix.env` | List of volumes: -- ${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro + +- `${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro` ## File dc/ref-dc-postgres.yaml ### Service db Image: `POSTGRES_VERSION` with `postgres:16.1` in `conf/versions.env` @@ -355,15 +366,16 @@ Image: `POSTGRES_VERSION` with `postgres:16.1` in `conf/versions.env` | `POSTGRES_USER` | `POSTGRES_USER` | `` | | `pg-user` in `conf/postgres.env` | List of volumes: -- ${POSTGRES_BACKUP_STORAGE}:/backup/ -- ${POSTGRES_CREATE_TABLE}:/docker-entrypoint-initdb.d/createTable.sql:ro -- ${POSTGRES_CRON}:/usr/local/bin/arlas/pg_backup_rotated.sh:ro -- ${POSTGRES_STORAGE}:/var/lib/postgresql/data + +- `${POSTGRES_BACKUP_STORAGE}:/backup/` +- `${POSTGRES_CREATE_TABLE}:/docker-entrypoint-initdb.d/createTable.sql:ro` +- `${POSTGRES_CRON}:/usr/local/bin/arlas/pg_backup_rotated.sh:ro` +- `${POSTGRES_STORAGE}:/var/lib/postgresql/data` ## File dc/ref-dc-aias-airs.yaml ### Service airs-server Description: AIRS Server is ARLAS Item registration service. It exposes a STAC-T interface for registering item and assets in ARLAS, such as Earth Observation products. -Image: `ARLAS_VERSION_AIRS` with `gisaia/airs:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_AIRS` with `gisaia/airs:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -377,12 +389,12 @@ Image: `ARLAS_VERSION_AIRS` with `gisaia/airs:0.5.5` in `conf/versions.env` | `AIRS_INDEX_LOGIN` | `ELASTIC_USER` | `` | | `elastic` in `conf/elastic.env` | | `AIRS_INDEX_PWD` | `ELASTIC_PASSWORD` | `` | | `elastic` in `conf/elastic.env` | | `AIRS_LOGGER_LEVEL` | `AIRS_LOGGER_LEVEL` | `` | | `INFO` in `conf/aias.env` | -| `AIRS_MAPPING_URL` | `AIRS_MAPPING_URL` | `/app/conf/mapping.json` | | | +| `ARLASEO_MAPPING_URL` | `ARLASEO_MAPPING_URL` | `/app/conf/mapping.json` | | `https://raw.githubusercontent.com/gisaia/ARLAS-EO/ ...` in `conf/aias.env` | | `AIRS_PORT` | `AIRS_PORT` | `8000` | | | | `AIRS_PREFIX` | `AIRS_PREFIX` | `/airs` | | | | `AIRS_S3_ACCESS_KEY_ID` | `AIRS_S3_ACCESS_KEY_ID` | `` | | `airs` in `conf/aias.env` | | `AIRS_S3_ASSET_HTTP_ENDPOINT_URL` | `AIRS_S3_ASSET_HTTP_ENDPOINT_URL` | `` | | `http://minio:9000/{}/{}` in `conf/aias.env` | -| `AIRS_S3_BUCKET` | `AIRS_S3_BUCKET` | `airs-storage` | | `airs` in `conf/aias.env` | +| `AIRS_S3_BUCKET` | `AIRS_S3_BUCKET` | `airs-storage` | | `airs-storage` in `conf/aias.env` | | `AIRS_S3_ENDPOINT_URL` | `AIRS_S3_ENDPOINT_URL` | `http://minio:9000` | | `http://minio:9000` in `conf/aias.env` | | `AIRS_S3_PLATFORM` | `AIRS_S3_PLATFORM` | `MINIO` | | | | `AIRS_S3_REGION` | `AIRS_S3_REGION` | `Standart` | | | @@ -397,11 +409,12 @@ Image: `ARLAS_VERSION_AIRS` with `gisaia/airs:0.5.5` in `conf/versions.env` | `ELASTIC_APM_SERVICE_NAME` | `airs-server` | `` | | | | `ELASTIC_APM_TRANSACTION_IGNORE_USER_AGENTS` | `GoogleHC/*, kube-probe/*, curl*, GoogleStackdriver ...` | `` | | | | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `true` | | | + ## File dc/ref-dc-aias-aproc-proc.yaml ### Service aproc-proc Description: ARLAS PROC is a worker, based on celery. Used for ingesting and downloading EO products. -Image: `ARLAS_VERSION_APROC_PROC` with `gisaia/aproc-proc:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_APROC_PROC` with `gisaia/aproc-proc:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -453,17 +466,18 @@ Image: `ARLAS_VERSION_APROC_PROC` with `gisaia/aproc-proc:0.5.5` in `conf/versio | `APROC_INPUT_STORAGE_FORCE_DOWNLOAD` | `APROC_INPUT_STORAGE_FORCE_DOWNLOAD` | `True` | | `True` in `conf/aias.env` | List of volumes: -- ${APROC_INPUT_DIR}:/inputs:ro -- ${APROC_DOWNLOAD_DIR}:/outbox -- ${PWD}/conf/aias/drivers.yaml:/home/app/worker/conf/drivers.yaml:ro -- ${PWD}/conf/aias/aproc.yaml:/home/app/worker/conf/aproc.yaml:ro -- ${PWD}/conf/aias/download_drivers.yaml:/home/app/worker/conf/download_drivers.yaml:ro -- ${PWD}/conf/aias/enrich_drivers.yaml:/home/app/worker/conf/enrich_drivers.yaml:ro + +- `${APROC_INPUT_DIR}:/inputs:ro` +- `${APROC_DOWNLOAD_DIR}:/outbox` +- `${PWD}/conf/aias/drivers.yaml:/home/app/worker/conf/drivers.yaml:ro` +- `${PWD}/conf/aias/aproc.yaml:/home/app/worker/conf/aproc.yaml:ro` +- `${PWD}/conf/aias/download_drivers.yaml:/home/app/worker/conf/download_drivers.yaml:ro` +- `${PWD}/conf/aias/enrich_drivers.yaml:/home/app/worker/conf/enrich_drivers.yaml:ro` ## File dc/ref-dc-aias-aproc-service.yaml ### Service aproc-service Description: ARLAS PROC is the OGC API Processes service. Used for ingesting and downloading EO products. -Image: `ARLAS_VERSION_APROC_SERVICE` with `gisaia/aproc-service:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_APROC_SERVICE` with `gisaia/aproc-service:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -515,16 +529,17 @@ Image: `ARLAS_VERSION_APROC_SERVICE` with `gisaia/aproc-service:0.5.5` in `conf/ | `APROC_INPUT_STORAGE_FORCE_DOWNLOAD` | `APROC_INPUT_STORAGE_FORCE_DOWNLOAD` | `True` | | `True` in `conf/aias.env` | List of volumes: -- ${APROC_INPUT_DIR}:/inputs:ro -- ${PWD}/conf/aias/drivers.yaml:/app/conf/drivers.yaml:ro -- ${PWD}/conf/aias/aproc.yaml:/app/conf/aproc.yaml:ro -- ${PWD}/conf/aias/download_drivers.yaml:/app/conf/download_drivers.yaml:ro -- ${PWD}/conf/aias/enrich_drivers.yaml:/app/conf/enrich_drivers.yaml:ro + +- `${APROC_INPUT_DIR}:/inputs:ro` +- `${PWD}/conf/aias/drivers.yaml:/app/conf/drivers.yaml:ro` +- `${PWD}/conf/aias/aproc.yaml:/app/conf/aproc.yaml:ro` +- `${PWD}/conf/aias/download_drivers.yaml:/app/conf/download_drivers.yaml:ro` +- `${PWD}/conf/aias/enrich_drivers.yaml:/app/conf/enrich_drivers.yaml:ro` ## File dc/ref-dc-aias-fam-wui.yaml ### Service arlas-fam-wui Description: ARLAS FAM is the ARLAS File and Archive Management interface. It allows exploration and registration of archives found in a directory. -Image: `ARLAS_VERSION_FAM_WUI` with `gisaia/arlas-fam-wui:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_FAM_WUI` with `gisaia/arlas-fam-wui:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -546,11 +561,12 @@ Image: `ARLAS_VERSION_FAM_WUI` with `gisaia/arlas-fam-wui:0.5.5` in `conf/versio | `AIRS_SERVER_URL` | `ARLAS_HOST` | `` | | `localhost` in `conf/stack.env` | | `AIRS_COLLECTION` | `AIRS_COLLECTION` | `` | | `main` in `conf/aias.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_FAM_LINKS` | `` | | `'` in `conf/aias.env` | + ## File dc/ref-dc-aias-fam.yaml ### Service fam-service Description: ARLAS FAM is the ARLAS File and Archive Management service. It allows exploration and registration of archives found in a directory. -Image: `ARLAS_VERSION_FAM` with `gisaia/fam:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_FAM` with `gisaia/fam:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -560,8 +576,9 @@ Image: `ARLAS_VERSION_FAM` with `gisaia/fam:0.5.5` in `conf/versions.env` | `APROC_RESOURCE_ID_HASH_STARTS_AT` | `3` | `` | | | List of volumes: -- ${APROC_INPUT_DIR}:/inputs:ro -- ${PWD}/conf/aias/drivers.yaml:/app/conf/drivers.yaml:ro + +- `${APROC_INPUT_DIR}:/inputs:ro` +- `${PWD}/conf/aias/drivers.yaml:/app/conf/drivers.yaml:ro` ## File dc/ref-dc-aias-minio.yaml ### Service minio Description: Minio is an object store @@ -575,27 +592,30 @@ Image: `ARLAS_VERSION_MINIO` with `minio/minio:RELEASE.2024-10-02T17-50-41Z` in | `MINIO_ROOT_USER` | `MINIO_ROOT_USER` | `` | | `airs` in `conf/minio.env` | List of volumes: -- ${AIRS_STORAGE_DIRECTORY:-arlas-data-minio}:/data + +- `${AIRS_STORAGE_DIRECTORY:-arlas-data-minio}:/data` ## File dc/ref-dc-aias-rabbitmq.yaml ### Service rabbitmq Image: `ARLAS_VERSION_RABBITMQ` with `rabbitmq:3.13.2-management-alpine` in `conf/versions.env` List of volumes: -- arlas-data-rabbimq:/var/lib/rabbitmq/mnesia + +- `arlas-data-rabbimq:/var/lib/rabbitmq/mnesia` ## File dc/ref-dc-aias-redis.yaml ### Service redis Image: `ARLAS_VERSION_REDIS` with `redis/redis-stack:7.2.0-v10` in `conf/versions.env` List of volumes: -- arlas-data-redis:/data + +- `arlas-data-redis:/data` ## File dc/ref-dc-aias-volumes.yaml ## File dc/ref-dc-aias-agate.yaml ### Service agate Description: AGATE is a forward authorization service for accessing resources such as images -Image: `ARLAS_VERSION_AGATE` with `gisaia/agate:0.5.5` in `conf/versions.env` +Image: `ARLAS_VERSION_AGATE` with `gisaia/agate:0.5.8` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -605,6 +625,8 @@ Image: `ARLAS_VERSION_AGATE` with `gisaia/agate:0.5.5` in `conf/versions.env` | `AGATE_HOST` | `AGATE_HOST` | `0.0.0.0` | | | | `AGATE_PORT` | `AGATE_PORT` | `8004` | | | | `AGATE_URL_HEADER` | `X-Forwarded-Uri` | `` | | | -| `AGATE_URL_HEADER_PREFIX` | `AIRS_S3_BUCKET` | `` | | `airs` in `conf/aias.env` | -| `ASSET_MINIO_PATTERN` | `"/(?P[^/]+)/items/(?P[^/]+)/asse ...` | `` | | | -| `ASSET_MINIO_PUBLIC_PATTERN` | `"/(?P[^/]+)/items/(?P[^/]+)/asse ...` | `` | | | +| `AGATE_URL_HEADER_PREFIX` | `AIRS_S3_BUCKET` | `` | | `airs-storage` in `conf/aias.env` | + +List of volumes: + +- `${PWD}/conf/aias/agate.yaml:/app/conf/agate.yaml:ro` diff --git a/docker_compose_services_iam.md b/docs/docs/dc_services/docker_compose_services_iam.md similarity index 95% rename from docker_compose_services_iam.md rename to docs/docs/dc_services/docker_compose_services_iam.md index 6995b8a..6a886bc 100644 --- a/docker_compose_services_iam.md +++ b/docs/docs/dc_services/docker_compose_services_iam.md @@ -29,7 +29,8 @@ Image: `ELASTIC_VERSION` with `docker.elastic.co/elasticsearch/elasticsearch:8.9 | `tracing.apm.enabled` | `false` | `` | | | List of volumes: -- ${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data + +- `${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data` ## File dc/ref-dc-arlas-server.yaml ### Service arlas-server Description: ARLAS Server is the geo-analytic engine of the ARLAS Exploration Stack @@ -64,6 +65,7 @@ Image: `ARLAS_SERVER_VERSION` with `gisaia/arlas-server:26.0.6` in `conf/version | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `` | | | | `ARLAS_AUTH_KEYCLOAK_SECRET` | `ARLAS_AUTH_KEYCLOAK_SECRET` | `` | | | | `ARLAS_AUTH_KEYCLOAK_URL` | `ARLAS_AUTH_KEYCLOAK_URL` | `` | | | + ## File dc/ref-dc-arlas-persistence-server.yaml ### Service arlas-persistence-server Description: ARLAS Persistence is a service for storing and retrieving small ojects, such as JSON documents or image previews. @@ -99,7 +101,8 @@ Image: `ARLAS_PERSISTENCE_VERSION` with `gisaia/arlas-persistence-server:26.0.0` | `JDK_JAVA_OPTIONS` | `ARLAS_PERSISTENCE_JDK_JAVA_OPTIONS` | `` | | | List of volumes: -- ${ARLAS_PERSISTENCE_STORAGE}:/persist/ + +- `${ARLAS_PERSISTENCE_STORAGE}:/persist/` ## File dc/ref-dc-arlas-permissions-server.yaml ### Service arlas-permissions-server Description: ARLAS Permissions is a service for listing user's permissions @@ -128,6 +131,7 @@ Image: `ARLAS_PERMISSIONS_VERSION` with `gisaia/arlas-permissions-server:26.0.0` | `ELASTIC_APM_TRANSACTION_IGNORE_USER_AGENTS` | `GoogleHC/*, kube-probe/*, curl*, GoogleStackdriver ...` | `` | | | | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `true` | | | | `JDK_JAVA_OPTIONS` | `ARLAS_PERMISSIONS_JDK_JAVA_OPTIONS` | `` | | empty value in `conf/permissions.env` | + ## File dc/ref-dc-iam-server.yaml ### Service arlas-iam-server Description: ARLAS IAM is the ARLAS Identity and Access Management service. @@ -164,11 +168,12 @@ Image: `ARLAS_IAM_SERVER_VERSION` with `gisaia/arlas-iam-server:26.0.2` in `conf | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `` | | | | `ARLAS_AUTH_KEYCLOAK_SECRET` | `ARLAS_AUTH_KEYCLOAK_SECRET` | `` | | | | `ARLAS_AUTH_KEYCLOAK_URL` | `ARLAS_AUTH_KEYCLOAK_URL` | `` | | | + ## File dc/ref-dc-iam-wui.yaml ### Service arlas-wui-iam Description: ARLAS IAM is the ARLAS Identity and Access Management web interface. -Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.0.2` in `conf/versions.env` +Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -180,11 +185,12 @@ Image: `ARLAS_WUI_IAM_VERSION` with `gisaia/arlas-wui-iam:26.0.2` in `conf/versi | `ARLAS_WUI_IAM_APP_PATH` | `/iam` | `` | | | | `ARLAS_WUI_IAM_BASE_HREF` | `/iam` | `` | | | | `ARLAS_STATIC_LINKS` | `ARLAS_IAM_LINKS` | `` | | `'` in `conf/arlas_iam.env` | + ## File dc/ref-dc-arlas-builder.yaml ### Service arlas-builder Description: ARLAS Builder is the interface for elaborating ARLAS Dashboards. -Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/versions.env` +Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -216,15 +222,16 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env`
`https://${ARLAS_HOST}/persist` in `conf/arlas_iam.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-hub.yaml ### Service arlas-hub Description: ARLAS Hub is the interface for discovering all the available ARLAS Dashboards -Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions.env` +Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -255,11 +262,12 @@ Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions. | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_HUB_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-wui.yaml ### Service arlas-wui Description: ARLAS WUI is ARLAS Web interface for visualising an analytic ARLAS Dashboard. -Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in `conf/versions.env` +Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-no-analytics` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -305,17 +313,19 @@ Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in ` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `` | | `/aproc/jobs` in `conf/arlas.env` | List of volumes: -- ${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles -- ${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs -- ${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook -- ${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles + +- `${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles` +- `${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs` +- `${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook` +- `${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles` ## File dc/ref-dc-protomaps.yaml ### Service protomaps Image: `PROTOMAP_VERSION` with `protomaps/go-pmtiles:v1.19.0` in `conf/versions.env` List of volumes: -- ${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro + +- `${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro` ## File dc/ref-dc-apisix.yaml ### Service apisix Description: APISIX is ARLAS Stack gateway. It handles all the incoming trafic. @@ -327,7 +337,8 @@ Image: `APISIX_VERSION` with `apache/apisix:3.9.1-debian` in `conf/versions.env` | `APISIX_STAND_ALONE` | `APISIX_STAND_ALONE` | `true` | | `true` in `conf/apisix.env` | List of volumes: -- ${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro + +- `${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro` ## File dc/ref-dc-postgres.yaml ### Service db Image: `POSTGRES_VERSION` with `postgres:16.1` in `conf/versions.env` @@ -346,7 +357,8 @@ Image: `POSTGRES_VERSION` with `postgres:16.1` in `conf/versions.env` | `POSTGRES_USER` | `POSTGRES_USER` | `` | | `pg-user` in `conf/postgres.env` | List of volumes: -- ${POSTGRES_BACKUP_STORAGE}:/backup/ -- ${POSTGRES_CREATE_TABLE}:/docker-entrypoint-initdb.d/createTable.sql:ro -- ${POSTGRES_CRON}:/usr/local/bin/arlas/pg_backup_rotated.sh:ro -- ${POSTGRES_STORAGE}:/var/lib/postgresql/data + +- `${POSTGRES_BACKUP_STORAGE}:/backup/` +- `${POSTGRES_CREATE_TABLE}:/docker-entrypoint-initdb.d/createTable.sql:ro` +- `${POSTGRES_CRON}:/usr/local/bin/arlas/pg_backup_rotated.sh:ro` +- `${POSTGRES_STORAGE}:/var/lib/postgresql/data` diff --git a/docker_compose_services_simple.md b/docs/docs/dc_services/docker_compose_services_simple.md similarity index 95% rename from docker_compose_services_simple.md rename to docs/docs/dc_services/docker_compose_services_simple.md index 7b580bf..a60337a 100644 --- a/docker_compose_services_simple.md +++ b/docs/docs/dc_services/docker_compose_services_simple.md @@ -26,7 +26,8 @@ Image: `ELASTIC_VERSION` with `docker.elastic.co/elasticsearch/elasticsearch:8.9 | `tracing.apm.enabled` | `false` | `` | | | List of volumes: -- ${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data + +- `${ELASTIC_STORAGE:-arlas-data-es}:/usr/share/elasticsearch/data` ## File dc/ref-dc-arlas-server.yaml ### Service arlas-server Description: ARLAS Server is the geo-analytic engine of the ARLAS Exploration Stack @@ -61,6 +62,7 @@ Image: `ARLAS_SERVER_VERSION` with `gisaia/arlas-server:26.0.6` in `conf/version | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `ARLAS_AUTH_KEYCLOAK_RESOURCE` | `` | | | | `ARLAS_AUTH_KEYCLOAK_SECRET` | `ARLAS_AUTH_KEYCLOAK_SECRET` | `` | | | | `ARLAS_AUTH_KEYCLOAK_URL` | `ARLAS_AUTH_KEYCLOAK_URL` | `` | | | + ## File dc/ref-dc-arlas-persistence-server.yaml ### Service arlas-persistence-server Description: ARLAS Persistence is a service for storing and retrieving small ojects, such as JSON documents or image previews. @@ -96,7 +98,8 @@ Image: `ARLAS_PERSISTENCE_VERSION` with `gisaia/arlas-persistence-server:26.0.0` | `JDK_JAVA_OPTIONS` | `ARLAS_PERSISTENCE_JDK_JAVA_OPTIONS` | `` | | | List of volumes: -- ${ARLAS_PERSISTENCE_STORAGE}:/persist/ + +- `${ARLAS_PERSISTENCE_STORAGE}:/persist/` ## File dc/ref-dc-arlas-permissions-server.yaml ### Service arlas-permissions-server Description: ARLAS Permissions is a service for listing user's permissions @@ -125,11 +128,12 @@ Image: `ARLAS_PERMISSIONS_VERSION` with `gisaia/arlas-permissions-server:26.0.0` | `ELASTIC_APM_TRANSACTION_IGNORE_USER_AGENTS` | `GoogleHC/*, kube-probe/*, curl*, GoogleStackdriver ...` | `` | | | | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `ELASTIC_APM_USE_JAXRS_PATH_AS_TRANSACTION_NAME` | `true` | | | | `JDK_JAVA_OPTIONS` | `ARLAS_PERMISSIONS_JDK_JAVA_OPTIONS` | `` | | empty value in `conf/permissions.env` | + ## File dc/ref-dc-arlas-builder.yaml ### Service arlas-builder Description: ARLAS Builder is the interface for elaborating ARLAS Dashboards. -Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/versions.env` +Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -161,15 +165,16 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.0.5` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-hub.yaml ### Service arlas-hub Description: ARLAS Hub is the interface for discovering all the available ARLAS Dashboards -Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions.env` +Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.1.0` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -200,11 +205,12 @@ Image: `ARLAS_HUB_VERSION` with `gisaia/arlas-wui-hub:26.0.3` in `conf/versions. | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | | | `ARLAS_STATIC_LINKS` | `ARLAS_HUB_LINKS` | `` | | `'` in `conf/arlas.env` | + ## File dc/ref-dc-arlas-wui.yaml ### Service arlas-wui Description: ARLAS WUI is ARLAS Web interface for visualising an analytic ARLAS Dashboard. -Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in `conf/versions.env` +Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-no-analytics` in `conf/versions.env` | Container variable | Value or environment variable | Default | Description | Env file setting | | --- | --- | --- | --- | --- | @@ -250,17 +256,19 @@ Image: `ARLAS_WUI_VERSION` with `gisaia/arlas-wui:26.1.0-rc.2-no-analytics` in ` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `ARLAS_ENRICH_PROCESS_STATUS_URL` | `` | | `/aproc/jobs` in `conf/arlas.env` | List of volumes: -- ${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles -- ${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs -- ${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook -- ${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles + +- `${PWD}/conf/protomaps/styles:/usr/share/nginx/html/assets/basemap/styles` +- `${PWD}/conf/protomaps/glyphs:/usr/share/nginx/html/assets/basemap/glyphs` +- `${PWD}/conf/protomaps/quicklook:/usr/share/nginx/html/assets/basemap/quicklook` +- `${PWD}/conf/protomaps/world.pmtiles:/usr/share/nginx/html/assets/basemap/world.pmtiles` ## File dc/ref-dc-protomaps.yaml ### Service protomaps Image: `PROTOMAP_VERSION` with `protomaps/go-pmtiles:v1.19.0` in `conf/versions.env` List of volumes: -- ${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro + +- `${PWD}/conf/protomaps/world.pmtiles:/protomaps/basemaps/world.pmtiles:ro` ## File dc/ref-dc-apisix.yaml ### Service apisix Description: APISIX is ARLAS Stack gateway. It handles all the incoming trafic. @@ -272,4 +280,5 @@ Image: `APISIX_VERSION` with `apache/apisix:3.9.1-debian` in `conf/versions.env` | `APISIX_STAND_ALONE` | `APISIX_STAND_ALONE` | `true` | | `true` in `conf/apisix.env` | List of volumes: -- ${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro + +- `${APISIX_CONF_FILE}:/usr/local/apisix/conf/apisix.yaml:ro` diff --git a/scripts/generate_dc_doc.py b/scripts/generate_dc_doc.py index 30e9546..977175e 100644 --- a/scripts/generate_dc_doc.py +++ b/scripts/generate_dc_doc.py @@ -109,19 +109,22 @@ def generate(yaml_files: list[str], env_files: list[str]): description = description + " " + c.value.lstrip('#').lstrip(' ').rstrip() variable = truncate(variable) print("| `{}` | `{}` | `{}` | {} | {} |".format(escape(k), escape(variable), escape(default), escape(description), escape(env_settings))) + print() volumes = services.get(service).get("volumes", None) if volumes: - print() - print("List of volumes:") + print("List of volumes:\n") for volume in volumes: - print("- " + volume) + print(f"- `{volume}`") -yaml_files: list[str] = [] -env_files: list[str] = [] -for f in sys.argv[1:]: - if Path(f).suffix == ".env": - env_files.append(f) - if Path(f).suffix == ".yaml": - yaml_files.append(f) -generate(yaml_files, env_files) +if __name__ == '__main__': + + yaml_files: list[str] = [] + env_files: list[str] = [] + for f in sys.argv[1:]: + if Path(f).suffix == ".env": + env_files.append(f) + if Path(f).suffix == ".yaml": + yaml_files.append(f) + + generate(yaml_files, env_files) From 16e3868e5d2b93bdb56e9c8842a103f96d47e4c2 Mon Sep 17 00:00:00 2001 From: Willi Date: Mon, 16 Dec 2024 16:02:26 +0100 Subject: [PATCH 3/5] Add link to github project --- docs/docs/arlas_exploration_stack.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs/arlas_exploration_stack.md b/docs/docs/arlas_exploration_stack.md index 7674aed..f881bc0 100644 --- a/docs/docs/arlas_exploration_stack.md +++ b/docs/docs/arlas_exploration_stack.md @@ -1,6 +1,6 @@ # ARLAS Exploration Stack -This projects contains reference docker compose files for all the ARLAS microservices and third party services for running the ARLAS Stack. It also contains the script for starting the stack in different modes: +The [ARLAS Exploration Stack](https://github.com/gisaia/ARLAS-Exploration-stack) project contains reference docker compose files for all the ARLAS microservices and third party services for running the ARLAS Stack. It also contains the script for starting the stack in different modes: - [Simple](#simple-deployment): ARLAS without authentication, on HTTP - [IAM](#iam-deployment): With ARLAS Identity and Access Management (ARLAS IAM), on HTTPS @@ -8,6 +8,8 @@ This projects contains reference docker compose files for all the ARLAS microser ## Run ARLAS stack +To run ARLAS stack, clone the [ARLAS Exploration Stack](https://github.com/gisaia/ARLAS-Exploration-stack) project and follow the guidelines. + ### Simple deployment The simple deployment has: From 9f2707edc756cdbf3c1bfde713271768e05c011a Mon Sep 17 00:00:00 2001 From: Willi Date: Tue, 17 Dec 2024 15:31:05 +0100 Subject: [PATCH 4/5] Remove local urls --- docs/docs/dc_services/docker_compose_services_aias.md | 2 +- docs/docs/dc_services/docker_compose_services_iam.md | 2 +- docs/docs/dc_services/docker_compose_services_simple.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/dc_services/docker_compose_services_aias.md b/docs/docs/dc_services/docker_compose_services_aias.md index 8380e31..c5155b9 100644 --- a/docs/docs/dc_services/docker_compose_services_aias.md +++ b/docs/docs/dc_services/docker_compose_services_aias.md @@ -231,7 +231,7 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env`
`https://${ARLAS_HOST}/persist` in `conf/arlas_iam.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | diff --git a/docs/docs/dc_services/docker_compose_services_iam.md b/docs/docs/dc_services/docker_compose_services_iam.md index 6a886bc..3a06907 100644 --- a/docs/docs/dc_services/docker_compose_services_iam.md +++ b/docs/docs/dc_services/docker_compose_services_iam.md @@ -222,7 +222,7 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env`
`https://${ARLAS_HOST}/persist` in `conf/arlas_iam.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | `https://${ARLAS_HOST}/arlas` in `conf/arlas_iam.env` | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | `true` in `conf/arlas_iam.env` | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | `https://${ARLAS_HOST}/wui/` in `conf/arlas_iam.env` | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | diff --git a/docs/docs/dc_services/docker_compose_services_simple.md b/docs/docs/dc_services/docker_compose_services_simple.md index a60337a..59bc2e3 100644 --- a/docs/docs/dc_services/docker_compose_services_simple.md +++ b/docs/docs/dc_services/docker_compose_services_simple.md @@ -165,7 +165,7 @@ Image: `ARLAS_BUILDER_VERSION` with `gisaia/arlas-wui-builder:26.1.0` in `conf/v | `ARLAS_IAM_SERVER_URL` | `ARLAS_IAM_SERVER_URL` | `/arlas_iam_server` | | | | `ARLAS_PERMISSIONS_URL` | `ARLAS_PERMISSIONS_URL` | `/arlas_permissions_server` | | | | `ARLAS_PERSISTENCE_URL` | `ARLAS_PERSISTENCE_URL` | `/arlas_persistence_server` | | `/persist` in `conf/persistence-file.env` | -| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `http://localhost/arlas` | ARLAS Server url | | +| `ARLAS_SERVER_URL` | `ARLAS_SERVER_URL` | `/arlas` | | | | `ARLAS_USE_AUTHENT` | `ARLAS_USE_AUTHENT` | `` | | | | `ARLAS_WUI_URL` | `ARLAS_WUI_URL` | `/wui/` | | | | `ARLAS_STATIC_LINKS` | `ARLAS_BUILDER_LINKS` | `` | | `'` in `conf/arlas.env` | From 87e62c504da801119db5dbb110fdc2af0fbd83c2 Mon Sep 17 00:00:00 2001 From: Willi Date: Tue, 17 Dec 2024 16:45:19 +0100 Subject: [PATCH 5/5] Add pip3.10 instead of pip to install ruamel.yaml --- mkDocs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkDocs.sh b/mkDocs.sh index 8189d3f..67b8dad 100755 --- a/mkDocs.sh +++ b/mkDocs.sh @@ -1,7 +1,7 @@ #!/bin/sh -e # Generate documentation -pip install ruamel.yaml +pip3.10 install ruamel.yaml mkdir -p docs/docs/dc_services python3.10 scripts/generate_dc_doc.py \