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

Windows demo documentation #20

Merged
merged 5 commits into from
Jun 27, 2023
Merged

Windows demo documentation #20

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7068e6
Doc for windows demo
lapentad Jun 13, 2023
d25f66d
Update demo-vagrant-windows.md
lapentad Jun 13, 2023
bb556f9
Update demo-vagrant-windows.md
lapentad Jun 13, 2023
77b5daf
Update install-guide/demo-vagrant-windows.md
lapentad Jun 16, 2023
f8949ab
Removal of autocrlf step
lapentad Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions install-guide/demo-vagrant-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Nephio demo on Windows

## Steps:
- install git
- install virtualbox
- install [vagrant](https://developer.hashicorp.com/vagrant/docs/installation)
- open git bash
- `git clone https://github.com/nephio-project/test-infra.git && cd test-infra/e2e/provision`
- `vagrant up`
- `vagrant ssh -- -L 7007:localhost:7007 -L 3000:172.18.0.200:3000`

## Networking

Also in order to access the nephio web-ui and gitea web-ui, the vagrant networking will not work on windows for [Hyper-V limitation](https://developer.hashicorp.com/vagrant/docs/providers/hyperv/limitations#limited-networking).
Meanwhile for [Virtualbox](https://developer.hashicorp.com/vagrant/docs/providers/virtualbox/networking#virtualbox-nic-type) (used here) we can create an internal network adding this line to Vagrant.configure:

`config.vm.network "private_network", ip: "192.168.50.4", virtualbox__intnet: true`

But the easiest way is to force the port-forwarding in the common way (as shown before):

`vagrant ssh -- -L 7007:localhost:7007 -L 3000:172.18.0.200:3000`

## Tests were done on:

1. Laptop : Windows 11 i7-10750H (16 T) 32GB ram (8VCPU 32GB)

2. Laptop : Windows 10 i5-7200U (4T) 24GB ram (4VCPU 16RAM)

## Notes

**Warning**: for low end machines(less then 8T32GB) you need to alter the Vagrant file. This is not recommended!

- In the Vagrant file "./Vagrantfile" there are *CPUS & RAM* parameters in `config.vm.provider`, it's possible to override them at runtime:

-On Linux, or the Git Bash on Windows we can use one-liner command `CPUS=16 MEMORY=32768 vagrant up`

- In the ansible "./playbooks/roles/bootstrap/tasks/prechecks.yml" there are the checks for *CPUS & RAM*
Copy link
Member

Choose a reason for hiding this comment

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

Eventually, we have to define/test these values

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, as from my tests using the 4CPUs and 16GB RAM the provisioning it's possible. But, I wouldn't recommend it because:

  • It takes around 30 minutes for all the kpt packages to be applied
  • I have not experienced any memory leaks, but the flow to 'Deploy Free5GC control plane functions' feels sluggish

Copy link
Member

Choose a reason for hiding this comment

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

I was thinking to increase the current CPU/Memory requirements, but doing that we'll restrict the number of users.