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

Update octant-plugin installation guide #914

Merged
merged 1 commit into from
Jul 10, 2020
Merged

Update octant-plugin installation guide #914

merged 1 commit into from
Jul 10, 2020

Conversation

mengdie-song
Copy link
Contributor

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

@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-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.

@mengdie-song mengdie-song mentioned this pull request Jul 8, 2020
Closed
tnqn
tnqn reviewed Jul 9, 2020
View reviewed changes
Copy link
Member

@tnqn tnqn left a comment

Choose a reason for hiding this comment

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

LGTM, but would let @antoninbas @jianjuns approve

docs/octant-plugin-installation.md Outdated Show resolved Hide resolved
antoninbas
antoninbas reviewed Jul 9, 2020
View reviewed changes
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/octant-plugin-installation.md Outdated Show resolved Hide resolved
antoninbas
antoninbas reviewed Jul 10, 2020
View reviewed changes
docs/octant-plugin-installation.md Outdated

```
wget -O antrea-octant-plugin https://github.com/vmware-tanzu/antrea/releases/download/v0.8.1/antrea-octant-plugin-linux-x86_64
# Make sure antrea-octant-plugin is executable, otherwise Octant can not find it.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/can not/cannot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

docs/octant-plugin-installation.md Outdated

```
wget -O antrea-octant-plugin https://github.com/vmware-tanzu/antrea/releases/download/v0.8.1/antrea-octant-plugin-linux-x86_64
# Make sure antrea-octant-plugin is executable, otherwise Octant can not find it.
chmod a+x antrea-octant-plugin
# If you did not change OCTANT_PLUGIN_PATH, the default folder should be $HOME/.config/octant/plugins.
mv antrea/plugins/octant/bin/antrea-octant-plugin $HOME/.config/octant/plugins/
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the source of the move should be antrea-octant-plugin based on the previous commands

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, thanks! Have updated.

docs/octant-plugin-installation.md Outdated
```

4. Move antrea-octant-plugin to OCTANT_PLUGIN_PATH.
For example, you can get antrea-octant-plugin-linux-x86_64 if it matches your operating system and architecture.

```
Copy link
Contributor

Choose a reason for hiding this comment

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

add bash after the triple backticks, I think Cody mentioned something about this being needed for the website (same comment for below)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

antoninbas
antoninbas previously approved these changes Jul 10, 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
Copy link
Contributor Author

/test-all

tnqn
tnqn reviewed Jul 10, 2020
View reviewed changes
docs/octant-plugin-installation.md Outdated
export KUBECONFIG=/etc/kubernetes/admin.conf
```

3. Build antrea-octant-plugin.
3. Get corresponding antrea-octant-plugin binary from [Release Assets](https://github.com/vmware-tanzu/antrea/releases/tag/v0.8.1)
Copy link
Member

Choose a reason for hiding this comment

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

I feel it should link to https://github.com/vmware-tanzu/antrea/releases and not a specific release, otherwise you will need to update it whenever a new release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@mengdie-song
Copy link
Contributor Author

/test-all

tnqn
tnqn approved these changes Jul 10, 2020
View reviewed changes
Copy link
Member

@tnqn tnqn 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 174fc96 into antrea-io:master Jul 10, 2020
@mengdie-song
Update octant-plugin installation guide
6db9ec2 
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 pull request Sep 22, 2020
@mengdie-song @GraysonWu
Update octant-plugin installation guide (antrea-io#914)
90b82d9 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tnqn tnqn tnqn approved these changes

@antoninbas antoninbas antoninbas left review comments

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

Successfully merging this pull request may close these issues.
5 participants
@mengdie-song @antrea-bot @antoninbas @tnqn @vmwclabot