Red Hat SummitChapter 1. Cryostat migration overview
As a cluster administrator in Red Hat OpenShift, you can upgrade from Cryostat 2.4 to Cryostat 3.0. This guide covers new updates available in the Cryostat 3.0 release, deprecated and unsupported features, and any required application and Operator configuration updates to maintain consistent behavior.
Before you begin the migration process, complete the following steps:
- Review the major Cryostat Operator changes in Cryostat 3.0.
- Review the application configuration changes.
- Review migration recommendations.
1.1. Major Cryostat Operator changes
Red Hat build of Cryostat 3.0 includes major updates to the installation mode of the Cryostat Operator as well as the types of provided APIs.
Installation mode changes
| Red Hat build of Cryostat version | Installation modes |
|---|---|
| 2.4 and earlier |
|
| 3.0 |
|
In Red Hat OpenShift, the Cryostat Operator can now only be installed on a cluster-wide basis (All namespaces on the cluster) rather than into a subset of cluster namespaces. Cluster-wide installation is the preferred mode for the Operator Lifecycle Manager and per-namespace installations are a deprecated feature.
Figure 1.1. Installation modes in Cryostat 3.0
Provided API changes
| Red Hat build of Cryostat version | Provided APIs |
|---|---|
| 2.4 and earlier |
|
| 3.0 |
|
ClusterCryostat and Cryostat APIs have now been unified into a singular Cryostat API. You can use the Cryostat API and its optional Target Namespaces field to create one or more Cryostat instances that correspond to namespaces or groups of namespaces that contain your applications.
Figure 1.2. Provided APIs available in Cryostat 3.0
1.2. Application configuration changes
For applications that are deployed with the Cryostat agent, an updated 0.4.0 version of the agent is available and required for using Red Hat build of Cryostat 3.0. For information about the latest available build version of the Cryostat agent, refer to the Red Hat Maven repository.
In addition to upgrading the agent, some of the agent configuration properties have changed:
| Agent configuration property | Cryostat 2.4 value | Cryostat 3.0 value | Details |
|---|---|---|---|
|
| http://cryostat.mynamespace.mycluster.svc:8181 | http://cryostat.mynamespace.mycluster.svc:4180 | Service port has changed from 8181 to 4180. |
|
| Bearer Base64 token | Bearer raw (plain-text) token | Bearer token no longer needs to be Base64-encoded. |
For more information about agent configuration changes and other new features and enhancements, see the Release notes for the Red Hat build of Cryostat 3.0.
For applications that are using remote JMX connections, Red Hat build of Cryostat does not include any configuration changes.
1.3. Migration recommendations
Before migrating, consider backing up any Cryostat data to ensure that customizations can be restored after upgrading.
This data includes:
- Custom profile templates
- Custom dashboard layouts
- Active and archived recordings
- Custom automated rules
If there are previous SSL certificates and stored credentials configurations, ensure that these are available during migration.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}