Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 5.07 KB

UPGRADE.md

File metadata and controls

62 lines (41 loc) · 5.07 KB

Upgrades

This document highlights breaking changes in releases that will require some migration effort in your project. As we move towards a 1.0.0 release these will be restricted to major upgrades only, but currently, whilst the API is still being fleshed out in the 0.x releases, they may be more frequent.

0.16.x -> 0.17.0

Kubernetes Ingress v1

Cloud Kubernetes providers such as Digitial Ocean will be forcing upgrades of Kubernetes to 1.22 in a few months, and will obsolete, amongst other things, Ingress extensions/v1beta1 and networking.k8s.io/v1beta1 apiVersions.

This release includes an upgrade from extensions/v1beta1 to networking.k8s.io/v1 apiVersion of Ingress resources to handle that.

Care is needed to ensure GitOps cluster deploy tools can handle this, which includes ArgoCD needing to be at least version 1.8, due to a bug in applying networking.k8s.io/v1 Ingresses failing.

MySQL

We are switching back to Docker Inc's official mysql for arm64 computers, as it now supports arm64 on 8.0-oracle tag. This was also done because Oracle's mysql-server repository changed it's image publishing structure to no longer be multi-platform images.

You can switch to any of the previous settings setting:

e.g. to Docker Inc's official mysql 5.7 (with no arm64 support)

attribute('services.mysql.version'): '5.7'
# since it's a multi-platform image of only one platform
attribute('services.mysql.platform'): linux/amd64

0.14.x -> 0.15.0

  • app.services in workspace.yml is deprecated and replaced with services.*.enabled. It will still continue to function until obsoleted
  • .Values.service in helm values is deprecated and replaced with .Values.docker.services.*.enabled. It will still continue to function until obsoleted.
  • _twig/docker-compose.yml/application.yml.twig moved to _twig/docker-compose.yml/service/app.yml.twig, to match the same features as other services, enabled by default

0.13.x -> 0.14.0

  • The default development workflow has now changed from host to app container. Before, the app container was still the default way to run your app, but all ws go ... commands executed on the host by default. These now run in the app container instead.
  • The ws recompile command now does an in-place recompile, rather than rebuilding the whole app container.
  • The .my127ws/harness/scripts/integration/run.sh was renamed to .my127ws/harness/scripts/integration/host-run.sh to reflect that it runs on the host.
  • The .my127ws/harness/scripts/integration/run-one.sh file has been removed, as .my127ws/harness/scripts/integration/host-run.sh can handle both single and full integration suite test execution.

0.12.x -> 0.13.0

  • The Dockerfiles have been restructured to make multi-platform images easier. You may need to restructure your own template overrides if you use a custom Dockerfile or Dockerfile.prod, as they have now been moved, see here.
  • The default Kafka and Zookeeper images have been switched to bitnami/kafka and bitnami/zookeeper, respectively. If you want to continue using the legacy wurstmeister images, you will need to specify this in your kafka.repository and zookeeper.repository attributes.
  • The configuration for Kafka and Zookeeper has moved from kafka and zookeeper attributes to services.kafka and services.zookeeper, respectively.
    • Additionally, the kafka.image and zookeeper.image attributes have been renamed during the move to services.kafka.repository and services.zookeeper.repository, respectively.
    • Similarly, the kafka.version and zookeeper.version attributes have been renamed during the move to services.kafka.tag and services.zookeeper.tag.

0.9.x -> 0.10.0

  • The kafka.host attribute is automatically set to kafka:29092 for your app container, which works with the default Kafka setup. You can remove this attribute from your workspace.yml file.
  • If you have integration test commands, you can probably remove them now in favour of the commands provided by this harness. See the guide on adding integration tests for more info.

0.8.x -> 0.9.0

  • Go version 1.15 is no longer supported, so make sure you are running 1.16+

0.6.x -> 0.7.0

  • If you have a project template override for Dockerfile.twig to execute go install commands after modules are downloaded, you can now remove that in favour of defining steps in the go.modules.after.steps attribute.
  • The image-dependencies.sh file has been removed in favour of defining steps in the go.modules.before.steps attribute.
  • The module_name attribute has been moved to go.module_name. You will need to change this attribute in your workspace.yml prior to updating to the 0.7.0 version of the harness.
  • The ws go commands have been updated to make it clear whether they run on the container or on the host machine. Commands ran on the container now follow the ws go docker... convention.