From 3a983b9d16740c7b3e6fd5d5e50da102d7221a62 Mon Sep 17 00:00:00 2001
From: Maarten de Waard <maarten@greenhost.nl>
Date: Fri, 13 Aug 2021 12:07:41 +0200
Subject: [PATCH] apply suggestions, but differently

---
 docs/upgrading.rst | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/upgrading.rst b/docs/upgrading.rst
index b91c4e82c..26d2da8c0 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
-- 
GitLab