From ce8f42eb79c0d346a98bfc727e45048bc88cc2d8 Mon Sep 17 00:00:00 2001 From: Julien Dessaux Date: Thu, 1 May 2025 09:09:16 +0200 Subject: [PATCH] feat(admin): add Upgrading --- Upgrading.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 Upgrading.md diff --git a/Upgrading.md b/Upgrading.md new file mode 100644 index 0000000..faed8cb --- /dev/null +++ b/Upgrading.md @@ -0,0 +1,30 @@ +# Upgrading + +## Preparing for an upgrade + +Administrators should [backup](./Backup) and thoroughly read the [release +notes](https://git.adyxax.org/adyxax/tfstated/releases) for each version before +upgrading. It is also recommended to shutdown TfStated prior to the attempt to +ensure no operations will be written to the database after the backup. + +Only upgrades from one feature release to the next in one of the deployment +options listed in this guide will be tested! + +Skipping feature releases might or might not work: use your best judgement based +on the contents of the release notes. Making a backup is an absolute requirement +if you intend to skip a feature release, as is completely shutting down TfStated +before the attempt. + +Another option is to [hire me](mailto:julien.dessaux@adyxax.org) to help perform +your upgrades. + +## Perform the upgrade + +Follow the following steps one by one to perform the upgrade: + +- Download or build the latest release binary or container image. +- Shutdown TfStated. +- Backup TfStated's database. +- Start TfStated's new binary or container image. +- Verify TfStated works: log in, browse the webui for a moment, run an + OpenTofu/Terraform plan. Check your logs for any error messages.