Skip to content

Fix: Add annotations regarding s3 related information for serviceaccount#391

Merged
dbasunag merged 1 commit intoopendatahub-io:mainfrom
Jooho:update_storage_secret
Jun 30, 2025
Merged

Fix: Add annotations regarding s3 related information for serviceaccount#391
dbasunag merged 1 commit intoopendatahub-io:mainfrom
Jooho:update_storage_secret

Conversation

@Jooho
Copy link
Copy Markdown
Contributor

@Jooho Jooho commented Jun 28, 2025

Description

Some test cases configure AWS credentials using a service account, but the S3 endpoint is set incorrectly — it should be provided via annotations.

How Has This Been Tested?

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

Some test casess use serviceaccount to set aws credential but the way how to set endpoint is wrong. It should use annotations.
Signed-off-by: Jooho Lee <jlee@redhat.com>
@Jooho Jooho requested a review from a team as a code owner June 28, 2025 04:12
@github-actions
Copy link
Copy Markdown

The following are automatically added/executed:

  • PR size label.
  • Run pre-commit
  • Run tox
  • Add PR author as the PR assignee
  • Build image based on the PR

Available user actions:

  • To mark a PR as WIP, add /wip in a comment. To remove it from the PR comment /wip cancel to the PR.
  • To block merging of a PR, add /hold in a comment. To un-block merging of PR comment /hold cancel.
  • To mark a PR as approved, add /lgtm in a comment. To remove, add /lgtm cancel.
    lgtm label removed on each new commit push.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To Cherry-pick a merged PR /cherry-pick <target_branch_name> to the PR. If <target_branch_name> is valid,
    and the current PR is merged, a cherry-picked PR would be created and linked to the current PR.
  • To build and push image to quay, add /build-push-pr-image in a comment. This would create an image with tag
    pr-<pr_number> to quay repository. This image tag, however would be deleted on PR merge or close action.
Supported labels

{'/cherry-pick', '/wip', '/lgtm', '/hold', '/verified', '/build-push-pr-image'}

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 28, 2025

📝 Walkthrough

Summary by CodeRabbit

  • Enhancements
    • Expanded the metadata annotations for S3 connection secrets to include endpoint, region, credential usage, SSL verification, and HTTPS usage details. This provides more comprehensive information about S3 connection parameters for end-users.

Walkthrough

The context manager responsible for creating S3 endpoint Secret resources was updated to include additional annotations. These new annotations provide details such as the S3 endpoint (without protocol), region, credential usage, SSL verification, and whether HTTPS is used, enriching the metadata associated with the Secret.

Changes

File(s) Change Summary
utilities/infra.py Enhanced the s3_endpoint_secret context manager to add more detailed S3 connection annotations.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
utilities/infra.py (2)

322-325: HTTPS detection logic is correct.

The logic correctly determines HTTPS usage by checking the endpoint protocol prefix. The implementation is sound and addresses the S3 configuration requirements.

Consider using boolean values and string literals for improved readability:

-        # Determine usehttps based on endpoint protocol
-        usehttps = 0
-        if aws_s3_endpoint.startswith("https://"):
-            usehttps = 1
+        # Determine usehttps based on endpoint protocol
+        usehttps = "1" if aws_s3_endpoint.startswith("https://") else "0"

327-334: Enhanced S3 annotations provide comprehensive configuration metadata.

The new annotations correctly address the S3 endpoint configuration issues mentioned in the PR objectives. The endpoint processing properly removes protocol prefixes, and the metadata provides all necessary S3 connection parameters.

Note that s3-useanoncredential and s3-verifyssl are hardcoded, which appears appropriate for the test environment context but may limit flexibility for other use cases.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3d0741 and 8d20327.

📒 Files selected for processing (1)
  • utilities/infra.py (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
utilities/infra.py (1)
utilities/constants.py (1)
  • ApiGroups (122-124)

@mwaykole
Copy link
Copy Markdown
Member

/lgtm

@dbasunag dbasunag merged commit 04cd6e1 into opendatahub-io:main Jun 30, 2025
12 checks passed
@github-actions
Copy link
Copy Markdown

Status of building tag latest: success.
Status of pushing tag latest to image registry: success.

@Jooho Jooho deleted the update_storage_secret branch July 1, 2025 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants