diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..c0970e1 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml new file mode 100644 index 0000000..0c379e9 --- /dev/null +++ b/.idea/workspace.xml @@ -0,0 +1,302 @@ + + + + + + + + + + + + + { + "associatedIndex": 8 +} + + + + { + "keyToString": { + "RunOnceActivity.ShowReadmeOnStart": "true", + "WebServerToolWindowFactoryState": "false", + "last_opened_file_path": "C:/Users/korel/DOC_DENT/docs.dent.dev", + "node.js.detected.package.eslint": "true", + "node.js.detected.package.tslint": "true", + "node.js.selected.package.eslint": "(autodetect)", + "node.js.selected.package.tslint": "(autodetect)", + "nodejs_package_manager_path": "npm", + "ruby.rails.projectView.checked": "true", + "vue.rearranger.settings.migration": "true" + } +} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1707396882824 + + + + + + \ No newline at end of file diff --git a/Installation/DENT Installation/DENTInstallation.md b/Installation/DENT Installation/DENTInstallation.md new file mode 100644 index 0000000..aef1e25 --- /dev/null +++ b/Installation/DENT Installation/DENTInstallation.md @@ -0,0 +1,101 @@ +--- +title: DENT Installation +parent: Installation +nav_order: 1 +layout: default +--- + +# DENT Installation + +## Overview +This section will describe the process of installing DENT on a device. + +The DENT NOS build system uses an ONIE-compatible installer. +This section will describe installing the dentOS using a USB drive and connecting +to the device using a serial console. + +There are several alternative methods for installing with an ONIE +system using various networking configurations which can also be found here. + +Steps: + +1. Download or manually compile the installer image and place it on the USB drive +under the name ``onie-installer`` +(we assume that the working directory is the top directory in the local copy of the repository): + +``` +~ $ sudo mount /dev/sda /mnt/usb +~ $ sudo cp RELEASE/stretch/arm64/DENTOS-main_ONL-OS9_2021-10-26.1332-240e9a7_ARM64_INSTALLED_INSTALLER /mnt/usb/onie-installer +~ $ sudo umount /mnt/usb +``` + +Enter the ONIE environment Power on the device and upon seeing the prompt, +press ``123`` to stop autoboot and enter +the U-Boot environment. The output should be as follows: + +``` +U-Boot 2018.03-devel-1.2.0 (Jul 17 2020 - 13:58:51 +0800) TN48M/TN48M-P/TN4810M/TN48M2 V05 + +Model: Marvell Armada 7040 TN48M/TN48M-P/TN4810M/TN48M2 +SoC: Armada7040-B0; AP806-B0; CP115-A0 +Clock: CPU 1400 [MHz] + DDR 800 [MHz] + FABRIC 800 [MHz] + MSS 200 [MHz] +LLC Enabled (Exclusive Mode) +DRAM: 8 GiB +Comphy chip #0: +Comphy-0: PEX0 5 Gbps +Comphy-1: SATA0 6 Gbps +Comphy-2: SGMII0 3.125 Gbps +Comphy-3: SGMII1 1.25 Gbps +Comphy-4: UNCONNECTED +Comphy-5: SGMII2 1.25 Gbps +UTMI PHY 0 initialized to USB Host0 +PCIE-0: Link up (Gen2-x1, Bus0) +NAND: 0 MiB +MMC: +Loading Environment from SPI Flash... Bus spi@700600 CS0 address is not set correct. +SF: Detected w25q128bv with page size 256 Bytes, erase size 4 KiB, total 16 MiB +OK +EEPROM: TlvInfo v1 len=127 +Model: Marvell Armada 7040 TN48M/TN48M-P/TN4810M/TN48M2 +Net: eth0: mvpp2-0, eth1: mvpp2-1, eth2: mvpp2-2 [PRIME] +SF: Detected w25q128bv with page size 256 Bytes, erase size 4 KiB, total 16 MiB +Type 123 to STOP autoboot +``` + +If the device is currently running a non-ONIE OS operating system, we need to trigger +ONIE environment from U-boot. U-Boot has a set of pre-defined environment variables, +out of which the mostimportat one is ``bootcmd`` which is executed during every boot. +ONIE defines several variables, and more details about that can be found here. +We can trigger ONIE from U-Boot by seting the ``onie_boot_reason`` environment variable to +``install`` and run bootcmd afterward. + +``` +Marvell>> setenv onie_boot_reason install +Marvell>> run bootcmd +Loading Open Network Install Environment ... +Platform: arm64-delta_tn48m-r0 +Version : 2019.08 +SF: Detected w25q128bv with page size 256 Bytes, erase size 4 KiB, total 16 MiB +device 0 offset 0x400000, size 0xc00000 +``` + +The system should now boot into ONIE with Installer Mode Enabled. Expected console output is as follows: + +``` +** Installer Mode Enabled ** +ONIE:/ # +ONIE:/ # down. +``` + +3. Plug in the USB into the device USB port and mount it + +``ONIE:/ # mount /dev/sdb1 /mnt/usb/`` + +The system should automatically locate the ``onie-installer`` file on the drive and execute it. After the installer +is executed, the device should boot into the dentOS environment. The default password for the ``root`` user is ``onl``. + +In case there is no pre-installed operating system on the device, powering up the switch will automaticallz boot +into the ONIE install environment. ONIE will scan the USB drive for the installer file and install DentOS from it. diff --git a/Installation/LocalMachine.md b/Installation/GNS3 Installation/LocalMachine.md similarity index 75% rename from Installation/LocalMachine.md rename to Installation/GNS3 Installation/LocalMachine.md index 2bf5d19..8e60f74 100644 --- a/Installation/LocalMachine.md +++ b/Installation/GNS3 Installation/LocalMachine.md @@ -1,7 +1,7 @@ --- -title: Using your local machine +title: GNS3 on a local machine parent: Installation -nav_order: 1 +nav_order: 2 layout: default --- @@ -23,35 +23,35 @@ layout: default ### 3. Import Appliance to GNS3 -![ImageTwoOfLocalUsage](../Images/ImagesForGNS3/ImageTwoOfLocalUsage.png) +![ImageTwoOfLocalUsage](../../Images/ImagesForGNS3/ImageTwoOfLocalUsage.png)     a. Open GNS3 and go to `File -> Import Appliance`.
    b. Select the GNS3 appliance file _(gns3a file)_ you downloaded from the OneDrive link.
    c. Choose the server on which to run the appliance. -![ImageThreeOfLocalUsage](../Images/ImagesForGNS3/ImageThreeOfLocalUsage.png) +![ImageThreeOfLocalUsage](../../Images/ImagesForGNS3/ImageThreeOfLocalUsage.png) ### 4. Choose QEMU Binary     a. Choose the QEMU binary that will be used to run the DENT NOS appliance.
    b. The recommended option is `/bin/qemu-system-x86_64 (v8.0.4)`. -![ImageFourOfLocalUsage](../Images/ImagesForGNS3/ImageFourOfLocalUsage.png) +![ImageFourOfLocalUsage](../../Images/ImagesForGNS3/ImageFourOfLocalUsage.png) ### 5. Import DENT NOS Image     a. Click on the DENT NOS image file and import it.
    b. Wait for the upload to finish; this may take some time. -![ImageFiveOfLocaLUsage](../Images/ImagesForGNS3/ImageFiveOfLocalUsage.png) +![ImageFiveOfLocaLUsage](../../Images/ImagesForGNS3/ImageFiveOfLocalUsage.png) ### 6. Confirm Installation     a. You will be prompted with an installation confirmation.
