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

Start documentation for antctl #529

Merged

Conversation

antoninbas
Copy link
Contributor

Add a new document under docs/ with information on how to install
(instructions valid starting with release 0.5.0) and use antctl. This is
user-facing documentation and does not include information about the
antctl implementation.

We also do not include a detailed list of commands at the moment. This
list can come later if needed (can be hard to keep up-to-date), and we
can keep adding information about specific commands in
troubleshooting.md for specific debugging scenarios.

Fixes #337

@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-networkpolicy: to trigger networkpolicy tests.
  • /skip-networkpolicy: to skip networkpolicy tests.
  • /test-all: to trigger all tests.
  • /skip-all: to skip all tests.

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

Copy link
Contributor

@abhiraut abhiraut left a comment

Choose a reason for hiding this comment

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

lgtm

docs/antctl.md Outdated Show resolved Hide resolved
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.

LGTM

weiqiangt
weiqiangt previously approved these changes Mar 21, 2020
Copy link
Contributor

@weiqiangt weiqiangt left a comment

Choose a reason for hiding this comment

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

LGTM, left one question.

docs/antctl.md Show resolved Hide resolved
lzhecheng
lzhecheng previously approved these changes Mar 23, 2020
Copy link
Contributor

@lzhecheng lzhecheng left a comment

Choose a reason for hiding this comment

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

LGTM

abhiraut
abhiraut previously approved these changes Mar 23, 2020
@antoninbas
Copy link
Contributor Author

/skip-all

abhiraut
abhiraut previously approved these changes Mar 24, 2020
weiqiangt
weiqiangt previously approved these changes Mar 24, 2020
Add a new document under docs/ with information on how to install
(instructions valid starting with release 0.5.0) and use antctl. This is
user-facing documentation and does not include information about the
antctl implementation.

We also do not include a detailed list of commands at the moment. This
list can come later if needed (can be hard to keep up-to-date), and we
can keep adding information about specific commands in
troubleshooting.md for specific debugging scenarios.

Fixes antrea-io#337
@antoninbas antoninbas dismissed stale reviews from weiqiangt and abhiraut via e8be942 March 24, 2020 18:58
@antoninbas antoninbas force-pushed the start-documentation-for-antctl branch from 7f89d25 to e8be942 Compare March 24, 2020 18:58
@antoninbas
Copy link
Contributor Author

/skip-all

@antoninbas antoninbas merged commit b3a5c27 into antrea-io:master Mar 24, 2020
@antoninbas antoninbas deleted the start-documentation-for-antctl branch March 24, 2020 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document antctl
7 participants