Files
dokku/docs/appendices/0.31.0-migration-guide.md
Jose Diaz-Gonzalez f842869c3d refactor: move the proxy port map from config to property
Also remove all direct references to DOKKU_PROXY_PORT_MAP from outside of ports.
2023-08-05 10:58:57 -04:00

2.8 KiB

0.31.0 Migration Guide

Changes

  • Herokuish build cache is now mounted from a docker volume - eg. cache-node-js-app - instead of the local filesystem. All existing app cache will be cleared upon upgrading past 0.29.0.
  • The vector container integration now mounts config to /etc/vector instead of the path /etc/vector/vector.json, allowing users the ability to provide extra configuration for Vector Sinks. To take advantage of the new functionality, the vector container should be stopped (via dokku logs:vector-stop) and then started (via dokku logs:vector-start).
  • The traefik integration now mounts config to /data instead of the path /acme.json, fixing permissions issues under certain architectures. To take advantage of the new functionality, the traefik container should be stopped (via dokku traefik:stop) and then started (via dokku traefik:start).
  • Users no longer need to clear the source-image git property when transitioning from image-based deploys (git:from-image and git:load-image) to other deployment methods (git push, git:from-archive, git:sync).
  • For deploys via the git:from-image and git:load-image commands, the CHECKS file is now extracted from the configured WORKDIR property of the image. For all other deploys - git push, git:from-archive, git:sync - will have the CHECKS extracted directly from the source code. The filename in both cases is CHECKS and cannot be modified.
  • The environment variable DOKKU_PROXY_PORT_MAP has been migrated to the properties system. Direct changes to the value will be ignored, and users should interact with port maps via the ports plugin.

Deprecations

  • The proxy:ports* commands have been replaced with the new ports plugin. Users will be able to use the old proxy:ports* commands for a single minor release, and they will be removed in the next minor release.
  • The common#get_app_raw_tcp_ports() function has been deprecated and will be removed in the next release. Users should avoid interacting with this function for dockerfile ports and instead use the ports-get plugin trigger for fetching ports for an app.
  • The common#get_available_port() function has been deprecated and will be removed in the next release. Users should avoid interacting with this function and instead use the ports-get-available plugin trigger for fetching an available port.
  • The proxy-configure-ports plugin trigger has been deprecated and will be removed in the next release. Users should instead trigger the ports-configure plugin trigger.

Un-Deprecations

  • The bare apps and config cli aliases are no longer deprecated. This better follows Heroku's output and is more useful to users. The subcommands will be treated as the primary, documented versions, while the aliases are there for convenience.