diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2020-01-07 08:35:07 +0100 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2020-01-09 12:46:07 +0100 |
commit | 1af63679f4360f1301efcc28e540005227821f81 (patch) | |
tree | 18f82e785765554a662f302524a3ac0e17f5a5fc /doc | |
parent | bf411c4b05e5ff256660b68544ab593e6904ed48 (diff) | |
download | el_releases-nfv-access-1af63679f4360f1301efcc28e540005227821f81.tar.gz |
af_th: add Enable/Disable DPDK chapter
- Add Enable / Disable DPDK section
- Add configuring interface in standard and sriov mode
- Replace PCI address with interface name, e.g. '0000:03:00.2' with 'enp4s0f1
- Update doc version to 2.2.2
Change-Id: I93e1cedafb9580a781f1f1cac6beac6e0f5f41f3
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | 182 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml | 4 |
2 files changed, 128 insertions, 58 deletions
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index da661db..e1bab54 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -10,7 +10,7 @@ | |||
10 | directory.</para> | 10 | directory.</para> |
11 | 11 | ||
12 | <para>The <literal>/device</literal> folder contains Python scripts for | 12 | <para>The <literal>/device</literal> folder contains Python scripts for |
13 | adding a uCPE device, receiving uCPE events' reports, removing a uCPE | 13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE |
14 | device, and waiting for a uCPE device to connect to the uCPE | 14 | device, and waiting for a uCPE device to connect to the uCPE |
15 | Manager.</para> | 15 | Manager.</para> |
16 | 16 | ||
@@ -362,7 +362,7 @@ test 004: Bind wan NIC to DPDK (__main__.UnittestSuite) ... | |||
362 | 2019-03-07 18:03:30,086 - DEBUG: Login successful on host 'localhost' | 362 | 2019-03-07 18:03:30,086 - DEBUG: Login successful on host 'localhost' |
363 | 2019-03-07 18:03:30,087 - DEBUG: Session token is: 8cd95f32-40f2-11e9-a81f525400d08e1d | 363 | 2019-03-07 18:03:30,087 - DEBUG: Session token is: 8cd95f32-40f2-11e9-a81f525400d08e1d |
364 | 2019-03-07 18:03:30,095 - DEBUG: Found device with name 'intelc3850-2' | 364 | 2019-03-07 18:03:30,095 - DEBUG: Found device with name 'intelc3850-2' |
365 | 2019-03-07 18:03:30,096 - DEBUG: Bind NIC '0000:03:00.2' | 365 | 2019-03-07 18:03:30,096 - DEBUG: Bind NIC 'enp4s0f1' |
366 | 2019-03-07 18:03:30,729 - INFO: Done | 366 | 2019-03-07 18:03:30,729 - INFO: Done |
367 | 2019-03-07 18:03:30,767 - DEBUG: Logging out and exiting... | 367 | 2019-03-07 18:03:30,767 - DEBUG: Logging out and exiting... |
368 | ok | 368 | ok |
@@ -811,11 +811,71 @@ Events on device: intelc3850-2 and severity: 1000 | |||
811 | </section> | 811 | </section> |
812 | </section> | 812 | </section> |
813 | 813 | ||
814 | <section id="enable_disable_dpdk"> | ||
815 | <title>Enabling or Disabling the DPDK</title> | ||
816 | |||
817 | <para>Steps and details on how to enable or disable the DPDK are explained below.</para> | ||
818 | |||
819 | <section id="script_dpdk"> | ||
820 | <title>Script Options</title> | ||
821 | |||
822 | <programlisting>$ python configDPDK.py -h | ||
823 | Usage: configDPDK.py [options] | ||
824 | |||
825 | Configure DPDK | ||
826 | |||
827 | Options: | ||
828 | --version show program's version number and exit | ||
829 | -h, --help show this help message and exit | ||
830 | -u USERNAME, --username=USERNAME Enea uCPE Manager login username | ||
831 | -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password | ||
832 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | ||
833 | -s STATE, --state=STATE Enable/Disable | ||
834 | -n DEVICENAME, --device-name=DEVICENAME Name of the device | ||
835 | |||
836 | Mandatory options: | ||
837 | -H/--host, -s/--state</programlisting> | ||
838 | </section> | ||
839 | |||
840 | <section id="run_pydpdk"> | ||
841 | <title>Running the Python Module</title> | ||
842 | |||
843 | <para>The <literal>configDPDK</literal> Python module can be executed | ||
844 | individually by running the following command lines:</para> | ||
845 | |||
846 | <para>To Enable DPDK:</para> | ||
847 | |||
848 | <programlisting>$ python configDPDK.py -s enable -n intelc3850-2 | ||
849 | |||
850 | 2020-01-06 08:35:16,820 - DEBUG: Started logging | ||
851 | 2020-01-06 08:35:16,821 - INFO: Configure DPDK | ||
852 | 2020-01-06 08:35:16,870 - DEBUG: Login successful on host '172.24.3.90' | ||
853 | 2020-01-06 08:35:16,871 - DEBUG: Session token is: 601149e0-3089-11ea-b0c7-525400b7889f | ||
854 | 2020-01-06 08:35:16,894 - DEBUG: Found device with name 'inteld1521-1' | ||
855 | 2020-01-06 08:35:16,895 - DEBUG: Set DPDK state to enable | ||
856 | 2020-01-06 08:35:16,936 - INFO: Done | ||
857 | 2020-01-06 08:35:16,961 - DEBUG: Logging out and exiting...</programlisting> | ||
858 | |||
859 | <para>To Disable DPDK:</para> | ||
860 | |||
861 | <programlisting>$ python configDPDK.py -s disable -n intelc3850-2 | ||
862 | |||
863 | 2020-01-06 08:33:57,157 - DEBUG: Started logging | ||
864 | 2020-01-06 08:33:57,158 - INFO: Configure DPDK | ||
865 | 2020-01-06 08:33:57,215 - DEBUG: Login successful on host '172.24.3.90' | ||
866 | 2020-01-06 08:33:57,216 - DEBUG: Session token is: 3096e670-3089-11ea-b0c7-525400b7889f | ||
867 | 2020-01-06 08:33:57,239 - DEBUG: Found device with name 'inteld1521-1' | ||
868 | 2020-01-06 08:33:57,241 - DEBUG: Set DPDK state to disable | ||
869 | 2020-01-06 08:33:57,284 - INFO: Done | ||
870 | 2020-01-06 08:33:57,310 - DEBUG: Logging out and exiting...</programlisting> | ||
871 | </section> | ||
872 | </section> | ||
873 | |||
814 | <section id="bind_ucpe_device"> | 874 | <section id="bind_ucpe_device"> |
815 | <title>Binding a Network Interface</title> | 875 | <title>Binding a Network Interface</title> |
816 | 876 | ||
817 | <para>How to Bind a physical network interface to a DPDK or SR-IOV is | 877 | <para>How to Bind a physical network interface to a DPDK, Standard or |
818 | detailed below.</para> | 878 | SR-IOV is detailed below.</para> |
819 | 879 | ||
820 | <section id="script_opts_bind"> | 880 | <section id="script_opts_bind"> |
821 | <title>Script Options</title> | 881 | <title>Script Options</title> |
@@ -823,7 +883,7 @@ Events on device: intelc3850-2 and severity: 1000 | |||
823 | <programlisting>$ python bindNetworkInterface.py -h | 883 | <programlisting>$ python bindNetworkInterface.py -h |
824 | Usage: bindNetworkInterface.py [options] | 884 | Usage: bindNetworkInterface.py [options] |
825 | 885 | ||
826 | Binds a physical network interface to a DPDK or SR-IOV. | 886 | Binds a physical network interface to a DPDK, standard or SR-IOV. |
827 | 887 | ||
828 | Options: | 888 | Options: |
829 | --version show program's version number and exit | 889 | --version show program's version number and exit |
@@ -858,21 +918,40 @@ format | |||
858 | "args": "-f ../../lab_config/intelc3850-2/lan_nic.json" | 918 | "args": "-f ../../lab_config/intelc3850-2/lan_nic.json" |
859 | }, | 919 | }, |
860 | { | 920 | { |
861 | "name": "Bind wan NIC to DPDK ", | 921 | "name": "Bind wan NIC to DPDK", |
862 | "args": "-f ../../lab_config/intelc3850-2/wan_nic.json" | 922 | "args": "-f ../../lab_config/intelc3850-2/wan_nic.json" |
923 | }, | ||
924 | { | ||
925 | "name": "Bind wan/lan NIC to SR-IOV", | ||
926 | "args": "-f ../../lab_config/intelc3850-2/sriov_nic.json" | ||
927 | }, | ||
928 | { | ||
929 | "name": "Bind wan/lan NIC to Standard", | ||
930 | "args": "-f ../../lab_config/intelc3850-2/std_nic.json" | ||
863 | } | 931 | } |
864 | ]</programlisting><emphasis role="bold">Sample | 932 | ]</programlisting><emphasis role="bold">Sample |
865 | <filename>lan_nic.json</filename> configuration | 933 | <filename>lan_nic.json</filename> configuration |
866 | file:</emphasis><programlisting>{ | 934 | file:</emphasis><programlisting>{ |
867 | "name": "0000:01:00.1", | 935 | "name": "enp4s0f0", |
868 | "type": "dpdk", | 936 | "type": "dpdk", |
869 | "subType": "igb_uio" | 937 | "subType": "vfio-pci" |
870 | }</programlisting><emphasis role="bold">Sample | 938 | }</programlisting><emphasis role="bold">Sample |
871 | <filename>wan_nic.json</filename> configuration | 939 | <filename>wan_nic.json</filename> configuration |
872 | file:</emphasis><programlisting>{ | 940 | file:</emphasis><programlisting>{ |
873 | "name": "0000:03:00.2", | 941 | "name": "enp4s0f1", |
874 | "type": "dpdk", | 942 | "type": "dpdk", |
875 | "subType": "igb_uio" | 943 | "subType": "vfio-pci" |
944 | }</programlisting><emphasis role="bold">Sample | ||
945 | <filename>sriov_nic.json</filename> configuration | ||
946 | file:</emphasis><programlisting>{ | ||
947 | "name": "eno1", | ||
948 | "type": "srIov", | ||
949 | "subType": "passthrough | adapter-pool" | ||
950 | }</programlisting><emphasis role="bold">Sample | ||
951 | <filename>std_nic.json</filename> configuration | ||
952 | file:</emphasis><programlisting>{ | ||
953 | "name": "eno2", | ||
954 | "type": "standard" | ||
876 | }</programlisting></para> | 955 | }</programlisting></para> |
877 | </section> | 956 | </section> |
878 | 957 | ||
@@ -952,7 +1031,7 @@ Unbinds a physical interface to the DPDK or SR-IOV | |||
952 | configuration file:</emphasis></para> | 1031 | configuration file:</emphasis></para> |
953 | 1032 | ||
954 | <programlisting>{ | 1033 | <programlisting>{ |
955 | "name": "0000:01:00.1", | 1034 | "name": "enp4s0f0", |
956 | "type": "dpdk" | 1035 | "type": "dpdk" |
957 | }</programlisting> | 1036 | }</programlisting> |
958 | 1037 | ||
@@ -960,7 +1039,7 @@ Unbinds a physical interface to the DPDK or SR-IOV | |||
960 | configuration file:</emphasis></para> | 1039 | configuration file:</emphasis></para> |
961 | 1040 | ||
962 | <programlisting>{ | 1041 | <programlisting>{ |
963 | "name": "0000:03:00.2", | 1042 | "name": "enp4s0f1", |
964 | "type": "dpdk", | 1043 | "type": "dpdk", |
965 | } | 1044 | } |
966 | </programlisting> | 1045 | </programlisting> |
@@ -1020,49 +1099,40 @@ Options: | |||
1020 | executed individually by running the following command:</para> | 1099 | executed individually by running the following command:</para> |
1021 | 1100 | ||
1022 | <programlisting>$ python getNetworkInterfaces.py -H localhost -n intelc3850-2 | 1101 | <programlisting>$ python getNetworkInterfaces.py -H localhost -n intelc3850-2 |
1023 | 2019-07-04 16:03:47,580 - DEBUG: Started logging | 1102 | 2020-01-07 05:58:03,630 - DEBUG: Started logging |
1024 | 2019-07-04 16:03:47,580 - INFO: Dump NICs | 1103 | 2020-01-07 05:58:03,630 - INFO: Dump NICs |
1025 | 2019-07-04 16:03:47,609 - DEBUG: Login successful on host 'localhost' | 1104 | 2020-01-07 05:58:03,687 - DEBUG: Login successful on host '172.24.3.90' |
1026 | 2019-07-04 16:03:47,610 - DEBUG: Session token is: 8ae9b103-9e64-11e9-a715-5254007632e2 | 1105 | 2020-01-07 05:58:03,688 - DEBUG: Session token is: 93dd3cd0-313c-11ea-b0c7-525400b7889f |
1027 | 2019-07-04 16:03:47,626 - DEBUG: Found device with name 'intelc3850-2' | 1106 | 2020-01-07 05:58:03,715 - DEBUG: Found device with name 'intelc3850-2' |
1028 | 2019-07-04 16:03:47,627 - DEBUG: | 1107 | 2020-01-07 05:58:03,717 - DEBUG: |
1029 | ----------------- External Network Interfaces for intelc3850-2----------------- | 1108 | ----------------- External Network Interfaces for intelc3850-2----------------- |
1030 | 2019-07-04 16:03:47,945 - DEBUG: 0000:01:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \ | 1109 | 2020-01-07 05:58:07,622 - DEBUG: eno4 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:dfsriov(7) |
1031 | MacAddress: ac:1f:6b:2d:ee:58sriov(63) | 1110 | 2020-01-07 05:58:07,624 - DEBUG: |
1032 | 2019-07-04 16:03:47,945 - DEBUG: | 1111 | 2020-01-07 05:58:07,656 - DEBUG: |
1033 | 2019-07-04 16:03:47,969 - DEBUG: | 1112 | ----------------- Configured External Network Interfaces for intelc3850-2----------------- |
1034 | ----------------- Configured External Network Interfaces for intelc3850-2------------- | 1113 | 2020-01-07 05:58:07,657 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7 |
1035 | 2019-07-04 16:03:47,969 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \ | 1114 | 2020-01-07 05:58:07,658 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1 |
1036 | 41d31385-fafd-48fe-b702-ce72fea85478 | 1115 | 2020-01-07 05:58:07,659 - DEBUG: enp1s0f0 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: ac:1f:6b:2d:ee:58sriov(63) |
1037 | 2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \ | 1116 | 2020-01-07 05:58:07,660 - DEBUG: |
1038 | b0a4b919-95cd-48c2-83ad-28ec233546b2 | 1117 | 2020-01-07 05:58:07,690 - DEBUG: |
1039 | 2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \ | 1118 | ----------------- Configured External Network Interfaces for intelc3850-2----------------- |
1040 | 380ac405-9e51-11e9-a715-5254007632e2 | 1119 | 2020-01-07 05:58:07,691 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7 |
1041 | 2019-07-04 16:03:47,970 - DEBUG: 0000:03:00.1 DpdkTypes: [u'igb_uio', u'vfio-pci'] \ | 1120 | 2020-01-07 05:58:07,692 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1 |
1042 | MacAddress: 0c:c4:7a:fb:85:ddsriov(7) | 1121 | 2020-01-07 05:58:07,693 - DEBUG: eno2 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:ddsriov(7) |
1043 | 2019-07-04 16:03:47,970 - DEBUG: | 1122 | 2020-01-07 05:58:07,695 - DEBUG: |
1044 | 2019-07-04 16:03:47,991 - DEBUG: | 1123 | 2020-01-07 05:58:07,724 - DEBUG: |
1045 | ----------------- Configured External Network Interfaces for intelc3850-2------------- | 1124 | ----------------- Configured External Network Interfaces for intelc3850-2----------------- |
1046 | 2019-07-04 16:03:47,991 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \ | 1125 | 2020-01-07 05:58:07,725 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7 |
1047 | 41d31385-fafd-48fe-b702-ce72fea85478 | 1126 | 2020-01-07 05:58:07,726 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1 |
1048 | 2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \ | 1127 | 2020-01-07 05:58:07,727 - DEBUG: eno1 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:dcsriov(7) |
1049 | b0a4b919-95cd-48c2-83ad-28ec233546b2 | 1128 | 2020-01-07 05:58:07,728 - DEBUG: |
1050 | 2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \ | 1129 | 2020-01-07 05:58:07,760 - DEBUG: |
1051 | 380ac405-9e51-11e9-a715-5254007632e2 | 1130 | ----------------- Configured External Network Interfaces for intelc3850-2----------------- |
1052 | 2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \ | 1131 | 2020-01-07 05:58:07,761 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7 |
1053 | MacAddress: 0c:c4:7a:fb:85:dcsriov(7) | 1132 | 2020-01-07 05:58:07,761 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1 |
1054 | 2019-07-04 16:03:47,992 - DEBUG: | 1133 | 2020-01-07 05:58:07,762 - DEBUG: |
1055 | 2019-07-04 16:03:48,012 - DEBUG: | 1134 | 2020-01-07 05:58:07,763 - INFO: Done |
1056 | ----------------- Configured External Network Interfaces for intelc3850-2------------- | 1135 | 2020-01-07 05:58:07,787 - DEBUG: Logging out and exiting...</programlisting> |
1057 | 2019-07-04 16:03:48,012 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \ | ||
1058 | 41d31385-fafd-48fe-b702-ce72fea85478 | ||
1059 | 2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \ | ||
1060 | b0a4b919-95cd-48c2-83ad-28ec233546b2 | ||
1061 | 2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \ | ||
1062 | 380ac405-9e51-11e9-a715-5254007632e2 | ||
1063 | 2019-07-04 16:03:48,013 - DEBUG: | ||
1064 | 2019-07-04 16:03:48,013 - INFO: Done | ||
1065 | 2019-07-04 16:03:48,029 - DEBUG: Logging out and exiting...</programlisting> | ||
1066 | </section> | 1136 | </section> |
1067 | </section> | 1137 | </section> |
1068 | 1138 | ||
@@ -1124,7 +1194,7 @@ Options: | |||
1124 | 1194 | ||
1125 | <programlisting>{ | 1195 | <programlisting>{ |
1126 | "name": "lan_br", | 1196 | "name": "lan_br", |
1127 | "interfaces": ["0000:01:00.1"] | 1197 | "interfaces": ["enp4s0f0"] |
1128 | }</programlisting> | 1198 | }</programlisting> |
1129 | 1199 | ||
1130 | <para><emphasis role="bold">Sample <filename>wan_br.json</filename> | 1200 | <para><emphasis role="bold">Sample <filename>wan_br.json</filename> |
@@ -1132,7 +1202,7 @@ Options: | |||
1132 | 1202 | ||
1133 | <programlisting>{ | 1203 | <programlisting>{ |
1134 | "name": "wan_br", | 1204 | "name": "wan_br", |
1135 | "interfaces": ["0000:03:00.2"] | 1205 | "interfaces": ["enp4s0f1"] |
1136 | }</programlisting> | 1206 | }</programlisting> |
1137 | </section> | 1207 | </section> |
1138 | 1208 | ||
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml index feabc9f..be0be23 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml | |||
@@ -42,7 +42,7 @@ export PATH=~/bin:$PATH</programlisting></para> | |||
42 | correct also compared to the "previous" REL VER in pardoc-distro.xml | 42 | correct also compared to the "previous" REL VER in pardoc-distro.xml |
43 | "prev_baseline".</bridgehead> | 43 | "prev_baseline".</bridgehead> |
44 | 44 | ||
45 | <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para> | 45 | <para id="EneaLinux_REL_VER"><phrase>2.2.2</phrase></para> |
46 | 46 | ||
47 | <para id="Yocto_VER"><phrase>2.4</phrase></para> | 47 | <para id="Yocto_VER"><phrase>2.4</phrase></para> |
48 | 48 | ||
@@ -283,4 +283,4 @@ repo sync</programlisting></para> | |||
283 | </tgroup> | 283 | </tgroup> |
284 | </table> | 284 | </table> |
285 | </section> | 285 | </section> |
286 | </section> \ No newline at end of file | 286 | </section> |