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

Document antctl #337

Closed
antoninbas opened this issue Jan 21, 2020 · 3 comments · Fixed by #529
Closed

Document antctl #337

antoninbas opened this issue Jan 21, 2020 · 3 comments · Fixed by #529
Assignees
@antoninbas
Labels
area/component/antctl Issues or PRs releated to the command line interface component enhancement New feature or request kind/documentation Categorizes issue or PR as related to a documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Milestone
Antrea v0.5.0 rel...

Comments

@antoninbas
Copy link
Contributor

Describe the problem/challenge you have
It seems that there is no documentation available for antctl.

Describe the solution you'd like
While it is probably not necessary at this stage to document every individual command that we may add (one can use the help messages), we should document a few things that can be surprising at first when using antctl. Some things which come to mind:

  • in-pod vs not in-pod
  • agent vs controller
  • when not in-pod, rules to determine kubeconfig (default, KUBECONFIG env variable, --kubeconfig command-line flag?)
  • which commands are available based on the different modes
  • some examples for the different "modes"

This information can probably go into docs/troubleshooting.md, at least for now.

This is not meant to replace the information in the architecture doc, but is meant to be user-facing documentation on how to use the antctl CLI.
@antoninbas antoninbas added the enhancement New feature or request label Jan 21, 2020
@antoninbas
Copy link
Contributor Author

Tagging this "optimistically" with release 0.3.0 since antctl will be part of that release.

@antoninbas antoninbas added this to the Antrea v0.3.0 release milestone Jan 21, 2020
@antoninbas antoninbas mentioned this issue Jan 22, 2020
Closed
@antoninbas
Copy link
Contributor Author

Pushing this out to 0.4.0 as discussed at the 01/22/2020 community meeting.

@McCodeman McCodeman added kind/documentation Categorizes issue or PR as related to a documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. area/component/antctl Issues or PRs releated to the command line interface component labels Feb 12, 2020
@antoninbas
Copy link
Contributor Author

No open patch for this (probably will happen after #356), so pushing this out to 0.5.0.

@McCodeman McCodeman added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Feb 26, 2020
@antoninbas antoninbas self-assigned this Mar 19, 2020
antoninbas added a commit to antoninbas/antrea that referenced this issue Mar 21, 2020
@antoninbas
Start documentation for antctl
bf7ad32 
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 mentioned this issue Mar 21, 2020
Merged
antoninbas added a commit to antoninbas/antrea that referenced this issue Mar 23, 2020
@antoninbas
Start documentation for antctl
e73a901 
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 added a commit to antoninbas/antrea that referenced this issue Mar 23, 2020
@antoninbas
Start documentation for antctl
7f89d25 
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 added a commit to antoninbas/antrea that referenced this issue Mar 24, 2020
@antoninbas
Start documentation for antctl
e8be942 
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 added a commit that referenced this issue Mar 24, 2020
@antoninbas
Start documentation for antctl
b3a5c27 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@antoninbas antoninbas

Labels
area/component/antctl Issues or PRs releated to the command line interface component enhancement New feature or request kind/documentation Categorizes issue or PR as related to a documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Milestone
Antrea v0.5.0 release
Development

Successfully merging a pull request may close this issue.

Start documentation for antctl antoninbas/antrea
2 participants
@antoninbas @McCodeman