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 Traceflow User Guide #972

Merged
merged 1 commit into from
Aug 4, 2020
Merged

Add Traceflow User Guide #972

merged 1 commit into from
Aug 4, 2020

Conversation

mengdie-song
Copy link
Contributor

@mengdie-song mengdie-song commented Jul 21, 2020 •
edited
Loading

Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: #901

@antrea-bot
Copy link
Collaborator

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

  • /test-e2e: to trigger e2e tests.
  • /skip-e2e: to skip e2e tests.
  • /test-conformance: to trigger conformance tests.
  • /skip-conformance: to skip conformance tests.
  • /test-whole-conformance: to trigger all conformance tests on linux.
  • /skip-whole-conformance: to skip all conformance tests on linux.
  • /test-networkpolicy: to trigger networkpolicy tests.
  • /skip-networkpolicy: to skip networkpolicy tests.
  • /test-windows-conformance: to trigger windows conformance tests.
  • /skip-windows-conformance: to skip windows conformance tests.
  • /test-windows-networkpolicy: to trigger windows networkpolicy tests.
  • /skip-windows-networkpolicy: to skip windows networkpolicy tests.
  • /test-all: to trigger all tests (except whole conformance).
  • /skip-all: to skip all tests (except whole conformance).

These commands can only be run by members of the vmware-tanzu organization.

jianjuns
jianjuns reviewed Jul 21, 2020
View reviewed changes
Copy link
Contributor

@jianjuns jianjuns left a comment

Choose a reason for hiding this comment

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

Thanks for the work. Would you also include descriptions about using yaml and kubectl to start a TF session?

@mengdie-song mengdie-song force-pushed the traceflow-doc branch 4 times, most recently from 3589aa6 to 06c58c0 Compare July 22, 2020 07:41
@mengdie-song
Copy link
Contributor Author

@jianjuns I have added using yaml and kubectl to start a traceflow as suggested.
Since we will adjust the titles a little bit in PR: #913, I will update this document with new pictures after previous PR is merged.

antoninbas
antoninbas reviewed Jul 22, 2020
View reviewed changes
Copy link
Contributor

@antoninbas antoninbas left a comment

Choose a reason for hiding this comment

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

I haven't reviewed the text yet, but I am a bit worried about including "large" images in the repo as it grows the size in a permanent way.

I have 2 solutions in mind:

  • host the images on the Antrea AWS S3 account (check with @edwardbadboy if you don't have access)
  • use the Github CDN: drag-and-drop files in an issue template and use the generated links, but do not actually open the issue.

abhiraut
abhiraut reviewed Jul 22, 2020
View reviewed changes
docs/traceflow-guide.md Show resolved Hide resolved
docs/traceflow-guide.md Show resolved Hide resolved
@mengdie-song
Copy link
Contributor Author

@antoninbas I have pushed pictures to Antrea AWS S3 account as suggested.
Another problem I want to confirm is whether we need to update release assets and antrea-octant-image since we have merged a patch to enhance Traceflow UI last Friday? Or we just need to update octant-plugin-installation.md with more details?

gran-vmv
gran-vmv reviewed Jul 27, 2020
View reviewed changes
docs/traceflow-guide.md Outdated Show resolved Hide resolved
antoninbas
antoninbas reviewed Jul 27, 2020
View reviewed changes
Copy link
Contributor

@antoninbas antoninbas left a comment

Choose a reason for hiding this comment

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

some typos

please use the full S3 bucket link for images so they can load over HTTPs

docs/octant-plugin-installation.md Outdated Show resolved Hide resolved
docs/octant-plugin-installation.md Outdated Show resolved Hide resolved
docs/octant-plugin-installation.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
@antrea-bot
Copy link
Collaborator

Can one of the admins verify this patch?

@antrea-bot
Copy link
Collaborator

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

  • /test-e2e: to trigger e2e tests.
  • /skip-e2e: to skip e2e tests.
  • /test-conformance: to trigger conformance tests.
  • /skip-conformance: to skip conformance tests.
  • /test-whole-conformance: to trigger all conformance tests on linux.
  • /skip-whole-conformance: to skip all conformance tests on linux.
  • /test-networkpolicy: to trigger networkpolicy tests.
  • /skip-networkpolicy: to skip networkpolicy tests.
  • /test-windows-conformance: to trigger windows conformance tests.
  • /skip-windows-conformance: to skip windows conformance tests.
  • /test-windows-networkpolicy: to trigger windows networkpolicy tests.
  • /skip-windows-networkpolicy: to skip windows networkpolicy tests.
  • /test-hw-offload: to trigger ovs hardware offload test.
  • /skip-hw-offload: to skip ovs hardware offload test.
  • /test-all: to trigger all tests (except whole conformance).
  • /skip-all: to skip all tests (except whole conformance).

These commands can only be run by members of the vmware-tanzu organization.

tnqn
tnqn reviewed Jul 31, 2020
View reviewed changes
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md
# ip: IP can also be marked as destination, but namespace/pod and ip are mutually exclusive.
packet:
ipHeader:
protocol: 6 # Protocol here can be 6 (TCP), 17 (UDP) or 1 (ICMP), default value is 1 (ICMP)
Copy link
Member

Choose a reason for hiding this comment

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

Not related to this PR. This reminds me we probably should use string "TCP", "UDP", "ICMP" for protocols like NetworkPolicy does to make it more friendly, otherwise people like me won't be able to set correct protocol without googling once every time. @jianjuns @antoninbas @gran-vmv what do you think?
https://github.com/kubernetes/kubernetes/blob/master/pkg/apis/core/types.go#L619

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 - but is breaking backwards-compatibility an issue? maybe open an issue and we will make that change when we switch the API to beta, along with any other change that may come up until then?

docs/traceflow-guide.md Outdated Show resolved Hide resolved
antoninbas
antoninbas reviewed Jul 31, 2020
View reviewed changes
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md Outdated Show resolved Hide resolved
docs/traceflow-guide.md
# ip: IP can also be marked as destination, but namespace/pod and ip are mutually exclusive.
packet:
ipHeader:
protocol: 6 # Protocol here can be 6 (TCP), 17 (UDP) or 1 (ICMP), default value is 1 (ICMP)
Copy link
Contributor

Choose a reason for hiding this comment

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

+1 - but is breaking backwards-compatibility an issue? maybe open an issue and we will make that change when we switch the API to beta, along with any other change that may come up until then?

@mengdie-song
Copy link
Contributor Author

/test-all

@mengdie-song
Add Traceflow User Guide
106c439 
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
antoninbas
antoninbas approved these changes Aug 3, 2020
View reviewed changes
Copy link
Contributor

@antoninbas antoninbas left a comment

Choose a reason for hiding this comment

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

LGTM

@mengdie-song mengdie-song merged commit 880d325 into antrea-io:master Aug 4, 2020
GraysonWu pushed a commit to GraysonWu/antrea that referenced this pull request Sep 22, 2020
@mengdie-song @GraysonWu
Add Traceflow User Guide (antrea-io#972)
4b79a11 
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gran-vmv gran-vmv gran-vmv left review comments

@jianjuns jianjuns jianjuns left review comments

@tnqn tnqn tnqn left review comments

@abhiraut abhiraut abhiraut left review comments

@antoninbas antoninbas antoninbas approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@mengdie-song @antrea-bot @abhiraut @antoninbas @tnqn @jianjuns @gran-vmv @vmwclabot