Add warning about S3 outages affecting form downloads - #2088
Add warning about S3 outages affecting form downloads#2088gaurav-goswamii wants to merge 7 commits into
Conversation
yanokwa
left a comment
yanokwa
left a comment
There was a problem hiding this comment.
Thanks for the PR. I think it would read better if slotted in as the second to last bullet.
- If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail.
- If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage.
|
@yanokwa Thanks! I've moved the warning to the second-to-last bullet and updated the wording as suggested. |
|
|
||
| - If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. | ||
| - If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage. | ||
| If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. |
There was a problem hiding this comment.
This explains why someone might want to opt into the functionality, it feels like it should be at the top as it was before.
There was a problem hiding this comment.
The introductory paragraph is fully restored right under the header.
| By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. | ||
|
|
||
| - If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. | ||
| - If you opt into S3-compatible storage, you must design a backup and restore strategy for that storage. |
There was a problem hiding this comment.
This is already in the consideration list below. I think it works well where it is.
There was a problem hiding this comment.
i removed the duplicate.
| By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database. | ||
| By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. | ||
|
|
||
| - If S3-compatible storage goes down, Central will still accept submissions, but devices may not receive updates to forms with attachments, and integrations or dashboards that use attachments may fail. |
There was a problem hiding this comment.
I would probably tend to add this bullet point to the consideration list below. Another alternative would be to style it here as a warning.
There was a problem hiding this comment.
Added the S3 outage bullet into the existing bullet list. thanks
3 participants
What is included in this PR?
Adds a warning to the S3 documentation explaining that an S3 outage can prevent devices from downloading new forms and attachments, even though Central can continue accepting submissions.
Fixes #2055