PBM-1728-OCI-with-WIF#373
Closed
rasika-chivate wants to merge 23 commits into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for using Oracle Cloud Infrastructure (OCI) Object Storage with PBM via Workload Identity-style authentication, and exposes the new page in the MkDocs navigation.
Changes:
- Add a new documentation page describing
instancePrincipalandokeWorkloadIdentityauthentication for OCI Object Storage. - Add the new OCI WIF documentation page to the “Storage” section in
mkdocs-base.yml.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| mkdocs-base.yml | Adds the new OCI Workload Identity auth page to the Storage navigation. |
| docs/details/oci-workload-identity-auth.md | Introduces OCI Workload Identity authentication documentation and configuration examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
+1
to
+5
| # Oracle Cloud Infrastructure (OCI) Object Storage with Workload Identity Authentication | ||
|
|
||
| Percona Backup for MongoDB (PBM) supports Workload Identity authentication for Oracle Cloud Infrastructure (OCI) Object Storage. With Workload Identity, PBM can access OCI resources without storing or managing API keys, reducing operational overhead and improving security. | ||
|
|
||
| Percona Backup for MongoDB (PBM) supports two Workload Identity authentication types for OCI Object Storage, in addition to the default `userPrincipal`: |
Comment on lines
+1
to
+3
| # Oracle Cloud Infrastructure (OCI) Object Storage with Workload Identity Authentication | ||
|
|
||
| Percona Backup for MongoDB (PBM) supports Workload Identity authentication for Oracle Cloud Infrastructure (OCI) Object Storage. With Workload Identity, PBM can access OCI resources without storing or managing API keys, reducing operational overhead and improving security. |
| - Storage: | ||
| - Remote backup storage overview: details/storage-configuration.md | ||
| - AWS S3 storage: details/s3-storage.md | ||
| - OCI Object Storage (Workload Identity): details/oci-workload-identity-auth.md |
| *Type*: string <br> | ||
| *Required*: YES | ||
|
|
||
| The OCI authentication type. Supported values: `userPrincipal`, `instancePrincipal`, `okeWorkloadIdentity`. |
Comment on lines
+84
to
+97
| === ":material-database: OCI Object Storage" | ||
|
|
||
| ```yaml | ||
| storage: | ||
| type: oci | ||
| oci: | ||
| region: us-ashburn-1 | ||
| namespace: your-namespace | ||
| bucket: your-bucket-name | ||
| prefix: data/pbm/backup | ||
| credentials: | ||
| type: instancePrincipal | ||
| ``` | ||
|
|
Collaborator
Author
|
Added this as part of #377, so closing this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add compatibility with Oracle Cloud Storage using Workload Identity authentication. For details, see
https://perconadev.atlassian.net/browse/PBM-1728