Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: oadp-dev
Choose a base branch
from
Open

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

wants to merge 2 commits into from
+556 −401

Conversation

kaovilai
Copy link
Member

Signed-off-by: Tiger Kaovilai [email protected]

Why the changes were made

How to test the changes made

@openshift-ci 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 OpenShift CI
Copy link

openshift-ci bot commented Aug 21, 2025

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

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Aug 21, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kaovilai

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci 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 kaovilai force-pushed the cloudstorageAPI-docs branch from c32b7ad to 5023c4c Compare August 21, 2025 16:27
kaovilai
kaovilai commented Aug 21, 2025
View reviewed changes
docs/design/gcp-wif-support_design.md
Copy link
Member Author

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 kaovilai force-pushed the cloudstorageAPI-docs branch from 5023c4c to bdd6171 Compare August 21, 2025 16:50
@kaovilai
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 <[email protected]>
@kaovilai kaovilai force-pushed the cloudstorageAPI-docs branch from bdd6171 to 49e25e5 Compare August 21, 2025 17:07
@kaovilai kaovilai marked this pull request as ready for review August 21, 2025 21:07
@openshift-ci 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
@kaovilai kaovilai changed the title Enhance documentation for OADP CloudStorage API, including installation instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. OADP-4005: Enhance documentation for OADP CloudStorage API, including installation instructions via OpenShift web console and provider-specific configurations for AWS, Azure, and GCP. Aug 25, 2025
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 25, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 25, 2025 •
edited by openshift-ci bot
Loading

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

In response to this:

Signed-off-by: Tiger Kaovilai [email protected]

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 kaovilai mentioned this pull request Sep 2, 2025
Open
2 tasks
kaovilai
kaovilai commented Sep 2, 2025
View reviewed changes
Copy link
Member Author

@kaovilai kaovilai left a 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

@weshayutin
Copy link
Contributor

Thanks Tiger! This looks great, I need some time to walk through it :)

@weshayutin 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
@kaovilai @claude
Remove redundant cloud provider service account annotations from docs
30cfb9b 
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]>
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Sep 2, 2025

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shubham-pampattiwar shubham-pampattiwar Awaiting requested review from shubham-pampattiwar

@sseago sseago Awaiting requested review from sseago

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kaovilai @openshift-ci-robot @weshayutin