-
Notifications
You must be signed in to change notification settings - Fork 84
OADP-4005: Enhance documentation for OADP CloudStorage API, including installation instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. #1925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: oadp-dev
Are you sure you want to change the base?
Conversation
Skipping CI for Draft Pull Request. |
c32b7ad
to
5023c4c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
symlinked to new doc.
5023c4c
to
bdd6171
Compare
…on instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. Signed-off-by: Tiger Kaovilai <[email protected]>
bdd6171
to
49e25e5
Compare
@kaovilai: This pull request references OADP-4005 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
official docs PR: openshift/openshift-docs#98366
Thanks Tiger! This looks great, I need some time to walk through it :) |
The service account annotations for AWS, Azure, and GCP are redundant because OADP already handles credential configuration internally: - AWS: Removed eks.amazonaws.com/role-arn annotation - OADP creates credentials file with role_arn and web_identity_token_file - Azure: Removed azure.workload.identity/client-id annotation - OADP sets environment variables directly via secret - GCP: Removed iam.gke.io/gcp-service-account annotation - OADP creates external account JSON with all needed configuration These annotations would only be useful if relying on cloud-specific admission webhooks (AWS Pod Identity Webhook, Azure Workload Identity Webhook, GKE Workload Identity), but OADP's approach is more portable as it works without requiring these webhooks to be present. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of creating a brand new doc, we should consider what we already have in production doc and look for required changes there.
These verification commands were checking for the cloud provider annotations that were removed in the previous commit. Since OADP handles credentials internally without needing those annotations, these verification steps are no longer necessary. Removed annotation checks for: - AWS: eks.amazonaws.com/role-arn - Azure: azure.workload.identity/client-id - GCP: iam.gke.io/gcp-service-account 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
drop the two aws docs as this would create duplication. Suggest updates to production doc instead. Keep:
All as merged drafts for prod doc team |
it follows existing split docs. ie. rosa is a separate page https://docs.okd.io/latest/backup_and_restore/application_backup_and_restore/oadp-rosa/oadp-rosa-backing-up-applications.html Do you want me to diff both pages? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wes will nuke from orbit in another pr.
so 3 prs.
- This: fixes of azure and wif, since there is no base doc in openshift-docs yet.
- AWS only doc diffs (for docs team reference, not merging) #1956
- wes PR to nuke existing AWS docs, to have single authorative place for docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
move to another pr
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Document the new status conditions field added in PR openshift#1937 that provides detailed information about bucket state: - Added conditions field to the status YAML example - Created comprehensive Status Conditions section explaining: - BucketReady condition type - All five condition reasons (BucketCreated, BucketReady, BucketCreationFailed, BucketCheckError, STSSecretError) - Example status with conditions - Benefits for troubleshooting, monitoring, and automation This helps users understand and diagnose CloudStorage resource states more effectively. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Signed-off-by: Tiger Kaovilai <[email protected]>
@kaovilai: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kaovilai, shubham-pampattiwar The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Tiger Kaovilai [email protected]
Why the changes were made
How to test the changes made