Add operation guide #541

rinx · 2020-07-02T08:21:54Z

Description:

Add operation guide.

Related Issue:

nothing.

How Has This Been Tested?:

nothing.

Environment:

Go Version: 1.14.3
Docker Version: 19.03.8
Kubernetes Version: 1.18.2
NGT Version: 1.11.5

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-07-02T08:21:56Z

Best reviewed: commit by commit

Optimal code review plan (2 warnings)

📝 Add TOC for configurations.md

...s/user-guides/configuration.md 95% changes removed in Apply suggestions fr...

📝 Add outline of operations.md

📝 Add observability section

📝 add about cluster

🚧 writing

docs/user-guides/operations.md 57% changes removed in Apply suggestions fr...

📝 update

📝 fix grammer

📝 update

Apply suggestions from code review

Update docs/user-guides/operations.md

Powered by Pull Assistant. Last update 824ae1b ... 78929da. Read the comment docs.

rinx · 2020-07-02T08:23:15Z

/label status/in-progress

rinx · 2020-07-03T03:02:18Z

/rebase

vdaas-ci · 2020-07-03T03:03:34Z

[REBASE] Rebase triggered by rinx for branch: documentation/operation-guides/add-operation-guide

docs/user-guides/operations.md

docs/user-guides/configuration.md

docs/user-guides/operations.md

kpango

Others looks good to me

docs/user-guides/operations.md

rinx · 2020-08-20T07:31:31Z

/rebase

vdaas-ci · 2020-08-20T07:32:08Z

