From c43f6ed97544191ca804a8885caa3af8906e7f65 Mon Sep 17 00:00:00 2001 From: Andy Fingerhut Date: Wed, 16 Oct 2024 18:55:00 -0400 Subject: [PATCH 1/3] Move optional steps for testing VMs out of README.md file This may help avoid new users being confused that they must follow those instructions. Signed-off-by: Andy Fingerhut --- vm-ubuntu-20.04/README.md | 217 +--------------- vm-ubuntu-20.04/create-vm-image-for-others.md | 210 ++++++++++++++++ vm-ubuntu-24.04/README.md | 235 +----------------- vm-ubuntu-24.04/create-vm-image-for-others.md | 214 ++++++++++++++++ 4 files changed, 435 insertions(+), 441 deletions(-) create mode 100644 vm-ubuntu-20.04/create-vm-image-for-others.md create mode 100644 vm-ubuntu-24.04/create-vm-image-for-others.md diff --git a/vm-ubuntu-20.04/README.md b/vm-ubuntu-20.04/README.md index ade3084c..6a1eb7ff 100644 --- a/vm-ubuntu-20.04/README.md +++ b/vm-ubuntu-20.04/README.md @@ -1,10 +1,12 @@ # Creating the VM + + Below are the steps to create a brand new VM using Vagrant: + Install [Vagrant](https://developer.hashicorp.com/vagrant/docs/installation) on your system if it's not already installed. - + Navigate to the directory where you want to create the new VM. + + In a shell/terminal window, change to this `vm-ubuntu-20.04` + directory inside the `tutorials` directory. + Run the below command in the terminal. - ``` + ```bash vagrant up ``` @@ -13,214 +15,9 @@ - You can update these packages using `apt upgrade` within the VM. + Alternatively, a development VM can be created by running - ``` + ```bash vagrant up dev ``` -*Note* : that creating a development VM can take one to several -hours, depending upon the speed of your computer and Internet -connection. - -Below are steps that were performed _after_ one of the commands above -was run on the host OS, before creating the VM images. Some of these -steps could probably be automated with programs, and changes to the -`vagrant` scripts that can do so are welcome. I performed these steps -manually to create a VM image, simply to avoid the experimentation and -time required to automate them. I typically only create new VM images -once per month. - -+ Log in as user p4 (password p4) -+ Click "Upgrade" in the pop-up window asking if you want to upgrade - the system, if asked. This will download the latest Linux kernel - version released for Ubuntu 20.04, and other updated packages. -+ Reboot the system. -+ This is optional, but if you want to save a little disk space, use - - ``` - sudo apt purge - ``` - - to remove older version of Linux - kernel, if the upgrade installed a newer one. -+ Clean the local repository of retrieved package files to free up disk space - - ``` - sudo apt clean - ``` - -+ Log in as user p4 (password p4) -+ Start menu -> Preferences -> LXQt settings -> Monitor settings - + Change resolution from initial 800x600 to 1024x768. Apply the changes. - + Close monitor settings window - + *Note*: For some reason I do not know, these settings seem to be - undone, even if I use the "Save" button. They are temporarily in - effect if I shut down the system and log back in, but then in a few - seconds it switches back to 800x600. Strange. -+ Start menu -> Preferences -> LXQt settings -> Desktop - + In "Wallpaper mode" popup menu, choose "Center on the screen". - + Click Apply button - + Close "Desktop preferences" window -+ Several of the icons on the desktop have an exclamation mark on - them. If you try double-clicking those icons, it pops up a window - saying "This file 'Wireshark' seems to be a desktop entry. What do - you want to do with it?" with buttons for "Open", "Execute", and - "Cancel". Clicking "Execute" executes the associated command. - If you do a mouse middle click on one of these desktop icons, a - popup menu appears where the second-to-bottom choice is "Trust this - executable". Selecting that causes the exclamation mark to go away, - and future double-clicks of the icon execute the program without - first popping up a window to choose between Open/Execute/Cancel. I - did that for each of these desktop icons: - + Terminal - + Wireshark -+ Log off - -+ Log in as user vagrant (password vagrant) -+ Change monitor settings and wallpaper mode as described above for - user p4. -+ Open a terminal. - + Run the command - - ``` - ./clean.sh - ``` - which removes about 6 to 7 GBytes of - files created while building the projects. -+ Log off - - -# Notes on test results for the VM - -I have run the tests below on every VM image I release, before -releasing it. You need not run them again, unless you are curious how -to do so. - - -## p4c testing results - -Steps to run the p4c tests: - -+ Log in as user vagrant (password vagrant) -+ In a new terminal, execute these commands: - -If you are testing on a Release VM image, first get a copy of the p4c -source code using the following command. This is unnecessary with a -Development VM image, as there is already a `p4c` directory with the -version of source code used to create that image already included in -the home directory of the `vagrant` user account: - -```bash -# for Release VM image only -git clone --recursive https://github.com/p4lang/p4c -``` - -The following steps are common for both Release and Development VM -images: - -```bash -# Compile p4c again from source, since the clean.sh step reduced disk -# space by deleting the p4c/build directory. -git clone https://github.com/jafingerhut/p4-guide -cd p4c -~/p4-guide/bin/build-p4c.sh - -# Run the p4c tests -cd build -make -j2 check |& tee make-check-out.txt -``` - -As of 2024-08-01, the p4c compiler passes all of its included tests, -except for some of the p4testgen tests (if those are enabled). - - -## Send ping packets in the solution to `basic` exercise of `p4lang/tutorials` repository - -With the version of the [tutorials](https://github.com/p4lang/tutorials) repository -that comes pre-installed in the `p4` user account of this VM, the -following tests pass. - -First log in as the user `p4` (password `p4`) and open a terminal -window. -```bash -$ cd tutorials/exercises/basic -$ cp solution/basic.p4 basic.p4 -$ make run -``` - -If at the end of many lines of logging output you see a prompt -`mininet>`, you can try entering the command `h1 ping h2` to ping from -virtual host `h1` in the exercise to `h2`, and it should report a -successful ping every second. It will not stop on its own. You can -type Control-C to stop it and return to the `mininet>` prompt, and you -can type Control-D to exit from mininet and get back to the original -shell prompt. To ensure that any processes started by the above steps -are terminated, you can run this command: -```bash -$ make stop -``` - - -# Creating a single file image of the VM - -These notes are primarily here as a reminder for people creating VM -images for distribution. If you downloaded a VM image, these steps -were already performed, and there is no reason you need to perform -them again. - -For the particular case of creating the VM named: - -+ 'P4 Tutorial Development 2024-08-01' -+ created on August 1, 2024 - -here were the host OS details, in case it turns out that matters to -the finished VM image for some reason: - -+ Windows 10 Enterprise -+ VirtualBox 6.1.30 r148432 -+ Vagrant 2.2.18 - -In the VirtualBox GUI interface: - -+ Choose menu item File -> Export Appliance ... -+ Select the VM named 'P4 Tutorial Development 2024-08-01' and click - Continue button - -+ Format - + I used: Open Virtualization Format 1.0 - + Other available options were: - + Open Virtualization Format 0.9 - + Open Virtualization Format 2.0 -+ Target file - + I used: /Users/andy/Documents/P4 Tutorials Development 2024-08-01.ova -+ Mac Address Policy - + I used: Include only NAT network adapter MAC addresses - + Other available options were: - + Include all network adapter MAC addresses - + Strip all network adapter MAC addresses -+ Additionally - + Write Manifest file: checked - + Include ISO image files: unchecked - -Clicked "Continue" button. - -Virtual system settings: - -+ Name: P4 Tutorial 2024-08-01 -+ Product: I left this blank -+ Product-URL: I left this blank -+ Vendor: P4.org - P4 Language Consortium -+ Vendor-URL: https://p4.org -+ Version: 2024-08-01 -+ Description: - -``` -Open source P4 development tools built from latest source code as of 2024-Aug-01 and packaged into an Ubuntu 20.04 Desktop Linux VM for the AMD64 architecture. -``` - -+ License - -``` -Open source code available hosted at https://github.com/p4lang is released under the Apache 2.0 license. Libraries it depends upon, such as Protobuf, Thrift, gRPC, Ubuntu Linux, etc. are released under their own licenses. -``` - -Clicked "Export" button. +*Note* that creating a development VM can take several hours, +depending upon the speed of your computer and Internet connection. diff --git a/vm-ubuntu-20.04/create-vm-image-for-others.md b/vm-ubuntu-20.04/create-vm-image-for-others.md new file mode 100644 index 00000000..6f050d1f --- /dev/null +++ b/vm-ubuntu-20.04/create-vm-image-for-others.md @@ -0,0 +1,210 @@ +# Creating a VM image for distribution to others + +If you want to run `p4c` tests, see the next section on how to do so, +_before_ running the commands in this section, since the commands in +this section will delete files that take one to several hours to +create while compiling p4c, needed for running p4c tests. + +Below are steps that were performed _after_ the commands in the +README.md file were run on the host OS, before creating the VM images. +Some of these steps could probably be automated with programs, and +changes to the `vagrant` scripts that can do so are welcome. I +performed these steps manually to create a VM image, simply to avoid +the experimentation and time required to automate them. I typically +only create new VM images once per month. + ++ Log in as user p4 (password p4) ++ Click "Upgrade" in the pop-up window asking if you want to upgrade + the system, if asked. This will download the latest Linux kernel + version released for Ubuntu 20.04, and other updated packages. ++ Reboot the system. ++ This is optional, but if you want to save a little disk space, use + + ``` + sudo apt purge + ``` + + to remove older version of Linux + kernel, if the upgrade installed a newer one. ++ Clean the local repository of retrieved package files to free up disk space + + ``` + sudo apt clean + ``` + ++ Log in as user p4 (password p4) ++ Start menu -> Preferences -> LXQt settings -> Monitor settings + + Change resolution from initial 800x600 to 1024x768. Apply the changes. + + Close monitor settings window + + *Note*: For some reason I do not know, these settings seem to be + undone, even if I use the "Save" button. They are temporarily in + effect if I shut down the system and log back in, but then in a few + seconds it switches back to 800x600. Strange. ++ Start menu -> Preferences -> LXQt settings -> Desktop + + In "Wallpaper mode" popup menu, choose "Center on the screen". + + Click Apply button + + Close "Desktop preferences" window ++ Several of the icons on the desktop have an exclamation mark on + them. If you try double-clicking those icons, it pops up a window + saying "This file 'Wireshark' seems to be a desktop entry. What do + you want to do with it?" with buttons for "Open", "Execute", and + "Cancel". Clicking "Execute" executes the associated command. + If you do a mouse middle click on one of these desktop icons, a + popup menu appears where the second-to-bottom choice is "Trust this + executable". Selecting that causes the exclamation mark to go away, + and future double-clicks of the icon execute the program without + first popping up a window to choose between Open/Execute/Cancel. I + did that for each of these desktop icons: + + Terminal + + Wireshark ++ Log off + ++ Log in as user vagrant (password vagrant) ++ Change monitor settings and wallpaper mode as described above for + user p4. ++ Open a terminal. + + Run the command + + ``` + ./clean.sh + ``` + which removes about 6 to 7 GBytes of + files created while building the projects. ++ Log off + + +# Notes on test results for the VM + +I have run the tests below on every VM image I release, before +releasing it. You need not run them again, unless you are curious how +to do so. + + +## p4c testing results + +Steps to run the p4c tests: + ++ Log in as user vagrant (password vagrant) ++ In a new terminal, execute these commands: + +If you are testing on a Release VM image, first get a copy of the p4c +source code using the following command. This is unnecessary with a +Development VM image, as there is already a `p4c` directory with the +version of source code used to create that image already included in +the home directory of the `vagrant` user account: + +```bash +# for Release VM image only +git clone --recursive https://github.com/p4lang/p4c +``` + +The following steps are common for both Release and Development VM +images: + +```bash +# Compile p4c again from source, since the clean.sh step reduced disk +# space by deleting the p4c/build directory. +git clone https://github.com/jafingerhut/p4-guide +cd p4c +~/p4-guide/bin/build-p4c.sh + +# Run the p4c tests +cd build +make -j2 check |& tee make-check-out.txt +``` + +As of 2024-08-01, the p4c compiler passes all of its included tests, +except for some of the p4testgen tests (if those are enabled). + + +## Send ping packets in the solution to `basic` exercise of `p4lang/tutorials` repository + +With the version of the [tutorials](https://github.com/p4lang/tutorials) repository +that comes pre-installed in the `p4` user account of this VM, the +following tests pass. + +First log in as the user `p4` (password `p4`) and open a terminal +window. +```bash +$ cd tutorials/exercises/basic +$ cp solution/basic.p4 basic.p4 +$ make run +``` + +If at the end of many lines of logging output you see a prompt +`mininet>`, you can try entering the command `h1 ping h2` to ping from +virtual host `h1` in the exercise to `h2`, and it should report a +successful ping every second. It will not stop on its own. You can +type Control-C to stop it and return to the `mininet>` prompt, and you +can type Control-D to exit from mininet and get back to the original +shell prompt. To ensure that any processes started by the above steps +are terminated, you can run this command: +```bash +$ make stop +``` + + +# Creating a single file image of the VM + +These notes are primarily here as a reminder for people creating VM +images for distribution. If you downloaded a VM image, these steps +were already performed, and there is no reason you need to perform +them again. + +For the particular case of creating the VM named: + ++ 'P4 Tutorial Development 2024-08-01' ++ created on August 1, 2024 + +here were the host OS details, in case it turns out that matters to +the finished VM image for some reason: + ++ Windows 10 Enterprise ++ VirtualBox 6.1.30 r148432 ++ Vagrant 2.2.18 + +In the VirtualBox GUI interface: + ++ Choose menu item File -> Export Appliance ... ++ Select the VM named 'P4 Tutorial Development 2024-08-01' and click + Continue button + ++ Format + + I used: Open Virtualization Format 1.0 + + Other available options were: + + Open Virtualization Format 0.9 + + Open Virtualization Format 2.0 ++ Target file + + I used: /Users/andy/Documents/P4 Tutorials Development 2024-08-01.ova ++ Mac Address Policy + + I used: Include only NAT network adapter MAC addresses + + Other available options were: + + Include all network adapter MAC addresses + + Strip all network adapter MAC addresses ++ Additionally + + Write Manifest file: checked + + Include ISO image files: unchecked + +Clicked "Continue" button. + +Virtual system settings: + ++ Name: P4 Tutorial 2024-08-01 ++ Product: I left this blank ++ Product-URL: I left this blank ++ Vendor: P4.org - P4 Language Consortium ++ Vendor-URL: https://p4.org ++ Version: 2024-08-01 ++ Description: + +``` +Open source P4 development tools built from latest source code as of 2024-Aug-01 and packaged into an Ubuntu 20.04 Desktop Linux VM for the AMD64 architecture. +``` + ++ License + +``` +Open source code available hosted at https://github.com/p4lang is released under the Apache 2.0 license. Libraries it depends upon, such as Protobuf, Thrift, gRPC, Ubuntu Linux, etc. are released under their own licenses. +``` + +Clicked "Export" button. diff --git a/vm-ubuntu-24.04/README.md b/vm-ubuntu-24.04/README.md index 31466a58..9a2fb11c 100644 --- a/vm-ubuntu-24.04/README.md +++ b/vm-ubuntu-24.04/README.md @@ -1,10 +1,7 @@ # Introduction -This directory is still new and a bit experimental at this point. -Feel free to try it out and report problems if you find any. - -Known issues that anyone who knows how to fix is welcome to suggest -improvements: +Known minor issues that anyone who knows how to fix is welcome to +suggest improvements: + The desktop icon for the Wireshark application does not seem to exist, at least not under the name that worked for Ubuntu 20.04, so @@ -15,7 +12,8 @@ improvements: + Below are the steps to create a brand new VM using Vagrant: + Install [Vagrant](https://developer.hashicorp.com/vagrant/docs/installation) on your system if it's not already installed. - + Navigate to the directory where you want to create the new VM. + + In a shell/terminal window, change to this `vm-ubuntu-24.04` + directory inside the `tutorials` directory. + Run the below command in the terminal. ```bash @@ -30,228 +28,3 @@ improvements: *Note* that creating a development VM can take several hours, depending upon the speed of your computer and Internet connection. - - -# Creating a VM image for distribution to others - -If you are creating the VM for your own use, there is no need to read -further below. All later instructions are for those who wish to -create a VM image for others to download and use. - -Some of these steps could probably be automated with programs, and -changes to the `vagrant` scripts that can do so are welcome. I -perform these steps manually to create a VM image, simply to avoid the -experimentation and time required to automate them. I typically only -create new VM images once per month. - -+ Log in as user p4 (password p4) -+ Upgrade Ubuntu packages if newer ones are available: - - ```bash - sudo apt update - sudo apt upgrade - ``` - -+ Reboot the system. -+ This is optional, but if you want to save a little disk space, use - - ```bash - sudo apt purge - ``` - - to remove older version of Linux - kernel, if the upgrade installed a newer one. -+ Clean the local repository of retrieved package files to free up disk space - - ```bash - sudo apt clean - ``` - -+ Log in as user p4 (password p4) -+ Start menu -> Preferences -> LXQt settings -> Monitor settings - + Change resolution from initial 800x600 to 1024x768. Apply the changes. - + Close monitor settings window - + *Note*: For some reason I do not know, these settings seem to be - undone, even if I use the "Save" button. They are temporarily in - effect if I shut down the system and log back in, but then in a few - seconds it switches back to 800x600. Strange. -+ Start menu -> Preferences -> LXQt settings -> Desktop - + Click "Background" tab - + To the right of "Wallpaper image file" name, click "Browse" - button. Find and choose "lxqt-default-wallpaper.png" from the - list and click "Open". - + In "Wallpaper mode" popup menu, choose "Center on the screen". - + Click Apply button - + Close "Desktop preferences" window -+ Start menu -> Preferences -> LXQt settings -> Appearance - + Click "Icons Theme" in left column - + Click "Ubuntu-Mono-Light ..." in right column. - + Click "Apply" button, then "Close" button. -+ Several of the icons on the desktop have an exclamation mark on - them. If you try double-clicking those icons, it pops up a window - saying "This file 'Wireshark' seems to be a desktop entry. What do - you want to do with it?" with buttons for "Open", "Execute", and - "Cancel". Clicking "Execute" executes the associated command. - If you do a mouse middle click on one of these desktop icons, a - popup menu appears where the second-to-bottom choice is "Trust this - executable". Selecting that causes the exclamation mark to go away, - and future double-clicks of the icon execute the program without - first popping up a window to choose between Open/Execute/Cancel. I - did that for each of these desktop icons: - + Terminal - + Wireshark -+ Log off - -+ Log in as user vagrant (password vagrant) -+ Change monitor settings and wallpaper mode as described above for - user p4. -+ Open a terminal. - + Run the command - - ```bash - ./clean.sh - ``` - which removes about 6 to 7 GBytes of - files created while building the projects. -+ Log off - - -# Notes on test results for the VM - -I have run the tests below on every VM image I release, before -releasing it. You need not run them again, unless you are curious how -to do so. - - -## p4c testing results - -Steps to run the p4c tests: - -+ Log in as user vagrant (password vagrant) -+ In a new terminal, execute these commands: - -If you are testing on a Release VM image, first get a copy of the p4c -source code using the following command. This is unnecessary with a -Development VM image, as there is already a `p4c` directory with the -version of source code used to create that image already included in -the home directory of the `vagrant` user account: - -```bash -# for Release VM image only -git clone --recursive https://github.com/p4lang/p4c -``` - -The following steps are common for both Release and Development VM -images: - -```bash -# Compile p4c again from source, since the clean.sh step reduced disk -# space by deleting the p4c/build directory. -git clone https://github.com/jafingerhut/p4-guide -cd p4c -~/p4-guide/bin/build-p4c.sh - -# Run the p4c tests -cd build -make -j2 check |& tee out1.txt - -# The above fails about 500 tests that require root. Re-run those tests -# as root using the next command. -sudo PATH=${PATH} VIRTUAL_ENV=${VIRTUAL_ENV} ${P4GUIDE_SUDO_OPTS} make -j2 recheck |& tee out2.txt -``` - -As of 2024-08-01, the p4c compiler passes all but about 15 of its -included tests when built using the steps above. - - -## Send ping packets in the solution to `basic` exercise of `p4lang/tutorials` repository - -With the version of the [tutorials](https://github.com/p4lang/tutorials) repository -that comes pre-installed in the `p4` user account of this VM, the -following tests pass. - -First log in as the user `p4` (password `p4`) and open a terminal -window. -```bash -$ cd tutorials/exercises/basic -$ cp solution/basic.p4 basic.p4 -$ make run -``` - -If at the end of many lines of logging output you see a prompt -`mininet>`, you can try entering the command `h1 ping h2` to ping from -virtual host `h1` in the exercise to `h2`, and it should report a -successful ping every second. It will not stop on its own. You can -type Control-C to stop it and return to the `mininet>` prompt, and you -can type Control-D to exit from mininet and get back to the original -shell prompt. To ensure that any processes started by the above steps -are terminated, you can run this command: -```bash -$ make stop -``` - - -# Creating a single file image of the VM - -These notes are primarily here as a reminder for people creating VM -images for distribution. If you downloaded a VM image, these steps -were already performed, and there is no reason you need to perform -them again. - -For the particular case of creating the VM named: - -+ 'P4 Tutorial Development 2024-08-01' -+ created on August 1, 2024 - -here were the host OS details, in case it turns out that matters to -the finished VM image for some reason: - -+ Windows 10 Enterprise -+ VirtualBox 6.1.30 r148432 -+ Vagrant 2.2.18 - -In the VirtualBox GUI interface: - -+ Choose menu item File -> Export Appliance ... -+ Select the VM named 'P4 Tutorial Development 2024-08-01' and click - Continue button - -+ Format - + I used: Open Virtualization Format 1.0 - + Other available options were: - + Open Virtualization Format 0.9 - + Open Virtualization Format 2.0 -+ Target file - + I used: /Users/andy/Documents/P4 Tutorials Development 2024-08-01.ova -+ Mac Address Policy - + I used: Include only NAT network adapter MAC addresses - + Other available options were: - + Include all network adapter MAC addresses - + Strip all network adapter MAC addresses -+ Additionally - + Write Manifest file: checked - + Include ISO image files: unchecked - -Clicked "Continue" button. - -Virtual system settings: - -+ Name: P4 Tutorial 2024-08-01 -+ Product: I left this blank -+ Product-URL: I left this blank -+ Vendor: P4.org - P4 Language Consortium -+ Vendor-URL: https://p4.org -+ Version: 2024-08-01 -+ Description: - -``` -Open source P4 development tools built from latest source code as of 2024-Aug-01 and packaged into an Ubuntu 24.04 Desktop Linux VM for the AMD64 architecture. -``` - -+ License - -``` -Open source code available hosted at https://github.com/p4lang is released under the Apache 2.0 license. Libraries it depends upon, such as Protobuf, Thrift, gRPC, Ubuntu Linux, etc. are released under their own licenses. -``` - -Clicked "Export" button. diff --git a/vm-ubuntu-24.04/create-vm-image-for-others.md b/vm-ubuntu-24.04/create-vm-image-for-others.md new file mode 100644 index 00000000..2e38ca84 --- /dev/null +++ b/vm-ubuntu-24.04/create-vm-image-for-others.md @@ -0,0 +1,214 @@ +# Creating a VM image for distribution to others + +If you want to run `p4c` tests, see the next section on how to do so, +_before_ running the commands in this section, since the commands in +this section will delete files that take one to several hours to +create while compiling p4c, needed for running p4c tests. + +If you are creating the VM for your own use, there is no need to read +further below. All later instructions are for those who wish to +create a VM image for others to download and use. + +Some of these steps could probably be automated with programs, and +changes to the `vagrant` scripts that can do so are welcome. I +perform these steps manually to create a VM image, simply to avoid the +experimentation and time required to automate them. I typically only +create new VM images once per month. + ++ Log in as user p4 (password p4) ++ Upgrade Ubuntu packages if newer ones are available: + + ```bash + sudo apt update + sudo apt upgrade + ``` + ++ Reboot the system. ++ This is optional, but if you want to save a little disk space, use + + ```bash + sudo apt purge + ``` + + to remove older version of Linux + kernel, if the upgrade installed a newer one. ++ Clean the local repository of retrieved package files to free up disk space + + ```bash + sudo apt clean + ``` + ++ Log in as user p4 (password p4) ++ Start menu -> Preferences -> LXQt settings -> Monitor settings + + Change resolution from initial 800x600 to 1024x768. Apply the changes. + + Close monitor settings window + + *Note*: For some reason I do not know, these settings seem to be + undone, even if I use the "Save" button. They are temporarily in + effect if I shut down the system and log back in, but then in a few + seconds it switches back to 800x600. Strange. ++ Start menu -> Preferences -> LXQt settings -> Desktop + + Click "Background" tab + + To the right of "Wallpaper image file" name, click "Browse" + button. Find and choose "lxqt-default-wallpaper.png" from the + list and click "Open". + + In "Wallpaper mode" popup menu, choose "Center on the screen". + + Click Apply button + + Close "Desktop preferences" window ++ Start menu -> Preferences -> LXQt settings -> Appearance + + Click "Icons Theme" in left column + + Click "Ubuntu-Mono-Light ..." in right column. + + Click "Apply" button, then "Close" button. ++ Several of the icons on the desktop have an exclamation mark on + them. If you try double-clicking those icons, it pops up a window + saying "This file 'Wireshark' seems to be a desktop entry. What do + you want to do with it?" with buttons for "Open", "Execute", and + "Cancel". Clicking "Execute" executes the associated command. + If you do a mouse middle click on one of these desktop icons, a + popup menu appears where the second-to-bottom choice is "Trust this + executable". Selecting that causes the exclamation mark to go away, + and future double-clicks of the icon execute the program without + first popping up a window to choose between Open/Execute/Cancel. I + did that for each of these desktop icons: + + Terminal + + Wireshark ++ Log off + ++ Log in as user vagrant (password vagrant) ++ Change monitor settings and wallpaper mode as described above for + user p4. ++ Open a terminal. + + Run the command + + ```bash + ./clean.sh + ``` + which removes about 6 to 7 GBytes of + files created while building the projects. ++ Log off + + +# Notes on test results for the VM + +I have run the tests below on every VM image I release, before +releasing it. You need not run them again, unless you are curious how +to do so. + + +## p4c testing results + +Steps to run the p4c tests: + ++ Log in as user vagrant (password vagrant) ++ In a new terminal, execute these commands: + +```bash +# Compile p4c again from source, since the clean.sh step reduced disk +# space by deleting the p4c/build directory. +git clone https://github.com/jafingerhut/p4-guide +cd p4c +~/p4-guide/bin/build-p4c.sh + +# Run the p4c tests +cd build +make -j2 check |& tee out1.txt + +# The above fails about 500 tests that require root. Re-run those tests +# as root using the next command. +sudo PATH=${PATH} VIRTUAL_ENV=${VIRTUAL_ENV} ${P4GUIDE_SUDO_OPTS} make -j2 recheck |& tee out2.txt +``` + +As of 2024-08-01, the p4c compiler passes all but about 15 of its +included tests when built using the steps above. + + +## Send ping packets in the solution to `basic` exercise of `p4lang/tutorials` repository + +With the version of the [tutorials](https://github.com/p4lang/tutorials) repository +that comes pre-installed in the `p4` user account of this VM, the +following tests pass. + +First log in as the user `p4` (password `p4`) and open a terminal +window. +```bash +$ cd tutorials/exercises/basic +$ cp solution/basic.p4 basic.p4 +$ make run +``` + +If at the end of many lines of logging output you see a prompt +`mininet>`, you can try entering the command `h1 ping h2` to ping from +virtual host `h1` in the exercise to `h2`, and it should report a +successful ping every second. It will not stop on its own. You can +type Control-C to stop it and return to the `mininet>` prompt, and you +can type Control-D to exit from mininet and get back to the original +shell prompt. To ensure that any processes started by the above steps +are terminated, you can run this command: +```bash +$ make stop +``` + + +# Creating a single file image of the VM + +These notes are primarily here as a reminder for people creating VM +images for distribution. If you downloaded a VM image, these steps +were already performed, and there is no reason you need to perform +them again. + +For the particular case of creating the VM named: + ++ 'P4 Tutorial Development 2024-08-01' ++ created on August 1, 2024 + +here were the host OS details, in case it turns out that matters to +the finished VM image for some reason: + ++ Windows 10 Enterprise ++ VirtualBox 6.1.30 r148432 ++ Vagrant 2.2.18 + +In the VirtualBox GUI interface: + ++ Choose menu item File -> Export Appliance ... ++ Select the VM named 'P4 Tutorial Development 2024-08-01' and click + Continue button + ++ Format + + I used: Open Virtualization Format 1.0 + + Other available options were: + + Open Virtualization Format 0.9 + + Open Virtualization Format 2.0 ++ Target file + + I used: /Users/andy/Documents/P4 Tutorials Development 2024-08-01.ova ++ Mac Address Policy + + I used: Include only NAT network adapter MAC addresses + + Other available options were: + + Include all network adapter MAC addresses + + Strip all network adapter MAC addresses ++ Additionally + + Write Manifest file: checked + + Include ISO image files: unchecked + +Clicked "Continue" button. + +Virtual system settings: + ++ Name: P4 Tutorial 2024-08-01 ++ Product: I left this blank ++ Product-URL: I left this blank ++ Vendor: P4.org - P4 Language Consortium ++ Vendor-URL: https://p4.org ++ Version: 2024-08-01 ++ Description: + +``` +Open source P4 development tools built from latest source code as of 2024-Aug-01 and packaged into an Ubuntu 24.04 Desktop Linux VM for the AMD64 architecture. +``` + ++ License + +``` +Open source code available hosted at https://github.com/p4lang is released under the Apache 2.0 license. Libraries it depends upon, such as Protobuf, Thrift, gRPC, Ubuntu Linux, etc. are released under their own licenses. +``` + +Clicked "Export" button. From 322494984d045d085562715f3e7fb3fece7ff1d5 Mon Sep 17 00:00:00 2001 From: Andy Fingerhut Date: Thu, 30 Jan 2025 21:17:19 +0000 Subject: [PATCH 2/3] Add 2025-Jan-30 versions of source code for install.sh Signed-off-by: Andy Fingerhut --- vm-ubuntu-24.04/install.sh | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/vm-ubuntu-24.04/install.sh b/vm-ubuntu-24.04/install.sh index ccc7728f..a7eae56b 100755 --- a/vm-ubuntu-24.04/install.sh +++ b/vm-ubuntu-24.04/install.sh @@ -27,11 +27,12 @@ print_usage() { 1>&2 echo "" 1>&2 echo "Dates supported:" 1>&2 echo " 2025-Jan-01" + 1>&2 echo " 2025-Jan-30" } if [ $# -eq 0 ] then - VERSION="2025-Jan-01" + VERSION="2025-Jan-30" echo "No version specified. Defaulting to ${VERSION}" elif [ $# -eq 1 ] then @@ -49,6 +50,13 @@ case ${VERSION} in export INSTALL_P4C_SOURCE_VERSION="1dc0afae2207f4bb9f5ab45f105ed569cc1ac89b" export INSTALL_PTF_SOURCE_VERSION="c554f83685186be4cfa9387eb5d6d700d2bbd7c0" ;; + 2025-Jan-30) + # 2025-Jan-01 versions: + export INSTALL_BEHAVIORAL_MODEL_SOURCE_VERSION="892c42198082d3252f4c6facc7363c02ca1d71d2" + export INSTALL_PI_SOURCE_VERSION="2bb40f7ab800b91b26f3aed174bbbfc739a37ffa" + export INSTALL_P4C_SOURCE_VERSION="2776b1948529bc7e8ccfb2f6ea2a9c1ab1f68796" + export INSTALL_PTF_SOURCE_VERSION="c554f83685186be4cfa9387eb5d6d700d2bbd7c0" + ;; latest) echo "Using the latest version of all p4lang repository source code." ;; From 054a6874418865041aaa5242d0f41816c648272f Mon Sep 17 00:00:00 2001 From: Andy Fingerhut Date: Fri, 6 Nov 2026 07:58:54 -0500 Subject: [PATCH 3/3] Change license of documentation files to CC-BY-4.0 Signed-off-by: Andy Fingerhut --- CONTRIBUTING.md | 2 +- LICENSES/CC-BY-4.0.txt | 156 ++++++++++++++++++ P4_tutorial.pdf.license | 2 +- README.md | 2 +- doc/P4sim/README.md | 2 +- doc/licenses.md | 2 +- exercises/basic/README.md | 2 +- exercises/basic/pod-topo/pod-topo.png.license | 2 +- exercises/basic_tunnel/README.md | 2 +- exercises/basic_tunnel/topo.pdf.license | 2 +- exercises/basic_tunnel/topo.png.license | 2 +- exercises/calc/README.md | 2 +- exercises/ecn/README.md | 2 +- exercises/ecn/setup.png.license | 2 +- exercises/firewall/README.md | 2 +- exercises/firewall/firewall-topo.png.license | 2 +- exercises/flowcache/README.md | 2 +- exercises/link_monitor/README.md | 2 +- .../link-monitor-topo.png.license | 2 +- exercises/load_balance/README.md | 2 +- exercises/mri/README.md | 2 +- exercises/mri/setup.png.license | 2 +- exercises/multicast/README.md | 2 +- exercises/multicast/topo.png.license | 2 +- exercises/p4runtime/README.md | 2 +- exercises/qos/README.md | 2 +- exercises/qos/setup.png.license | 2 +- exercises/source_routing/README.md | 2 +- exercises/source_routing/setup.png.license | 2 +- p4-cheat-sheet.pdf.license | 2 +- utils/README.md | 2 +- utils/cheat_sheet_src/main.tex | 4 +- utils/cheat_sheet_src/src/actions.txt.license | 2 +- .../src/adv_parsing.txt.license | 2 +- .../src/architecture.txt.license | 2 +- .../src/control_flow.txt.license | 2 +- .../cheat_sheet_src/src/counters.txt.license | 2 +- .../src/data_types.txt.license | 2 +- .../cheat_sheet_src/src/deparsing.txt.license | 2 +- .../src/expressions.txt.license | 2 +- .../src/header_stack.txt.license | 2 +- utils/cheat_sheet_src/src/parsers.txt.license | 2 +- utils/cheat_sheet_src/src/tables.txt.license | 2 +- .../src/v1model_std_metadata.txt.license | 2 +- utils/img/TopoExample.png.license | 2 +- utils/img/minipython.png.license | 2 +- utils/img/summary.png.license | 2 +- vm-ubuntu-20.04/README.md | 2 +- vm-ubuntu-20.04/create-vm-image-for-others.md | 2 +- vm-ubuntu-20.04/p4-logo.png.license | 2 +- ...-using-iso-installer-for-ubuntu-desktop.md | 2 +- ...m-using-iso-installer-for-ubuntu-server.md | 2 +- .../README-create-vm-using-iso-installer.md | 2 +- .../README-create-vm-using-vagrant.md | 2 +- vm-ubuntu-24.04/README.md | 2 +- vm-ubuntu-24.04/create-vm-image-for-others.md | 2 +- ...-using-iso-installer-for-ubuntu-desktop.md | 2 +- .../README-create-vm-using-iso-installer.md | 2 +- vm-ubuntu-26.04/README.md | 2 +- vm/README.md | 2 +- vm/p4-logo.png.license | 2 +- 61 files changed, 217 insertions(+), 61 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8dfa85d..c12031f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ --- diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 00000000..13ca539f --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,156 @@ +Creative Commons Attribution 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + +b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/P4_tutorial.pdf.license b/P4_tutorial.pdf.license index 447195dd..2c1fd529 100644 --- a/P4_tutorial.pdf.license +++ b/P4_tutorial.pdf.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/README.md b/README.md index 21642088..e58e1a3e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # P4 Tutorial diff --git a/doc/P4sim/README.md b/doc/P4sim/README.md index c82dc94b..c1fbdf7d 100644 --- a/doc/P4sim/README.md +++ b/doc/P4sim/README.md @@ -1,7 +1,7 @@ # P4sim: P4-Programmable Packet Processing in ns-3 diff --git a/doc/licenses.md b/doc/licenses.md index 9c1a6b26..b730ac7b 100644 --- a/doc/licenses.md +++ b/doc/licenses.md @@ -1,7 +1,7 @@ # Introduction diff --git a/exercises/basic/README.md b/exercises/basic/README.md index eda777b4..39a93313 100644 --- a/exercises/basic/README.md +++ b/exercises/basic/README.md @@ -1,7 +1,7 @@ # Implementing Basic Forwarding diff --git a/exercises/basic/pod-topo/pod-topo.png.license b/exercises/basic/pod-topo/pod-topo.png.license index 3ca42bf4..e09a079d 100644 --- a/exercises/basic/pod-topo/pod-topo.png.license +++ b/exercises/basic/pod-topo/pod-topo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2019 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/basic_tunnel/README.md b/exercises/basic_tunnel/README.md index 7793465a..1774674b 100644 --- a/exercises/basic_tunnel/README.md +++ b/exercises/basic_tunnel/README.md @@ -1,7 +1,7 @@ # Implementing Basic Tunneling diff --git a/exercises/basic_tunnel/topo.pdf.license b/exercises/basic_tunnel/topo.pdf.license index 447195dd..2c1fd529 100644 --- a/exercises/basic_tunnel/topo.pdf.license +++ b/exercises/basic_tunnel/topo.pdf.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/basic_tunnel/topo.png.license b/exercises/basic_tunnel/topo.png.license index 447195dd..2c1fd529 100644 --- a/exercises/basic_tunnel/topo.png.license +++ b/exercises/basic_tunnel/topo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/calc/README.md b/exercises/calc/README.md index 0f9a6775..737b1d58 100644 --- a/exercises/calc/README.md +++ b/exercises/calc/README.md @@ -1,7 +1,7 @@ # Implementing a P4 Calculator diff --git a/exercises/ecn/README.md b/exercises/ecn/README.md index 0aa798ab..66ece22d 100644 --- a/exercises/ecn/README.md +++ b/exercises/ecn/README.md @@ -1,7 +1,7 @@ # Implementing ECN diff --git a/exercises/ecn/setup.png.license b/exercises/ecn/setup.png.license index 447195dd..2c1fd529 100644 --- a/exercises/ecn/setup.png.license +++ b/exercises/ecn/setup.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/firewall/README.md b/exercises/firewall/README.md index 1ec246be..32014cfd 100644 --- a/exercises/firewall/README.md +++ b/exercises/firewall/README.md @@ -1,7 +1,7 @@ # Implementing A Basic Stateful Firewall diff --git a/exercises/firewall/firewall-topo.png.license b/exercises/firewall/firewall-topo.png.license index 3ca42bf4..e09a079d 100644 --- a/exercises/firewall/firewall-topo.png.license +++ b/exercises/firewall/firewall-topo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2019 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/flowcache/README.md b/exercises/flowcache/README.md index f3cc7b2a..70597c04 100644 --- a/exercises/flowcache/README.md +++ b/exercises/flowcache/README.md @@ -1,7 +1,7 @@ ## Introduction diff --git a/exercises/link_monitor/README.md b/exercises/link_monitor/README.md index a8abd6f7..bc30a555 100644 --- a/exercises/link_monitor/README.md +++ b/exercises/link_monitor/README.md @@ -1,7 +1,7 @@ # Implementing Link Monitoring diff --git a/exercises/link_monitor/link-monitor-topo.png.license b/exercises/link_monitor/link-monitor-topo.png.license index 3ca42bf4..e09a079d 100644 --- a/exercises/link_monitor/link-monitor-topo.png.license +++ b/exercises/link_monitor/link-monitor-topo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2019 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/load_balance/README.md b/exercises/load_balance/README.md index 49edde72..6fb3c752 100644 --- a/exercises/load_balance/README.md +++ b/exercises/load_balance/README.md @@ -1,7 +1,7 @@ # Load Balancing diff --git a/exercises/mri/README.md b/exercises/mri/README.md index c73d880f..f56c196d 100644 --- a/exercises/mri/README.md +++ b/exercises/mri/README.md @@ -1,7 +1,7 @@ # Implementing MRI diff --git a/exercises/mri/setup.png.license b/exercises/mri/setup.png.license index 447195dd..2c1fd529 100644 --- a/exercises/mri/setup.png.license +++ b/exercises/mri/setup.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/multicast/README.md b/exercises/multicast/README.md index f8ccf83d..452fa9c9 100644 --- a/exercises/multicast/README.md +++ b/exercises/multicast/README.md @@ -1,7 +1,7 @@ # Implementing Multicast diff --git a/exercises/multicast/topo.png.license b/exercises/multicast/topo.png.license index e8bfa12c..82bbfd87 100644 --- a/exercises/multicast/topo.png.license +++ b/exercises/multicast/topo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2024 Abhinav Kumar -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/p4runtime/README.md b/exercises/p4runtime/README.md index c80b1fc4..9707ffae 100644 --- a/exercises/p4runtime/README.md +++ b/exercises/p4runtime/README.md @@ -1,7 +1,7 @@ # Implementing a Control Plane using P4Runtime diff --git a/exercises/qos/README.md b/exercises/qos/README.md index d7151d93..d739ff35 100644 --- a/exercises/qos/README.md +++ b/exercises/qos/README.md @@ -1,7 +1,7 @@ # Implementing QOS diff --git a/exercises/qos/setup.png.license b/exercises/qos/setup.png.license index 5a743cae..b6b28c90 100644 --- a/exercises/qos/setup.png.license +++ b/exercises/qos/setup.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2020 nikkytub -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/exercises/source_routing/README.md b/exercises/source_routing/README.md index b175f9e6..04e2817c 100644 --- a/exercises/source_routing/README.md +++ b/exercises/source_routing/README.md @@ -1,7 +1,7 @@ # Implementing Source Routing diff --git a/exercises/source_routing/setup.png.license b/exercises/source_routing/setup.png.license index 7c0071d2..51358f9f 100644 --- a/exercises/source_routing/setup.png.license +++ b/exercises/source_routing/setup.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2024 Adarsh Rawat -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/p4-cheat-sheet.pdf.license b/p4-cheat-sheet.pdf.license index 22c87eb0..559e14f4 100644 --- a/p4-cheat-sheet.pdf.license +++ b/p4-cheat-sheet.pdf.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/README.md b/utils/README.md index 950ecdc1..ada806cb 100644 --- a/utils/README.md +++ b/utils/README.md @@ -1,7 +1,7 @@ # P4 Utils diff --git a/utils/cheat_sheet_src/main.tex b/utils/cheat_sheet_src/main.tex index 05bb1416..be0b4147 100644 --- a/utils/cheat_sheet_src/main.tex +++ b/utils/cheat_sheet_src/main.tex @@ -1,7 +1,7 @@ % SPDX-FileCopyrightText: 2018 Stephen Ibanez % -% SPDX-License-Identifier: Apache-2.0 -% +% SPDX-License-Identifier: CC-BY-4.0 + % P4 Cheat Sheet % By P4.org diff --git a/utils/cheat_sheet_src/src/actions.txt.license b/utils/cheat_sheet_src/src/actions.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/actions.txt.license +++ b/utils/cheat_sheet_src/src/actions.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/adv_parsing.txt.license b/utils/cheat_sheet_src/src/adv_parsing.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/adv_parsing.txt.license +++ b/utils/cheat_sheet_src/src/adv_parsing.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/architecture.txt.license b/utils/cheat_sheet_src/src/architecture.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/architecture.txt.license +++ b/utils/cheat_sheet_src/src/architecture.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/control_flow.txt.license b/utils/cheat_sheet_src/src/control_flow.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/control_flow.txt.license +++ b/utils/cheat_sheet_src/src/control_flow.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/counters.txt.license b/utils/cheat_sheet_src/src/counters.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/counters.txt.license +++ b/utils/cheat_sheet_src/src/counters.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/data_types.txt.license b/utils/cheat_sheet_src/src/data_types.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/data_types.txt.license +++ b/utils/cheat_sheet_src/src/data_types.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/deparsing.txt.license b/utils/cheat_sheet_src/src/deparsing.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/deparsing.txt.license +++ b/utils/cheat_sheet_src/src/deparsing.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/expressions.txt.license b/utils/cheat_sheet_src/src/expressions.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/expressions.txt.license +++ b/utils/cheat_sheet_src/src/expressions.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/header_stack.txt.license b/utils/cheat_sheet_src/src/header_stack.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/header_stack.txt.license +++ b/utils/cheat_sheet_src/src/header_stack.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/parsers.txt.license b/utils/cheat_sheet_src/src/parsers.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/parsers.txt.license +++ b/utils/cheat_sheet_src/src/parsers.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/tables.txt.license b/utils/cheat_sheet_src/src/tables.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/tables.txt.license +++ b/utils/cheat_sheet_src/src/tables.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/cheat_sheet_src/src/v1model_std_metadata.txt.license b/utils/cheat_sheet_src/src/v1model_std_metadata.txt.license index 22c87eb0..559e14f4 100644 --- a/utils/cheat_sheet_src/src/v1model_std_metadata.txt.license +++ b/utils/cheat_sheet_src/src/v1model_std_metadata.txt.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Stephen Ibanez -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/img/TopoExample.png.license b/utils/img/TopoExample.png.license index 13161a14..1a900a77 100644 --- a/utils/img/TopoExample.png.license +++ b/utils/img/TopoExample.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2024 Duarte Dias -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/img/minipython.png.license b/utils/img/minipython.png.license index 13161a14..1a900a77 100644 --- a/utils/img/minipython.png.license +++ b/utils/img/minipython.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2024 Duarte Dias -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/utils/img/summary.png.license b/utils/img/summary.png.license index 13161a14..1a900a77 100644 --- a/utils/img/summary.png.license +++ b/utils/img/summary.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2024 Duarte Dias -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/vm-ubuntu-20.04/README.md b/vm-ubuntu-20.04/README.md index 8f9b2b8f..75b0d0e6 100644 --- a/vm-ubuntu-20.04/README.md +++ b/vm-ubuntu-20.04/README.md @@ -1,7 +1,7 @@ # Creating the VM diff --git a/vm-ubuntu-20.04/create-vm-image-for-others.md b/vm-ubuntu-20.04/create-vm-image-for-others.md index b9d2e3ad..8a0cdac0 100644 --- a/vm-ubuntu-20.04/create-vm-image-for-others.md +++ b/vm-ubuntu-20.04/create-vm-image-for-others.md @@ -1,7 +1,7 @@ # Creating a VM image for distribution to others diff --git a/vm-ubuntu-20.04/p4-logo.png.license b/vm-ubuntu-20.04/p4-logo.png.license index 447195dd..2c1fd529 100644 --- a/vm-ubuntu-20.04/p4-logo.png.license +++ b/vm-ubuntu-20.04/p4-logo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0 diff --git a/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md b/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md index a91bf03e..95da94d2 100644 --- a/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md +++ b/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md @@ -1,7 +1,7 @@ # Creating a VM using VirtualBox and an ISO disk image with an Ubuntu Desktop Linux 24.04 installer diff --git a/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-server.md b/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-server.md index 187364ad..0ed3d368 100644 --- a/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-server.md +++ b/vm-ubuntu-24.04/README-create-vm-using-iso-installer-for-ubuntu-server.md @@ -1,7 +1,7 @@ # Creating a VM using VirtualBox and an ISO disk image with an Ubuntu Server Linux 24.04 installer diff --git a/vm-ubuntu-24.04/README-create-vm-using-iso-installer.md b/vm-ubuntu-24.04/README-create-vm-using-iso-installer.md index 37b2a582..c58ddafc 100644 --- a/vm-ubuntu-24.04/README-create-vm-using-iso-installer.md +++ b/vm-ubuntu-24.04/README-create-vm-using-iso-installer.md @@ -1,7 +1,7 @@ # Create VM using ISO installer diff --git a/vm-ubuntu-24.04/README-create-vm-using-vagrant.md b/vm-ubuntu-24.04/README-create-vm-using-vagrant.md index 785cad47..3bd015d1 100644 --- a/vm-ubuntu-24.04/README-create-vm-using-vagrant.md +++ b/vm-ubuntu-24.04/README-create-vm-using-vagrant.md @@ -1,7 +1,7 @@ ## Creating the VM using VirtualBox and Vagrant diff --git a/vm-ubuntu-24.04/README.md b/vm-ubuntu-24.04/README.md index 75fd1965..09d6524c 100644 --- a/vm-ubuntu-24.04/README.md +++ b/vm-ubuntu-24.04/README.md @@ -1,7 +1,7 @@ # Introduction diff --git a/vm-ubuntu-24.04/create-vm-image-for-others.md b/vm-ubuntu-24.04/create-vm-image-for-others.md index 09c124ab..514cb10b 100644 --- a/vm-ubuntu-24.04/create-vm-image-for-others.md +++ b/vm-ubuntu-24.04/create-vm-image-for-others.md @@ -1,7 +1,7 @@ # Creating a VM image for distribution to others diff --git a/vm-ubuntu-26.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md b/vm-ubuntu-26.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md index 0157cde8..538f22ac 100644 --- a/vm-ubuntu-26.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md +++ b/vm-ubuntu-26.04/README-create-vm-using-iso-installer-for-ubuntu-desktop.md @@ -1,7 +1,7 @@ # Creating a VM using VirtualBox and an ISO disk image with an Ubuntu Desktop Linux 26.04 installer diff --git a/vm-ubuntu-26.04/README-create-vm-using-iso-installer.md b/vm-ubuntu-26.04/README-create-vm-using-iso-installer.md index e5d46736..0355c824 100644 --- a/vm-ubuntu-26.04/README-create-vm-using-iso-installer.md +++ b/vm-ubuntu-26.04/README-create-vm-using-iso-installer.md @@ -1,7 +1,7 @@ # Create VM using ISO installer diff --git a/vm-ubuntu-26.04/README.md b/vm-ubuntu-26.04/README.md index 3a9a9c17..935235af 100644 --- a/vm-ubuntu-26.04/README.md +++ b/vm-ubuntu-26.04/README.md @@ -1,7 +1,7 @@ # Introduction diff --git a/vm/README.md b/vm/README.md index 8b76797d..c9b5f6cf 100644 --- a/vm/README.md +++ b/vm/README.md @@ -1,7 +1,7 @@ # Introduction diff --git a/vm/p4-logo.png.license b/vm/p4-logo.png.license index 447195dd..2c1fd529 100644 --- a/vm/p4-logo.png.license +++ b/vm/p4-logo.png.license @@ -1,3 +1,3 @@ SPDX-FileCopyrightText: 2018 Nate Foster -SPDX-License-Identifier: Apache-2.0 +SPDX-License-Identifier: CC-BY-4.0