-![ImageSixOfLocaLUsage](../Images/ImagesForGNS3/ImageSixOfLocalUsage.png)
+![ImageSixOfLocaLUsage](../../Images/ImagesForGNS3/ImageSixOfLocalUsage.png)
    b. Click “Yes” to confirm the installation.
-![ImageTenOfLocaLUsage](../Images/ImagesForGNS3/ImageTenOfLocalUsage.png) +![ImageTenOfLocaLUsage](../../Images/ImagesForGNS3/ImageTenOfLocalUsage.png)     **Congratulations!**
    You have successfully installed DENT NOS on GNS3. @@ -62,14 +62,14 @@ layout: default     b. Create your network topology, adding DENT NOS appliances as needed.
    c. Right-click on each appliance and select “Start” to initiate the simulation. -![ImageSevenOfLocaLUsage](../Images/ImagesForGNS3/ImageSevenOfLocalUsage.png) +![ImageSevenOfLocaLUsage](../../Images/ImagesForGNS3/ImageSevenOfLocalUsage.png) ### Default Credentials     DENT login: root
    Password: onl
-![ImageEightOfLocaLUsage](../Images/ImagesForGNS3/ImageEightOfLocalUsage.png) +![ImageEightOfLocaLUsage](../../Images/ImagesForGNS3/ImageEightOfLocalUsage.png)
diff --git a/Installation/Server.md b/Installation/GNS3 Installation/Server.md similarity index 64% rename from Installation/Server.md rename to Installation/GNS3 Installation/Server.md index a4b11df..644f7ec 100644 --- a/Installation/Server.md +++ b/Installation/GNS3 Installation/Server.md @@ -1,7 +1,7 @@ --- -title: Using a remote server +title: GNS3 on a remote server parent: Installation -nav_order: 3 +nav_order: 4 layout: default --- diff --git a/Installation/VirtualMachine.md b/Installation/GNS3 Installation/VirtualMachine.md similarity index 65% rename from Installation/VirtualMachine.md rename to Installation/GNS3 Installation/VirtualMachine.md index 6c55c88..414b58f 100644 --- a/Installation/VirtualMachine.md +++ b/Installation/GNS3 Installation/VirtualMachine.md @@ -1,7 +1,7 @@ --- -title: Using a virtual machine +title: GNS3 on a virtual machine parent: Installation -nav_order: 2 +nav_order: 3 layout: default --- @@ -11,49 +11,49 @@ First, install the DENT GNS3 appliance file as well as the disk image for the dent Virtual Machine. You can find the required files here:\*\* [DENT Image and gns3a file](https://1drv.ms/f/s!AkTUp6FU_dW0gt4dlXatZOhyr8boog?e=Ltqpa5.) -![ImageOneOfVmUsage.png](../Images/ImagesForGNS3/ImageOneOfVmUsage.png) +![ImageOneOfVmUsage.png](../../Images/ImagesForGNS3/ImageOneOfVmUsage.png) Install the appropirate GNS3 VM for your machine -![ImageTwoOfVmUsage.png](../Images/ImagesForGNS3/ImageTwoOfVmUsage.png) +![ImageTwoOfVmUsage.png](../../Images/ImagesForGNS3/ImageTwoOfVmUsage.png) If you are using VMware Workstation Pro, install the VMWare Workstation and Fusion GNS3 VM and extract the .zip folder you downloaded. -![ImageThreeOfVmUsage.png](../Images/ImagesForGNS3/ImageThreeOfVmUsage.png) +![ImageThreeOfVmUsage.png](../../Images/ImagesForGNS3/ImageThreeOfVmUsage.png) Open VMWare Workstation then click Open a Virtual Machine and select the extracted GNS3 VMWare Workstation folder. -![ImageFourOfVmUsage.png](../Images/ImagesForGNS3/ImageFourOfVmUsage.png) +![ImageFourOfVmUsage.png](../../Images/ImagesForGNS3/ImageFourOfVmUsage.png) When ready, run the Virtual Machine. You should see a screen similar to this below once the Virtual machine is running. -![ImageFiveOfVmUsage.png](../Images/ImagesForGNS3/ImageFiveOfVmUsage.png) +![ImageFiveOfVmUsage.png](../../Images/ImagesForGNS3/ImageFiveOfVmUsage.png) Now Open GNS3, go to Edit -> Preferences -> GNS3 VM and check the “Enable the (GNS3) VM” box. Select the appropriate Virtual Machine you are running GNS3 on as your Virtualization Engine and click ok -![ImageSixOfVmUsage.png](../Images/ImagesForGNS3/ImageSixOfVmUsage.png) +![ImageSixOfVmUsage.png](../../Images/ImagesForGNS3/ImageSixOfVmUsage.png) You Should now See an Additional Server Listed under Server Summary -![ImageSevenOfVmUsage.png](../Images/ImagesForGNS3/ImageSevenOfVmUsage.png) +![ImageSevenOfVmUsage.png](../../Images/ImagesForGNS3/ImageSevenOfVmUsage.png) Go to File -> Import Appliance and select the appliance file. In this scenario we will select one of the previously downloaded files “DENT - 3.2”. -![ImageEightOfVmUsage.png](../Images/ImagesForGNS3/ImageEightOfVmUsage.png) +![ImageEightOfVmUsage.png](../../Images/ImagesForGNS3/ImageEightOfVmUsage.png) The QEMU binary that will be used to run this appliance is recommended as /bin/qemu-system-x86_64(v4.2.1). -![ImageNineOfVmUsage.png](../Images/ImagesForGNS3/ImageNineOfVmUsage.png) +![ImageNineOfVmUsage.png](../../Images/ImagesForGNS3/ImageNineOfVmUsage.png) Next, we need to import the DENT image file by selecting again one of the previously downloaded files “dent-vm.qcow2” and clicking @@ -61,18 +61,18 @@ import. **Wait for the upload to finish, it may take some time.** -![ImageTenOfVmUsage.png](../Images/ImagesForGNS3/ImageTenOfVmUsage.png) +![ImageTenOfVmUsage.png](../../Images/ImagesForGNS3/ImageTenOfVmUsage.png) Once the upload is finished, you may click next and yes to install DENT -![ImageElevenOfVmUsage.png](../Images/ImagesForGNS3/ImageElevenOfVmUsage.png) +![ImageElevenOfVmUsage.png](../../Images/ImagesForGNS3/ImageElevenOfVmUsage.png) Once Installed you may now use the DENT appliance in GNS3. The example below demonstrate 3 dent appliances connecting to each other -![ImageTwelveOfVmUsage.png](../Images/ImagesForGNS3/ImageTwelveOfVmUsage.png) +![ImageTwelveOfVmUsage.png](../../Images/ImagesForGNS3/ImageTwelveOfVmUsage.png) After Starting the simulation you may right-click on any DENT appliance and select _console_ to log-in. @@ -82,7 +82,7 @@ appliance and select _console_ to log-in. - **Localhost login: root** - **Password: onl** -![ImageThirteenOfVmUsage.png](../Images/ImagesForGNS3/ImageThirteenOfVmUsage.png) +![ImageThirteenOfVmUsage.png](../../Images/ImagesForGNS3/ImageThirteenOfVmUsage.png) ### You have now successfully set up DENT in GNS3 with a virtual machine