[REBASE] Rebase triggered by rinx for branch: documentation/operation-guides/add-operation-guide

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/user-guides/operations.md|34 col 34| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: they, THA, the, that, their, than, tho, tea, TNA, Thai, ta, thy, THC, TSA, TWA, thaw, FHA, TCA, TPA, Tia, TBA, TTA, Thad, Thea, GHA, aha, AHA, BHA, DHA, HA, Ha, OHA, PHA, SHA, TA, TAA, TDA, TFA, TGA, TH, THB, THD, THF, THM, THP, THS, THT, THX, TLA, TMA, TUA, TVA, TZA, Ta, Th, Thar, Thu, WHA, YHA, ha, t ha, HHA
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|40 col 21| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|41 col 27| Use a smart opening quote here: "“". (EN_QUOTES[1])
Suggestions: “
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=1
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 33| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 36| Use a smart opening quote here: "“". (EN_QUOTES[1])
Suggestions: “
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=1
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 41| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 44| Use a smart opening quote here: "“". (EN_QUOTES[1])
Suggestions: “
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=1
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 49| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 52| Use a smart opening quote here: "“". (EN_QUOTES[1])
Suggestions: “
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=1
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 58| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 64| Use a smart opening quote here: "“". (EN_QUOTES[1])
Suggestions: “
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=1
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 70| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|41 col 73| Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_BEGINNING_RULE?lang=en-US
Category: STYLE
docs/user-guides/operations.md|44 col 4| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Observably, Absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|44 col 30| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|46 col 4| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|46 col 53| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|46 col 70| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|47 col 57| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Jagger
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|47 col 67| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Stack driver
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|48 col 102| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Not, Net, Nut, NGC, Sgt, Nat, NWT, Nit, Gt, AGT, BGT, CGT, DGT, EGT, GNT, GT, HGT, LGT, NBT, NDT, NFT, NG, NGA, NGE, NGN, NGS, NMT, NRT, NST, NT, NUT, NVT, PGT, SGT, UGT, Hgt, N GT, NG T, NGO
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|48 col 152| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: PCs, RCS, RPC, RFCs, Rps, PCS, RPS, RSCS, R PCs, RP Cs, RPC s, UPCs
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|50 col 13| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|52 col 21| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|52 col 61| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|52 col 135| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|53 col 3| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|54 col 28| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|56 col 71| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|56 col 163| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|58 col 15| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|60 col 42| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|60 col 74| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|60 col 103| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Grafana
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|62 col 5| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|64 col 66| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|64 col 80| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|64 col 127| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|65 col 76| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|65 col 98| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: observably, absorbability
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|65 col 112| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|67 col 25| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|73 col 1| Consider using an m-dash in dialogues and enumerations. (DASH_RULE[1])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=1
Category: PUNCTUATION
docs/user-guides/operations.md|74 col 24| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|74 col 45| Consider using an m-dash if you do not want to join two words. (DASH_RULE[2])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=2
Category: PUNCTUATION
docs/user-guides/operations.md|75 col 29| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|75 col 46| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|77 col 116| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|78 col 29| Apostrophe might be missing. Did you mean "endpoints'" or "endpoint's"? (POSSESSIVE_APOSTROPHE[1])
Suggestions: endpoints', endpoint's
Rule: https://community.languagetool.org/rule/show/POSSESSIVE_APOSTROPHE?lang=en-US&subId=1
Category: TYPOS
docs/user-guides/operations.md|83 col 1| Consider using an m-dash in dialogues and enumerations. (DASH_RULE[1])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=1
Category: PUNCTUATION
docs/user-guides/operations.md|84 col 21| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|84 col 39| Consider using an m-dash if you do not want to join two words. (DASH_RULE[2])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=2
Category: PUNCTUATION
docs/user-guides/operations.md|85 col 26| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|85 col 43| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|91 col 60| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|92 col 91| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|94 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: IMG, BMG, IMF, CMG, IMO, DMG, GMG, IMA, IMC, IMT, IMU, SMG, imp, IDG, mg, AMG, FMG, IAG, IEG, ILG, IMAG, IMB, IMD, IME, IMH, IMK, IMN, IMP, IMS, IMV, ING, IPG, IRG, ISG, IVG, MG, Mg, OMG, PMG, TMG, i mg, IG
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|94 col 5| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: SRC, arc, PRC, sic, sac, sec, CRC, DRC, GRC, NRC, SBC, SCC, SLC, FRC, LRC, SFC, SGC, SNC, SRA, SRM, SRS, SRT, Sec, TRC, SDC, SRO, SVC, soc, ARC, BRC, ERC, HRC, IRC, JRC, MRC, QRC, RC, RRC, SAC, SC, SEC, SIC, SMC, SOC, SPC, SR1, SR2, SR3, SRB, SRD, SRE, SRF, SRFC, SRI, SRP, SRU, SRV, SRX, STC, SYC, Sc, Soc, Sr, WRC, orc, SSC, Sri
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|94 col 9| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|94 col 65| Use a smart closing quote here: "”". (EN_QUOTES[2])
Suggestions: ”
URL: https://en.wikipedia.org/wiki/Smart_quote#Electronic_documents
Rule: https://community.languagetool.org/rule/show/EN_QUOTES?lang=en-US&subId=2
Category: TYPOGRAPHY
docs/user-guides/operations.md|99 col 58| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: server, sever
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|101 col 17| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Changeling
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|101 col 28| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Changeling
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|105 col 67| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: confirms, configures, configs
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|106 col 44| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|110 col 26| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|112 col 21| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|114 col 17| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|115 col 17| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|115 col 47| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Thor, VHR, VOR
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|118 col 52| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|118 col 69| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: or, Dr, Mr, Jr, vs, PR, VP, var, RR, VCR, VH, VM, fr, CVR, DVR, PVR, SVR, VG, VN, MVR, VRI, qr, AR, AVR, Ar, BR, BVR, Br, CR, Cr, DR, ER, Er, FR, Fr, GR, Gr, HR, IR, IVR, Ir, KR, Kr, LR, LVR, Lr, MR, NR, OR, Pr, R, RVR, Sr, TR, Ur, V, V1, V2, VA, VBR, VC, VD, VE, VF, VFR, VHR, VI, VIR, VJ, VO, VOR, VRB, VRD, VRF, VRG, VRP, VRS, VRV, VSR, VT, VU, Va, Vt, YVR, Zr, er, gr, hr, jr, pr, r, tr, v, vb, ve, vi, yr, v r, VR, VW
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|119 col 75| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Valid, Bald, Veil, Veiled, Vlad, Wald, Vale, Veils, Val, Veld, ALD, Val d
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|125 col 1| Consider using an m-dash in dialogues and enumerations. (DASH_RULE[1])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=1
Category: PUNCTUATION
docs/user-guides/operations.md|126 col 3| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|126 col 20| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|126 col 37| Consider using an m-dash if you do not want to join two words. (DASH_RULE[2])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=2
Category: PUNCTUATION
docs/user-guides/operations.md|127 col 3| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|127 col 29| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|127 col 55| Consider using an m-dash if you do not want to join two words. (DASH_RULE[2])
Suggestions: —
URL: https://en.wikipedia.org/wiki/Dash#Em_dash
Rule: https://community.languagetool.org/rule/show/DASH_RULE?lang=en-US&subId=2
Category: PUNCTUATION
docs/user-guides/operations.md|128 col 3| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Changeling
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|128 col 14| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Changeling
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|131 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|132 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|133 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Changeling
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|140 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Prometheus
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|141 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: Grafana
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|142 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|143 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|144 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|145 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|146 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|147 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS
docs/user-guides/operations.md|148 col 1| Possible spelling mistake found (MORFOLOGIK_RULE_EN_US)
Suggestions: server, sever
Rule: https://community.languagetool.org/rule/show/MORFOLOGIK_RULE_EN_US?lang=en-US
Category: TYPOS

