Skip to content

Commit c648752

Browse files
Merge pull request #58 from johnbelamaric/fix-formatting
Fix formatting
2 parents ce03f52 + 47eea05 commit c648752

File tree

2 files changed

+44
-16
lines changed

2 files changed

+44
-16
lines changed

install-guide/demo-vagrant-windows.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,13 @@
1111

1212
## Networking
1313

14-
The Vagrant networking will not work on Windows to allow access to the Nephio Web UI and Gitea Web UI due the [Hyper-V limitation](https://developer.hashicorp.com/vagrant/docs/providers/hyperv/limitations#limited-networking).
15-
Meanwhile, for [VirtualBox](https://developer.hashicorp.com/vagrant/docs/providers/virtualbox/networking#virtualbox-nic-type) (used here), we can create an internal network by adding the following line to the Vagrant.configure:
14+
The Vagrant networking will not work on Windows to allow access to the Nephio
15+
Web UI and Gitea Web UI due the [Hyper-V
16+
limitation](https://developer.hashicorp.com/vagrant/docs/providers/hyperv/limitations#limited-networking).
17+
Meanwhile, for
18+
[VirtualBox](https://developer.hashicorp.com/vagrant/docs/providers/virtualbox/networking#virtualbox-nic-type)
19+
(used here), we can create an internal network by adding the following line to
20+
the Vagrant.configure:
1621

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

@@ -28,10 +33,13 @@ But the easiest way is to force the port-forwarding as shown before:
2833

2934
## Notes
3035

31-
**Warning**: For low-end machines (less then 8T32GB), you will need to modify the Vagrant file. This is not recommended!
36+
**Warning**: For low-end machines (less then 8T32GB), you will need to modify
37+
the Vagrant file. This is not recommended!
3238

33-
- In the Vagrant file "./Vagrantfile", there are *CPUS & RAM* parameters in `config.vm.provider`, it's possible to override them at runtime:
39+
- In the Vagrant file "./Vagrantfile", there are *CPUS & RAM* parameters in
40+
`config.vm.provider`, it's possible to override them at runtime:
41+
- On Linux, or the Git Bash on Windows we can use a one-liner command `CPUS=16
42+
MEMORY=32768 vagrant up`
3443

35-
-On Linux, or the Git Bash on Windows we can use a one-liner command `CPUS=16 MEMORY=32768 vagrant up`
36-
37-
- In the Ansible "./playbooks/roles/bootstrap/tasks/prechecks.yml" file, there are the checks for *CPUS & RAM*
44+
- In the Ansible "./playbooks/roles/bootstrap/tasks/prechecks.yml" file, there
45+
are the checks for *CPUS & RAM*

install-guide/explore-sandbox.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Exploring the Nephio Sandbox
22
============================
33

4-
You have installed the Nephio sandbox on your VM
5-
[using the installation instructions](https://github.com/nephio-project/test-infra/blob/main/e2e/provision/README.md). The installation has done a good job of installing a complex software stack without any fuss. Let's take a look around.
4+
You have installed the Nephio sandbox on your VM [using the installation
5+
instructions](https://github.com/nephio-project/test-infra/blob/main/e2e/provision/README.md).
6+
The installation has done a good job of installing a complex software stack
7+
without any fuss. Let's take a look around.
68

79
![Software Installed by the Nephio Sandbox Installation](ExploreSandbox-diagrams/ManagementCluster.png)
810

@@ -19,15 +21,28 @@ The following components are installed on the VM itself. These components are in
1921
| cni | Used to implement the k8s network model for the KinD clusters |
2022
| gtp5g | A Linux module that supports the 3GPP GPRS tunneling protocol (required by free5gc NFs) |
2123

22-
The Ansible install scripts use kind to create the Management cluster. Once the Management KinD cluster is created, the install uses kpt packages to install the remainder of the software.
24+
The Ansible install scripts use kind to create the Management cluster. Once the
25+
Management KinD cluster is created, the install uses kpt packages to install the
26+
remainder of the software.
2327

2428
# Components Installed on the Management KinD cluster
2529

26-
Everything is installed on the Management KinD cluster by Ansible scripts using kpt packages.
30+
Everything is installed on the Management KinD cluster by Ansible scripts using
31+
kpt packages.
2732

28-
The install unpacks each kpt package in the */tmp* directory. It then applies the kpt functions to the packages and applies the packages to the Management KinD cluster. This allows the user to check the status of the kpt packages in the cluster using the *kpt live status* command on the unpacked packages in the */tmp* directory.
33+
The install unpacks each kpt package in the */tmp* directory. It then applies
34+
the kpt functions to the packages and applies the packages to the Management
35+
KinD cluster. This allows the user to check the status of the kpt packages in
36+
the cluster using the *kpt live status* command on the unpacked packages in the
37+
*/tmp* directory.
2938

30-
The rendered kpt packages containing components are unpacked in the */tmp/kpt-pkg* directory. The rendered kpt packages that create the *mgmt* and *mgmt-staging* repositories are unpacked in the */tmp/repository* directory. The rendered kpt package containing the rootsync configuration for the *mgmt* repository is unpacked in the */tmp/rootsync* directory. You can examine the contents of any rendered kpt packager by examining the contents of these directories.
39+
The rendered kpt packages containing components are unpacked in the
40+
*/tmp/kpt-pkg* directory. The rendered kpt packages that create the *mgmt* and
41+
*mgmt-staging* repositories are unpacked in the */tmp/repository* directory. The
42+
rendered kpt package containing the rootsync configuration for the *mgmt*
43+
repository is unpacked in the */tmp/rootsync* directory. You can examine the
44+
contents of any rendered kpt packager by examining the contents of these
45+
directories.
3146

3247
```
3348
/tmp/kpt-pkg/ /tmp/repository /tmp/rootsync/
@@ -90,7 +105,10 @@ inventory-38069595/namespace//nephio-system is Current: Resource is current
90105

91106
## Base Components
92107

93-
The following base components are installed on the Management cluster. Base components are the infrastructure components that are needed for the Nephio sandbox, which Nephio uses out of the box. In real world installations, alternative components that provide the same functionality may be used.
108+
The following base components are installed on the Management cluster. Base
109+
components are the infrastructure components that are needed for the Nephio
110+
sandbox, which Nephio uses out of the box. In real world installations,
111+
alternative components that provide the same functionality may be used.
94112

95113
| Component | Purpose |
96114
| ------------ | -------------------------------------------------------------------|
@@ -104,8 +122,10 @@ The following base components are installed on the Management cluster. Base comp
104122

105123
## Specific Components
106124

107-
The following specific components are installed on the Management cluster. The specific components are Nephio components and components from
108-
[Google Container Tools](https://github.com/GoogleContainerTools) that Nephio uses heavily and interacts closely with.
125+
The following specific components are installed on the Management cluster. The
126+
specific components are Nephio components and components from [Google Container
127+
Tools](https://github.com/GoogleContainerTools) that Nephio uses heavily and
128+
interacts closely with.
109129

110130
| Component | Purpose |
111131
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)