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

Backport PR #2485 to release/v1.7 for Update continuous benchmark docs #2486

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Apr 25, 2024

Description

SSIA

Related Issue

Versions

  • Go Version: 1.22.2
  • Rust Version: 1.77.2
  • Docker Version: 20.10.8
  • Kubernetes Version: v1.29.3
  • NGT Version: 2.2

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • Documentation
    • Updated the Continuous Benchmark Tool description.
    • Clarified the execution process for benchmark jobs.
    • Enhanced configuration details for benchmark jobs.
    • Added guidance on monitoring benchmark job metrics.

* 📝 Update continous benchmark docs

Signed-off-by: vankichi <kyukawa315@gmail.com>

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in e3ab1d2 according to the output
from Gofumpt and Prettier.

Details: #2485

* Update docs/performance/continuous-benchmark.md

Signed-off-by: Kiichiro YUKAWA <kyukawa315@gmail.com>

* 📝 Fix

Signed-off-by: vankichi <kyukawa315@gmail.com>

---------

Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Copy link

cloudflare-workers-and-pages bot commented Apr 25, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 148fa05
Status: ✅  Deploy successful!
Preview URL: https://075cf55e.vald.pages.dev
Branch Preview URL: https://backport-release-v1-7-docume-zzta.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Apr 25, 2024

Walkthrough

Walkthrough

This update enhances the Continuous Benchmark Tool documentation by refining its description, clarifying the execution of CRUD operations in benchmark jobs, updating configuration details, and adding guidance on monitoring key metrics. This ensures users have clearer instructions and better tools for performance tracking.

Changes

File Path Change Summary
docs/.../benchmark.md Refined tool description, clarified CRUD execution, updated configuration details, added monitoring guidance.

Poem

