diff --git a/docs/upgrading.rst b/docs/upgrading.rst index b91c4e82c4a51852324b3cff8de26cc96c2b3e62..26d2da8c0283d68bc10997286d1540d7fcf6f61b 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -12,6 +12,18 @@ that run during installation to manage secrets. Because we have removed the generated. **It is important that you back up these secrets before switching from ``v0.6`` to ``v0.7``!** +Before you start, please ensure that you have the right ``yq`` tool installed, +because you will need it later. There are two very different versions of +``yq``. The one you need is the go based [yq from Mike +Farah](http://mikefarah.github.io/yq/), which installs the same binary name ``yq`` +as the [python-yq](https://github.com/kislyuk/yq), while both have different +command sets. + +The yq needed here can be installed by running ``sudo snap install yq``, +``brew install yq`` or with other methods from the [``yq`` installation +instructions](http://mikefarah.github.io/yq/#install). + + To back-up your secrets, run the following script: .. code:: bash @@ -45,6 +57,8 @@ lines under "data:", rename the field to ``wekan_oauth_client_secret`` and enter a different random password. Make sure to base64 encode it (``echo "<your random password>" | base64``). +If you get the error several times, that means ther + This script creates a directory called ``secrets-backup`` and places the secrets that have been generated by Helm in it as ``yaml`` files. @@ -64,7 +78,7 @@ the following code: #!/usr/bin/env bash - # Uses https://github.com/mikefarah/yq -- install with `snap install yq` + # Again: make sure you use https://github.com/mikefarah/yq -- install with `snap install yq` yq eval 'del(.metadata.annotations,.metadata.labels,.metadata.creationTimestamp,.metadata.resourceVersion,.metadata.uid)' secrets-backup/oas-cluster-variables.yaml | kubectl apply -f - -n flux-system yq eval 'del(.metadata.annotations,.metadata.labels,.metadata.creationTimestamp,.metadata.resourceVersion,.metadata.uid)' secrets-backup/oas-wordpress-variables.yaml | kubectl apply -f - -n flux-system yq eval 'del(.metadata.annotations,.metadata.labels,.metadata.creationTimestamp,.metadata.resourceVersion,.metadata.uid)' secrets-backup/oas-wekan-variables.yaml | kubectl apply -f - -n flux-system