Upgrading Ory Hydra OEL
This document provides a comprehensive guide on how to upgrade your Ory Hydra Enterprise License (OEL) version. Upgrading to the latest version ensures you have the newest features, security updates, and performance improvements.
Prerequisites
Before proceeding with the upgrade, ensure you have:
- A valid Ory Enterprise License.
- Access to the Ory Enterprise Docker Registry.
- Backup of your current data and configuration.
Pick the right version
To upgrade Ory Hydra OEL, you need to know the version you are currently running. Check your Docker or Kubernetes environment to find the tag. You should find your tag in this list:
| Image Tag | Release Date |
|---|---|
| 897e224960bb8677edf3344bd51c9edd779e9da7 | 2024-06-05 |
| f2ead7db68e8af72dbd1ab099fbaa6bf0f0ec8c3 | 2024-06-12 |
| 39bbe4e0d99d40d5c4feb97321fc68b20f02a7ae | 2024-06-14 |
| f066fc62fc37ee1d28b4f2973faaa2bc098fc952 | 2024-06-18 |
| f832e165e187e49657229902c13ad30c4cf10d0b | 2024-06-20 |
| 1578667fa246c374ca85c5eadbf49cc53a296775 | 2024-06-26 |
| 73a77968be31cbcba18b02918a8c11343a1fa038 | 2024-07-04 |
| 470aebc3ab2d4c225ca14ab8b1a12809f51b7eb3 | 2024-07-18 |
| 0fd87c560867f19ab12276edf258e42c4688454a | 2024-07-24 |
| 04858989138f4b09c2b9b9676e3641326d96b1a6 | 2024-08-02 |
| 1f407d0b2035e50812e6888a71b772530d17fc7a | 2024-08-12 |
| 9b96c2507f9f17f639f73c2a9284f32bf63cd9d8 | 2024-08-27 |
| bf4441cc6dc1f8e8387173ae8f1396395dc1f433 | 2024-08-30 |
| ce413707a03c4551b3f0bbe2e1e9c929a7e0b025 | 2024-09-05 |
| 20b15ef54f30d3d43a5d04bcdb7fd1d1f3fa2832 | 2024-09-10 |
| c35bfb780da7ddacba23f31b5e1634fa155af9c9 | 2024-09-19 |
| 52ebf819f5538176c7ac1c4afc953123e8f0d3bf | 2024-09-24 |
| e2439391378f3abd513fb13847bc6a1b5f0157f1 | 2024-09-26 |
| 75ade08cd441f43f7771ed4f11417a30ff0b31ac | 2024-09-27 |
| a22eff120ff38ee4596ed3afddb4ca4307b1adbb | 2024-10-07 |
| 14f390f978b2ebcdc8e181ac04f9978a397e21d2 | 2024-10-11 |
| 83f53137a823ee0ace7e2ae94e7823caa036b800 | 2024-10-17 |
| 69efdbbb45f642b5b142426a03a255f39e276689 | 2024-11-05 |
| f5eb2f3ae6c3ece3e00dc68c5e8743de7e9f1117 | 2024-11-05 |
| 94d6dfba9d81c00ff03ad61a0005e93a974a03f7 | 2024-11-12 |
Zero-downtime migrations are only possible if you do not skip any version when upgrading.
The tags are ordered by date. To upgrade, you need to pick the next version in the list.
Upgrade Using Helm Charts in Kubernetes
Upgrading Ory Hydra OEL in Kubernetes is straightforward when using Ory's Helm Charts. Follow these steps to upgrade Ory Hydra OEL:
1. Enable auto SQL migration
Set hydra.automigration.enabled to true in the values.yaml file:
image:
# ....
# ...
hydra:
automigration:
enabled: true
# ...
2. Update the image tag
image:
repository: europe-docker.pkg.dev/ory-artifacts/ory-enterprise/hydra-oel
tag: <replace-with-current-image-tag>
# ...
3. Apply / install the helm chart
You can now apply the upgrade:
helm upgrade ory-oel-hydra ory/hydra --namespace ory -f values.yaml
4. Wait for the upgrade to propagate
Once the init container is done and the main container is running, the upgrade is complete.
Upgrade steps without Helm Charts
1. Check Release Notes
Before upgrading, review the changelog for the new version to understand the changes, new features, and any deprecations.
2. Backup Your Data
Ensure you have a complete backup of your database and configuration files. This step is crucial for restoring your system in case of an upgrade failure.
3. Pull the Latest Docker Image
Pull the latest Ory Hydra OEL Docker image from the Ory Enterprise Docker Registry:
docker pull europe-docker.pkg.dev/ory-artifacts/ory-enterprise/hydra-oel:<new-version-tag>
5. Apply SQL Migrations
Before deploying the service, you need to apply SQL migrations:
docker run \
-e DSN=your_database_connection_string \
europe-docker.pkg.dev/ory-artifacts/ory-enterprise/hydra-oel:<new-version-tag> \
-- migrate sql -e -f /path/to/config.yaml
Replace your_database_connection_string with your actual database connection string.
5. Stop the Service
Once done, you can stop the processes running the old service.
6. Start the Service
Now you will be able to start the service:
docker run \
-p 4444:4444 -p 4445:4445 \
-e DSN=your_database_connection_string \
europe-docker.pkg.dev/ory-artifacts/ory-enterprise/hydra-oel:<new-version-tag> \
-- serve all -f /path/to/config.yaml
Replace your_database_connection_string with your actual database connection string.
Conclusion
Upgrading Ory Hydra OEL is essential to keep your system secure and up-to-date. By following the steps outlined in this guide, you can ensure a smooth upgrade process with minimal downtime.
If you encounter any issues during the upgrade process, please reach out to the Ory support team for assistance.