Skip to content

generic object storage documentation

Ben Prescott_ requested to merge docs-bprescott-objstorage-20200324 into master

What does this MR do?

Customer asked for advice (internal link) on object storage.

They highlighted that the red warning on the job artifacts page was confusing, as it appeared to say that S3 didn't work for job logs, use NFS. But object storage is specifically sold in the HA docs as a replacement for NFS. Revision in preview app

They asked if one bucket could be used for all object types. Answer no: our docs hint at it in the helm docs, and there's an issue about it. As far as I can see, it's absolutely not helm specific, and the challenges documented in the issue make this clear.

Looking into this, I found the excellent 'one stop' page in the HA docs for object storage. It's be great for single machine omnibus installs, helm, AWS, and so I've moved it and repurposed it. New page in preview app.

I've added a lot of other gotchas that customers have found, and aren't currently signposted from the docs.

Related issues

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Craig Norris

Merge request reports