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

Missing documentation for Traceflow API #901

Closed
antoninbas opened this issue Jul 2, 2020 · 2 comments
Closed

Missing documentation for Traceflow API #901

antoninbas opened this issue Jul 2, 2020 · 2 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to a documentation.

Comments

@antoninbas
Copy link
Contributor

There is currently no documentation, whether for the CRD API or the UI Octant plugin (screenshots / a video may be useful there).

See the documentation we have for Antrea ClusterNetworkPolicies: https://github.com/vmware-tanzu/antrea/blob/master/docs/network-policy.md

@antoninbas antoninbas added the kind/bug Categorizes issue or PR as related to a bug. label Jul 2, 2020
@abhiraut abhiraut added the kind/documentation Categorizes issue or PR as related to a documentation. label Jul 2, 2020
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 6, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merge antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 6, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 10, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 10, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 10, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
mengdie-song added a commit that referenced this issue Jul 10, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: #901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 21, 2020
Add document to guide users how to
use Traceflow via Antrea UI.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 21, 2020
Add document to guide users how to
use Traceflow via Antrea UI.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 21, 2020
Add document to guide users how to
use Traceflow via Antrea UI.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 22, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 22, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 22, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 22, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 27, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 27, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 28, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Jul 30, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit to mengdie-song/antrea that referenced this issue Aug 2, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: antrea-io#901
mengdie-song added a commit that referenced this issue Aug 4, 2020
Add document to guide users how to
use Traceflow via Antrea UI and Kubectl.

Related: #901
@jianjuns
Copy link
Contributor

jianjuns commented Sep 22, 2020

Should we close this one? @antoninbas @mengdie-song

@antoninbas
Copy link
Contributor Author

Yes we can close this. We have a user guide and I have a more generic issue to auto-generate API documentation for Antrea interfaces: #1287

GraysonWu pushed a commit to GraysonWu/antrea that referenced this issue Sep 22, 2020
Since we have included antrea-octant-plugin binary
into release assets and have a separate plugin
for Traceflow for now, update octant-plugin installation
guide to address the changes.

TODO: Update the doc after merging antrea-traceflow-plugin
into antrea-octant-plugin.

Related: antrea-io#901
GraysonWu pushed a commit to GraysonWu/antrea that referenced this issue Sep 22, 2020
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
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to a documentation.
Projects
None yet
Development

No branches or pull requests

3 participants