Backport PR #2514 to release/v1.7 for add faiss in values.yaml & valdrelease.yaml

[vdaas-ci]

Description

SSIA

Related Issue

Versions

• Go Version: 1.22.3
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.0
• NGT Version: 2.2.1

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• New Features

  • Added Faiss configuration options to enhance indexing, memory management, and timeout settings.

• Bug Fixes

  • Corrected metric_type value from "inner_product" to "innerproduct" for consistency in Faiss configurations.

• Documentation

  • Updated the "Get Started with Faiss Agent" tutorial to reflect the corrected metric_type value.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	510ee99
Status:	✅  Deploy successful!
Preview URL:	https://05800799.vald.pages.dev
Branch Preview URL:	https://backport-release-v1-7-featur-khw2.vald.pages.dev

View logs

[coderabbitai]

Walkthrough

Recent changes introduce comprehensive Faiss configuration capabilities to the Vald project's Helm chart files. These include additions to values.yaml, a new faiss section in CRDs, and updated sample configurations and documentation to reflect updated indexing, memory, and metric settings in faiss. Additionally, metric_type configuration has been streamlined from "inner_product" to "innerproduct".

Changes

Files/Paths	Change Summaries
charts/vald-helm-operator/crds/valdrelease.yaml	Added faiss section under spec with properties for Faiss configuration.
charts/vald/values.yaml	Added new Faiss configurations including indexing, dimensions, and timeouts.
cmd/agent/core/faiss/sample.yaml	Changed metric_type from "inner_product" to "innerproduct".
docs/tutorial/get-started-with-faiss-agent.md	Updated metric_type from "inner_product" to "innerproduct".
k8s/operator/helm/crds/valdrelease.yaml	Added Faiss configurations under spec.

Sequence Diagram(s)

Changes are primarily configuration-based or minor syntax updates and do not necessitate significant control flow modifications.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[vdaas-ci]

[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

[github-actions]

[documents cspell] _{reported by reviewdog 🐶}
Unknown word (innerproduct) Suggestions: []

[coderabbitai]

Actionable comments posted: 2

Outside diff range and nitpick comments (2)

docs/tutorial/get-started-with-faiss-agent.md (2)

Line range hint 89-89: Grammatical Correction: Add possessive apostrophe.

Consider modifying "Vald's pods status" to "Vald's pod status" for grammatical correctness and clarity.

- Vald's pods status
+ Vald's pod status

---

Line range hint 261-261: Improve clarity by reducing wordiness.

The phrase "completed with success" can be simplified to "completed successfully" to enhance readability and conciseness.

- completed with success
+ completed successfully

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 38018db and 6d64648.

Files selected for processing (5)

• charts/vald-helm-operator/crds/valdrelease.yaml (1 hunks)
• charts/vald/values.yaml (1 hunks)
• cmd/agent/core/faiss/sample.yaml (1 hunks)
• docs/tutorial/get-started-with-faiss-agent.md (1 hunks)
• k8s/operator/helm/crds/valdrelease.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• cmd/agent/core/faiss/sample.yaml

Additional context used

LanguageTool

docs/tutorial/get-started-with-faiss-agent.md

[uncategorized] ~89-~89: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...eploying Vald, you can check the Vald's pods status following command. ```bash ...

---

[style] ~261-~261: ‘with success’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_SUCCESS)
Context: ...s list of ids when loading is completed with success.

example ...

Additional comments not posted (18)

docs/tutorial/get-started-with-faiss-agent.md (1)

63-63: Update metric type configuration for consistency.

The change from "inner_product" to "innerproduct" in the metric type configuration aligns with the standard naming conventions used elsewhere in the project. This update is crucial for ensuring that the configuration is consistent and does not lead to errors during deployment or runtime.

charts/vald/values.yaml (7)

2177-2178: New Faiss Configuration Section Added

The addition of the faiss section under agent is well-structured and follows the YAML best practices for nesting and comments.

---

2203-2209: Dimension and Metric Type Configuration

The configuration for dimension and metric_type is correctly defined with appropriate types and constraints. Good use of comments to specify expected values for metric_type.

---

2210-2218: Configuration of Index Parameters

Settings for nlist, m, and nbits_per_idx are well-defined. These parameters are crucial for the performance and accuracy of the Faiss index.

---

2219-2237: Boolean Flags for Feature Toggles

The boolean settings for enable_in_memory_mode, enable_proactive_gc, and enable_copy_on_write are clear and provide straightforward toggles for these features.

---

2188-2202: Review Time Configuration Formats

Ensure that the time formats used (24h, 30m, 35m, 3m) are compatible with the application's time parsing logic and are consistent across the configuration.

---

2180-2184: Clarify Pod Name and Namespace Defaults

The placeholders _MY_POD_NAME_ and _MY_POD_NAMESPACE_ are used. Ensure these are replaced by actual values during deployment or handled dynamically by the deployment scripts.

---

2247-2250: Concurrency Setting for KVSDB

The concurrency setting for kvsdb is set to 6. Ensure this setting is aligned with the hardware capabilities and overall system architecture to avoid performance bottlenecks.

charts/vald-helm-operator/crds/valdrelease.yaml (10)

153-154: Validate auto_index_check_duration type and description.

The property auto_index_check_duration is correctly defined as a string. Ensure that the format of the string is well-documented elsewhere, possibly indicating expected time units (e.g., ms, s, m).

---

155-156: Check auto_index_duration_limit string format.

Similar to auto_index_check_duration, validate that the format and acceptable values for auto_index_duration_limit are documented, emphasizing the time units.

---

157-158: Confirm type of auto_index_length.

The property auto_index_length is defined as an integer. Consider adding constraints such as a minimum value if applicable.

---

159-160: Validate auto_save_index_duration string format.

Ensure that the string format for auto_save_index_duration is clearly defined and documented, particularly the expected time units.

---

161-163: Check dimension property constraints.

The dimension property has a minimum value constraint set to 1, which is appropriate. Ensure this aligns with the operational constraints of the Faiss library.

---

164-169: Review boolean properties for feature toggles.

Properties enable_copy_on_write, enable_in_memory_mode, and enable_proactive_gc are all defined as booleans, which is standard for feature toggles. Ensure these are adequately described in the documentation to clarify their impact on system behavior.

---

170-171: Confirm index_path type.

The index_path is correctly set as a string. This should be a filesystem path; ensure that there are checks to validate the path format and existence at runtime.

---

172-173: Validate initial_delay_max_duration.

Ensure the string format for initial_delay_max_duration is clearly defined, especially the expected time units.

---

174-178: Check kvsdb object and concurrency property.

The kvsdb object includes a concurrency property, defined as an integer. It's important to document the expected range and impact of different concurrency levels on performance.

---

179-206: Review remaining properties in the faiss section.

Properties such as load_index_timeout_factor, m, max_load_index_timeout, metric_type, min_load_index_timeout, namespace, nbits_per_idx, nlist, pod_name, and the vqueue object with its sub-properties are all defined appropriately. Ensure each of these properties is well-documented, particularly their types, constraints, and the impact they have on system performance and behavior.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release/v1.7@c7effd7). Learn more about missing BASE report.

Additional details and impacted files

@@               Coverage Diff               @@
##             release/v1.7    #2519   +/-   ##
===============================================
  Coverage                ?   18.96%           
===============================================
  Files                   ?      565           
  Lines                   ?    65225           
  Branches                ?        0           
===============================================
  Hits                    ?    12368           
  Misses                  ?    52058           
  Partials                ?      799           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[hlts2]

LGTM