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.

Sign up for GitHub

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

Jump to bottom

📝 Add configurations.md #356

Merged
merged 9 commits into from
May 12, 2020
Merged

📝 Add configurations.md #356

merged 9 commits into from
May 12, 2020

Conversation

rinx
Copy link
Contributor

@rinx rinx commented Apr 28, 2020 •
edited
Loading

Signed-off-by: Rintaro Okamura rintaro.okamura@gmail.com

Description:

Adding configurations guide.

Several modifications in values.yaml

  • add detail comments
  • add hpa to discoverer
  • add queue-check-duration field to compressor registerer

Related Issue:

Nothing.

How Has This Been Tested?:

Nothing.

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
Copy link

pull-assistant bot commented Apr 28, 2020 •
edited
Loading

Score: 0.93

Best reviewed: commit by commit

Optimal code review plan (1 warning)

📝 Add configurations.md

...tes/discoverer/deployment.yaml 67% changes removed in ♻️ refactor h...

     🐛 Add queue_check_duration to compressor registerer / 📝 Add...

     🤖 Update license headers and formatting go codes

     📝 Revise configuration.md

     🔧 Fix

     🐛 Fix go.mod go.sum

     ⬆️ upgrade valdcli version

     ♻️ refactor helm templates

     Apply suggestions from code review

Powered by Pull Assistant. Last update d83e35d ... 14ed74f. Read the comment docs.

@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch from d4d3b61 to bc4b9ce Compare April 28, 2020 06:35
@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch 10 times, most recently from 023a619 to c579333 Compare May 1, 2020 06:50
@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch 6 times, most recently from f116a6b to 6827c16 Compare May 7, 2020 02:57
@rinx
Copy link
Contributor Author

rinx commented May 7, 2020

/rebase
/format

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented May 7, 2020

[REBASE] Rebase triggered by rinx for branch: documentation/guides-configurations/add-configuration-guides

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented May 7, 2020

[REBASE] Failed to rebase.

@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch from c47d42a to f5275ac Compare May 7, 2020 03:38
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented May 7, 2020

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@rinx
🔧 Fix
5391d33 
Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch from e7adb67 to 5391d33 Compare May 12, 2020 01:56
@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@rinx
Copy link
Contributor Author

rinx commented May 12, 2020

@hlts2 @vankichi @kevindiu @kpango could you please check this PR again?
🙏 🙏 🙏

@rinx
🐛 Fix go.mod go.sum
01e01a8 
Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@rinx
⬆️ upgrade valdcli version
cfb99d7 
Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@rinx rinx force-pushed the documentation/guides-configurations/add-configuration-guides branch from 01e597e to cfb99d7 Compare May 12, 2020 02:18
@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@rinx
♻️ refactor helm templates
f0c7339 
Signed-off-by: Rintaro Okamura <rintaro.okamura@gmail.com>
@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

vankichi
vankichi reviewed May 12, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

@rinx Almost, LGTM about content detail.
I leaved some comments about grammar review.
If you fix/resolve these reviews, I'll approve :)

docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
docs/guides/configurations.md Outdated Show resolved Hide resolved
kpango
kpango previously approved these changes May 12, 2020
View reviewed changes
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.

Overall LGTM, please merge this PR after @vankichi 's suggestion is revised.

@rinx @vankichi
Apply suggestions from code review
14ed74f 
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

@rinx
Copy link
Contributor Author

rinx commented May 12, 2020

@vankichi @kpango Thanks for reviewing again.
I've just committed vankichi's suggestions.

It's ready to merge. 👍

@vdaas-ci
Copy link
Collaborator

[WARNING] Changes in interal/config may require you to change Helm charts. Please check.

vankichi
vankichi approved these changes May 12, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

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

LGTM. Excellent !!!! xD

@vankichi
Copy link
Contributor

/approve
/rebase
/format

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/guides-configurations/add-configuration-guides

@vdaas-ci
Copy link
Collaborator

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

kevindiu
kevindiu reviewed May 12, 2020
View reviewed changes
docs/guides/configurations.md

### Replication Manager

TBW
Copy link
Contributor

Choose a reason for hiding this comment

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

this section is skipped?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes.
Currently there's no resources or configurations about replication manager in our Helm chart.
Also, there's no configurations about ingress/egress filters, so the section about them is also skipped.

vdaas-ci
vdaas-ci approved these changes May 12, 2020
View reviewed changes
Copy link
Collaborator

@vdaas-ci vdaas-ci left a comment

Choose a reason for hiding this comment

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

[APPROVED] This PR is approved by vankichi.

@kpango kpango merged commit 067d8ad into master May 12, 2020
@kpango kpango deleted the documentation/guides-configurations/add-configuration-guides branch May 12, 2020 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevindiu kevindiu kevindiu left review comments

@hlts2 hlts2 hlts2 left review comments

@vankichi vankichi vankichi approved these changes

@vdaas-ci vdaas-ci vdaas-ci approved these changes

@kpango kpango kpango left review comments

Assignees
No one assigned
Labels
area/helm area/internal area/makefile priority/low size/L team/sre SRE team type/ci type/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@rinx @vdaas-ci @kevindiu @vankichi @kpango @hlts2