The documentation How to Create a Schedule is filed under "How-to"s but it is not a how-to. It is lacking several crucial steps which aren't even hinted at.
It lacks the creation of an S3 bucket
It lacks the creation of a secret holding the credentials of the S3 bucket
It lacks the creation of a secret holding the encryption key
It lacks the adjustment required to make the schedule.yaml work on the reader's setup
In fact the paragraph
Save the YAML above in a file named schedule.yaml and use the kubectl apply -f schedule.yaml command to deploy this configuration to your cluster.
makes it sound like the described configuration should work out-of-the-box which is absolutely not the case.
Additional Context
No response
Logs
No response
Expected Behavior
A "How-to" should include all necessary steps and prerequisites to make something work. It doesn't necessarily have to explain them all in detail (e.g. it doesn't necessarily have to explain how the yaml for a secret looks) but it should still list everything that needs to be done.
In this particular case the page the list of instructions should include:
Installing k8up (as a pre-requisite)
Creating an S3 bucket
Putting credentials for the S3 bucket into a secret
Creating a secret for the encryption key
Making sure the secretRefs in the schedule yaml reference the secrets correctly
Installing the secret yaml
It would also be fair to just leave it as an exercise to the reader to figure all of this out, but then don't call it "How-to".
Description
The documentation How to Create a Schedule is filed under "How-to"s but it is not a how-to. It is lacking several crucial steps which aren't even hinted at.
In fact the paragraph
Save the YAML above in a file named schedule.yaml and use the kubectl apply -f schedule.yaml command to deploy this configuration to your cluster.makes it sound like the described configuration should work out-of-the-box which is absolutely not the case.Additional Context
No response
Logs
No response
Expected Behavior
A "How-to" should include all necessary steps and prerequisites to make something work. It doesn't necessarily have to explain them all in detail (e.g. it doesn't necessarily have to explain how the yaml for a secret looks) but it should still list everything that needs to be done.
In this particular case the page the list of instructions should include:
It would also be fair to just leave it as an exercise to the reader to figure all of this out, but then don't call it "How-to".
Steps To Reproduce
No response
Version of K8up
irrelevant
Version of Kubernetes
irrelevant
Distribution of Kubernetes
irrelevant