Skip to content

Major upgrades

Major versions can contain incompatible changes. The following sections describe how to upgrade to a new major version.

Upgrading from 2023.2.x to 2023.3.x

Engine

  • The JVM_MAX_RAM_PERCENTAGE environment variable is no longer supported. Use the standard JAVA_TOOL_OPTIONS environment variable to modify Java settings.

    For example, JVM_MAX_RAM_PERCENTAGE=25 would translate to JAVA_TOOL_OPTIONS="-XX:MaxRAMPercentage=25".

  • The FEATURE_MIGRATION_DESCRIPTOR_NAME_BACKWARD_COMPATIBILITY feature flag has been removed. Migration descriptors now must be called migration.yml instead of upshift.yml.
  • The FEATURE_APPLY_NPL_MIGRATIONS_AT_STARTUP feature flag has been removed. If a migration is present in the directory indicated by ENGINE_NPL_MIGRATION_DIRECTORY_PATH it will always be attempted.

  • The FEATURE_CODEGEN_EMPTY_STRUCT_STATIC_OBJECT feature flag has been removed. Empty structs are now always static.

  • The deprecated ADMIN_HOST variable is no longer supported. Use ENGINE_ADMIN_HOST instead.

  • The deprecated ADMIN_PORT variable is no longer supported. Use ENGINE_ADMIN_PORT instead.
  • The deprecated APPLICATION_MANAGEMENT_HOST variable is no longer supported. Use ENGINE_MANAGEMENT_HOST instead.
  • The deprecated APPLICATION_MANAGEMENT_PORT variable is no longer supported. Use ENGINE_MANAGEMENT_PORT instead.
  • The deprecated APPLICATION_MANAGEMENT_ARCHIVESIZELIMIT variable is no longer supported. Use ENGINE_MANAGEMENT_ARCHIVE_SIZE_LIMIT instead.
  • The deprecated POSTGRAPHILE_DB_USER variable is no longer supported. Use ENGINE_DB_POSTGRAPHILE_USER instead.
  • The deprecated POSTGRAPHILE_DB_PASSWORD variable is no longer supported. Use ENGINE_DB_POSTGRAPHILE_PASSWORD instead. It also no longer has a default value. It now has to be set explicitly.
  • The deprecated ENGINE_NPL_MIGRATION_DIRECTORYPATH variable is no longer supported. Use ENGINE_NPL_MIGRATION_DIRECTORY_PATH instead.
  • The deprecated ENGINE_NPL_MIGRATION_RUNONLY variable is no longer supported. Use ENGINE_NPL_MIGRATION_RUN_ONLY instead.
  • The deprecated ENGINE_ACTUATOR_EXPOSE variable is no longer supported. Use ENGINE_SPRING_ACTUATOR_EXPOSE instead.
  • The ENGINE_DB_PASSWORD variable no longer has a default value. It now has to be set explicitly.

History

  • The JVM_MAX_RAM_PERCENTAGE environment variable is no longer supported. Use the standard JAVA_TOOL_OPTIONS environment variable to modify Java settings.
  • The HISTORY_DB_PASSWORD variable no longer has a default value. It now has to be set explicitly.

Postgraphile

  • The DATABASE_URL environment variable is no longer supported. Use POSTGRAPHILE_DB_URL instead.
  • The ENGINE_HEALTH_ENDPOINT environment variable is no longer supported. Use POSTGRAPHILE_ENGINE_HEALTH_ENDPOINT instead.
  • The ENGINE_TIMEOUT_SECONDS environment variable is no longer supported. Use POSTGRAPHILE_ENGINE_HEALTH_TIMEOUT_SECONDS instead.
  • The ISSUER_OVERRIDE environment variable is no longer supported. Use POSTGRAPHILE_ISSUER_OVERRIDE instead.
  • The PORT environment variable is no longer supported. Use POSTGRAPHILE_PORT instead.
  • The SCHEMA environment variable is no longer supported. Use POSTGRAPHILE_DB_SCHEMA instead.
  • The TRUSTED_ISSUERS environment variable is no longer supported. Use POSTGRAPHILE_TRUSTED_ISSUERS instead.

Upgrading from 2023.1.x to 2023.2.x

This upgrade contained no incompatible changes.