Upgrade SaltStack Config to the latest stable version from a previous version.
As part of VMware’s initiative to remove problematic terminology, the term Salt master will be replaced with a better term in SaltStack Config and related products and documentation. This terminology update may take a few release cycles before it is fully complete.
- Back up your data, including certain files and directories that are crucial to your specific installation of SaltStack Config
- Upgrade PostgreSQL (optional, but recommended)
- Upgrade your Salt infrastructure (optional, but recommended)
- Download the upgrade files
- Upgrade the RaaS node
- Upgrade any Salt masters using the Master Plugin
Best practices when upgrading
Follow these guidelines while planning your upgrade:
- Do not upgrade using the installer or manual installation instructions.If you are upgrading your SaltStack Config installation, refer to the following upgrade instructions.
- For best results, increment from one major release to the next. As a best practice, always upgrade from the latest major version of SaltStack Config to the new release. If you are on an older release, upgrade incrementally from one release to the next.
- Back up your data. In order to prevent data loss, back up your data. For an explanation of which files and directories must be backed up before upgrading, see Back up your data.
- Perform upgrades during hours of slow network activity. Database upgrades require re-indexing data. Depending on the complexity of your data, a database upgrade could potentially take several hours. To prevent service disruptions, consider upgrading the database during slower business hours or trimming your database prior to an upgrade.
- Check the database for any old commands being stored. In some cases, the PostgreSQL database stores old commands that haven’t run. These commands might run during the upgrade process, when you restart the Master Plugin. To prevent this from happening, check whether any old commands are stored in the database, and enable skipping jobs that are older than a defined time.
- Test the upgrade before deploying. If possible, you could try running a dress rehearsal in a test environment to get a sense of how long the upgrade could take.
- Read through the whole guide first. Consider also reading through this entire guide one time before you implement an upgrade so that you have a good sense of the tasks that are required and whether they require planning from your team or if stakeholders must be notified of pending changes.
Upgrading from older versions
As a best practice, always upgrade from the latest major version of SaltStack Config to the new release. If you are upgrading from a version earlier than the latest release, you might see the best results if you upgrade in increments from one major release to the next.
For instructions on upgrading to earlier SaltStack Config versions, see the specific upgrade instructions for the releases you are upgrading from. The upgrade instructions for previous releases are included in the installation guide PDF for the subsequent release. For example, if you need to upgrade from 5.5 to 6.0, see the upgrade instructions in the 6.0 installation PDF.
For SaltStack Config versions 8.4 and later, use the version selector at the top of this page to select the correct upgrade guide for your product version. For versions 8.3 and older, use the PDF guides in the following table:
| Version | Installation and upgrade guide (PDF) |
|---|---|
| 8.3 | 8.3 Installation and upgrade guide |
| 6.4 | 6.4 Installation and upgrade guide |
| 6.3 | 6.3 Installation and upgrade guide |
| 6.2 | 6.2 Installation and upgrade guide |
| 6.1 | 6.1 Installation and upgrade guide |
| 6.0.1 | 6.0.1 Installation and upgrade guide |
| 6.0 | 6.0 Installation and upgrade guide |
How to upgrade SaltStack Config
To upgrade SaltStack Config, complete the following tasks. These tasks are intended to be followed in a specific order as listed in this guide.
