Vald architecture document #366

kevindiu · 2020-05-07T09:31:02Z

#106 # Description:
This PR create a Vald Architecture document including the summary of each components in Vald and the data flow explanation.

Remaining task:

Update and Delete flow (another PR)
Fix image design

Related Issue:

How Has This Been Tested?:

Environment:

Golang Version: 1.14
Docker Version: 19.03.5
Kubernetes Version: 1.17.3
NGT Version: 1.9.1

Types of changes:

Bug fix [type/bug]
New feature [type/feature]
Add tests [type/test]
Security related changes [type/security]
Add documents [type/documentation]
Refactoring [type/refactoring]
Update dependencies [type/dependency]
Update benchmarks and performances [type/bench]
Update CI [type/ci]

Changes to Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your core changes, as applicable?
Have you successfully ran tests with your changes locally?

Checklist:

I have read the CONTRIBUTING document.
I have checked open Pull Requests for the similar feature or fixes?
I have added tests and benchmarks to cover my changes.
I have ensured all new and existing tests passed.
I have commented my code, particularly in hard-to-understand areas
I have updated the documentation accordingly.

pull-assistant · 2020-05-07T09:31:08Z

Best reviewed: commit by commit

Optimal code review plan (15 warnings, 3 commits squashed)

add architecture overview draft

docs/user/architecture.md 56% changes removed in add vector data spac...

fix

README.md 50% changes removed in Update doc path

update architecture doc

docs/user/architecture.md 59% changes removed in Apply suggestions fr...

fix

update Vald Meta section

docs/user/architecture.md 59% changes removed in add vector data spac...

fix Vald backup

docs/user/architecture.md 64% changes removed in Apply suggestions fr...

fix grammar

docs/user/architecture.md 80% changes removed in draft data flow sect...

fix arch doc: vald agent section

docs/user/architecture.md 56% changes removed in Apply suggestions fr...

fix

docs/user/architecture.md 62% changes removed in Apply suggestions fr...

fix Vald filter section

draft data flow section

docs/user/architecture.md 64% changes removed in explain more detail ...

edit search flow

docs/user/architecture.md 94% changes removed in separate insert and ...

add vector data space explaination

docs/user/architecture.md 42% changes removed in Apply suggestions fr...

Apply suggestions from code review

docs/user/architecture.md 57% changes removed in Apply suggestions fr...

move assets to assets/doc folder

docs/user/architecture.md 67% changes removed in change docs and imag...

Apply suggestions from code review

update vector data space explaination diagram

separate insert and search flow diagram

docs/user/architecture.md 88% changes removed in fix

fix image

