Skip to content
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

Multi-PF build for example-client image #2713

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Oct 24, 2024

Description

SSIA

Related Issue

Versions

  • Vald Version: v1.7.13
  • Go Version: v1.23.2
  • Rust Version: v1.81.0
  • Docker Version: v27.3.1
  • Kubernetes Version: v1.31.1
  • Helm Version: v3.16.2
  • NGT Version: v2.2.4
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • New Features
    • Enhanced Docker image build process to support multiple architectures (linux/amd64 and linux/arm64), improving compatibility across different environments.

@vankichi vankichi requested review from a team, kmrmt and hlts2 and removed request for a team October 24, 2024 03:09
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the GitHub Actions workflow for building the Docker image of the example client. A new input parameter named platforms has been added to the build job, allowing the specification of target platforms as linux/amd64 and linux/arm64. This enhancement enables the workflow to create Docker images compatible with multiple architectures.

Changes

File Path Change Summary
.github/workflows/dockers-example-client-image.yaml Added platforms: linux/amd64,linux/arm64 parameter in build job.

Possibly related PRs

Suggested labels

type/feature, size/L, area/makefile

Suggested reviewers

  • kpango

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@vankichi vankichi requested review from kpango and removed request for hlts2 October 24, 2024 03:09
@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

coderabbitai[bot]
coderabbitai bot previously approved these changes Oct 24, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi force-pushed the ci/makefile-github/multipf-build-for-example-client branch from cb9e9ab to 3063d1c Compare October 24, 2024 03:14
Copy link

cloudflare-workers-and-pages bot commented Oct 24, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4d0fced
Status: ✅  Deploy successful!
Preview URL: https://292f40f6.vald.pages.dev
Branch Preview URL: https://ci-makefile-github-multipf-b.vald.pages.dev

View logs

Copy link
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

🧹 Outside diff range and nitpick comments (1)
.github/workflows/dockers-example-client-image.yaml (1)

76-76: LGTM! Good addition of multi-platform support.

The addition of multi-platform builds (linux/amd64,linux/arm64) is a valuable enhancement that improves the image's compatibility across different architectures, particularly beneficial for ARM-based environments like Apple Silicon or AWS Graviton.

Consider the following operational aspects:

  1. Build times may increase due to multi-arch builds
  2. Ensure sufficient CI runner resources are available
  3. Consider implementing platform-specific tests if the example client has architecture-dependent code
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between cb9e9ab and 3063d1c.

📒 Files selected for processing (1)
  • .github/workflows/dockers-example-client-image.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/dockers-example-client-image.yaml (1)

76-77: Verify Docker buildx setup in the shared workflow.

Since this workflow reuses ./.github/workflows/_docker-image.yaml, let's verify that the shared workflow properly handles multi-platform builds.

✅ Verification successful

Based on the results from the shell scripts, I can now generate the final response as the verification is complete.

Docker buildx setup is properly configured for multi-platform builds

The shared workflow .github/workflows/_docker-image.yaml has all the necessary components for multi-platform builds:

  • Uses docker/setup-qemu-action@v3 with proper platform configuration (linux/amd64,linux/arm64)
  • Sets up buildx with docker/setup-buildx-action@v3 and matching platform configuration
  • Includes necessary driver options with a buildkit image
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the shared workflow has proper buildx setup for multi-platform builds

# Check if the shared workflow uses docker buildx
echo "Checking for buildx setup in shared workflow..."
rg -A 5 "docker.*buildx" .github/workflows/_docker-image.yaml

# Check for QEMU setup which is typically needed for multi-arch builds
echo "Checking for QEMU setup..."
rg -A 5 "qemu-user-static|docker/setup-qemu-action" .github/workflows/_docker-image.yaml

Length of output: 745

@kpango kpango merged commit 9898338 into main Oct 24, 2024
28 checks passed
@kpango kpango deleted the ci/makefile-github/multipf-build-for-example-client branch October 24, 2024 06:31
vdaas-ci pushed a commit that referenced this pull request Oct 24, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 2024
2 tasks
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
takuyaymd pushed a commit to takuyaymd/vald that referenced this pull request Dec 2, 2024
Signed-off-by: vankichi <kyukawa315@gmail.com>
This was referenced Dec 3, 2024
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.

4 participants