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

Update filter gateway document #1721

Merged

Conversation

vankichi
Copy link
Contributor

@vankichi vankichi commented Jul 4, 2022

Signed-off-by: vankichi kyukawa315@gmail.com

Description:

I have updated the filter gateway document.

  • add ingress filtering description
  • add egress filtering description

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

vdaas-ci commented Jul 4, 2022

[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

@vankichi vankichi force-pushed the documentation/docs/update-filter-gateway-component-document branch from 6fa75a8 to ffcfa2d Compare July 4, 2022 09:29
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi force-pushed the documentation/docs/update-filter-gateway-component-document branch from ffcfa2d to f07c1a8 Compare July 4, 2022 09:29
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
Signed-off-by: vankichi <kyukawa315@gmail.com>
@vankichi vankichi changed the title [WIP] update filter gateway document Update filter gateway document Jul 5, 2022
@vankichi vankichi marked this pull request as ready for review July 5, 2022 08:03
@vankichi vankichi assigned kevindiu and taisuou and unassigned kevindiu and taisuou Jul 5, 2022
@vankichi vankichi requested review from kevindiu, taisuou, a team and hlts2 and removed request for a team July 5, 2022 08:04
@taisuou
Copy link
Contributor

taisuou commented Jul 5, 2022

Looks good! but fixing the flowing details will make the image better.

In the egress filtering image

Put the block of Serch request within a left line.
sc1

The text of No.7,Pass the aggregated 〜 shoud be align left.
sc2

sorry for the detailed comments.

@kevindiu
Copy link
Contributor

kevindiu commented Jul 6, 2022

On the ingress filter diagram, no. 6, I think it is better to specify the request passing is filtered request.
Pass the filtered request

docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
docs/overview/component/filter-gateway.md Outdated Show resolved Hide resolved
Signed-off-by: vankichi <kyukawa315@gmail.com>
Signed-off-by: vankichi <kyukawa315@gmail.com>
hlts2
hlts2 previously approved these changes Jul 7, 2022
Copy link
Contributor

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM!

kevindiu
kevindiu previously approved these changes Jul 7, 2022
@taisuou
Copy link
Contributor

taisuou commented Jul 11, 2022

filiter-gateway-ingress-filtering_blob drawio
filiter-gateway-ingress_filtering_vector drawio
filiter-gateway-egress_filtering drawio

Sorry for the late reply.
I modified each image.

* edit filtering images

* change the flow positions 7 and 9
@vankichi vankichi dismissed stale reviews from kevindiu and hlts2 via 84e44b5 July 12, 2022 00:25
@vankichi vankichi requested review from kevindiu and hlts2 July 12, 2022 00:26
Copy link
Contributor

@hlts2 hlts2 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 merged commit 6bcbe1f into master Jul 12, 2022
@vankichi vankichi deleted the documentation/docs/update-filter-gateway-component-document branch July 12, 2022 01:01
@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.

5 participants