OADP-4005: Enhance documentation for OADP CloudStorage API, including installation instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. by kaovilai · Pull Request #1925 · openshift/oadp-operator

kaovilai · 2025-08-21T15:44:38Z

Signed-off-by: Tiger Kaovilai tkaovila@redhat.com

Why the changes were made

How to test the changes made

openshift-ci · 2025-08-21T15:44:55Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

kaovilai · 2025-08-21T16:27:45Z

docs/design/gcp-wif-support_design.md

symlinked to new doc.

…on instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

openshift-ci-robot · 2025-08-25T13:03:29Z

@kaovilai: This pull request references OADP-4005 which is a valid jira issue.

Details

In response to this:

Signed-off-by: Tiger Kaovilai tkaovila@redhat.com

Why the changes were made

How to test the changes made

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.

kaovilai

official docs PR: openshift/openshift-docs#98366

weshayutin · 2025-09-02T22:12:44Z

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 <noreply@anthropic.com>

weshayutin

Instead of creating a brand new doc, we should consider what we already have in production doc and look for required changes there.

https://docs.okd.io/latest/backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.html

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 <noreply@anthropic.com>

weshayutin · 2025-09-15T16:59:34Z

drop the two aws docs as this would create duplication. Suggest updates to production doc instead.
https://docs.okd.io/latest/backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.html

Keep:

GCP
Azure
CloudStorage

All as merged drafts for prod doc team

docs/config/oadp-cloudstorage-api.adoc

kaovilai · 2025-09-15T21:20:47Z

drop the two aws docs as this would create duplication. Suggest updates to production doc instead.
https://docs.okd.io/latest/backup_and_restore/application_backup_and_restore/aws-sts/oadp-aws-sts.html

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?

kaovilai

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.

docs/config/aws/oadp-aws-sts-cloud-authentication.adoc

kaovilai · 2025-09-15T21:35:14Z

docs/config/aws/oadp-rosa-sts-cloud-authentication.adoc

move to another pr

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 <noreply@anthropic.com>

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

openshift-bot · 2025-12-17T01:00:24Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

coderabbitai · 2025-12-17T01:00:45Z

Important

Review skipped

Auto reviews are limited based on label configuration.

🚫 Review skipped — only excluded labels are configured. (1)

do-not-merge/work-in-progress

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

weshayutin · 2026-01-07T17:15:53Z

@kaovilai please get this PR updated for review

kaovilai · 2026-01-07T17:25:20Z

This was ready

openshift-ci · 2026-01-14T19:20:57Z

@kaovilai: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

weshayutin

/LGTM

openshift-ci · 2026-01-14T20:18:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kaovilai, shubham-pampattiwar, weshayutin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [kaovilai,shubham-pampattiwar]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 21, 2025

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 21, 2025

kaovilai force-pushed the cloudstorageAPI-docs branch from c32b7ad to 5023c4c Compare August 21, 2025 16:27

kaovilai commented Aug 21, 2025

View reviewed changes

docs/design/gcp-wif-support_design.md

Copy link

Member Author

kaovilai Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symlinked to new doc.

kaovilai force-pushed the cloudstorageAPI-docs branch from 5023c4c to bdd6171 Compare August 21, 2025 16:50

Enhance documentation for OADP CloudStorage API, including installati…

49e25e5

…on instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

kaovilai force-pushed the cloudstorageAPI-docs branch from bdd6171 to 49e25e5 Compare August 21, 2025 17:07

kaovilai marked this pull request as ready for review August 21, 2025 21:07

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 21, 2025

openshift-ci bot requested review from shubham-pampattiwar and sseago August 21, 2025 21:07

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 25, 2025

kaovilai mentioned this pull request Sep 2, 2025

OADP-4005: Add CloudStorage API support openshift/openshift-docs#98366

Merged

2 tasks

kaovilai commented Sep 2, 2025

View reviewed changes

weshayutin added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 2, 2025

weshayutin requested changes Sep 15, 2025

View reviewed changes

shubham-pampattiwar reviewed Sep 15, 2025

View reviewed changes

docs/config/oadp-cloudstorage-api.adoc Show resolved Hide resolved

docs/config/oadp-cloudstorage-api.adoc Outdated Show resolved Hide resolved

Update docs/config/oadp-cloudstorage-api.adoc

c20772f

kaovilai commented Sep 15, 2025

View reviewed changes

kaovilai and others added 2 commits September 15, 2025 17:49

git checkout upstream/oadp-dev docs/config/aws/

9d6904c

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

kaovilai requested a review from weshayutin September 16, 2025 19:20

kaovilai requested a review from shubham-pampattiwar September 16, 2025 19:20

shubham-pampattiwar approved these changes Sep 17, 2025

View reviewed changes

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 17, 2025

weshayutin removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 14, 2026

weshayutin approved these changes Jan 14, 2026

View reviewed changes

weshayutin merged commit f509f50 into openshift:oadp-dev Jan 14, 2026
9 of 10 checks passed

openshift-ci bot assigned weshayutin Jan 14, 2026

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 14, 2026

Conversation

kaovilai commented Aug 21, 2025

Why the changes were made

How to test the changes made

Uh oh!

openshift-ci bot commented Aug 21, 2025

Uh oh!

kaovilai Aug 21, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Aug 25, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why the changes were made

How to test the changes made

Uh oh!

kaovilai left a comment

Choose a reason for hiding this comment

Uh oh!

weshayutin commented Sep 2, 2025

Uh oh!

weshayutin left a comment

Choose a reason for hiding this comment

Uh oh!

weshayutin commented Sep 15, 2025

Uh oh!

Uh oh!

Uh oh!

kaovilai commented Sep 15, 2025

Uh oh!

kaovilai left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kaovilai Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

kaovilai Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-bot commented Dec 17, 2025

Uh oh!

coderabbitai bot commented Dec 17, 2025

Review skipped

Uh oh!

weshayutin commented Jan 7, 2026

Uh oh!

kaovilai commented Jan 7, 2026

Uh oh!

openshift-ci bot commented Jan 14, 2026

Uh oh!

weshayutin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openshift-ci bot commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

openshift-ci-robot commented Aug 25, 2025 •

edited by openshift-ci bot

Loading

kaovilai left a comment •

edited

Loading