docs/user-guides/configuration.md

docs/user-guides/operations.md

rinx · 2020-08-20T07:53:31Z

/rebase

vdaas-ci · 2020-08-20T07:54:06Z

[REBASE] Rebase triggered by rinx for branch: documentation/operation-guides/add-operation-guide

docs/user-guides/operations.md

github-actions · 2020-08-20T07:56:35Z

docs/user-guides/operations.md

+### Logging
+
+The logging level of Vald components can be configured by using `defaults.logging.level` (or `[component].logging.level`) field in Helm Chart values.
+The level must be a one of "debug", "info", "warn", "error" and "fatal".


[LanguageTool] _{reported by reviewdog 🐶}
Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_BEGINNING_RULE?lang=en-US
Category: STYLE

docs/user-guides/operations.md

rinx · 2020-08-20T08:00:19Z

/rebase

vdaas-ci · 2020-08-20T08:00:57Z

[REBASE] Rebase triggered by rinx for branch: documentation/operation-guides/add-operation-guide

github-actions · 2020-08-20T08:21:20Z

docs/user-guides/operations.md

+
+However, to maximize the efficiency of search operations, it is better to have a certain amount of vectors in each NGT vector space.
+
+We recommend to have more than 3 worker nodes with enough memory for the workload.


[LanguageTool] _{reported by reviewdog 🐶}
The verb 'recommend' is used with the gerund form: "recommend having". (ADMIT_ENJOY_VB[1])
Suggestions: recommend having
URL: http://www.ef.com/english-resources/english-grammar/gerund-equals-infinitive/
Rule: https://community.languagetool.org/rule/show/ADMIT_ENJOY_VB?lang=en-US&subId=1
Category: GRAMMAR

docs/user-guides/operations.md

vankichi

LGTM

kpango · 2020-08-24T09:22:49Z

/rebase
/format
/approve

vdaas-ci · 2020-08-24T09:23:34Z

[REBASE] Rebase triggered by kpango for branch: documentation/operation-guides/add-operation-guide

Signed-off-by: Rintaro Okamura <[email protected]> :pencil: fix link Signed-off-by: Rintaro Okamura <[email protected]>

Signed-off-by: Rintaro Okamura <[email protected]>

Co-authored-by: Kiichiro YUKAWA <[email protected]>

Co-authored-by: Yusuke Kato <[email protected]>

vdaas-ci · 2020-08-24T09:24:37Z

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

vdaas-ci

[APPROVED] This PR is approved by kpango.

github-actions bot added size/L type/documentation priority/low labels Jul 2, 2020

vdaas-ci added the status/in-progress label Jul 2, 2020

vdaas-ci force-pushed the documentation/operation-guides/add-operation-guide branch from c9146ba to cd789ae Compare July 3, 2020 03:03

rinx force-pushed the documentation/operation-guides/add-operation-guide branch from b21f5e3 to 9187bd1 Compare July 6, 2020 07:49

rinx force-pushed the documentation/operation-guides/add-operation-guide branch from 645c727 to 978f29a Compare July 14, 2020 01:32

rinx force-pushed the documentation/operation-guides/add-operation-guide branch from 5cc5ca2 to 5d833cb Compare July 30, 2020 04:31

github-actions bot reviewed Jul 30, 2020

View reviewed changes

rinx force-pushed the documentation/operation-guides/add-operation-guide branch 2 times, most recently from 2492d7c to 4e04e6d Compare August 18, 2020 07:58

rinx marked this pull request as ready for review August 18, 2020 08:07

rinx requested review from kpango and vankichi August 18, 2020 08:07

vankichi reviewed Aug 19, 2020

View reviewed changes

github-actions bot reviewed Aug 19, 2020

View reviewed changes

docs/user-guides/operations.md Show resolved Hide resolved

docs/user-guides/operations.md Show resolved Hide resolved

kpango requested changes Aug 20, 2020

View reviewed changes