🐇✨
In the meadow of code, under the sky so blue,
A little rabbit hopped, with updates anew.
"Refine, clarify, update!" it cheerfully said,
Monitoring the benchmarks, ahead it led.
With each hop and skip, performance refined,
A trail of better code, it left behind. 🌼📊


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 23f4fcd and 148fa05.
Files ignored due to path filters (1)
  • assets/docs/performance/benchmark-grafana.png is excluded by !**/*.png
Files selected for processing (1)
  • docs/performance/continuous-benchmark.md (6 hunks)
Additional Context Used
LanguageTool (296)
docs/performance/continuous-benchmark.md (296)

Near line 5: Possible spelling mistake found.
Context: ...llows you to continuously benchmark the Vald cluster. Assumed use case is: - Verif...


Near line 10: Possible spelling mistake found.
Context: ...cation before service installation when Vald version up ## Architecture Continuous...


Near line 17: Possible spelling mistake found.
Context: ...ob: Executes CRUD request to the target Vald cluster ## Benchmark component and its...


Near line 30: Possible spelling mistake found.
Context: ... - Executes CRUD request to the target Vald cluster based on defined config. - Exec...


Near line 37: Possible spelling mistake found.
Context: ... the Kubernetes Custom Resources(CRDs), ValdBenchmarkScenarioResource or ValdBenchmarkJobResource. Benchma...


Near line 37: Possible spelling mistake found.
Context: ...Ds), ValdBenchmarkScenarioResource or ValdBenchmarkJobResource. Benchmark Operator manages benchmark ...


Near line 37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...esourceorValdBenchmarkJobResource`. Benchmark Operator manages benchmark job accordin...


Near line 40: Possible spelling mistake found.
Context: ...according to the applied manifest. ### ValdBenchmarkJob [ValdBenchmarkJob](https://github.co...


Near line 42: This sentence does not start with an uppercase letter.
Context: ...rk-operator/crds/valdbenchmarkjob.yaml) is used for executing single benchmark job...


Near line 44: Possible spelling mistake found.
Context: ...s it to the Kubernetes cluster based on ValdBenchmarkScenarioResource. main properties | Name ...


Near line 46: This sentence does not start with an uppercase letter.
Context: ... on ValdBenchmarkScenarioResource. main properties | Name ...


Near line 48: Possible typo: you repeated a whitespace
Context: ...oResource`. main properties | Name | mandatory | Description ...


Near line 48: Possible typo: you repeated a whitespace
Context: ... | mandatory | Description | type ...


Near line 48: Possible typo: you repeated a whitespace
Context: ... | type | sample ...


Near line 48: Possible typo: you repeated a whitespace
Context: ... | sample | | :------------------------- | :------...


Near line 50: Possible typo: you repeated a whitespace
Context: ...----------------------------- | | target | * | target Vald cluster ...


Near line 50: Possible typo: you repeated a whitespace
Context: ...---- | | target | * | target Vald cluster ...


Near line 50: Possible spelling mistake found.
Context: ... | * | target Vald cluster ...


Near line 50: Possible typo: you repeated a whitespace
Context: ... | * | target Vald cluster | object ...


Near line 50: Possible typo: you repeated a whitespace
Context: ... | object | ref: target ...


Near line 50: Possible typo: you repeated a whitespace
Context: ... | ref: target | | dataset | * ...


Near line 51: Possible typo: you repeated a whitespace
Context: ... | | dataset | * | dataset information ...


Near line 51: Possible typo: you repeated a whitespace
Context: ... | | dataset | * | dataset information ...


Near line 51: Possible typo: you repeated a whitespace
Context: ... | * | dataset information | object ...


Near line 51: Possible typo: you repeated a whitespace
Context: ... | object | ref: dataset ...


Near line 51: Possible typo: you repeated a whitespace
Context: ... | ref: dataset | | job_type | * ...


Near line 52: Possible typo: you repeated a whitespace
Context: ... | | job_type | * | execute job type ...


Near line 52: Possible typo: you repeated a whitespace
Context: ... | | job_type | * | execute job type ...


Near line 52: Possible typo: you repeated a whitespace
Context: ... | * | execute job type | string enum: [insert, update, upsert, ...


Near line 52: Possible spelling mistake found.
Context: ... | string enum: [insert, update, upsert, remove, searc...


Near line 52: Possible spelling mistake found.
Context: ... | string enum: [insert, update, upsert, remove, search, getobject, exists] | s...


Near line 52: Possible spelling mistake found.
Context: ...insert, update, upsert, remove, search, getobject, exists] | search ...


Near line 52: Possible typo: you repeated a whitespace
Context: ...ove, search, getobject, exists] | search | | repetition | ...


Near line 53: Possible typo: you repeated a whitespace
Context: ... | | repetition | | the number of job repetiti...


Near line 53: Possible typo: you repeated a whitespace
Context: ... | | repetition | | the number of job repetitions
defau...


Near line 53: Possible typo: you repeated a whitespace
Context: ...umber of job repetitions
default: 1 | integer ...


Near line 53: Possible typo: you repeated a whitespace
Context: ... | integer | 1 ...


Near line 53: Possible typo: you repeated a whitespace
Context: ... | 1 | | replica | ...


Near line 54: Possible typo: you repeated a whitespace
Context: ... | | replica | | the number of job concurre...


Near line 54: Possible typo: you repeated a whitespace
Context: ... | | replica | | the number of job concurrent job execu...


Near line 54: Possible typo: you repeated a whitespace
Context: ...oncurrent job executions
default: 1 | integer ...


Near line 54: Possible typo: you repeated a whitespace
Context: ... | integer | 2 ...


Near line 54: Possible typo: you repeated a whitespace
Context: ... | 2 | | rps | ...


Near line 55: Possible typo: you repeated a whitespace
Context: ... | | rps | | designed request per sec t...


Near line 55: Possible typo: you repeated a whitespace
Context: ... | | rps | | designed request per sec to the target...


Near line 55: Possible typo: you repeated a whitespace
Context: ...to the target cluster
default: 1000 | integer ...


Near line 55: Possible typo: you repeated a whitespace
Context: ... | integer | 1000 ...


Near line 55: Possible typo: you repeated a whitespace
Context: ... | 1000 | | concurrency_limit | ...


Near line 56: Possible typo: you repeated a whitespace
Context: ... | | concurrency_limit | | goroutine count limit for ...


Near line 56: Possible typo: you repeated a whitespace
Context: ... | | concurrency_limit | | goroutine count limit for rps adjustme...


Near line 56: Possible spelling mistake found.
Context: ...oncurrency_limit | | goroutine count limit for rps adjustment
defau...


Near line 56: Possible typo: you repeated a whitespace
Context: ...mit for rps adjustment
default: 200 | integer ...


Near line 56: Possible typo: you repeated a whitespace
Context: ... | integer | 20 ...


Near line 56: Possible typo: you repeated a whitespace
Context: ... | 20 | | ttl_seconds_after_finished | ...


Near line 57: Possible spelling mistake found.
Context: ... | | ttl_seconds_after_finished | | ti...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | | ttl_seconds_after_finished | | time until deletion of Pod after job e...


Near line 57: Possible typo: you repeated a whitespace
Context: ...n of Pod after job end
default: 600 | integer ...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | integer | 120 ...


Near line 57: Possible typo: you repeated a whitespace
Context: ... | 120 | | insert_config | ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | | insert_config | | request config for insert ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | | insert_config | | request config for insert job ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | request config for insert job | object ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 58: Possible typo: you repeated a whitespace
Context: ... | ref: config | | update_config | ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | | update_config | | request config for update ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | | update_config | | request config for update job ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | request config for update job | object ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | ref: config | | upsert_config | ...


Near line 60: Possible spelling mistake found.
Context: ... | | upsert_config | | reque...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | | upsert_config | | request config for upsert ...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | | upsert_config | | request config for upsert job ...


Near line 60: Possible spelling mistake found.
Context: ... | | request config for upsert job ...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | request config for upsert job | object ...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 60: Possible typo: you repeated a whitespace
Context: ... | ref: config | | search_config | ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | | search_config | | request config for search ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | | search_config | | request config for search job ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | request config for search job | object ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 61: Possible typo: you repeated a whitespace
Context: ... | ref: config | | remove_config | ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | | remove_config | | request config for remove ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | | remove_config | | request config for remove job ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | request config for remove job | object ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 62: Possible typo: you repeated a whitespace
Context: ... | ref: config | | object_config | ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | | object_config | | request config for object ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | | object_config | | request config for object job ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | request config for object job | object ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | object | ref: config ...


Near line 63: Possible typo: you repeated a whitespace
Context: ... | ref: config | | client_config | ...


Near line 64: Possible typo: you repeated a whitespace
Context: ... | | client_config | | gRPC client config for run...


Near line 64: Possible typo: you repeated a whitespace
Context: ... | | client_config | | gRPC client config for running benchma...


Near line 64: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ig for running benchmark job
Tune if can not getting the expected performance with d...


Near line 64: Possible typo: you repeated a whitespace
Context: ...erformance with default config. | object | ref: [defaults.grpc](https://github.co...


Near line 64: Possible typo: you repeated a whitespace
Context: ...as/vald/blob/main/charts/vald/README.md) | | server_config | ...


Near line 65: Possible typo: you repeated a whitespace
Context: ...ld/README.md) | | server_config | | server config for benchmar...


Near line 65: Possible typo: you repeated a whitespace
Context: ... | | server_config | | server config for benchmark job pod<BR...


Near line 65: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...config for benchmark job pod
Tune if can not getting the expected performance with d...


Near line 65: Possible typo: you repeated a whitespace
Context: ...pected performance with default config. | object ...


Near line 65: Possible typo: you repeated a whitespace
Context: ...e with default config. | object | ref: [defaults.server_config](https://...


Near line 71: Possible spelling mistake found.
Context: ...="target-prop" /> target - target Vald cluster information - type: object | p...


Near line 74: Possible typo: you repeated a whitespace
Context: ...ct | property | mandatory | description | type | sample | | :------- | :--...


Near line 74: Possible typo: you repeated a whitespace
Context: ...mandatory | description | type | sample | | :------- | :-------- | :...


Near line 74: Possible typo: you repeated a whitespace
Context: ...description | type | sample | | :------- | :-------- | :------------...


Near line 76: Possible typo: you repeated a whitespace
Context: ...--------- | :------ | :-------- | | host | * | target cluster's host | st...


Near line 76: Possible typo: you repeated a whitespace
Context: ... | :------ | :-------- | | host | * | target cluster's host | string | loca...


Near line 76: Possible typo: you repeated a whitespace
Context: ... | target cluster's host | string | localhost | | port | * | t...


Near line 77: Possible typo: you repeated a whitespace
Context: ...er's host | string | localhost | | port | * | target cluster's port | in...


Near line 77: Possible typo: you repeated a whitespace
Context: ... | string | localhost | | port | * | target cluster's port | integer | 8081...


Near line 77: Possible typo: you repeated a whitespace
Context: ...| target cluster's port | integer | 8081 | dataset ...


Near line 86: Possible typo: you repeated a whitespace
Context: ...job operation - type: object | property | mandatory | description ...


Near line 86: Possible typo: you repeated a whitespace
Context: ... | property | mandatory | description | type ...


Near line 86: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :---------- | :-----...


Near line 86: Possible typo: you repeated a whitespace
Context: ... | sample | | :---------- | :-------- | :---------...


Near line 88: Possible typo: you repeated a whitespace
Context: ...--------------- | :------------ | | name | * | dataset name ...


Near line 88: Possible typo: you repeated a whitespace
Context: ...--- | :------------ | | name | * | dataset name ...


Near line 88: Possible typo: you repeated a whitespace
Context: ...| name | * | dataset name | string enum: [fashion-mnist, original]...


Near line 88: Possible spelling mistake found.
Context: ... | string enum: [fashion-mnist, original] | fashion-mn...


Near line 88: Possible spelling mistake found.
Context: ... | string enum: [fashion-mnist, original] | fashion-mnist | | group ...


Near line 88: Possible spelling mistake found.
Context: ...tring enum: [fashion-mnist, original] | fashion-mnist | | group | * | group nam...


Near line 89: Possible typo: you repeated a whitespace
Context: ...ist, original] | fashion-mnist | | group | * | group name ...


Near line 89: Possible typo: you repeated a whitespace
Context: ...al] | fashion-mnist | | group | * | group name ...


Near line 89: Possible typo: you repeated a whitespace
Context: ...| | group | * | group name | string enum: [train, test, neighbors] ...


Near line 89: Possible spelling mistake found.
Context: ... | string enum: [train, test, neighbors] | train ...


Near line 89: Possible typo: you repeated a whitespace
Context: ... | string enum: [train, test, neighbors] | train | | indexes | * ...


Near line 89: Possible typo: you repeated a whitespace
Context: ... enum: [train, test, neighbors] | train | | indexes | * | amount of ...


Near line 90: Possible typo: you repeated a whitespace
Context: ... neighbors] | train | | indexes | * | amount of index size ...


Near line 90: Possible typo: you repeated a whitespace
Context: ...s] | train | | indexes | * | amount of index size ...


Near line 90: Possible typo: you repeated a whitespace
Context: ...s | * | amount of index size | integer ...


Near line 90: Possible typo: you repeated a whitespace
Context: ... | integer | 1000000 | | range | * ...


Near line 90: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | range | * | range of i...


Near line 91: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | range | * | range of indexes to be use...


Near line 91: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | range | * | range of indexes to be used (if there ...


Near line 91: Possible typo: you repeated a whitespace
Context: ...l be corrected on the job side) | object | - | | range.start | * ...


Near line 91: Possible typo: you repeated a whitespace
Context: ...ject | - | | range.start | * | start of r...


Near line 92: If a new sentence starts here, add a space and start with an uppercase letter.
Context: ... | - | | range.start | * | start of range ...


Near line 92: Possible typo: you repeated a whitespace
Context: ... | - | | range.start | * | start of range ...


Near line 92: Possible typo: you repeated a whitespace
Context: ...range.start | * | start of range | integer ...


Near line 92: Possible typo: you repeated a whitespace
Context: ... | integer | 1 | | range.end | * ...


Near line 92: Possible typo: you repeated a whitespace
Context: ...teger | 1 | | range.end | * | end of ran...


Near line 93: If a new sentence starts here, add a space and start with an uppercase letter.
Context: ... | 1 | | range.end | * | end of range ...


Near line 93: Possible typo: you repeated a whitespace
Context: ... | 1 | | range.end | * | end of range ...


Near line 93: Possible typo: you repeated a whitespace
Context: ... | 1 | | range.end | * | end of range ...


Near line 93: Possible typo: you repeated a whitespace
Context: ...| range.end | * | end of range | integer ...


Near line 93: Possible typo: you repeated a whitespace
Context: ... | integer | 1000000 | | url | ...


Near line 93: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | url | | the datase...


Near line 94: Possible spelling mistake found.
Context: ... | 1000000 | | url | | the dataset url. ...


Near line 94: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | url | | the dataset url. It should...


Near line 94: Possible typo: you repeated a whitespace
Context: ... | 1000000 | | url | | the dataset url. It should be set when...


Near line 94: Possible spelling mistake found.
Context: ...| url | | the dataset url. It should be set when set name as `o...


Near line 94: Possible typo: you repeated a whitespace
Context: ...uld be set when set name as original | string ...


Near line 94: Possible typo: you repeated a whitespace
Context: ... | string | | <a id="insert-cfg-pro...


Near line 94: Possible typo: you repeated a whitespace
Context: ...string | | **insert...


Near line 100: Possible spelling mistake found.
Context: ...ert-cfg-props" /> insert_config - rpc config for insert request - type: objec...


Near line 103: Possible typo: you repeated a whitespace
Context: ...nsert request - type: object | property | mandatory | description ...


Near line 103: Possible typo: you repeated a whitespace
Context: ... | mandatory | description | type | sample | | :-------------...


Near line 103: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :----------------------...


Near line 103: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :---------------------- | :-------- ...


Near line 105: Possible typo: you repeated a whitespace
Context: ...:--------- | | skip_strict_exist_check | | Check whether the same vector is alrea...


Near line 105: Possible spelling mistake found.
Context: ...uld be unique if the value is true. | bool | false | | timestamp ...


Near line 105: Possible typo: you repeated a whitespace
Context: ...be unique if the value is true. | bool | false | | timestamp ...


Near line 105: Possible typo: you repeated a whitespace
Context: ...if the value is true. | bool | false | | timestamp | ...


Near line 106: Possible typo: you repeated a whitespace
Context: ...ue`. | bool | false | | timestamp | | The timestamp of the vecto...


Near line 106: Possible typo: you repeated a whitespace
Context: ...false | | timestamp | | The timestamp of the vector inserted.<...


Near line 106: Possible typo: you repeated a whitespace
Context: ... is N/A, the current time will be used. | string | 1707272658 | <a id="update-c...


Near line 112: Possible spelling mistake found.
Context: ...ate-cfg-props" /> update_config - rpc config for update request - type: objec...


Near line 115: Possible typo: you repeated a whitespace
Context: ...pdate request - type: object | property | mandatory | description ...


Near line 115: Possible typo: you repeated a whitespace
Context: ... | mandatory | description | type | sample | | :-------------...


Near line 115: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :----------------------...


Near line 115: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :---------------------- | :-------- ...


Near line 117: Possible typo: you repeated a whitespace
Context: ...:--------- | | skip_strict_exist_check | | Check whether the same vector is alrea...


Near line 117: Possible spelling mistake found.
Context: ...uld be unique if the value is true. | bool | false | | timestamp ...


Near line 117: Possible typo: you repeated a whitespace
Context: ...be unique if the value is true. | bool | false | | timestamp ...


Near line 117: Possible typo: you repeated a whitespace
Context: ...if the value is true. | bool | false | | timestamp | ...


Near line 118: Possible typo: you repeated a whitespace
Context: ...ue`. | bool | false | | timestamp | | The timestamp of the vecto...


Near line 118: Possible typo: you repeated a whitespace
Context: ...false | | timestamp | | The timestamp of the vector inserted.<...


Near line 118: Possible typo: you repeated a whitespace
Context: ... is N/A, the current time will be used. | string | 1707272658 | | disable_balanc...


Near line 119: Possible typo: you repeated a whitespace
Context: ...1707272658 | | disable_balanced_update | | A flag to disable balanced update (spl...


Near line 119: Possible spelling mistake found.
Context: ... disable balanced update (split remove -> insert operation) during update operat...


Near line 119: Possible typo: you repeated a whitespace
Context: ...ert operation) during update operation. | bool | false | <a id="upsert-c...


Near line 119: Possible spelling mistake found.
Context: ... during update operation. | bool | false | <a id="upsert-cfg-pro...


Near line 119: Possible typo: you repeated a whitespace
Context: ...ing update operation. | bool | false | <a id="upsert-cfg-props"...


Near line 119: Possible typo: you repeated a whitespace
Context: ... operation. | bool | false | **upsert...


Near line 123: Possible spelling mistake found.
Context: ... | upsert_config - rpc config for upsert reque...


Near line 125: Possible spelling mistake found.
Context: ...ert-cfg-props" /> upsert_config - rpc config for upsert request - type: objec...


Near line 125: Possible spelling mistake found.
Context: .../> upsert_config - rpc config for upsert request - type: object | property ...


Near line 128: Possible typo: you repeated a whitespace
Context: ...psert request - type: object | property | mandatory | description ...


Near line 128: Possible typo: you repeated a whitespace
Context: ... | mandatory | description | type | sample | | :-------------...


Near line 128: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :----------------------...


Near line 128: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :---------------------- | :-------- ...


Near line 130: Possible typo: you repeated a whitespace
Context: ...:--------- | | skip_strict_exist_check | | Check whether the same vector is alrea...


Near line 130: Possible spelling mistake found.
Context: ...uld be unique if the value is true. | bool | false | | timestamp ...


Near line 130: Possible typo: you repeated a whitespace
Context: ...be unique if the value is true. | bool | false | | timestamp ...


Near line 130: Possible typo: you repeated a whitespace
Context: ...if the value is true. | bool | false | | timestamp | ...


Near line 131: Possible typo: you repeated a whitespace
Context: ...ue`. | bool | false | | timestamp | | The timestamp of the vecto...


Near line 131: Possible typo: you repeated a whitespace
Context: ...false | | timestamp | | The timestamp of the vector inserted.<...


Near line 131: Possible typo: you repeated a whitespace
Context: ... is N/A, the current time will be used. | string | 1707272658 | | disable_balanc...


Near line 132: Possible typo: you repeated a whitespace
Context: ...1707272658 | | disable_balanced_update | | A flag to disable balanced update (spl...


Near line 132: Possible spelling mistake found.
Context: ... disable balanced update (split remove -> insert operation) during update operat...


Near line 132: Possible typo: you repeated a whitespace
Context: ...ert operation) during update operation. | bool | false | <a id="search-c...


Near line 132: Possible spelling mistake found.
Context: ... during update operation. | bool | false | <a id="search-cfg-pro...


Near line 132: Possible typo: you repeated a whitespace
Context: ...ing update operation. | bool | false | <a id="search-cfg-props"...


Near line 132: Possible typo: you repeated a whitespace
Context: ... operation. | bool | false | **upsert...


Near line 136: Possible spelling mistake found.
Context: ... | upsert_config - rpc config for search reque...


Near line 138: Possible spelling mistake found.
Context: ...rch-cfg-props" /> upsert_config - rpc config for search request - type: objec...


Near line 141: Possible typo: you repeated a whitespace
Context: ...earch request - type: object | property | mandatory | description ...


Near line 141: Possible typo: you repeated a whitespace
Context: ...y | mandatory | description | type ...


Near line 141: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :-------------------- | :--...


Near line 143: Possible typo: you repeated a whitespace
Context: ...-------------------- | :----- | | radius | | The search radius.
defa...


Near line 143: Possible typo: you repeated a whitespace
Context: ...--- | :----- | | radius | | The search radius.
default: -1 ...


Near line 143: Possible typo: you repeated a whitespace
Context: ... | The search radius.
default: -1 | number ...


Near line 143: Possible typo: you repeated a whitespace
Context: ... | number | -1 | | epsilon | ...


Near line 143: Possible typo: you repeated a whitespace
Context: ... | -1 | | epsilon | | ...


Near line 144: Possible typo: you repeated a whitespace
Context: ... | -1 | | epsilon | | The search coefficient.<BR...


Near line 144: Possible typo: you repeated a whitespace
Context: ... | -1 | | epsilon | | The search coefficient.
default: `0...


Near line 144: Possible typo: you repeated a whitespace
Context: ...e search coefficient.
default: 0.05 | number ...


Near line 144: Possible typo: you repeated a whitespace
Context: ... | number | 0.05 | | num | * ...


Near line 144: Possible typo: you repeated a whitespace
Context: ... | 0.05 | | num | * | ...


Near line 145: Possible spelling mistake found.
Context: ... | 0.05 | | num | * | The max...


Near line 145: Possible typo: you repeated a whitespace
Context: ... | 0.05 | | num | * | The maximum number of resu...


Near line 145: Possible typo: you repeated a whitespace
Context: ... | 0.05 | | num | * | The maximum number of results to be re...


Near line 145: Possible typo: you repeated a whitespace
Context: ...ximum number of results to be returned. | integer ...


Near line 145: Possible typo: you repeated a whitespace
Context: ... | integer | 10 | | min_num | ...


Near line 145: Possible typo: you repeated a whitespace
Context: ... | 10 | | min_num | | ...


Near line 146: Possible spelling mistake found.
Context: ... | 10 | | min_num | | The minimum...


Near line 146: Possible typo: you repeated a whitespace
Context: ... | 10 | | min_num | | The minimum number of resu...


Near line 146: Possible typo: you repeated a whitespace
Context: ... | 10 | | min_num | | The minimum number of results to be re...


Near line 146: Possible typo: you repeated a whitespace
Context: ...nimum number of results to be returned. | integer ...


Near line 146: Possible typo: you repeated a whitespace
Context: ... | integer | 5 | | timeout | ...


Near line 146: Possible typo: you repeated a whitespace
Context: ... | 5 | | timeout | | ...


Near line 147: Possible typo: you repeated a whitespace
Context: ... | 5 | | timeout | | Search timeout in nanoseco...


Near line 147: Possible typo: you repeated a whitespace
Context: ... | 5 | | timeout | | Search timeout in nanoseconds
defau...


Near line 147: Possible typo: you repeated a whitespace
Context: ...timeout in nanoseconds
default: 10s | string ...


Near line 147: Possible typo: you repeated a whitespace
Context: ... | string | 3s | | enable_linear_search | ...


Near line 147: Possible typo: you repeated a whitespace
Context: ... | 3s | | enable_linear_search | | ...


Near line 148: Possible typo: you repeated a whitespace
Context: ... | 3s | | enable_linear_search | | A flag to enable linear se...


Near line 148: Possible typo: you repeated a whitespace
Context: ... | 3s | | enable_linear_search | | A flag to enable linear search operati...


Near line 148: Possible spelling mistake found.
Context: ...n with linear operation will execute. | bool ...


Near line 148: Possible typo: you repeated a whitespace
Context: ...th linear operation will execute. | bool | false | | aggregation_algorithm | ...


Near line 148: Possible typo: you repeated a whitespace
Context: ... | false | | aggregation_algorithm | | ...


Near line 149: Possible typo: you repeated a whitespace
Context: ... | false | | aggregation_algorithm | | The search aggregation algorithm optio...


Near line 149: Possible typo: you repeated a whitespace
Context: ... algorithm option.
default: Unknown | string enum: ["Unknown", "ConcurrentQu...


Near line 149: Possible spelling mistake found.
Context: ... | string enum: ["Unknown", "ConcurrentQueue", "SortSl...


Near line 149: Possible spelling mistake found.
Context: ... | string enum: ["Unknown", "ConcurrentQueue", "SortSlice", "SortPoolSlice", "Pairin...


Near line 149: Possible spelling mistake found.
Context: ...g enum: ["Unknown", "ConcurrentQueue", "SortSlice", "SortPoolSlice", "PairingHeap"] | ...


Near line 149: Possible spelling mistake found.
Context: ...nown", "ConcurrentQueue", "SortSlice", "SortPoolSlice", "PairingHeap"] | | <a id="rem...


Near line 149: Possible spelling mistake found.
Context: ...tQueue", "SortSlice", "SortPoolSlice", "PairingHeap"] | | <a id="remove-cfg-props" ...


Near line 149: Possible typo: you repeated a whitespace
Context: ...lice", "SortPoolSlice", "PairingHeap"] | | **remove...


Near line 155: Possible spelling mistake found.
Context: ...ove-cfg-props" /> remove_config - rpc config for remove request - type: objec...


Near line 158: Possible typo: you repeated a whitespace
Context: ...emove request - type: object | property | mandatory | description ...


Near line 158: Possible typo: you repeated a whitespace
Context: ... | mandatory | description | type | sample | | :-------------...


Near line 158: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :----------------------...


Near line 158: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :---------------------- | :-------- ...


Near line 160: Possible typo: you repeated a whitespace
Context: ...:--------- | | skip_strict_exist_check | | Check whether the same vector is alrea...


Near line 160: Possible spelling mistake found.
Context: ...uld be unique if the value is true. | bool | false | | timestamp ...


Near line 160: Possible typo: you repeated a whitespace
Context: ...be unique if the value is true. | bool | false | | timestamp ...


Near line 160: Possible typo: you repeated a whitespace
Context: ...if the value is true. | bool | false | | timestamp | ...


Near line 161: Possible typo: you repeated a whitespace
Context: ...ue`. | bool | false | | timestamp | | The timestamp of the vecto...


Near line 161: Possible typo: you repeated a whitespace
Context: ...false | | timestamp | | The timestamp of the vector inserted.<...


Near line 161: Possible typo: you repeated a whitespace
Context: ... is N/A, the current time will be used. | string | 1707272658 | <a id="object-c...


Near line 167: Possible spelling mistake found.
Context: ...ect-cfg-props" /> object_config - rpc config for get object request - type: o...


Near line 170: Possible typo: you repeated a whitespace
Context: ...bject request - type: object | property | mandatory | description ...


Near line 170: Possible typo: you repeated a whitespace
Context: ...y | mandatory | description | type | sample | | :---------------...


Near line 170: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :-------------------- | :--...


Near line 172: Possible typo: you repeated a whitespace
Context: ...--- | :----- | | filter_config.targets | | filter target host and port for bypass...


Near line 172: Possible typo: you repeated a whitespace
Context: ...bypassing filter component. | []object | | ### ValdBenchmarkScenario [`ValdBenc...


Near line 174: Possible spelling mistake found.
Context: ...r component. | []object | | ### ValdBenchmarkScenario [ValdBenchmarkScenario](https://gith...


Near line 176: This sentence does not start with an uppercase letter.
Context: ...erator/crds/valdbenchmarkscenario.yaml) is used for executing single or multiple b...


Near line 181: This sentence does not start with an uppercase letter.
Context: ...ritten when each job has own config. main properties | property | mandatory | ...


Near line 183: Possible typo: you repeated a whitespace
Context: ...** | property | mandatory | description | type | sample ...


Near line 183: Possible typo: you repeated a whitespace
Context: ... | type | sample ...


Near line 183: Possible typo: you repeated a whitespace
Context: ... | type | sample | | :------- | :-------- | :------------...


Near line 185: Possible typo: you repeated a whitespace
Context: ...----------------------------- | | target | * | target Vald cluster inform...


Near line 185: Possible typo: you repeated a whitespace
Context: ...---------------------- | | target | * | target Vald cluster information
It ...


Near line 185: Possible spelling mistake found.
Context: ...----- | | target | * | target Vald cluster information
It will be overw...


Near line 185: Possible typo: you repeated a whitespace
Context: ...g | object | ref: target | | dataset | * | dataset infor...


Near line 186: Possible typo: you repeated a whitespace
Context: ...t](#target-prop) | | dataset | * | dataset information
It ...


Near line 186: Possible typo: you repeated a whitespace
Context: ...rget-prop) | | dataset | * | dataset information
It will be over...


Near line 186: Possible typo: you repeated a whitespace
Context: ...overwritten when each job has own config | object | ref: dataset...


Near line 186: Possible typo: you repeated a whitespace
Context: ...| object | ref: dataset | | jobs | * | benchmark job...


Near line 187: Possible typo: you repeated a whitespace
Context: ...taset](#dataset-prop) | | jobs | * | benchmark job config
Th...


Near line 187: Possible typo: you repeated a whitespace
Context: ...ataset-prop) | | jobs | * | benchmark job config
The jobs writt...


Near line 187: Possible typo: you repeated a whitespace
Context: ...ritten above will be executed in order. | object | ref: [benchmark job](#valdben...


Near line 191: Possible spelling mistake found.
Context: ...ator can be applied with Helm same as Vald cluster. It requires `ValdBenchmarkOpe...


Near line 193: Possible spelling mistake found.
Context: ...elmsame as Vald cluster. It requiresValdBenchmarkOperatorReleasefor deployingvald-benchmark-operator...


Near line 193: Possible spelling mistake found.
Context: ...BenchmarkOperatorReleasefor deployingvald-benchmark-operator`. It is not must to apply, so please e...


Near line 195: After ‘must’, the verb is used without ‘to’. Probably, you should use “must” or “have to” here.
Context: ...g vald-benchmark-operator. It is not must to apply, so please edit and apply as nece...


Near line 449: Possible spelling mistake found.
Context: ...or more details of the configuration of vald-benchmark-operator-release, please refer to [here](https://github...


Near line 449: Unpaired symbol: ‘]’ seems to be missing
Context: ...mark-operator-release`, please refer to [here](https://github.com/vdaas/vald/blob...


Near line 451: Possible spelling mistake found.
Context: ...benchmark-operator/values.yaml) 1. Add Vald repo into the helm repo ```bash ...


Near line 471: Possible spelling mistake found.
Context: ...xecute continuous benchmark by applying ValdBenchmarkScenarioRelease or ValdBenchmarkJobRelease. Please ...


Near line 471: Possible spelling mistake found.
Context: ...lying ValdBenchmarkScenarioRelease or ValdBenchmarkJobRelease. Please configure designed benchmark ...


Near line 473: Possible spelling mistake found.
Context: ...nfigure designed benchmark and apply by kubectl command. The sample manifests are [he...


Near line 479: Possible spelling mistake found.
Context: ...onitoring can be set in the same way as Vald cluster. For information on building a ...


Near line 482: Possible spelling mistake found.
Context: ...ut continuous benchmarking, please edit ValdBenchmarkOperatorRelease as follows: ```yaml --- # @Schema {"n...

Additional comments not posted (2)
docs/performance/continuous-benchmark.md (2)

197-201: Ensure the notice div is correctly formatted for markdown. If it's intended to be a highlighted notice, consider using a blockquote (>) or a different markdown extension that supports the div class.


222-355: Verify that all YAML configurations are correct and align with the latest schema definitions. Ensure that all default values and mandatory fields are correctly documented.


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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
Copy link
Collaborator Author

[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

# @schema {"name": "job.image", "type": "object"}
image:
# @schema {"name": "job.image.repository", "type": "string"}
# image.repository -- job image repository
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Repository, repository
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

# @schema {"name": "job.image", "type": "object"}
image:
# @schema {"name": "job.image.repository", "type": "string"}
# image.repository -- job image repository
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: repository
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# image.repository -- job image repository
repository: vdaas/vald-benchmark-job
# @schema {"name": "job.image.tag", "type": "string"}
# image.tag -- image tag for job docker image
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Tag, tag
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

# job.client_config.connection_pool.rebalance_duration -- gRPC client connection pool rebalance duration
rebalance_duration: 30m
# @schema {"name": "job.client_config.connection_pool.size", "type": "integer"}
# job.client_config.connection_pool.size -- gRPC client connection pool size
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: size
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# job.client_config.backoff.retry_count -- gRPC client backoff retry count
retry_count: 100
# @schema {"name": "job.client_config.backoff.enable_error_log", "type": "boolean"}
# job.client_config.backoff.enable_error_log -- gRPC client backoff log enabled
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
You’ve repeated a verb. Did you mean to only write one of them? (REPEATED_VERBS[1])
Suggestions: enabled, enable
Rule: https://community.languagetool.org/rule/show/REPEATED_VERBS?lang=en-US&subId=1
Category: GRAMMAR

# job.client_config.dial_option.insecure -- gRPC client dial option insecure enabled
insecure: true
# @schema {"name": "job.client_config.dial_option.timeout", "type": "string"}
# job.client_config.dial_option.timeout -- gRPC client dial option timeout
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: timeout
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# job.client_config.dial_option.timeout -- gRPC client dial option timeout
timeout: ""
# @schema {"name": "job.client_config.dial_option.interceptors", "type": "array", "items": {"type": "string", "enum": ["TraceInterceptor"]}}
# job.client_config.dial_option.interceptors -- gRPC client interceptors
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: interceptors
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# @schema {"name": "job.client_config.dial_option.net.dialer", "type": "object"}
dialer:
# @schema {"name": "job.client_config.dial_option.net.dialer.timeout", "type": "string"}
# job.client_config.dial_option.net.dialer.timeout -- gRPC client TCP dialer timeout
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: timeout
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# @schema {"name": "job.client_config.dial_option.keepalive", "type": "object"}
keepalive:
# @schema {"name": "job.client_config.dial_option.keepalive.time", "type": "string"}
# job.client_config.dial_option.keepalive.time -- gRPC client keep alive time
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: time
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

# job.client_config.dial_option.keepalive.time -- gRPC client keep alive time
time: "120s"
# @schema {"name": "job.client_config.dial_option.keepalive.timeout", "type": "string"}
# job.client_config.dial_option.keepalive.timeout -- gRPC client keep alive timeout
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: timeout
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

image:
# @schema {"name": "job.image.repository", "type": "string"}
# image.repository -- job image repository
repository: vdaas/vald-benchmark-job
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (vdaas) Suggestions: [vasa, vaasa, vadis, Vaasa, adas]

# @schema {"name": "job.client_config", "type": "object"}
# client_config -- gRPC client config for request to the Vald cluster
client_config:
# @schema {"name": "job.client_config.addrs", "type": "array", "items": {"type": "string"}}
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (addrs) Suggestions: [addr, adds, adars, adders, Adars]

# client_config -- gRPC client config for request to the Vald cluster
client_config:
# @schema {"name": "job.client_config.addrs", "type": "array", "items": {"type": "string"}}
# job.client_config.addrs -- gRPC client addresses
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (addrs) Suggestions: [addr, adds, adars, adders, Adars]

client_config:
# @schema {"name": "job.client_config.addrs", "type": "array", "items": {"type": "string"}}
# job.client_config.addrs -- gRPC client addresses
addrs: []
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (addrs) Suggestions: [addr, adds, adars, adders, Adars]

# @schema {"name": "job.client_config.connection_pool.enable_dns_resolver", "type": "boolean"}
# job.client_config.connection_pool.enable_dns_resolver -- enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance
enable_dns_resolver: true
# @schema {"name": "job.client_config.connection_pool.enable_rebalance", "type": "boolean"}
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (rebalance) Suggestions: [rebalanced, balance, realine, replace, reliance]

# job.client_config.connection_pool.enable_dns_resolver -- enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance
enable_dns_resolver: true
# @schema {"name": "job.client_config.connection_pool.enable_rebalance", "type": "boolean"}
# job.client_config.connection_pool.enable_rebalance -- enables gRPC client connection pool rebalance
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (rebalance) Suggestions: [rebalanced, balance, realine, replace, reliance]

# job.client_config.connection_pool.enable_dns_resolver -- enables gRPC client connection pool dns resolver, when enabled vald uses ip handshake exclude dns discovery which improves network performance
enable_dns_resolver: true
# @schema {"name": "job.client_config.connection_pool.enable_rebalance", "type": "boolean"}
# job.client_config.connection_pool.enable_rebalance -- enables gRPC client connection pool rebalance
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (rebalance) Suggestions: [rebalanced, balance, realine, replace, reliance]

enable_dns_resolver: true
# @schema {"name": "job.client_config.connection_pool.enable_rebalance", "type": "boolean"}
# job.client_config.connection_pool.enable_rebalance -- enables gRPC client connection pool rebalance
enable_rebalance: true
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (rebalance) Suggestions: [rebalanced, balance, realine, replace, reliance]

# @schema {"name": "job.client_config.connection_pool.enable_rebalance", "type": "boolean"}
# job.client_config.connection_pool.enable_rebalance -- enables gRPC client connection pool rebalance
enable_rebalance: true
# @schema {"name": "job.client_config.connection_pool.rebalance_duration", "type": "string"}
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (rebalance) Suggestions: [rebalanced, balance, realine, replace, reliance]

otlp:
# @schema {"name": "observability.otlp.collector_endpoint", "type": "string"}
# Please confirm correct collector_endpoint
collector_endpoint: "opentelemetry-collector-collector.default.svc.cluster.local:4317"
Copy link
Contributor

Choose a reason for hiding this comment

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

[documents cspell] reported by reviewdog 🐶
Unknown word (opentelemetry) Suggestions: []

@@ -29,7 +29,7 @@ Continuous Benchmark Tool has following 2 components:

- Executes CRUD request to the target Vald cluster based on defined config.
- Execute steps are:
1. Load dataset (valid only for HDF5 format )
1. Load dataset (valid only for HDF5 format)
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [documents testlint] <eslint.rules.write-good> reported by reviewdog 🐶
"only" can weaken meaning (write-good)

Metrics monitoring can be set in the same way as Vald cluster.
For information on building a monitoring environment, please refer to [Observability Configuration](../user-guides/observability-configuration.md).

To monitor metrics about continuous benchmarking, please edit `ValdBenchmarkOperatorRelease` as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [documents testlint] <eslint.rules.write-good> reported by reviewdog 🐶
"monitor" is wordy or unneeded (write-good)

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: 4

@@ -2,7 +2,7 @@

## What is the Continuous Benchmark Tool?

Continuous Benchmark Tool allows you to get benchmark of Vald cluster in 24/7.
Continuous Benchmark Tool allows you to continuously benchmark the Vald cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider rephrasing to enhance clarity: "The Continuous Benchmark Tool allows you to continuously benchmark the Vald cluster, particularly useful for verifying workloads close to the production environment and before service installation when updating the Vald version."

@@ -14,7 +14,7 @@
Continuous Benchmark Tool has following 2 components:

- Benchmark Operator: Manages benchmark jobs
- Benchmark Job: Executes CRUDs request to the target Vald cluster
- Benchmark Job: Executes CRUD request to the target Vald cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

Clarify the description: "The Benchmark Job component is responsible for executing CRUD requests against the target Vald cluster."

@@ -29,7 +29,7 @@

- Executes CRUD request to the target Vald cluster based on defined config.
- Execute steps are:
1. Load dataset (valid only for HDF5 format )
1. Load dataset (valid only for HDF5 format)
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding more detail to the step description: "Load the dataset, which is only valid for the HDF5 format."

Comment on lines +477 to +498
## Monitoring Benchmark Job Metrics

Metrics monitoring can be set in the same way as Vald cluster.
For information on building a monitoring environment, please refer to [Observability Configuration](../user-guides/observability-configuration.md).

To monitor metrics about continuous benchmarking, please edit `ValdBenchmarkOperatorRelease` as follows:

```yaml
---
# @schema {"name": "observability", "type": "object"}
observability:
# @schema {"name": "observability.enabled", "type": "boolean"}
enabled: true
# @schema {"name": "observability.otlp", "type": "object"}
otlp:
# @schema {"name": "observability.otlp.collector_endpoint", "type": "string"}
# Please confirm correct collector_endpoint
collector_endpoint: "opentelemetry-collector-collector.default.svc.cluster.local:4317"
trace:
# @schema {"name": "observability.trace.enabled", "type": "boolean"}
enabled: true
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Clarify the monitoring setup instructions: "To monitor metrics related to continuous benchmarking, edit the ValdBenchmarkOperatorRelease configuration as follows:"

@vankichi vankichi merged commit 9efb3aa into release/v1.7 Apr 25, 2024
23 checks passed
@vankichi vankichi deleted the backport/release/v1.7/documentation/docs/update-con-bench-docs branch April 25, 2024 08:29
kpango added a commit that referenced this pull request May 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)

Signed-off-by: kpango <kpango@vdaas.org>
kpango added a commit that referenced this pull request May 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)

Signed-off-by: kpango <kpango@vdaas.org>
kpango added a commit that referenced this pull request May 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)

Signed-off-by: kpango <kpango@vdaas.org>
kpango added a commit that referenced this pull request Aug 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)
Sync release/v1.7 to main (#2495)
add read replica and rotator docs (#2497) (#2499)
add reviewer guideline (#2507) (#2508)
update large top-K ratio handling logic (#2509) (#2511)
Change default image tag from latest to nightly (#2516) (#2518)
Bugfix that caused an error when argument has 3 or more nil arguments (#2517) (#2520)
add faiss in values.yaml & valdrelease.yaml (#2514) (#2519)
capitalize faq (#2512) (#2522)
Backport docs updates to release/v1.7 (#2521)
[CI] Add workflow to synchronize ubuntu base image (#2526) (#2527)
fix: update schedule (#2528) (#2530)
refactor index manager service add index service API to expose index informations (#2525) (#2532)
fix conflict bug (#2537)
fix: make format (#2534) (#2540)
Backport PR #2542, #2538 to release/v1.7 (#2543)
fix: add checkout option (#2545) (#2546)
Implement ngt Statistics API (#2539) (#2547)
Add workflow to check git conflict for backport PR (#2548) (#2550)
[create-pull-request] automated change (#2552) (#2556)
Update dependencies, C++ standard, and improve Dockerfiles for better build systems and localization (#2549) (#2557)
Backport #2559 (#2560)
[BUGFIX] index correction process (#2565) (#2566)
change external docker image reference to ghcr.io registry (#2567) (#2568)
[patch] Release v1.7.13 (#2569)
:bookmark: :robot: Release v1.7.13 (#2570)
add HTTP2 support for http.Client and Vald HTTP Server (#2572) (#2575)

Signed-off-by: kpango <kpango@vdaas.org>
kpango added a commit that referenced this pull request Aug 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)
Sync release/v1.7 to main (#2495)
add read replica and rotator docs (#2497) (#2499)
add reviewer guideline (#2507) (#2508)
update large top-K ratio handling logic (#2509) (#2511)
Change default image tag from latest to nightly (#2516) (#2518)
Bugfix that caused an error when argument has 3 or more nil arguments (#2517) (#2520)
add faiss in values.yaml & valdrelease.yaml (#2514) (#2519)
capitalize faq (#2512) (#2522)
Backport docs updates to release/v1.7 (#2521)
[CI] Add workflow to synchronize ubuntu base image (#2526) (#2527)
fix: update schedule (#2528) (#2530)
refactor index manager service add index service API to expose index informations (#2525) (#2532)
fix conflict bug (#2537)
fix: make format (#2534) (#2540)
Backport PR #2542, #2538 to release/v1.7 (#2543)
fix: add checkout option (#2545) (#2546)
Implement ngt Statistics API (#2539) (#2547)
Add workflow to check git conflict for backport PR (#2548) (#2550)
[create-pull-request] automated change (#2552) (#2556)
Update dependencies, C++ standard, and improve Dockerfiles for better build systems and localization (#2549) (#2557)
Backport #2559 (#2560)
[BUGFIX] index correction process (#2565) (#2566)
change external docker image reference to ghcr.io registry (#2567) (#2568)
[patch] Release v1.7.13 (#2569)
:bookmark: :robot: Release v1.7.13 (#2570)
add HTTP2 support for http.Client and Vald HTTP Server (#2572) (#2575)

Signed-off-by: kpango <kpango@vdaas.org>
kpango added a commit that referenced this pull request Aug 8, 2024
fix: git add chart directory for release (#2356) (#2357)
[patch] release v1.7.11 (#2358)
:bookmark: :robot: Release v1.7.11 (#2360)
Change docker scan timeout longer (#2363) (#2364)
refactor code using golangci-lint (#2362) (#2365)
Create SECURITY.md (#2367) (#2368)
add commit hash build image (#2359) (#2371)
update docker build target platform selection rules (#2370) (#2374)
Make agent export index metrics to Pod k8s resource (#2319) (#2372)
backport ci deps others (#2386)
Update workflow to release readreplica chart (#2383) (#2387)
:green_heart: :recycle: Add Con-Bench helm chart to the Vald charts (#2388) (#2389)
Delete unnecessary code for mirror (#2366) (#2391)
change JP logo to EN logo (#2369) (#2392)
Add rotate-all option to rotator (#2305) (#2393)
fix: build error of internal kvs test (#2396) (#2398)
Resolve kvs already closed before last saving (#2390) (#2394)
:robot: Update license headers / Format Go codes and YAML files (#2397) (#2400)
create continous benchmark doc (#2352) (#2395)
fix: disable protobuf dispatch for client (#2401) (#2403)
update deps (#2404) (#2405)
[patch] release v1.7.12 (#2406)
:bookmark: :robot: Release v1.7.12 (#2408)
:pencil: Fix typo of file name (#2413) (#2415)
Fix agent-faiss build failed (#2418) (#2419)
Add tests for index information export (#2412) (#2414)
Fix the logic to determine docker image (#2410) (#2420)
Update build rule for nightly image (#2421) (#2422)
Fix output settings to determine-docker-image-tag action and release branch build tag name (#2423) (#2425)
Add `index-operator` template implementation (#2375) (#2424)
fix: typo of execution rule (#2426) (#2427)
Backport Flush API (#2434)
update deps & add validation for Flush API when agent is Read Only (#2433) (#2436)
docs: add hrichiksite as a contributor for doc (#2441) (#2442)
fix: bugfix version update for docker build (#2445) (#2446)
Fix index job logic to pass DNS A record (#2438) (#2448)
Added snapshot timestamp annotations to read replica agent (#2428) (#2443)
Fix operator-sdk version (#2447) (#2449)
add file name lint (#2417) (#2450)
fix: add extra option for ci-container build (#2451) (#2452)
Add base of benchmark operator dashboard (#2430) (#2453)
Implement index operator logic for read replica rotation (#2444) (#2456)
add inner product distance type for ngt (#2454) (#2458)
Fix e2e for read replica and add e2e for index operator (#2455) (#2459)
Add unit tests for index operator (#2460) (#2461)
Bugfix recreate benchmark job when operator reboot (#2463) (#2464)
Refactor k8s types (#2462) (#2465)
:robot: Automatically update PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE (#2457) (#2469)
Fix workflow trigger for backport pr creation (#2471) (#2472)
Automatically add backport main label for release-pr (#2473) (#2475)
update deps (#2468) (#2476)
Implement client metrics interceptor for continuous benchmark job (#2477) (#2480)
:chart_with_upwards_trend: Add client metrics panels for continuous benchmark job (#2481) (#2483)
Update continuous benchmark docs (#2485) (#2486)
Sync release/v1.7 to main (#2495)
add read replica and rotator docs (#2497) (#2499)
add reviewer guideline (#2507) (#2508)
update large top-K ratio handling logic (#2509) (#2511)
Change default image tag from latest to nightly (#2516) (#2518)
Bugfix that caused an error when argument has 3 or more nil arguments (#2517) (#2520)
add faiss in values.yaml & valdrelease.yaml (#2514) (#2519)
capitalize faq (#2512) (#2522)
Backport docs updates to release/v1.7 (#2521)
[CI] Add workflow to synchronize ubuntu base image (#2526) (#2527)
fix: update schedule (#2528) (#2530)
refactor index manager service add index service API to expose index informations (#2525) (#2532)
fix conflict bug (#2537)
fix: make format (#2534) (#2540)
Backport PR #2542, #2538 to release/v1.7 (#2543)
fix: add checkout option (#2545) (#2546)
Implement ngt Statistics API (#2539) (#2547)
Add workflow to check git conflict for backport PR (#2548) (#2550)
[create-pull-request] automated change (#2552) (#2556)
Update dependencies, C++ standard, and improve Dockerfiles for better build systems and localization (#2549) (#2557)
Backport #2559 (#2560)
[BUGFIX] index correction process (#2565) (#2566)
change external docker image reference to ghcr.io registry (#2567) (#2568)
[patch] Release v1.7.13 (#2569)
:bookmark: :robot: Release v1.7.13 (#2570)
add HTTP2 support for http.Client and Vald HTTP Server (#2572) (#2575)

Signed-off-by: kpango <kpango@vdaas.org>
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.

2 participants