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

[Documentation] Update Installation #265

Merged
merged 1 commit into from
Nov 10, 2020
Merged

Conversation

JackKuo-tw
Copy link
Contributor

@JackKuo-tw JackKuo-tw commented Oct 27, 2020

  1. Fill in missing package
  2. Update unprecise word

Summary:

This PR is tested on clean Vagrant Box bento/ubuntu-20.04, add some missing packages needed by ONVM

There is one thing interesting, the original installation doc said ONVM needs Python3, but in my test it also needs Python2, so I added it.

Usage:

This PR includes
Resolves issues
Breaking API changes
Internal API changes
Usability improvements X
Bug fixes
New functionality
New NF/onvm_mgr args
Changes to starting NFs
Dependency updates
Web stats updates

Merging notes:

  • Dependencies: None

TODO before merging :

  • PR is ready for review

Test Plan:

Review:

Anyone.

@onvm
Copy link

onvm commented Oct 27, 2020

In response to PR creation

CI Message

Aborting, need an authorized user to run CI

@kevindweb
Copy link
Contributor

@JackKuo-tw thanks for looking into this. I thought we got rid of our Python 2 dependencies, do you remember, or have screenshots of where it was necessary? I think it would be better to remove those instances if possible, rather than adding the python 2 package.

@JackKuo-tw
Copy link
Contributor Author

@kevindweb Please refer to the screenshot below, it looks like dpdk-devbind.py needs python (#! /usr/bin/env python3 in the first line)
But I can use Python3 to run it correctly, so I think the problem is I need to link pyhton to python3 in my env.

Although, in this transition period (py2 -> py3), I think add a comment to remind the user is the best way.

After I change the doc, I'll notify you again, thanks.

Screen Shot 2020-11-07 at 11 08 30 PM

@JackKuo-tw
Copy link
Contributor Author

@kevindweb done, please have a look.

docs/Install.md Outdated
@@ -130,6 +130,8 @@ Configure and compile DPDK

The [install script](../scripts/install.sh) will automatically run the [environment setup script](../scripts/setup_environment.sh), which configures your local environment. This should be run once for every reboot, as it loads the appropraite kernel modules and can bind your NIC ports to the DPDK driver.

If `which python` shows **not found** in your environment, please link `python` it to your Python2 or Python3, e.g., via `link -s` or `alias python=$(which python3)`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If `which python` shows **not found** in your environment, please link `python` it to your Python2 or Python3, e.g., via `link -s` or `alias python=$(which python3)`.
If `which python` shows **not found** in your environment, please link `python` to Python3, e.g., via `link -s` or `alias python=$(which python3)`.

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 maybe changing the wording to this might let people know that Python2 isn't really relevant anymore.

Copy link
Contributor Author

@JackKuo-tw JackKuo-tw Nov 8, 2020

Choose a reason for hiding this comment

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

@kevindweb Looks great! I've modified it 😁

1. Fill in missing package
2. Update unprecise word
@dennisafa dennisafa merged commit d5ca458 into sdnfv:develop Nov 10, 2020
@twood02 twood02 added this to the ONVM 21 Summer Release milestone Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants