Update BRO readme #460
Update BRO readme #460
Conversation
mallardduck
force-pushed
the
readme-enhancements
branch
from
62f18fa to
d6b809e
Compare
README.md
Outdated
|
|
||
| ### Use-Cases | ||
| - Backing up Rancher before Rancher upgrades and restoring after a failed one. | ||
| - Restoring your *Rancher application* to a new cluster in a DR scenario. |
There was a problem hiding this comment.
I don't think you need to highlight this
There was a problem hiding this comment.
And "DR" should prob be spelled out as it's not defined earlier
There was a problem hiding this comment.
Will opt to expand DR and include this item - I know it's a topic that comes up in support world. So mainly defining that here for clarity on that.
There was a problem hiding this comment.
Right, we need to emphasize that it's the Rancher application getting backed up, and not user data
README.md
Outdated
| Our default chart is built for the use-case of backing up and restoring the Rancher application. | ||
| However, under the hood the Backup Restore Operator is rather flexible extension for backup and restore of Kubernetes resources. | ||
|
|
||
| * This operator provides ability to backup and restore Kubernetes applications (metadata) running on any cluster. It accepts a list of resources that need to be backed up for a particular application. It then gathers these resources by querying the Kubernetes API server, packages all the resources to create a tarball file and pushes it to the configured backup storage location. Since it gathers resources by querying the API server, it can back up applications from any type of Kubernetes cluster. |
There was a problem hiding this comment.
"provides the ability"
There was a problem hiding this comment.
I'm not sure what you mean "for a particular application". Isn't Rancher the the only application it backs up?
There was a problem hiding this comment.
Also, I would insert an Oxford comma like so: packages all the resources to create a tarball file, and pushes it to. -- that's in the Microsoft style guide, so it's ok here
There was a problem hiding this comment.
I'm not sure what you mean "for a particular application". Isn't Rancher the the only application it backs up?
Adjusting that to read as "backed up for the application" - since by default "the application" is Rancher. But this section is highlighting that with care and caution that BRO can backup other application data too. Technically I didn't write the wording here, just reorganizing it to a new section. But I like these improvements too!
This PR seeks to simplify the "above the fold" content of our readme. Essentially as a means to improve the experience for any Rancher end-users that end up on this repo. The goal is to optimize for that without removing any beneficial information for any power-users out there.
Change Highlights