update vector data space diagram( Tree -> Index

change docs and images path

Update doc path

🤖 Update license headers and formatting go codes

Apply suggestions from code review

Revert ":robot: Update license headers and formatting go codes"

Apply suggestions from code review

explain more detail ... ... fix

Squashed 3 commits:

explain more detail in insert flow

fix

docs/overview/architecture.md 52% changes removed in update searching flo...

update searching flow

Apply suggestions from code review

Revert ":robot: Update license headers and formatting go codes"

Update docs/overview/architecture.md

Merge branch 'master' into documentation/architecture_doc

🤖 Automatically add contributor

Powered by Pull Assistant. Last update 41271d3 ... a3f34df. Read the comment docs.

docs/user/architecture.md

vankichi · 2020-05-12T02:12:17Z

/rebase

vdaas-ci · 2020-05-12T02:21:41Z

[REBASE] Rebase triggered by vankichi for branch: documentation/architecture_doc

hlts2 · 2020-05-12T06:48:02Z

LGTM

docs/user/architecture.md

vankichi

@kevindiu I left some comments.
I think it is better each sentence written each row.
It helps to protect against unwanted changes.

docs/user/architecture.md

vankichi · 2020-05-13T05:07:16Z

/rebase
/format

vdaas-ci · 2020-05-13T05:07:53Z

[REBASE] Rebase triggered by vankichi for branch: documentation/architecture_doc

vdaas-ci · 2020-05-13T05:08:50Z

[FORMAT] Updating license headers and formatting go codes triggered by vankichi.

vankichi · 2020-05-14T01:19:06Z

@kpango @kmrmt @rinx
When you have time, could you please review Architecture Document?

vankichi · 2020-05-14T01:33:14Z

/rebase

vdaas-ci · 2020-05-14T01:33:52Z

[REBASE] Rebase triggered by vankichi for branch: documentation/architecture_doc

kpango · 2020-05-14T06:05:57Z

/rebase
/format

vdaas-ci · 2020-05-14T06:06:40Z

[REBASE] Rebase triggered by kpango for branch: documentation/architecture_doc

kevindiu · 2020-05-25T07:49:20Z

/rebase

vdaas-ci · 2020-05-25T07:50:04Z

[REBASE] Rebase triggered by kevindiu for branch: documentation/architecture_doc

This reverts commit 07ac8d9.

kevindiu · 2020-05-25T07:58:50Z

/rebase

vdaas-ci · 2020-05-25T07:59:23Z

[REBASE] Rebase triggered by kevindiu for branch: documentation/architecture_doc

kmrmt · 2020-05-26T05:12:40Z

docs/overview/architecture.md

+1. Generate the corresponding UUID for internal use.
+1. Forward the vector ID and UUID request to the Vald Meta.
+1. Forward the vector information (vector ID, vector, and UUID) to Vald Backup Gateway.
+


why are all numbers 1?

It is github markdown coding style.

a

b

c

vankichi · 2020-05-27T03:24:13Z

@kpango Could you review again about "Insert Data Flow" and "Search Data Flow" when you are free?

kmrmt

LGTM

docs/overview/architecture.md

kpango · 2020-05-28T02:36:39Z

/rebase
/format
/approve

vdaas-ci · 2020-05-28T02:37:13Z

[REBASE] Rebase triggered by kpango for branch: documentation/architecture_doc

vdaas-ci · 2020-05-28T02:37:18Z

[REBASE] Failed to rebase.

rinx · 2020-05-28T02:42:26Z

/add-contributors

vdaas-ci · 2020-05-28T02:43:18Z

[ADD CONTRIBUTORS] Add contributor kevindiu to CONTRIBUTORS triggered by rinx.

Signed-off-by: vdaas-ci <[email protected]>

kpango · 2020-05-28T02:43:50Z

/rebase
/format
/approve

vdaas-ci · 2020-05-28T02:44:26Z

[REBASE] Rebase triggered by kpango for branch: documentation/architecture_doc

vdaas-ci · 2020-05-28T02:44:31Z

[REBASE] Failed to rebase.

kpango · 2020-05-28T02:45:06Z

/format
/approve

vdaas-ci · 2020-05-28T02:46:29Z

[FORMAT] Updating license headers and formatting go codes triggered by kpango.

vdaas-ci · 2020-05-28T02:47:02Z

[FORMAT] Failed to format.

kpango · 2020-05-28T02:47:37Z

/approve

vdaas-ci

[APPROVED] This PR is approved by kpango.

github-actions bot added size/L type/documentation priority/low labels May 7, 2020

kpango changed the title ~~[Drafe] Vald architecture document~~ [Draft] Vald architecture document May 8, 2020

hlts2 reviewed May 11, 2020

View reviewed changes

docs/user/architecture.md Outdated Show resolved Hide resolved

vdaas-ci force-pushed the documentation/architecture_doc branch from 9a2f787 to 4b370f0 Compare May 12, 2020 02:21

vankichi reviewed May 12, 2020

View reviewed changes

vankichi reviewed May 13, 2020

View reviewed changes

kevindiu commented May 13, 2020

View reviewed changes

docs/user/architecture.md Outdated Show resolved Hide resolved

vankichi added the status/author-review label May 13, 2020

vankichi requested review from kpango, kmrmt and rinx May 13, 2020 05:07

vdaas-ci force-pushed the documentation/architecture_doc branch from 8946862 to 44299d4 Compare May 13, 2020 05:08

kevindiu force-pushed the documentation/architecture_doc branch from f71fb0c to d2a82c5 Compare May 13, 2020 08:26

vankichi changed the title ~~[Draft] Vald architecture document~~ Vald architecture document May 14, 2020

vankichi marked this pull request as ready for review May 14, 2020 01:07

vdaas-ci force-pushed the documentation/architecture_doc branch from bd7dd95 to bb3a5b1 Compare May 14, 2020 01:34

Revert ":robot: Update license headers and formatting go codes"

df5b59a

This reverts commit 07ac8d9.

kmrmt reviewed May 26, 2020

View reviewed changes

vankichi previously approved these changes May 26, 2020

View reviewed changes

kmrmt previously approved these changes May 28, 2020

View reviewed changes

kpango reviewed May 28, 2020

View reviewed changes

docs/overview/architecture.md Outdated Show resolved Hide resolved

Update docs/overview/architecture.md

7b65940

kpango dismissed stale reviews from kmrmt and vankichi via 7b65940 May 28, 2020 02:36

Merge branch 'master' into documentation/architecture_doc

2318394

🤖 Automatically add contributor

a3f34df

Signed-off-by: vdaas-ci <[email protected]>

vdaas-ci approved these changes May 28, 2020

View reviewed changes

kpango merged commit 12b26e2 into master May 28, 2020

kpango deleted the documentation/architecture_doc branch May 28, 2020 02:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vald architecture document #366

Vald architecture document #366

kevindiu commented May 7, 2020 •

edited

Loading

pull-assistant bot commented May 7, 2020 •

edited

Loading

vankichi commented May 12, 2020

vdaas-ci commented May 12, 2020

hlts2 commented May 12, 2020

vankichi left a comment

vankichi commented May 13, 2020

vdaas-ci commented May 13, 2020

vdaas-ci commented May 13, 2020

vankichi commented May 14, 2020

vankichi commented May 14, 2020

vdaas-ci commented May 14, 2020

kpango commented May 14, 2020

vdaas-ci commented May 14, 2020

kevindiu commented May 25, 2020

vdaas-ci commented May 25, 2020

kevindiu commented May 25, 2020

vdaas-ci commented May 25, 2020

kmrmt May 26, 2020

vankichi May 26, 2020

vankichi commented May 27, 2020

kmrmt left a comment

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

rinx commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci left a comment

Vald architecture document #366

Vald architecture document #366

Conversation

kevindiu commented May 7, 2020 • edited Loading

Related Issue:

How Has This Been Tested?:

Environment:

Types of changes:

Changes to Core Features:

Checklist:

pull-assistant bot commented May 7, 2020 • edited Loading

vankichi commented May 12, 2020

vdaas-ci commented May 12, 2020

hlts2 commented May 12, 2020

vankichi left a comment

Choose a reason for hiding this comment

vankichi commented May 13, 2020

vdaas-ci commented May 13, 2020

vdaas-ci commented May 13, 2020

vankichi commented May 14, 2020

vankichi commented May 14, 2020

vdaas-ci commented May 14, 2020

kpango commented May 14, 2020

vdaas-ci commented May 14, 2020

kevindiu commented May 25, 2020

vdaas-ci commented May 25, 2020

kevindiu commented May 25, 2020

vdaas-ci commented May 25, 2020

kmrmt May 26, 2020

Choose a reason for hiding this comment

vankichi May 26, 2020

Choose a reason for hiding this comment

vankichi commented May 27, 2020

kmrmt left a comment

Choose a reason for hiding this comment

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

rinx commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci commented May 28, 2020

vdaas-ci commented May 28, 2020

kpango commented May 28, 2020

vdaas-ci left a comment

Choose a reason for hiding this comment

kevindiu commented May 7, 2020 •

edited

Loading

pull-assistant bot commented May 7, 2020 •

edited

Loading