openshift / openshift/openshift-docs

[online] Issue in file rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc

Open
#54,721 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lifecycle/frozen
Dominant language
HTML
Stars
883
Forks
2k
Avg merge
21h 5m
Merged PRs (30d)
737

Description

Which section(s) is the issue in?

"Backup and recovery"
https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.html#backup-recovery_rosa-policy-process-security

What needs fixing?

The usage of the term "object store backup" is confusing, and the explanation "all Kubernetes objects like etcd" is not sufficient to make its meaning clear.

As an AWS user, I would assume "object store" means S3 service as the destination of the backups or it means the backup of cluster data that is stored in S3 buckets, such as container images from the internal registry.

It is not clear from the table of what, if anything, these backups include other than Kubernetes API resources (stored in etcd) and application data on Persistent Volumes. For example:

  • would container images from the internal registry be included in any of these backups?
  • would application data stored in S3 buckets be included?

IMHO our docs should be sensitivite to the terms AWS customers would be used to, even of the meaning would be clar to skilled OpenShift customers. And the internal registry should be mentioned explicitly, as well as application data stored on S3, RDS, and any other AWS server that we do not back up.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc and read the “Backup and recovery” section and its table. Verify what object store backups cover, including the internal registry, S3 application data, RDS, and other AWS services, then clarify the terminology and backup boundaries. Done means AWS users can tell what is and is not included.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.