diff --git a/VERSIONS/GO_VERSION b/VERSIONS/GO_VERSION index 013173af5..14bee92c9 100644 --- a/VERSIONS/GO_VERSION +++ b/VERSIONS/GO_VERSION @@ -1 +1 @@ -1.22.6 +1.23.2 diff --git a/VERSIONS/VALD_LATEST_VERSION b/VERSIONS/VALD_LATEST_VERSION index 36c5cb9ef..68ced4b6e 100644 --- a/VERSIONS/VALD_LATEST_VERSION +++ b/VERSIONS/VALD_LATEST_VERSION @@ -1 +1 @@ -1.7.13 +1.7.14 diff --git a/content/docs/api/flush.md b/content/docs/api/flush.md index fa5441ee7..57b196e8c 100644 --- a/content/docs/api/flush.md +++ b/content/docs/api/flush.md @@ -1,7 +1,7 @@ --- title: "Flush_api" -date: 2024-08-08T00:23:48+09:00 -draft: true +date: 2024-10-16T16:03:41+09:00 +draft: false weight: 600 description: Remove all indexes from the Vald cluster menu: diff --git a/content/docs/api/insert.md b/content/docs/api/insert.md index 400e771e5..358e4b3f3 100644 --- a/content/docs/api/insert.md +++ b/content/docs/api/insert.md @@ -1,6 +1,6 @@ --- title: "Insert_api" -date: 2024-04-25T20:33:02+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 100 description: Insert vectors to the Vald cluster @@ -111,7 +111,7 @@ Inset RPC is the method to add a new single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -237,7 +237,7 @@ It's the recommended method to insert a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -360,7 +360,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/api/object.md b/content/docs/api/object.md index fdfb032d9..a2649d463 100644 --- a/content/docs/api/object.md +++ b/content/docs/api/object.md @@ -1,6 +1,6 @@ --- title: "Object_api" -date: 2024-04-25T20:33:02+09:00 +date: 2024-10-16T16:03:41+09:00 draft: false weight: 700 description: Get object information in the Vald cluster @@ -78,7 +78,7 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -159,7 +159,7 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -253,7 +253,7 @@ Each Upsert request and response are independent. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/api/remove.md b/content/docs/api/remove.md index 768c162d2..818f84426 100644 --- a/content/docs/api/remove.md +++ b/content/docs/api/remove.md @@ -1,6 +1,6 @@ --- title: "Remove_api" -date: 2024-08-08T00:23:48+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 500 description: Remove indexes from the Vald cluster @@ -112,7 +112,7 @@ Remove RPC is the method to remove a single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -233,7 +233,7 @@ RemoveByTimestamp RPC is the method to remove vectors based on timestamp. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -355,7 +355,7 @@ It's the recommended method to remove a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -476,7 +476,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/api/search.md b/content/docs/api/search.md index e5bafa9a0..834b91713 100644 --- a/content/docs/api/search.md +++ b/content/docs/api/search.md @@ -1,6 +1,6 @@ --- title: "Search_api" -date: 2024-05-21T15:09:37+09:00 +date: 2024-10-16T16:03:41+09:00 draft: false weight: 400 description: Search ANN vectors from the Vald cluster @@ -157,7 +157,7 @@ Search RPC is the method to search vector(s) similar to the request vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -278,7 +278,7 @@ The vector with the same requested ID should be indexed into the `vald-agent` be | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -414,7 +414,7 @@ Each Search request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -550,7 +550,7 @@ Each SearchByID request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -695,7 +695,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -841,7 +841,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -957,7 +957,7 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -1075,7 +1075,7 @@ You will get a `NOT_FOUND` error if the vector isn't stored. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -1207,7 +1207,7 @@ Each LinearSearch request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -1339,7 +1339,7 @@ Each LinearSearchByID request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -1480,7 +1480,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -1622,7 +1622,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/api/update.md b/content/docs/api/update.md index 7bae3b4a6..d8a9fa1d3 100644 --- a/content/docs/api/update.md +++ b/content/docs/api/update.md @@ -1,6 +1,6 @@ --- title: "Update_api" -date: 2024-04-25T20:33:03+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 200 description: Update vectors indexed in the Vald cluster @@ -113,7 +113,7 @@ Update RPC is the method to update a single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -242,7 +242,7 @@ It's the recommended method to update the large amount of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -368,7 +368,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/api/upsert.md b/content/docs/api/upsert.md index 6acfd8c80..2aeebc786 100644 --- a/content/docs/api/upsert.md +++ b/content/docs/api/upsert.md @@ -1,6 +1,6 @@ --- title: "Upsert_api" -date: 2024-04-25T20:33:03+09:00 +date: 2024-10-16T16:03:41+09:00 draft: false weight: 300 description: Update or Insert vectors to the Vald cluster @@ -116,7 +116,7 @@ Upsert RPC is the method to update the inserted vector to a new single vector or | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -243,7 +243,7 @@ It’s the recommended method to upsert a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting @@ -367,7 +367,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/status) for more details. ### Troubleshooting diff --git a/content/docs/contributing/coding-style.md b/content/docs/contributing/coding-style.md index 0ced62988..5ac722223 100644 --- a/content/docs/contributing/coding-style.md +++ b/content/docs/contributing/coding-style.md @@ -1,6 +1,6 @@ --- title: "Coding Style_contributing" -date: 2024-08-08T00:23:46+09:00 +date: 2024-10-16T16:03:39+09:00 draft: false weight: 300 description: Coding style for Vald project @@ -1418,4 +1418,4 @@ Since each package has its purpose, we decided to apply different strategies to For the rest of the `./pkg` packages, we decided to implement the unit test for the exported function only. -Please follow the [unit test guideline](./unit-test-guideline) for more details on how to implement good unit test. +Please follow the [unit test guideline](/docs/unit-test-guideline) for more details on how to implement good unit test. diff --git a/content/docs/contributing/unit-test-guideline.md b/content/docs/contributing/unit-test-guideline.md index 30e7295ec..3dd1514a1 100644 --- a/content/docs/contributing/unit-test-guideline.md +++ b/content/docs/contributing/unit-test-guideline.md @@ -1,6 +1,6 @@ --- title: "Unit Test Guideline_contributing" -date: 2024-08-08T00:23:46+09:00 +date: 2024-10-16T16:03:39+09:00 draft: false weight: 400 description: Unit test guideline for Vald project @@ -139,7 +139,7 @@ You have to create unit tests for error patterns as the same as success patterns #### Advanced -##### Robust boudary test +##### Robust boundary test The previous section is about the basic test cases. The (robust) boundary test should be applied to cover more test coverage. diff --git a/content/docs/performance/continuous-benchmark.md b/content/docs/performance/continuous-benchmark.md index 6834900c5..ec27a5b6a 100644 --- a/content/docs/performance/continuous-benchmark.md +++ b/content/docs/performance/continuous-benchmark.md @@ -1,6 +1,6 @@ --- title: "Continuous Benchmark_performance" -date: 2024-05-20T15:12:59+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 300 description: Performance verification using continuous benchmark tool @@ -56,24 +56,24 @@ And, Benchmark Operator also applies it to the Kubernetes cluster based on `Vald **main properties** -| Name | mandatory | Description | type | sample | -| :------------------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -| target | \* | target Vald cluster | object | ref: [target](#target-prop) | -| dataset | \* | dataset information | object | ref: [dataset](#dataset-prop) | -| job_type | \* | execute job type | string enum: [insert, update, upsert, remove, search, getobject, exists] | search | -| repetition | | the number of job repetitions
default: `1` | integer | 1 | -| replica | | the number of job concurrent job executions
default: `1` | integer | 2 | -| rps | | designed request per sec to the target cluster
default: `1000` | integer | 1000 | -| concurrency_limit | | goroutine count limit for rps adjustment
default: `200` | integer | 20 | -| ttl_seconds_after_finished | | time until deletion of Pod after job end
default: `600` | integer | 120 | -| insert_config | | request config for insert job | object | ref: [config](#insert-cfg-props) | -| update_config | | request config for update job | object | ref: [config](#update-cfg-props) | -| upsert_config | | request config for upsert job | object | ref: [config](#upsert-cfg-props) | -| search_config | | request config for search job | object | ref: [config](#search-cfg-props) | -| remove_config | | request config for remove job | object | ref: [config](#remove-cfg-props) | -| object_config | | request config for object job | object | ref: [config](#object-cfg-props) | -| client_config | | gRPC client config for running benchmark job
Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/README) | -| server_config | | server config for benchmark job pod
Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/README) | +| Name | mandatory | Description | type | sample | +| :------------------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------- | +| target | \* | target Vald cluster | object | ref: [target](#target-prop) | +| dataset | \* | dataset information | object | ref: [dataset](#dataset-prop) | +| job_type | \* | execute job type | string enum: [insert, update, upsert, remove, search, getobject, exists] | search | +| repetition | | the number of job repetitions
default: `1` | integer | 1 | +| replica | | the number of job concurrent job executions
default: `1` | integer | 2 | +| rps | | designed request per sec to the target cluster
default: `1000` | integer | 1000 | +| concurrency_limit | | goroutine count limit for rps adjustment
default: `200` | integer | 20 | +| ttl_seconds_after_finished | | time until deletion of Pod after job end
default: `600` | integer | 120 | +| insert_config | | request config for insert job | object | ref: [config](#insert-cfg-props) | +| update_config | | request config for update job | object | ref: [config](#update-cfg-props) | +| upsert_config | | request config for upsert job | object | ref: [config](#upsert-cfg-props) | +| search_config | | request config for search job | object | ref: [config](#search-cfg-props) | +| remove_config | | request config for remove job | object | ref: [config](#remove-cfg-props) | +| object_config | | request config for object job | object | ref: [config](#object-cfg-props) | +| client_config | | gRPC client config for running benchmark job
Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) | +| server_config | | server config for benchmark job pod
Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) | diff --git a/content/docs/release/changelog.md b/content/docs/release/changelog.md index e97a6ff7f..07ce4ad7a 100644 --- a/content/docs/release/changelog.md +++ b/content/docs/release/changelog.md @@ -1,6 +1,6 @@ --- title: "Changelog_release" -date: 2024-08-08T00:23:46+09:00 +date: 2024-10-16T16:03:39+09:00 draft: false weight: 0 description: "" @@ -11,6 +11,148 @@ menu: # CHANGELOG +## v1.7.14 + +### Docker images + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
componentDocker pull
Agent NGT + docker pull vdaas/vald-agent-ngt:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-agent-ngt:v1.7.14 +
Agent sidecar + docker pull vdaas/vald-agent-sidecar:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-agent-sidecar:v1.7.14 +
Discoverers + docker pull vdaas/vald-discoverer-k8s:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-discoverer-k8s:v1.7.14 +
Gateways + docker pull vdaas/vald-lb-gateway:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-lb-gateway:v1.7.14
+ docker pull vdaas/vald-filter-gateway:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-filter-gateway:v1.7.14 +
Index Manager + docker pull vdaas/vald-manager-index:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-manager-index:v1.7.14 +
Helm Operator + docker pull vdaas/vald-helm-operator:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-helm-operator:v1.7.14 +
+ +### Documents + +- [GoDoc](https://pkg.go.dev/github.com/vdaas/vald@v1.7.14) +- [Helm Chart Reference](https://github.com/vdaas/vald/blob/v1.7.14/charts/vald/README.md) +- [Helm Operator Chart Reference](https://github.com/vdaas/vald/blob/v1.7.14/charts/vald-helm-operator/README.md) + +### Changes + +### :sparkles: New feature + +- Add String sorted topologicalSort [#2696](https://github.com/vdaas/vald/pull/2696) [#2698](https://github.com/vdaas/vald/pull/2698) +- Add CPU_INFO_FLAGS for Apple Silicon [#2694](https://github.com/vdaas/vald/pull/2694) [#2697](https://github.com/vdaas/vald/pull/2697) +- Add New gRPC Options and Add Reconnect Logic for connection Pool [#2685](https://github.com/vdaas/vald/pull/2685) [#2693](https://github.com/vdaas/vald/pull/2693) +- Add option to disable dns resolve [#2634](https://github.com/vdaas/vald/pull/2634) [#2641](https://github.com/vdaas/vald/pull/2641) +- Backport PR #2584 to release/v1.7 for Implement ngt property get API [#2588](https://github.com/vdaas/vald/pull/2588) +- add HTTP2 support for http.Client and Vald HTTP Server [#2572](https://github.com/vdaas/vald/pull/2572) [#2575](https://github.com/vdaas/vald/pull/2575) + +### :zap: Improve performance + +- Refactor grpc/status.withDetails function for performance [#2664](https://github.com/vdaas/vald/pull/2664) [#2668](https://github.com/vdaas/vald/pull/2668) + +### :recycle: Refactor + +- Refactor use Absolute path for Makefile [#2673](https://github.com/vdaas/vald/pull/2673) +- Refactor internal/net/grpc/client.go [#2675](https://github.com/vdaas/vald/pull/2675) +- modify ParseError to FromError for agent handler [#2667](https://github.com/vdaas/vald/pull/2667) [#2679](https://github.com/vdaas/vald/pull/2679) +- Backport PR #2674 to release/v1.7 for Refactor internal/net/grpc/client.go [#2675](https://github.com/vdaas/vald/pull/2675) +- Backport PR #2670 to release/v1.7 for Refactor use Absolute path for Makefile [#2673](https://github.com/vdaas/vald/pull/2673) +- Refactor grpc/status.withDetails function for performance [#2664](https://github.com/vdaas/vald/pull/2664) [#2668](https://github.com/vdaas/vald/pull/2668) +- Refactor for release v1.7.14 [#2639](https://github.com/vdaas/vald/pull/2639) [#2648](https://github.com/vdaas/vald/pull/2648) +- refactor(gateway): delete unused file [#2644](https://github.com/vdaas/vald/pull/2644) [#2646](https://github.com/vdaas/vald/pull/2646) +- Refactor test checkFunc condition [#2599](https://github.com/vdaas/vald/pull/2599) [#2602](https://github.com/vdaas/vald/pull/2602) +- Backport PR #2586 to release/v1.7 for modify rust package structure [#2590](https://github.com/vdaas/vald/pull/2590) +- Backport PR #2577 to release/v1.7 for refactor docker and change buildkit-syft-scanner reference to ghcr.io [#2578](https://github.com/vdaas/vald/pull/2578) + +### :bug: Bugfix + +- Fix gRPC error handling for gateway/filter handler [#2669](https://github.com/vdaas/vald/pull/2669) [#2689](https://github.com/vdaas/vald/pull/2689) +- fix: increase limit [#2683](https://github.com/vdaas/vald/pull/2683) [#2686](https://github.com/vdaas/vald/pull/2686) +- Fix gRPC error handling for mirror-gateway handler [#2665](https://github.com/vdaas/vald/pull/2665) [#2681](https://github.com/vdaas/vald/pull/2681) +- Fix gRPC error msg handling for lb-gateway handler [#2663](https://github.com/vdaas/vald/pull/2663) [#2682](https://github.com/vdaas/vald/pull/2682) +- Bugfix ingress route settings [#2636](https://github.com/vdaas/vald/pull/2636) [#2642](https://github.com/vdaas/vald/pull/2642) +- Fix broken links in the document files [#2611](https://github.com/vdaas/vald/pull/2611) [#2614](https://github.com/vdaas/vald/pull/2614) +- Fix: make command name [#2610](https://github.com/vdaas/vald/pull/2610) [#2612](https://github.com/vdaas/vald/pull/2612) +- Bugfix NGT flush logic [#2598](https://github.com/vdaas/vald/pull/2598) [#2606](https://github.com/vdaas/vald/pull/2606) + +### :pencil2: Document + +- Fix broken links in the document files [#2611](https://github.com/vdaas/vald/pull/2611) [#2614](https://github.com/vdaas/vald/pull/2614) + +### :white_check_mark: Testing + +- Refactor test checkFunc condition [#2599](https://github.com/vdaas/vald/pull/2599) [#2602](https://github.com/vdaas/vald/pull/2602) + +### :green_heart: CI + +- Buf CLI migrate to v2 [#2691](https://github.com/vdaas/vald/pull/2691) [#2695](https://github.com/vdaas/vald/pull/2695) +- [create-pull-request] automated change [#2677](https://github.com/vdaas/vald/pull/2677) [#2678](https://github.com/vdaas/vald/pull/2678) +- automatically generate workflows [#2595](https://github.com/vdaas/vald/pull/2595) [#2603](https://github.com/vdaas/vald/pull/2603) + +### :chart_with_upwards_trend: Metrics/Tracing + +- Introduce an observability crate using opentelemetry-rust [#2535](https://github.com/vdaas/vald/pull/2535) [#2609](https://github.com/vdaas/vald/pull/2609) + + + +## Summary by CodeRabbit + +- **New Features** + + - Added several new contributors to the project, enhancing community involvement. + - Introduced a new configuration file for spell checking, improving documentation quality. + - Expanded the project with new configuration files, documentation, and source code for enhanced functionality. + +- **Bug Fixes** + + - Updated version information in issue templates for accuracy. + +- **Documentation** + + - Improved clarity in the pull request template and updated version information. + +- **Chores** + - Modified GitHub Actions for better handling of Docker image tags. + + + ## v1.7.13 ### Docker images diff --git a/content/docs/troubleshooting/client-side.md b/content/docs/troubleshooting/client-side.md index 1ccabccb9..b89d9579f 100644 --- a/content/docs/troubleshooting/client-side.md +++ b/content/docs/troubleshooting/client-side.md @@ -1,6 +1,6 @@ --- title: "Client Side_troubleshooting" -date: 2024-08-08T00:23:46+09:00 +date: 2024-10-16T16:03:39+09:00 draft: false weight: 100 description: The popular troubleshooting for client side @@ -66,4 +66,4 @@ Please check your CPU information. - [Provisioning Troubleshooting](/docs/troubleshooting/provisioning) - [API Status](/docs/api/status) -- [FAQ](/docs/support/FAQ) +- [FAQ](/docs/support/faq) diff --git a/content/docs/tutorial/get-started-with-faiss-agent.md b/content/docs/tutorial/get-started-with-faiss-agent.md index 1817092cb..f866123a6 100644 --- a/content/docs/tutorial/get-started-with-faiss-agent.md +++ b/content/docs/tutorial/get-started-with-faiss-agent.md @@ -1,6 +1,6 @@ --- title: "Get Started With Faiss Agent_tutorial" -date: 2024-08-08T00:23:47+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 200 description: Running Vald cluster with faiss Agent on Kubernetes and execute client codes @@ -11,7 +11,7 @@ menu: # Get Started -This tutorial is for those who have already completed [Get Started](https://github.com/vdaas/vald/blob/main/docs/tutorial/get-started). +This tutorial is for those who have already completed [Get Started](/docs/tutorial/get-started). Please refer to Prepare the Kubernetes Cluster and others there. ## Deploy Vald on Kubernetes Cluster @@ -71,6 +71,7 @@ In this tutorial, you will deploy the basic configuration of Vald that is consis load_index_timeout_factor: 1ms m: 8 # dimension % m == 0, train size >= 2^m(or nlist) * minPointsPerCentroid max_load_index_timeout: 10m + method_type: "ivfpq" metric_type: "innerproduct" min_load_index_timeout: 3m nbits_per_idx: 8 @@ -288,7 +289,7 @@ If you are interested, please refer to [SDKs](/docs/user-guides/sdks).
```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithInsecure()) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithInsecure()) if err != nil { glg.Fatal(err) } diff --git a/content/docs/tutorial/get-started.md b/content/docs/tutorial/get-started.md index 369d731d8..7110d2ec4 100644 --- a/content/docs/tutorial/get-started.md +++ b/content/docs/tutorial/get-started.md @@ -1,6 +1,6 @@ --- title: "Get Started_tutorial" -date: 2024-05-21T13:22:43+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 100 description: Running Vald cluster with NGT Agent on Kubernetes and execute client codes @@ -344,7 +344,7 @@ If you are interested, please refer to [SDKs](/docs/user-guides/sdks).
```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { glg.Fatal(err) } diff --git a/content/docs/tutorial/vald-agent-standalone-on-k8s.md b/content/docs/tutorial/vald-agent-standalone-on-k8s.md index 64a52a3e3..8d793ead3 100644 --- a/content/docs/tutorial/vald-agent-standalone-on-k8s.md +++ b/content/docs/tutorial/vald-agent-standalone-on-k8s.md @@ -1,6 +1,6 @@ --- title: "Vald Agent Standalone on K8s_tutorial" -date: 2024-05-20T15:12:59+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 300 description: Running only Vald Agent on Kubernetes and execute client codes @@ -247,7 +247,7 @@ This chapter uses [NGT](https://github.com/yahoojapan/ngt) as Vald Agent to perf ```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { glg.Fatal(err) } diff --git a/content/docs/tutorial/vald-multicluster-on-k8s.md b/content/docs/tutorial/vald-multicluster-on-k8s.md index eff00d8f9..77bf28fd8 100644 --- a/content/docs/tutorial/vald-multicluster-on-k8s.md +++ b/content/docs/tutorial/vald-multicluster-on-k8s.md @@ -1,6 +1,6 @@ --- title: "Vald Multicluster on K8s_tutorial" -date: 2024-08-08T00:23:47+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 500 description: Running Multi Vald Clusters with Mirror Gateway on Kubernetes and execute client codes @@ -99,7 +99,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n git clone https://github.com/vdaas/vald.git &&　cd vald ``` -2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-01 charts/vald \ @@ -108,7 +108,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n -n vald-01 ``` -3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-02 charts/vald \ @@ -117,7 +117,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n -n vald-02 ``` -4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-03 charts/vald \ @@ -205,7 +205,7 @@ It requires applying the `ValdMirrorTarget` Custom Resource to the one Namespace When applied successfully, the destination information is automatically created on other Namespaces when interconnected with each `vald-mirror-gateway`. -This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/tree/main/charts/vald/values/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command. +This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command. ```bash kubectl apply -f ./charts/vald/values/multi-vald/mirror-target.yaml -n vald-03 @@ -266,7 +266,7 @@ If you are interested, please refer to [SDKs](https://vald.vdaas.org/docs/user- 3. Run Example - We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/feature/mirror-gateway-example/example/client/mirror/main.go) to run the example. + We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/main/example/client/mirror/main.go) to run the example. This example will insert and index 400 vectors into the Vald cluster from the Fashion-MNIST dataset via [gRPC](https://grpc.io/). And then, after waiting for indexing, it will request to search the nearest vector 10 times to all Vald clusters. You will get the 10 nearest neighbor vectors for each search query. diff --git a/content/docs/user-guides/client-api-config.md b/content/docs/user-guides/client-api-config.md index f89bb5f9a..798348264 100644 --- a/content/docs/user-guides/client-api-config.md +++ b/content/docs/user-guides/client-api-config.md @@ -1,6 +1,6 @@ --- title: "Client Api Config_user Guides" -date: 2024-02-15T17:10:13+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 1000 description: Shows more detailed explanation about APIs configuration @@ -57,7 +57,7 @@ func main() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -173,7 +173,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -297,7 +297,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -481,7 +481,7 @@ func main() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -664,7 +664,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } diff --git a/content/docs/user-guides/cluster-role-binding.md b/content/docs/user-guides/cluster-role-binding.md index 07c036c98..2a6de8730 100644 --- a/content/docs/user-guides/cluster-role-binding.md +++ b/content/docs/user-guides/cluster-role-binding.md @@ -1,6 +1,6 @@ --- title: "Cluster Role Binding_user Guides" -date: 2024-02-15T17:10:14+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 500 description: Configures cluster role for Vald cluster @@ -152,7 +152,7 @@ In this section, we will describe how to configure it and how to customize these ### Cluster role configuration for Vald Mirror Gateway -By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gatewat/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`. +By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gateway/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`. ```yaml apiVersion: rbac.authorization.k8s.io/v1 diff --git a/content/docs/user-guides/filtering-configuration.md b/content/docs/user-guides/filtering-configuration.md index a0ec05e4a..0c96c8873 100644 --- a/content/docs/user-guides/filtering-configuration.md +++ b/content/docs/user-guides/filtering-configuration.md @@ -1,6 +1,6 @@ --- title: "Filtering Configuration_user Guides" -date: 2024-01-10T18:16:45+09:00 +date: 2024-10-16T16:03:39+09:00 draft: false weight: 300 description: Applies filtering feature to the Vald cluster @@ -164,7 +164,7 @@ func main() { // connect to the Vald cluster ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithInsecure()) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithInsecure()) if err != nil { log.Error(err) return diff --git a/content/docs/user-guides/mirroring-configuration.md b/content/docs/user-guides/mirroring-configuration.md index e51e2b3f7..0078c6322 100644 --- a/content/docs/user-guides/mirroring-configuration.md +++ b/content/docs/user-guides/mirroring-configuration.md @@ -1,6 +1,6 @@ --- title: "Mirroring Configuration_user Guides" -date: 2024-02-15T17:10:15+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 400 description: Applies mirror gateway for running multi Vald clusters @@ -69,7 +69,7 @@ gateway: The cluster role configuration is required when you deploy Vald clusters with Vald Mirror Gateway on multiple Namespaces in the Kubernetes cluster. -Please refer to [Cluster Role Configuration](./cluster-role-binding) about cluster role settings for Mirror Gateway. +Please refer to [Cluster Role Configuration](/docs/user-guides/cluster-role-binding) about cluster role settings for Mirror Gateway. ### Custom Resource Configuration diff --git a/content/docs/user-guides/observability-configuration.md b/content/docs/user-guides/observability-configuration.md index a26c4883c..7959eb016 100644 --- a/content/docs/user-guides/observability-configuration.md +++ b/content/docs/user-guides/observability-configuration.md @@ -1,6 +1,6 @@ --- title: "Observability Configuration_user Guides" -date: 2024-08-08T00:23:47+09:00 +date: 2024-10-16T16:03:40+09:00 draft: false weight: 1100 description: Monitors performance on metrics dashboards @@ -187,7 +187,7 @@ defaults: #### Specify the Telemetry attribute -You can add the component information to the attribute of telemetry data by editing `defaults.observability.otlp.attirbute`. +You can add the component information to the attribute of telemetry data by editing `defaults.observability.otlp.attribute`. E.g., when setting `vald-agent-ngt-0` as `agent.observability.otlp.attribute.pod_name`, `target_pod: vald-agent-ngt-0` will be added to the attribute. These attributes are set auto by the environment values, so Vald recommends using default values unless there is a specific reason. diff --git a/content/docs/v1.7/api/flush.md b/content/docs/v1.7/api/flush.md index 2de5c04d5..c276a392f 100644 --- a/content/docs/v1.7/api/flush.md +++ b/content/docs/v1.7/api/flush.md @@ -1,7 +1,7 @@ --- title: "Flush_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 -draft: true +date: 2024-10-16T16:06:00+09:00 +draft: false weight: 600 description: Remove all indexes from the Vald cluster menu: diff --git a/content/docs/v1.7/api/insert.md b/content/docs/v1.7/api/insert.md index 2b72766b1..ae0b252f0 100644 --- a/content/docs/v1.7/api/insert.md +++ b/content/docs/v1.7/api/insert.md @@ -1,6 +1,6 @@ --- title: "Insert_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 100 description: Insert vectors to the Vald cluster @@ -111,7 +111,7 @@ Inset RPC is the method to add a new single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -237,7 +237,7 @@ It's the recommended method to insert a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -360,7 +360,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/api/object.md b/content/docs/v1.7/api/object.md index d0e279a59..f75e89ff8 100644 --- a/content/docs/v1.7/api/object.md +++ b/content/docs/v1.7/api/object.md @@ -1,6 +1,6 @@ --- title: "Object_v1.7/Api" -date: 2024-04-25T20:34:53+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 700 description: Get object information in the Vald cluster @@ -78,7 +78,7 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -159,7 +159,7 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -253,7 +253,7 @@ Each Upsert request and response are independent. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/api/remove.md b/content/docs/v1.7/api/remove.md index 4a81231ad..583c33734 100644 --- a/content/docs/v1.7/api/remove.md +++ b/content/docs/v1.7/api/remove.md @@ -1,6 +1,6 @@ --- title: "Remove_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 500 description: Remove indexes from the Vald cluster @@ -112,7 +112,7 @@ Remove RPC is the method to remove a single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -233,7 +233,7 @@ RemoveByTimestamp RPC is the method to remove vectors based on timestamp. | 5 | NOT_FOUND | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -355,7 +355,7 @@ It's the recommended method to remove a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -476,7 +476,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/api/search.md b/content/docs/v1.7/api/search.md index 31709aa2e..5f4711cc9 100644 --- a/content/docs/v1.7/api/search.md +++ b/content/docs/v1.7/api/search.md @@ -1,6 +1,6 @@ --- title: "Search_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 400 description: Search ANN vectors from the Vald cluster @@ -157,7 +157,7 @@ Search RPC is the method to search vector(s) similar to the request vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -278,7 +278,7 @@ The vector with the same requested ID should be indexed into the `vald-agent` be | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -414,7 +414,7 @@ Each Search request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -550,7 +550,7 @@ Each SearchByID request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -695,7 +695,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -841,7 +841,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -957,7 +957,7 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -1075,7 +1075,7 @@ You will get a `NOT_FOUND` error if the vector isn't stored. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -1207,7 +1207,7 @@ Each LinearSearch request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -1339,7 +1339,7 @@ Each LinearSearchByID request and response are independent. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -1480,7 +1480,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -1622,7 +1622,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/api/update.md b/content/docs/v1.7/api/update.md index a16f33f17..e7647c9c4 100644 --- a/content/docs/v1.7/api/update.md +++ b/content/docs/v1.7/api/update.md @@ -1,6 +1,6 @@ --- title: "Update_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 200 description: Update vectors indexed in the Vald cluster @@ -113,7 +113,7 @@ Update RPC is the method to update a single vector. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -242,7 +242,7 @@ It's the recommended method to update the large amount of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -368,7 +368,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/api/upsert.md b/content/docs/v1.7/api/upsert.md index 0579064a9..e96f1d851 100644 --- a/content/docs/v1.7/api/upsert.md +++ b/content/docs/v1.7/api/upsert.md @@ -1,6 +1,6 @@ --- title: "Upsert_v1.7/Api" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 300 description: Update or Insert vectors to the Vald cluster @@ -116,7 +116,7 @@ Upsert RPC is the method to update the inserted vector to a new single vector or | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -243,7 +243,7 @@ It’s the recommended method to upsert a large number of vectors. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting @@ -367,7 +367,7 @@ Please be careful that the size of the request exceeds the limit. | 10 | ABORTED | | 13 | INTERNAL | -Please refer to [Response Status Code](./status) for more details. +Please refer to [Response Status Code](/docs/v1.7/status) for more details. ### Troubleshooting diff --git a/content/docs/v1.7/contributing/coding-style.md b/content/docs/v1.7/contributing/coding-style.md index ddb98f220..a0d056f88 100644 --- a/content/docs/v1.7/contributing/coding-style.md +++ b/content/docs/v1.7/contributing/coding-style.md @@ -1,6 +1,6 @@ --- title: "Coding Style_v1.7/Contributing" -date: 2024-08-08T10:35:16+09:00 +date: 2024-10-16T16:05:58+09:00 draft: false weight: 300 description: Coding style for Vald project @@ -1418,4 +1418,4 @@ Since each package has its purpose, we decided to apply different strategies to For the rest of the `./pkg` packages, we decided to implement the unit test for the exported function only. -Please follow the [unit test guideline](./unit-test-guideline) for more details on how to implement good unit test. +Please follow the [unit test guideline](/docs/v1.7/unit-test-guideline) for more details on how to implement good unit test. diff --git a/content/docs/v1.7/contributing/unit-test-guideline.md b/content/docs/v1.7/contributing/unit-test-guideline.md index ecbd3e26d..558c01e3d 100644 --- a/content/docs/v1.7/contributing/unit-test-guideline.md +++ b/content/docs/v1.7/contributing/unit-test-guideline.md @@ -1,6 +1,6 @@ --- title: "Unit Test Guideline_v1.7/Contributing" -date: 2024-08-08T10:35:16+09:00 +date: 2024-10-16T16:05:58+09:00 draft: false weight: 400 description: Unit test guideline for Vald project @@ -139,7 +139,7 @@ You have to create unit tests for error patterns as the same as success patterns #### Advanced -##### Robust boudary test +##### Robust boundary test The previous section is about the basic test cases. The (robust) boundary test should be applied to cover more test coverage. diff --git a/content/docs/v1.7/overview/component/agent.md b/content/docs/v1.7/overview/component/agent.md index 7dff21492..e35e60a88 100644 --- a/content/docs/v1.7/overview/component/agent.md +++ b/content/docs/v1.7/overview/component/agent.md @@ -1,6 +1,6 @@ --- title: "Agent_v1.7/Overview/Component" -date: 2024-08-08T10:35:19+09:00 +date: 2024-10-16T16:06:01+09:00 draft: false weight: 100 description: Stores index data and Search ANN vectors @@ -87,7 +87,7 @@ This image shows the mechanism to create NGT index. NGT Index Creation Mechanism -Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@v1.7.13/pkg/agent/core/ngt/service) for other functions. +Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@v1.7.14/pkg/agent/core/ngt/service) for other functions. #### Vald Agent Faiss diff --git a/content/docs/v1.7/performance/continuous-benchmark.md b/content/docs/v1.7/performance/continuous-benchmark.md index 6221d049f..dcf63b655 100644 --- a/content/docs/v1.7/performance/continuous-benchmark.md +++ b/content/docs/v1.7/performance/continuous-benchmark.md @@ -1,6 +1,6 @@ --- title: "Continuous Benchmark_v1.7/Performance" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 300 description: Performance verification using continuous benchmark tool @@ -56,24 +56,24 @@ And, Benchmark Operator also applies it to the Kubernetes cluster based on `Vald **main properties** -| Name | mandatory | Description | type | sample | -| :------------------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -| target | \* | target Vald cluster | object | ref: [target](#target-prop) | -| dataset | \* | dataset information | object | ref: [dataset](#dataset-prop) | -| job_type | \* | execute job type | string enum: [insert, update, upsert, remove, search, getobject, exists] | search | -| repetition | | the number of job repetitions
default: `1` | integer | 1 | -| replica | | the number of job concurrent job executions
default: `1` | integer | 2 | -| rps | | designed request per sec to the target cluster
default: `1000` | integer | 1000 | -| concurrency_limit | | goroutine count limit for rps adjustment
default: `200` | integer | 20 | -| ttl_seconds_after_finished | | time until deletion of Pod after job end
default: `600` | integer | 120 | -| insert_config | | request config for insert job | object | ref: [config](#insert-cfg-props) | -| update_config | | request config for update job | object | ref: [config](#update-cfg-props) | -| upsert_config | | request config for upsert job | object | ref: [config](#upsert-cfg-props) | -| search_config | | request config for search job | object | ref: [config](#search-cfg-props) | -| remove_config | | request config for remove job | object | ref: [config](#remove-cfg-props) | -| object_config | | request config for object job | object | ref: [config](#object-cfg-props) | -| client_config | | gRPC client config for running benchmark job
Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/README) | -| server_config | | server config for benchmark job pod
Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/README) | +| Name | mandatory | Description | type | sample | +| :------------------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------- | +| target | \* | target Vald cluster | object | ref: [target](#target-prop) | +| dataset | \* | dataset information | object | ref: [dataset](#dataset-prop) | +| job_type | \* | execute job type | string enum: [insert, update, upsert, remove, search, getobject, exists] | search | +| repetition | | the number of job repetitions
default: `1` | integer | 1 | +| replica | | the number of job concurrent job executions
default: `1` | integer | 2 | +| rps | | designed request per sec to the target cluster
default: `1000` | integer | 1000 | +| concurrency_limit | | goroutine count limit for rps adjustment
default: `200` | integer | 20 | +| ttl_seconds_after_finished | | time until deletion of Pod after job end
default: `600` | integer | 120 | +| insert_config | | request config for insert job | object | ref: [config](#insert-cfg-props) | +| update_config | | request config for update job | object | ref: [config](#update-cfg-props) | +| upsert_config | | request config for upsert job | object | ref: [config](#upsert-cfg-props) | +| search_config | | request config for search job | object | ref: [config](#search-cfg-props) | +| remove_config | | request config for remove job | object | ref: [config](#remove-cfg-props) | +| object_config | | request config for object job | object | ref: [config](#object-cfg-props) | +| client_config | | gRPC client config for running benchmark job
Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) | +| server_config | | server config for benchmark job pod
Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) | diff --git a/content/docs/v1.7/release/changelog.md b/content/docs/v1.7/release/changelog.md index 8fef5c002..74a9094e3 100644 --- a/content/docs/v1.7/release/changelog.md +++ b/content/docs/v1.7/release/changelog.md @@ -1,6 +1,6 @@ --- title: "Changelog_v1.7/Release" -date: 2024-08-08T10:35:17+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 0 description: "" @@ -11,6 +11,148 @@ menu: # CHANGELOG +## v1.7.14 + +### Docker images + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
componentDocker pull
Agent NGT + docker pull vdaas/vald-agent-ngt:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-agent-ngt:v1.7.14 +
Agent sidecar + docker pull vdaas/vald-agent-sidecar:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-agent-sidecar:v1.7.14 +
Discoverers + docker pull vdaas/vald-discoverer-k8s:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-discoverer-k8s:v1.7.14 +
Gateways + docker pull vdaas/vald-lb-gateway:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-lb-gateway:v1.7.14
+ docker pull vdaas/vald-filter-gateway:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-filter-gateway:v1.7.14 +
Index Manager + docker pull vdaas/vald-manager-index:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-manager-index:v1.7.14 +
Helm Operator + docker pull vdaas/vald-helm-operator:v1.7.14
+ docker pull ghcr.io/vdaas/vald/vald-helm-operator:v1.7.14 +
+ +### Documents + +- [GoDoc](https://pkg.go.dev/github.com/vdaas/vald@v1.7.14) +- [Helm Chart Reference](https://github.com/vdaas/vald/blob/v1.7.14/charts/vald/README.md) +- [Helm Operator Chart Reference](https://github.com/vdaas/vald/blob/v1.7.14/charts/vald-helm-operator/README.md) + +### Changes + +### :sparkles: New feature + +- Add String sorted topologicalSort [#2696](https://github.com/vdaas/vald/pull/2696) [#2698](https://github.com/vdaas/vald/pull/2698) +- Add CPU_INFO_FLAGS for Apple Silicon [#2694](https://github.com/vdaas/vald/pull/2694) [#2697](https://github.com/vdaas/vald/pull/2697) +- Add New gRPC Options and Add Reconnect Logic for connection Pool [#2685](https://github.com/vdaas/vald/pull/2685) [#2693](https://github.com/vdaas/vald/pull/2693) +- Add option to disable dns resolve [#2634](https://github.com/vdaas/vald/pull/2634) [#2641](https://github.com/vdaas/vald/pull/2641) +- Backport PR #2584 to release/v1.7 for Implement ngt property get API [#2588](https://github.com/vdaas/vald/pull/2588) +- add HTTP2 support for http.Client and Vald HTTP Server [#2572](https://github.com/vdaas/vald/pull/2572) [#2575](https://github.com/vdaas/vald/pull/2575) + +### :zap: Improve performance + +- Refactor grpc/status.withDetails function for performance [#2664](https://github.com/vdaas/vald/pull/2664) [#2668](https://github.com/vdaas/vald/pull/2668) + +### :recycle: Refactor + +- Refactor use Absolute path for Makefile [#2673](https://github.com/vdaas/vald/pull/2673) +- Refactor internal/net/grpc/client.go [#2675](https://github.com/vdaas/vald/pull/2675) +- modify ParseError to FromError for agent handler [#2667](https://github.com/vdaas/vald/pull/2667) [#2679](https://github.com/vdaas/vald/pull/2679) +- Backport PR #2674 to release/v1.7 for Refactor internal/net/grpc/client.go [#2675](https://github.com/vdaas/vald/pull/2675) +- Backport PR #2670 to release/v1.7 for Refactor use Absolute path for Makefile [#2673](https://github.com/vdaas/vald/pull/2673) +- Refactor grpc/status.withDetails function for performance [#2664](https://github.com/vdaas/vald/pull/2664) [#2668](https://github.com/vdaas/vald/pull/2668) +- Refactor for release v1.7.14 [#2639](https://github.com/vdaas/vald/pull/2639) [#2648](https://github.com/vdaas/vald/pull/2648) +- refactor(gateway): delete unused file [#2644](https://github.com/vdaas/vald/pull/2644) [#2646](https://github.com/vdaas/vald/pull/2646) +- Refactor test checkFunc condition [#2599](https://github.com/vdaas/vald/pull/2599) [#2602](https://github.com/vdaas/vald/pull/2602) +- Backport PR #2586 to release/v1.7 for modify rust package structure [#2590](https://github.com/vdaas/vald/pull/2590) +- Backport PR #2577 to release/v1.7 for refactor docker and change buildkit-syft-scanner reference to ghcr.io [#2578](https://github.com/vdaas/vald/pull/2578) + +### :bug: Bugfix + +- Fix gRPC error handling for gateway/filter handler [#2669](https://github.com/vdaas/vald/pull/2669) [#2689](https://github.com/vdaas/vald/pull/2689) +- fix: increase limit [#2683](https://github.com/vdaas/vald/pull/2683) [#2686](https://github.com/vdaas/vald/pull/2686) +- Fix gRPC error handling for mirror-gateway handler [#2665](https://github.com/vdaas/vald/pull/2665) [#2681](https://github.com/vdaas/vald/pull/2681) +- Fix gRPC error msg handling for lb-gateway handler [#2663](https://github.com/vdaas/vald/pull/2663) [#2682](https://github.com/vdaas/vald/pull/2682) +- Bugfix ingress route settings [#2636](https://github.com/vdaas/vald/pull/2636) [#2642](https://github.com/vdaas/vald/pull/2642) +- Fix broken links in the document files [#2611](https://github.com/vdaas/vald/pull/2611) [#2614](https://github.com/vdaas/vald/pull/2614) +- Fix: make command name [#2610](https://github.com/vdaas/vald/pull/2610) [#2612](https://github.com/vdaas/vald/pull/2612) +- Bugfix NGT flush logic [#2598](https://github.com/vdaas/vald/pull/2598) [#2606](https://github.com/vdaas/vald/pull/2606) + +### :pencil2: Document + +- Fix broken links in the document files [#2611](https://github.com/vdaas/vald/pull/2611) [#2614](https://github.com/vdaas/vald/pull/2614) + +### :white_check_mark: Testing + +- Refactor test checkFunc condition [#2599](https://github.com/vdaas/vald/pull/2599) [#2602](https://github.com/vdaas/vald/pull/2602) + +### :green_heart: CI + +- Buf CLI migrate to v2 [#2691](https://github.com/vdaas/vald/pull/2691) [#2695](https://github.com/vdaas/vald/pull/2695) +- [create-pull-request] automated change [#2677](https://github.com/vdaas/vald/pull/2677) [#2678](https://github.com/vdaas/vald/pull/2678) +- automatically generate workflows [#2595](https://github.com/vdaas/vald/pull/2595) [#2603](https://github.com/vdaas/vald/pull/2603) + +### :chart_with_upwards_trend: Metrics/Tracing + +- Introduce an observability crate using opentelemetry-rust [#2535](https://github.com/vdaas/vald/pull/2535) [#2609](https://github.com/vdaas/vald/pull/2609) + + + +## Summary by CodeRabbit + +- **New Features** + + - Added several new contributors to the project, enhancing community involvement. + - Introduced a new configuration file for spell checking, improving documentation quality. + - Expanded the project with new configuration files, documentation, and source code for enhanced functionality. + +- **Bug Fixes** + + - Updated version information in issue templates for accuracy. + +- **Documentation** + + - Improved clarity in the pull request template and updated version information. + +- **Chores** + - Modified GitHub Actions for better handling of Docker image tags. + + + ## v1.7.13 ### Docker images diff --git a/content/docs/v1.7/troubleshooting/client-side.md b/content/docs/v1.7/troubleshooting/client-side.md index 4dd6d4cb4..9ef51c5e1 100644 --- a/content/docs/v1.7/troubleshooting/client-side.md +++ b/content/docs/v1.7/troubleshooting/client-side.md @@ -1,6 +1,6 @@ --- title: "Client Side_v1.7/Troubleshooting" -date: 2024-08-08T10:35:17+09:00 +date: 2024-10-16T16:05:58+09:00 draft: false weight: 100 description: The popular troubleshooting for client side @@ -66,4 +66,4 @@ Please check your CPU information. - [Provisioning Troubleshooting](/docs/v1.7/troubleshooting/provisioning) - [API Status](/docs/v1.7/api/status) -- [FAQ](/docs/v1.7/support/FAQ) +- [FAQ](/docs/support/faq) diff --git a/content/docs/v1.7/tutorial/get-started-with-faiss-agent.md b/content/docs/v1.7/tutorial/get-started-with-faiss-agent.md index 2c8e1dfab..79b05fa76 100644 --- a/content/docs/v1.7/tutorial/get-started-with-faiss-agent.md +++ b/content/docs/v1.7/tutorial/get-started-with-faiss-agent.md @@ -1,6 +1,6 @@ --- title: "Get Started With Faiss Agent_v1.7/Tutorial" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 200 description: Running Vald cluster with faiss Agent on Kubernetes and execute client codes @@ -11,7 +11,7 @@ menu: # Get Started -This tutorial is for those who have already completed [Get Started](https://github.com/vdaas/vald/blob/main/docs/tutorial/get-started). +This tutorial is for those who have already completed [Get Started](/docs/v1.7/tutorial/get-started). Please refer to Prepare the Kubernetes Cluster and others there. ## Deploy Vald on Kubernetes Cluster @@ -71,6 +71,7 @@ In this tutorial, you will deploy the basic configuration of Vald that is consis load_index_timeout_factor: 1ms m: 8 # dimension % m == 0, train size >= 2^m(or nlist) * minPointsPerCentroid max_load_index_timeout: 10m + method_type: "ivfpq" metric_type: "innerproduct" min_load_index_timeout: 3m nbits_per_idx: 8 @@ -288,7 +289,7 @@ If you are interested, please refer to [SDKs](/docs/v1.7/user-guides/sdks).
```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithInsecure()) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithInsecure()) if err != nil { glg.Fatal(err) } diff --git a/content/docs/v1.7/tutorial/get-started.md b/content/docs/v1.7/tutorial/get-started.md index d7d8e373f..76f885e2d 100644 --- a/content/docs/v1.7/tutorial/get-started.md +++ b/content/docs/v1.7/tutorial/get-started.md @@ -1,6 +1,6 @@ --- title: "Get Started_v1.7/Tutorial" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 100 description: Running Vald cluster with NGT Agent on Kubernetes and execute client codes @@ -344,7 +344,7 @@ If you are interested, please refer to [SDKs](/docs/v1.7/user-guides/sdks).
```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { glg.Fatal(err) } diff --git a/content/docs/v1.7/tutorial/vald-agent-standalone-on-k8s.md b/content/docs/v1.7/tutorial/vald-agent-standalone-on-k8s.md index 0f0989ace..73e0a92a6 100644 --- a/content/docs/v1.7/tutorial/vald-agent-standalone-on-k8s.md +++ b/content/docs/v1.7/tutorial/vald-agent-standalone-on-k8s.md @@ -1,6 +1,6 @@ --- title: "Vald Agent Standalone on K8s_v1.7/Tutorial" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 300 description: Running only Vald Agent on Kubernetes and execute client codes @@ -247,7 +247,7 @@ This chapter uses [NGT](https://github.com/yahoojapan/ngt) as Vald Agent to perf ```go ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { glg.Fatal(err) } diff --git a/content/docs/v1.7/tutorial/vald-multicluster-on-k8s.md b/content/docs/v1.7/tutorial/vald-multicluster-on-k8s.md index 088be28ec..97f6a9c2b 100644 --- a/content/docs/v1.7/tutorial/vald-multicluster-on-k8s.md +++ b/content/docs/v1.7/tutorial/vald-multicluster-on-k8s.md @@ -1,6 +1,6 @@ --- title: "Vald Multicluster on K8s_v1.7/Tutorial" -date: 2024-08-08T10:35:18+09:00 +date: 2024-10-16T16:06:00+09:00 draft: false weight: 500 description: Running Multi Vald Clusters with Mirror Gateway on Kubernetes and execute client codes @@ -99,7 +99,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n git clone https://github.com/vdaas/vald.git &&　cd vald ``` -2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-01 charts/vald \ @@ -108,7 +108,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n -n vald-01 ``` -3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-02 charts/vald \ @@ -117,7 +117,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n -n vald-02 ``` -4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) +4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml) ```bash helm install vald-cluster-03 charts/vald \ @@ -205,7 +205,7 @@ It requires applying the `ValdMirrorTarget` Custom Resource to the one Namespace When applied successfully, the destination information is automatically created on other Namespaces when interconnected with each `vald-mirror-gateway`. -This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/tree/main/charts/vald/values/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command. +This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command. ```bash kubectl apply -f ./charts/vald/values/multi-vald/mirror-target.yaml -n vald-03 @@ -266,7 +266,7 @@ If you are interested, please refer to [SDKs](https://vald.vdaas.org/docs/user- 3. Run Example - We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/feature/mirror-gateway-example/example/client/mirror/main.go) to run the example. + We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/main/example/client/mirror/main.go) to run the example. This example will insert and index 400 vectors into the Vald cluster from the Fashion-MNIST dataset via [gRPC](https://grpc.io/). And then, after waiting for indexing, it will request to search the nearest vector 10 times to all Vald clusters. You will get the 10 nearest neighbor vectors for each search query. diff --git a/content/docs/v1.7/user-guides/client-api-config.md b/content/docs/v1.7/user-guides/client-api-config.md index f8a665183..232612d8c 100644 --- a/content/docs/v1.7/user-guides/client-api-config.md +++ b/content/docs/v1.7/user-guides/client-api-config.md @@ -1,6 +1,6 @@ --- title: "Client Api Config_v1.7/User Guides" -date: 2024-02-15T17:12:32+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 1000 description: Shows more detailed explanation about APIs configuration @@ -57,7 +57,7 @@ func main() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -173,7 +173,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -297,7 +297,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -481,7 +481,7 @@ func main() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } @@ -664,7 +664,7 @@ func example() { ctx, cancel := context.WithCancel(context.Background()) defer cancel() target := "localhost:8080" - conn, err := grpc.DialContext(ctx, target) + conn, err := grpc.NewClient(target) if err != nil { panic(err) } diff --git a/content/docs/v1.7/user-guides/cluster-role-binding.md b/content/docs/v1.7/user-guides/cluster-role-binding.md index d956c8447..b41fe5a82 100644 --- a/content/docs/v1.7/user-guides/cluster-role-binding.md +++ b/content/docs/v1.7/user-guides/cluster-role-binding.md @@ -1,6 +1,6 @@ --- title: "Cluster Role Binding_v1.7/User Guides" -date: 2024-02-15T17:12:32+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 500 description: Configures cluster role for Vald cluster @@ -152,7 +152,7 @@ In this section, we will describe how to configure it and how to customize these ### Cluster role configuration for Vald Mirror Gateway -By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gatewat/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`. +By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gateway/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`. ```yaml apiVersion: rbac.authorization.k8s.io/v1 diff --git a/content/docs/v1.7/user-guides/filtering-configuration.md b/content/docs/v1.7/user-guides/filtering-configuration.md index 183fcf016..62ca46958 100644 --- a/content/docs/v1.7/user-guides/filtering-configuration.md +++ b/content/docs/v1.7/user-guides/filtering-configuration.md @@ -1,6 +1,6 @@ --- title: "Filtering Configuration_v1.7/User Guides" -date: 2024-01-15T17:31:19+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 300 description: Applies filtering feature to the Vald cluster @@ -164,7 +164,7 @@ func main() { // connect to the Vald cluster ctx := context.Background() - conn, err := grpc.DialContext(ctx, grpcServerAddr, grpc.WithInsecure()) + conn, err := grpc.NewClient(grpcServerAddr, grpc.WithInsecure()) if err != nil { log.Error(err) return diff --git a/content/docs/v1.7/user-guides/mirroring-configuration.md b/content/docs/v1.7/user-guides/mirroring-configuration.md index cadcc379b..eed9fc518 100644 --- a/content/docs/v1.7/user-guides/mirroring-configuration.md +++ b/content/docs/v1.7/user-guides/mirroring-configuration.md @@ -1,6 +1,6 @@ --- title: "Mirroring Configuration_v1.7/User Guides" -date: 2024-02-15T17:12:33+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 400 description: Applies mirror gateway for running multi Vald clusters @@ -69,7 +69,7 @@ gateway: The cluster role configuration is required when you deploy Vald clusters with Vald Mirror Gateway on multiple Namespaces in the Kubernetes cluster. -Please refer to [Cluster Role Configuration](./cluster-role-binding) about cluster role settings for Mirror Gateway. +Please refer to [Cluster Role Configuration](/docs/v1.7/user-guides/cluster-role-binding) about cluster role settings for Mirror Gateway. ### Custom Resource Configuration diff --git a/content/docs/v1.7/user-guides/observability-configuration.md b/content/docs/v1.7/user-guides/observability-configuration.md index 30a713d8f..d288ec4b7 100644 --- a/content/docs/v1.7/user-guides/observability-configuration.md +++ b/content/docs/v1.7/user-guides/observability-configuration.md @@ -1,6 +1,6 @@ --- title: "Observability Configuration_v1.7/User Guides" -date: 2024-08-08T10:35:17+09:00 +date: 2024-10-16T16:05:59+09:00 draft: false weight: 1100 description: Monitors performance on metrics dashboards @@ -187,7 +187,7 @@ defaults: #### Specify the Telemetry attribute -You can add the component information to the attribute of telemetry data by editing `defaults.observability.otlp.attirbute`. +You can add the component information to the attribute of telemetry data by editing `defaults.observability.otlp.attribute`. E.g., when setting `vald-agent-ngt-0` as `agent.observability.otlp.attribute.pod_name`, `target_pod: vald-agent-ngt-0` will be added to the attribute. These attributes are set auto by the environment values, so Vald recommends using default values unless there is a specific reason. diff --git a/preview b/preview index ed99572cc..457f1a00b 160000 --- a/preview +++ b/preview @@ -1 +1 @@ -Subproject commit ed99572cccb1e2defcbbb39d985b091c209c0ce4 +Subproject commit 457f1a00b027efaca7cb2f5e07502642ade4197c diff --git a/public b/public index dfd9fdb5e..78a76497b 160000 --- a/public +++ b/public @@ -1 +1 @@ -Subproject commit dfd9fdb5e20af0cdca152573adea6b1e9f9190eb +Subproject commit 78a76497b185e9dba8405ab6785f60b4e85fd71a diff --git a/themes/vald/layouts/partials/header.html b/themes/vald/layouts/partials/header.html index cecfcb6c7..dc88b8cdf 100644 --- a/themes/vald/layouts/partials/header.html +++ b/themes/vald/layouts/partials/header.html @@ -1,4 +1,4 @@ -{{ $latest := "v1.7.13" }} +{{ $latest := "v1.7.14" }} {{ $ver := "" }} {{ $docsBaseURL := "/docs" }}