From 11901f662bfdffac773b81efc0a82be39026069b Mon Sep 17 00:00:00 2001 From: Amandus Butzer Date: Wed, 20 Mar 2024 14:49:41 +0100 Subject: [PATCH 1/2] build(docker): add migration info to output Co-authored-by: jhaeu --- docker-entrypoint.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh index f74fb5397b..127ea8c236 100755 --- a/docker-entrypoint.sh +++ b/docker-entrypoint.sh @@ -336,12 +336,12 @@ success "CATALINA_OPTS and JAVA_OPTS ready. For details set CONTAINER_LOG_LEVEL= # Print the migration info if print_migration_info is set to true but not if PRINT_MIGRATION_INFO is set to False if [ "${print_migration_info}" = "true" ]; then info "##########################################" - info "# Config migration and usage information #" + info "# Config options and migration information #" info "##########################################" info ">>> Migration information <<<" - info "Find detailed information for migrating to ORS version 8 at: "# TODO - info ">>> Config migration <<<" - info "Configuring ors with a .json config is deprecated and will be removed in the future." + warning "Configuring ors with a .json config is deprecated and will be removed in the future." + info "You can use the ors-config-migration tool to migrate your .json config to .yml: https://github.com/GIScience/ors-config-migration#usage" + info ">>> Config options <<<" info "You have the following options to configure ORS:" info "Method 1 yml config:" info "> docker cp ors-container-name:${ORS_HOME}/config/example-ors-config.yml ./ors-config.yml" From 3d0698e170b3cc2bab9dc475215ce673fd15ac92 Mon Sep 17 00:00:00 2001 From: Amandus Butzer Date: Wed, 20 Mar 2024 14:50:18 +0100 Subject: [PATCH 2/2] docs: link to migration tool usage docs - remove unused page --- docs/run-instance/configuration/index.md | 2 +- docs/run-instance/configuration/json.md | 4 ++-- docs/run-instance/configuration/migrate-from-json.md | 3 --- 3 files changed, 3 insertions(+), 6 deletions(-) delete mode 100644 docs/run-instance/configuration/migrate-from-json.md diff --git a/docs/run-instance/configuration/index.md b/docs/run-instance/configuration/index.md index 9000aa21b2..9e2395442f 100644 --- a/docs/run-instance/configuration/index.md +++ b/docs/run-instance/configuration/index.md @@ -37,7 +37,7 @@ Which format to use in which scenario is documented in the config documentations * `.yml` is the default configuration format since version 8. You can find an [example configuration file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.yml) with all available configuration options. Only a minimal set of properties is active, all others are commented out. * `.env` files for Docker setup. There is also an [example env file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.env) that you can download and customize. -* `.json` config file: In the past openrouteservice was configured [via JSON file](json.md). This configuration method has been **deprecated** and will be eventually removed. Therefore, we strongly discourage you from using it. If you have an old JSON config, please consider to [migrate to the new config](migrate-from-json.md). +* `.json` config file: In the past openrouteservice was configured [via JSON file](json.md). This configuration method has been **deprecated** and will be eventually removed. Therefore, we strongly discourage you from using it. If you have an old JSON config, please consider to [migrate to the new config](https://github.com/GIScience/ors-config-migration#usage). All of the above described config files can contain the same logic application properties. diff --git a/docs/run-instance/configuration/json.md b/docs/run-instance/configuration/json.md index 929705b1c3..e9cb2a578f 100644 --- a/docs/run-instance/configuration/json.md +++ b/docs/run-instance/configuration/json.md @@ -1,13 +1,13 @@ # Configuration via `ors-config.json` :::warning -The ors-config.json is deprecated! +The ors-config.json is deprecated! [Migrate to ors-config.yml](https://github.com/GIScience/ors-config-migration#usage). ::: The "old" configuration method is supported for a while for convenience. The description below is kept as long as openrouteservice still supports configuration via JSON file, but we do **not** recommend using this configuration method. -Please consider to [migrate JSON configuration](migrate-from-json.md) to the new style. +Please consider [migrating your JSON configuration](https://github.com/GIScience/ors-config-migration#usage) to the new style. Note that currently all settings in a provided JSON configuration file will **override** any settings in the YAML file. ## ors diff --git a/docs/run-instance/configuration/migrate-from-json.md b/docs/run-instance/configuration/migrate-from-json.md deleted file mode 100644 index b29c7a7b2d..0000000000 --- a/docs/run-instance/configuration/migrate-from-json.md +++ /dev/null @@ -1,3 +0,0 @@ -# Migrate JSON Config to New Style - -[//]: # (TODO write) \ No newline at end of file