Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add capacity planning document #1714

Merged
merged 11 commits into from
Jul 12, 2022

Conversation

vankichi
Copy link
Contributor

Description:

SSIA

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.18.3
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.6

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.

@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - replace the PR body by changelog details
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase master
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

Signed-off-by: vankichi <kyukawa315@gmail.com>
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/add-capacity-plannnig branch from 7c5e5db to 7a1410c Compare June 29, 2022 08:50
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
vankichi and others added 2 commits June 30, 2022 15:33
Co-authored-by: Kevin Diu <kevindiujp@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
kevindiu
kevindiu previously approved these changes Jun 30, 2022
@vankichi vankichi changed the title Add capacity plannnig document Add capacity planning document Jun 30, 2022
datelier
datelier previously approved these changes Jul 6, 2022
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
@hlts2
Copy link
Contributor

hlts2 commented Jul 7, 2022

@vankichi
I reviewed this PR.
Overall, it's good 👍
I will approve this PR after you fix content based on @kpango comment.

Co-authored-by: Yusuke Kato <kpango@vdaas.org>
@vankichi vankichi dismissed stale reviews from datelier and kevindiu via f03e879 July 7, 2022 07:09
Signed-off-by: vankichi <kyukawa315@gmail.com>
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Outdated Show resolved Hide resolved
@vankichi vankichi requested a review from kpango July 7, 2022 07:46
Therefore, the actual minimum RAM capacity will be:

```bash
8,7168,000,000 (bit) / 0.6 = 145,280,000,000 (bit) = 18.16 (GB)
```

<div class="warn">
Memory usage is not enough in the minimum required RAM.<BR>
Copy link
Collaborator

Choose a reason for hiding this comment

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

In many production operation cases, memory usage can be unstable with minimal RAM required.

It is easy to change by editing the `values.yaml` file and applying it.

```yaml
# e.g. LB Gateway resources settings.
Copy link
Contributor

Choose a reason for hiding this comment

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

[LanguageTool] reported by reviewdog 🐶
This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Suggestions: Gateway
Rule: https://community.languagetool.org/rule/show/UPPERCASE_SENTENCE_START?lang=en-US
Category: CASING

docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
docs/user-guides/capacity-plannig.md Show resolved Hide resolved
@vankichi vankichi force-pushed the documentation/docs/add-capacity-plannnig branch from 8095efc to 26eb422 Compare July 7, 2022 08:28
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi force-pushed the documentation/docs/add-capacity-plannnig branch from 26eb422 to 1a7964d Compare July 8, 2022 01:51
Signed-off-by: vankichi <kyukawa315@gmail.com>
kevindiu
kevindiu previously approved these changes Jul 12, 2022
hlts2
hlts2 previously approved these changes Jul 12, 2022
@@ -15,6 +15,7 @@
#
version: 1
# index: ann
# index: burstable
Copy link
Collaborator

Choose a reason for hiding this comment

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

it would be better to add Guaranteed and BestEffort and QoS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kpango updated

Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi dismissed stale reviews from hlts2 and kevindiu via 1f1348b July 12, 2022 01:50
@vankichi vankichi requested a review from kpango July 12, 2022 01:50
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

LGTM

@vankichi vankichi requested review from kevindiu and hlts2 July 12, 2022 02:38
@vankichi vankichi merged commit 4ec27c8 into master Jul 12, 2022
@vankichi vankichi deleted the documentation/docs/add-capacity-plannnig branch July 12, 2022 05:12
@hlts2 hlts2 mentioned this pull request Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants