fix backups, explain backup usage better in values-local.yaml.example

templates/statefulset.yaml

@@ -168,6 +168,9 @@ spec:
               mountPath: /var/local/ssh-private-key
             - name: ssh-known-hosts
               mountPath: /etc/ssh/ssh_known_hosts
+              # We need to set subPath so it does not create an ssh_known_hosts
+              # directory with an ssh_known_hosts file in it
+              subPath: ssh_known_hosts
             {{- end }}
         {{- end }}
     {{- with .Values.nodeSelector }}

values-local.yaml.example

@@ -130,8 +130,12 @@ redis:
 
 
 
-# This will add a cronjob that performs a daily backup of the wordpress
+# This will add a cronjob that performs backups of the wordpress
 # database, copying an sql file created by `wp db export` to the given target.
+#
+# The backups are saved as yyyy-mm-dd and as such if you do several backups per
+# day, previous backups of the same day will be overwritten. There is no cleanup
+# of backups: it is assumed that cleanup is done on the target server.
 # backup:
 #   enabled: true
 #   # The target location of the backup. This can be a local directory (not
@@ -143,10 +147,14 @@ redis:
 #     -----BEGIN OPENSSH PRIVATE KEY-----
 #     ...
 #     -----END OPENSSH PRIVATE KEY-----
-#   # Mounted to /etc/ssh/ssh_known_hosts. Required when `sshPrivateKey` is
-#   # provided, ignored otherwise
+#   # This string is mounted as a text file to /etc/ssh/ssh_known_hosts.
+#   # Required when `sshPrivateKey` is provided. Required for SSH host key
+#   # verification. If this is ill-configured, expect a host key verification
+#   # error in the logs of the wordpress-backup container.
+#   # Read the SSH documentation for the correct contents of the ssh_known_hosts
+#   # file. You can use `ssh-keyscan` on a trusted network to find host keys.
 #   sshKnownHosts: |
-#     hostname keytype key
+#     <hostname> <keytype> <key>
 #   # The interval at which backups occur. Defaults to 86400 seconds (24 hours)
 #   intervalSeconds:
 # It's advisable to set resource limits to prevent your K8s cluster from