vdaas-ci force-pushed the documentation/operation-guides/add-operation-guide branch from 1d4b4c2 to 8e8846b Compare August 20, 2020 07:32

github-actions bot reviewed Aug 20, 2020

View reviewed changes

vdaas-ci force-pushed the documentation/operation-guides/add-operation-guide branch from 8e8846b to 25315bf Compare August 20, 2020 07:54

github-actions bot reviewed Aug 20, 2020

View reviewed changes

vdaas-ci force-pushed the documentation/operation-guides/add-operation-guide branch from 25315bf to 96c8919 Compare August 20, 2020 08:01

github-actions bot reviewed Aug 20, 2020

View reviewed changes

vankichi previously approved these changes Aug 24, 2020

View reviewed changes

rinx and others added 13 commits August 24, 2020 09:23

📝 Add TOC for configurations.md

824ae1b

Signed-off-by: Rintaro Okamura <[email protected]> :pencil: fix link Signed-off-by: Rintaro Okamura <[email protected]>

📝 Add outline of operations.md

8456a30

Signed-off-by: Rintaro Okamura <[email protected]>

📝 Add observability section

5a5992a

Signed-off-by: Rintaro Okamura <[email protected]>

📝 add about cluster

ffec51c

Signed-off-by: Rintaro Okamura <[email protected]>

🚧 writing

906307f

Signed-off-by: Rintaro Okamura <[email protected]>

📝 update

ea5f5dc

Signed-off-by: Rintaro Okamura <[email protected]>

📝 update

302236e

Signed-off-by: Rintaro Okamura <[email protected]>

📝 fix grammer

debd1cb

Signed-off-by: Rintaro Okamura <[email protected]>

📝 update

255fa26

Signed-off-by: Rintaro Okamura <[email protected]>

📝 update

f383eca

Signed-off-by: Rintaro Okamura <[email protected]>

Apply suggestions from code review

1dee4d3

Co-authored-by: Kiichiro YUKAWA <[email protected]>

Apply suggestions from code review

3aee828

Co-authored-by: Yusuke Kato <[email protected]>

Update docs/user-guides/operations.md

78929da

vdaas-ci dismissed vankichi’s stale review via 78929da August 24, 2020 09:23

vdaas-ci force-pushed the documentation/operation-guides/add-operation-guide branch from 66b72d9 to 78929da Compare August 24, 2020 09:23

vdaas-ci approved these changes Aug 24, 2020

View reviewed changes

kpango merged commit 764aa14 into master Aug 24, 2020

kpango deleted the documentation/operation-guides/add-operation-guide branch August 24, 2020 09:26

vdaas-ci mentioned this pull request Sep 2, 2020

[patch] update deps #660

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add operation guide #541

Add operation guide #541

rinx commented Jul 2, 2020

pull-assistant bot commented Jul 2, 2020 •

edited

Loading

rinx commented Jul 2, 2020

rinx commented Jul 3, 2020

vdaas-ci commented Jul 3, 2020

kpango left a comment

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot left a comment

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot Aug 20, 2020

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot Aug 20, 2020

vankichi left a comment

kpango commented Aug 24, 2020

vdaas-ci commented Aug 24, 2020

vdaas-ci commented Aug 24, 2020

vdaas-ci left a comment


		However, to maximize the efficiency of search operations, it is better to have a certain amount of vectors in each NGT vector space.

		We recommend to have more than 3 worker nodes with enough memory for the workload.

Add operation guide #541

Add operation guide #541

Conversation

rinx commented Jul 2, 2020

Description:

Related Issue:

How Has This Been Tested?:

Environment:

Types of changes:

Changes to Core Features:

Checklist:

pull-assistant bot commented Jul 2, 2020 • edited Loading

rinx commented Jul 2, 2020

rinx commented Jul 3, 2020

vdaas-ci commented Jul 3, 2020

kpango left a comment

Choose a reason for hiding this comment

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot left a comment

Choose a reason for hiding this comment

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot Aug 20, 2020

Choose a reason for hiding this comment

rinx commented Aug 20, 2020

vdaas-ci commented Aug 20, 2020

github-actions bot Aug 20, 2020

Choose a reason for hiding this comment

vankichi left a comment

Choose a reason for hiding this comment

kpango commented Aug 24, 2020

vdaas-ci commented Aug 24, 2020

vdaas-ci commented Aug 24, 2020

vdaas-ci left a comment

Choose a reason for hiding this comment

pull-assistant bot commented Jul 2, 2020 •

edited

Loading