Add supportbundle information to antctl documentation #812
Conversation
|
Thanks for your PR. The following commands are available:
These commands can only be run by members of the vmware-tanzu organization. |
| including logs, so please review the contents of the directory before sharing | ||
| it on Github and ensure that you do not share anything sensitive.** | ||
|
|
||
| The `antctl supportbundle` command can also be run inside a Controller or Agent |
There was a problem hiding this comment.
Do you want to mention we are able to collect bundles of only matched Nodes?
BTW, I suggested to review the current command design: provide a flag to collect controller bundle only; command with a matching expression should not include controller bundle.
There was a problem hiding this comment.
I agree with your points. I'm aware of the --controller-only flag. It seems that matching on Node name still collects cluster info & controller bundle.
I'm happy to update this document in the future when changes are made to the command. For now, I'd rather not include information that may become stale soon if the command is still evolving.
We add information on par with what we have for the other antctl commands. Fixes antrea-io#765 Some formatting issues are fixed in the documentation: * broken relative links * an empty line is required before code blocks or the markdown documentation does not render properly on the netlify website We also include some very minor code changes for antctl: * the directory where support bundles are collected is created later, to avoid creating a directory in case of an early error (e.g. invalid kubeconfig) * the timestamp suffix for the default directory name now uses a more UNIX filepath-friendly format. We also do not generate the default directory name when registering the `--dir` flag, as it causes the help output to change every time the command is invoked.
antoninbas
force-pushed
the
add-supportbundle-information-to-antctl-documentation
branch
from
e888c9b
to
5a533a0
Compare
|
/test-all |
|
/test-conformance |
|
/test-windows-conformance |
antoninbas
deleted the
add-supportbundle-information-to-antctl-documentation
branch
We add information on par with what we have for the other antctl
commands.
Fixes #765
Some formatting issues are fixed in the documentation:
documentation does not render properly on the netlify website
We also include some very minor code changes for antctl:
to avoid creating a directory in case of an early error (e.g. invalid
kubeconfig)
UNIX filepath-friendly format. We also do not generate the default
directory name when registering the
--dirflag, as it causes thehelp output to change every time the command is invoked.