diff options
author | Miruna Paun <mrpa@enea.se> | 2020-01-22 11:30:33 +0100 |
---|---|---|
committer | Gerrit Code Review <gerrit2@sestogerrit02> | 2020-01-22 11:30:33 +0100 |
commit | e7e260265dd3b497e25775982ebc32943f01d0c5 (patch) | |
tree | 99087d0a42b5c84fe05d0c44f2fe8ef25953c02d | |
parent | 6dbfe558e1ff3e9d9d7e50c2c3da15234efc854a (diff) | |
parent | a527d2c3f55c58770748892b619a693df03dbebf (diff) | |
download | el_releases-nfv-access-e7e260265dd3b497e25775982ebc32943f01d0c5.tar.gz |
Merge "Add uCPE Mgr's CPU, RAM and storage requirements" into rocko
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 136 |
1 files changed, 101 insertions, 35 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 095d2d5..186c304 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
@@ -18,6 +18,66 @@ | |||
18 | <para>A machine running CentOS with network access to the physical | 18 | <para>A machine running CentOS with network access to the physical |
19 | device.</para> | 19 | device.</para> |
20 | </listitem> | 20 | </listitem> |
21 | |||
22 | <listitem> | ||
23 | <para>CPU, RAM and storage requirements for the uCPE Manager:</para> | ||
24 | |||
25 | <itemizedlist> | ||
26 | <listitem> | ||
27 | <para>For small-sized deployments (tens of devices):</para> | ||
28 | |||
29 | <itemizedlist spacing="compact"> | ||
30 | <listitem> | ||
31 | <para>4 cores</para> | ||
32 | </listitem> | ||
33 | |||
34 | <listitem> | ||
35 | <para>16 GB RAM</para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para>300 GB hard-drive</para> | ||
40 | </listitem> | ||
41 | </itemizedlist> | ||
42 | </listitem> | ||
43 | |||
44 | <listitem> | ||
45 | <para>For mid-sized deployments (hundreds of devices):</para> | ||
46 | |||
47 | <itemizedlist spacing="compact"> | ||
48 | <listitem> | ||
49 | <para>8 cores</para> | ||
50 | </listitem> | ||
51 | |||
52 | <listitem> | ||
53 | <para>32 GB RAM</para> | ||
54 | </listitem> | ||
55 | |||
56 | <listitem> | ||
57 | <para>300 GB hard-drive</para> | ||
58 | </listitem> | ||
59 | </itemizedlist> | ||
60 | </listitem> | ||
61 | |||
62 | <listitem> | ||
63 | <para>For large deployments (thousands of devices):</para> | ||
64 | |||
65 | <itemizedlist spacing="compact"> | ||
66 | <listitem> | ||
67 | <para>16 cores</para> | ||
68 | </listitem> | ||
69 | |||
70 | <listitem> | ||
71 | <para>64-256 GB RAM</para> | ||
72 | </listitem> | ||
73 | |||
74 | <listitem> | ||
75 | <para>1 - 2 TB hard-drive</para> | ||
76 | </listitem> | ||
77 | </itemizedlist> | ||
78 | </listitem> | ||
79 | </itemizedlist> | ||
80 | </listitem> | ||
21 | </itemizedlist> | 81 | </itemizedlist> |
22 | </section> | 82 | </section> |
23 | 83 | ||
@@ -890,18 +950,18 @@ | |||
890 | <title>Custom Scripts</title> | 950 | <title>Custom Scripts</title> |
891 | 951 | ||
892 | <para>The custom scripts feature allows users to execute user-defined | 952 | <para>The custom scripts feature allows users to execute user-defined |
893 | scripts on the uCPE device at various times.This allows | 953 | scripts on the uCPE device at various times.This allows for more |
894 | for more flexible and advanced configurations such as a LTE modem | 954 | flexible and advanced configurations such as a LTE modem |
895 | configuration, advanced network configurations or OVS flow rule | 955 | configuration, advanced network configurations or OVS flow rule |
896 | programming at any time.</para> | 956 | programming at any time.</para> |
897 | 957 | ||
898 | <section id="upload_scripts"> | 958 | <section id="upload_scripts"> |
899 | <title>Uploading Scripts</title> | 959 | <title>Uploading Scripts</title> |
900 | 960 | ||
901 | <para>The scripts need to be uploaded to the uCPE Manager prior to use. | 961 | <para>The scripts need to be uploaded to the uCPE Manager prior to |
902 | When uploading scripts to the uCPE Manager make sure to select the | 962 | use. When uploading scripts to the uCPE Manager make sure to select |
903 | right script type.</para> | 963 | the right script type.</para> |
904 | 964 | ||
905 | <para>The following script types are supported:</para> | 965 | <para>The following script types are supported:</para> |
906 | 966 | ||
907 | <itemizedlist> | 967 | <itemizedlist> |
@@ -911,8 +971,8 @@ | |||
911 | </listitem> | 971 | </listitem> |
912 | 972 | ||
913 | <listitem> | 973 | <listitem> |
914 | <para><literal>Always-before-startup</literal>. This script will always | 974 | <para><literal>Always-before-startup</literal>. This script will |
915 | execute during the startup.</para> | 975 | always execute during the startup.</para> |
916 | </listitem> | 976 | </listitem> |
917 | 977 | ||
918 | <listitem> | 978 | <listitem> |
@@ -921,8 +981,8 @@ | |||
921 | </listitem> | 981 | </listitem> |
922 | 982 | ||
923 | <listitem> | 983 | <listitem> |
924 | <para><literal>Always-after-startup</literal>. This script will always | 984 | <para><literal>Always-after-startup</literal>. This script will |
925 | execute after the system has been started.</para> | 985 | always execute after the system has been started.</para> |
926 | </listitem> | 986 | </listitem> |
927 | </itemizedlist> | 987 | </itemizedlist> |
928 | 988 | ||
@@ -939,13 +999,13 @@ | |||
939 | </listitem> | 999 | </listitem> |
940 | 1000 | ||
941 | <listitem> | 1001 | <listitem> |
942 | <para>In the <literal>Script Type</literal> menu, select the type | 1002 | <para>In the <literal>Script Type</literal> menu, select the |
943 | the uploaded script should have.</para> | 1003 | type the uploaded script should have.</para> |
944 | </listitem> | 1004 | </listitem> |
945 | 1005 | ||
946 | <listitem> | 1006 | <listitem> |
947 | <para>Press <literal>Choose File</literal> to select the scripts needed, | 1007 | <para>Press <literal>Choose File</literal> to select the scripts |
948 | and then press <literal>Send</literal>.</para> | 1008 | needed, and then press <literal>Send</literal>.</para> |
949 | </listitem> | 1009 | </listitem> |
950 | </orderedlist> | 1010 | </orderedlist> |
951 | </section> | 1011 | </section> |
@@ -964,7 +1024,8 @@ | |||
964 | <listitem> | 1024 | <listitem> |
965 | <para>Select the script you want to delete from the | 1025 | <para>Select the script you want to delete from the |
966 | <literal>Uploaded Scripts</literal> tab and then click | 1026 | <literal>Uploaded Scripts</literal> tab and then click |
967 | <literal>Delete</literal>, which will remove the script immediately from the uCPE Manager.</para> | 1027 | <literal>Delete</literal>, which will remove the script |
1028 | immediately from the uCPE Manager.</para> | ||
968 | </listitem> | 1029 | </listitem> |
969 | </orderedlist> | 1030 | </orderedlist> |
970 | </section> | 1031 | </section> |
@@ -982,13 +1043,13 @@ | |||
982 | </listitem> | 1043 | </listitem> |
983 | 1044 | ||
984 | <listitem> | 1045 | <listitem> |
985 | <para>Select the <literal>Configuration</literal> tab and specify a | 1046 | <para>Select the <literal>Configuration</literal> tab and |
986 | new loacation to store the scripts.</para> | 1047 | specify a new loacation to store the scripts.</para> |
987 | 1048 | ||
988 | <note> | 1049 | <note> |
989 | <para>Change the script storage location only if you have many | 1050 | <para>Change the script storage location only if you have many |
990 | scripts which you would prefer to store on another | 1051 | scripts which you would prefer to store on another partition, |
991 | partition, otherwise leave this configuration as is.</para> | 1052 | otherwise leave this configuration as is.</para> |
992 | </note> | 1053 | </note> |
993 | </listitem> | 1054 | </listitem> |
994 | </orderedlist> | 1055 | </orderedlist> |
@@ -1008,20 +1069,22 @@ | |||
1008 | 1069 | ||
1009 | <listitem> | 1070 | <listitem> |
1010 | <para>In the <literal>Script Config Screen</literal> pop up, | 1071 | <para>In the <literal>Script Config Screen</literal> pop up, |
1011 | select the devices from the device(s) chooser list on which to run the | 1072 | select the devices from the device(s) chooser list on which to |
1012 | scripts. Press the <literal>></literal> button to move | 1073 | run the scripts. Press the <literal>></literal> button to |
1013 | the devices to the right side of the chooser, which is the list | 1074 | move the devices to the right side of the chooser, which is the |
1014 | of devices that will execute the selected scripts.</para> | 1075 | list of devices that will execute the selected scripts.</para> |
1015 | </listitem> | 1076 | </listitem> |
1016 | 1077 | ||
1017 | <listitem> | 1078 | <listitem> |
1018 | <para>Select the scripts from the list under the device(s) chooser | 1079 | <para>Select the scripts from the list under the device(s) |
1019 | by pressing the <literal>+</literal> button.</para></listitem> | 1080 | chooser by pressing the <literal>+</literal> button.</para> |
1020 | 1081 | </listitem> | |
1021 | <listitem> | 1082 | |
1022 | <para>In the pop-up window, select the scripts from the list. | 1083 | <listitem> |
1023 | If there are no scripts to select, then there is no script | 1084 | <para>In the pop-up window, select the scripts from the list. If |
1024 | uploaded with that particular type. Upload the script(s) needed and try again.</para> | 1085 | there are no scripts to select, then there is no script uploaded |
1086 | with that particular type. Upload the script(s) needed and try | ||
1087 | again.</para> | ||
1025 | </listitem> | 1088 | </listitem> |
1026 | 1089 | ||
1027 | <listitem> | 1090 | <listitem> |
@@ -1030,10 +1093,10 @@ | |||
1030 | press <literal>ok</literal>.</para> | 1093 | press <literal>ok</literal>.</para> |
1031 | 1094 | ||
1032 | <note> | 1095 | <note> |
1033 | <para>The status of execution for the scripts can be seen by opening the | 1096 | <para>The status of execution for the scripts can be seen by |
1034 | <literal>Fault</literal> -> <literal>Events</literal> | 1097 | opening the <literal>Fault</literal> -> |
1035 | screen and filtering by device and/or the event name | 1098 | <literal>Events</literal> screen and filtering by device |
1036 | <filename>Custom</filename>.</para> | 1099 | and/or the event name <filename>Custom</filename>.</para> |
1037 | </note> | 1100 | </note> |
1038 | </listitem> | 1101 | </listitem> |
1039 | </orderedlist> | 1102 | </orderedlist> |
@@ -1694,7 +1757,10 @@ | |||
1694 | 1757 | ||
1695 | <para>When a VNF is onboarded and available in the VNF catalog, it can | 1758 | <para>When a VNF is onboarded and available in the VNF catalog, it can |
1696 | be instantiated on connected uCPE devices. The configurations provided | 1759 | be instantiated on connected uCPE devices. The configurations provided |
1697 | when the VNF is onboarded, serve as a template for instantiation.</para> | 1760 | when the VNF is onboarded, serve as a template for instantiation. Before |
1761 | instantiating any VNF, please make sure the available storage space on | ||
1762 | the uCPE device is big enough to accommodate the VNF you need to | ||
1763 | instantiate.</para> | ||
1698 | 1764 | ||
1699 | <para>Follow the instructions below to instantiate a VNF:</para> | 1765 | <para>Follow the instructions below to instantiate a VNF:</para> |
1700 | 1766 | ||