Upgrading Package Security Manager
This guide walks you through the process of upgrading your Package Security Manager installation to a newer version. Package Security Manager supports in-place upgrades, meaning you can upgrade while the software is running.
Upgrade process
Verify system requirements
Ensure your environment meets the new version’s system requirements.
If upgrading your OS to RHEL 9, you must first switch from Docker to Podman.
Create backups
Create backups of the docker-compose.yml
and .env
files:
These contain your custom configurations and will be overwritten during the upgrade!
-
Open a terminal.
-
Log in to the server that hosts your Package Security Manager installation.
-
Navigate to your Anaconda installer directory (
ate-installer-*
) by running the following command:Type “ate-installer-”, then press Tab to autocomplete the directory name.
-
Create backups of your configuration files by running the following commands:
Verify service account permissions
If you are using Package Security Manager 6.1.6 or later, you can skip this step.
You must verify the correct permissions are set for the service account to prevent users from losing their assigned permissions:
- Log in to your Keycloak admin panel at
https://<YOUR_DOMAIN>/auth/admin
. - Navigate to Clients and select repo-account-sync.
- Select the Service Account Roles tab.
- Open the Client Roles dropdown and select realm-management.
- Add
manage-users
andmanage-realm
to the Assigned Roles.
Download the installer
Download the installer using the URL provided by Anaconda:
Run the upgrade
Choose the appropriate command based on your setup:
If your setup uses HTTPS protocol, you’ll need to provide the TLS certificate and key in your installation command:
If your current version of Package Security Manager is utilizing Grafana, you must include the following argument in your upgrade. If you do not, you will lose access to your Grafana dashboards. Upgrading removes your previous version of Grafana.
Don’t forget to log in and update your password for your Grafana monitoring dashboards!
If you’re upgrading with Podman and you encounter an error similar to the following:
You can safely remove the existing containers and create new ones by running the following command from inside your ate-installer-*
directory:
If your setup uses HTTPS protocol, you’ll need to provide the TLS certificate and key in your installation command:
If your current version of Package Security Manager is utilizing Grafana, you must include the following argument in your upgrade. If you do not, you will lose access to your Grafana dashboards. Upgrading removes your previous version of Grafana.
Don’t forget to log in and update your password for your Grafana monitoring dashboards!
If you’re upgrading with Podman and you encounter an error similar to the following:
You can safely remove the existing containers and create new ones by running the following command from inside your ate-installer-*
directory:
If your current version of Package Security Manager is utilizing Grafana, you must include the following argument in your upgrade. If you do not, you will lose access to your Grafana dashboards. Upgrading removes your previous version of Grafana.
Don’t forget to log in and update your password for your Grafana monitoring dashboards!
If you’re upgrading with Podman and you encounter an error similar to the following:
You can safely remove the existing containers and create new ones by running the following command from inside your ate-installer-*
directory:
Once the upgrade is complete, run the following command to instruct Keycloak to allow HTTP traffic:
If your upgrade fails at this point, it is likely due to a permissions issue with your Redis cache. To complete the upgrade, reset permissions for your Redis cache and restart your containers by running the following commands:
Reapply configurations
If necessary, review the docker-compose.yml.backup
and .env.backup
files you created when you began the upgrade process, reapply your custom configurations to your new installations configuration files, and verify that your repo.conf
(nginx configuration) file also reflects the upgraded changes.
Additional considerations
- For upgrades to Package Security Manager
6.6.2
or later, see Upgrading Postgres. - To support artifacts larger than 3GB, see Increasing artifact upload size limit.