diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2019-11-22 08:54:46 +0100 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2019-12-17 13:55:43 +0100 |
commit | e7ef0bffc081936b60559a32f820d97f7a868cf8 (patch) | |
tree | acc959a71879fee0393c48342e03013fa1626a4e | |
parent | 9986174de78a30cee3ab5ffb160be77f73000bf8 (diff) | |
download | el_releases-nfv-access-e7ef0bffc081936b60559a32f820d97f7a868cf8.tar.gz |
GettingStarted: add device upgrade chapter
- Add device upgrade from uCPE Manager chapter
- Update doc version to 2.2.2
- Fixed minor review comments
- Added 4.4.2.3 Releases installed on a device ch
- Added Note to 4.4.2.2 Upgrade Operations ch
Change-Id: Ie46ae108f159b376e491b8364c049041ae914e87
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml | 2 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 320 |
2 files changed, 313 insertions, 9 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml index 7fe09ec..be0be23 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-getting-started/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 | ||
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 688c278..3155be6 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 | |||
@@ -178,8 +178,8 @@ | |||
178 | 178 | ||
179 | <para>In order to manage the ucpemanager service, user can run: | 179 | <para>In order to manage the ucpemanager service, user can run: |
180 | <programlisting>service ucpemanager start/stop</programlisting></para> | 180 | <programlisting>service ucpemanager start/stop</programlisting></para> |
181 | |||
182 | </section> | 181 | </section> |
182 | |||
183 | <section id="ins_restore_option"> | 183 | <section id="ins_restore_option"> |
184 | <title>Installing with the restore option</title> | 184 | <title>Installing with the restore option</title> |
185 | 185 | ||
@@ -195,7 +195,7 @@ | |||
195 | 195 | ||
196 | <para>The name format of this file will be: | 196 | <para>The name format of this file will be: |
197 | <filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename> (e.g | 197 | <filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename> (e.g |
198 | <literal>SystemBackup_Feb19_2013_2257_42.zip</literal>). </para> | 198 | <literal>SystemBackup_Feb19_2013_2257_42.zip</literal>).</para> |
199 | 199 | ||
200 | <para>Follow the steps for Installation provided above and provide an | 200 | <para>Follow the steps for Installation provided above and provide an |
201 | additional argument as shown below:</para> | 201 | additional argument as shown below:</para> |
@@ -380,7 +380,7 @@ | |||
380 | <para>Running this command will remove any vestiges of the existing | 380 | <para>Running this command will remove any vestiges of the existing |
381 | ucpemanager service, if they exist, and reinstall the ucpemanager | 381 | ucpemanager service, if they exist, and reinstall the ucpemanager |
382 | application on the specified target, restoring the data in the database | 382 | application on the specified target, restoring the data in the database |
383 | and files in the process. </para> | 383 | and files in the process.</para> |
384 | 384 | ||
385 | <para>The ucpemanager service is then started and the older version is | 385 | <para>The ucpemanager service is then started and the older version is |
386 | now running on the system.</para> | 386 | now running on the system.</para> |
@@ -888,6 +888,311 @@ | |||
888 | </section> | 888 | </section> |
889 | </section> | 889 | </section> |
890 | 890 | ||
891 | <section id="device_upgrade"> | ||
892 | <title>Device Upgrade</title> | ||
893 | |||
894 | <section id="device_upgrade_process"> | ||
895 | <title>Device Upgrade Process</title> | ||
896 | |||
897 | <para>Device Upgrade/Install performs the following operations to the | ||
898 | device:</para> | ||
899 | |||
900 | <itemizedlist> | ||
901 | <listitem> | ||
902 | <para><emphasis role="bold">Prepare for upgrade</emphasis>. This | ||
903 | stage tells the device that an upgrade is about to happen.</para> | ||
904 | </listitem> | ||
905 | |||
906 | <listitem> | ||
907 | <para><emphasis role="bold">Install file on device</emphasis>. This | ||
908 | stage copies the file to the uCPE device.</para> | ||
909 | </listitem> | ||
910 | |||
911 | <listitem> | ||
912 | <para><emphasis role="bold">Upgrade Device</emphasis>. This stage | ||
913 | causes the device to replace its running image with the newly | ||
914 | copied image.</para> | ||
915 | </listitem> | ||
916 | </itemizedlist> | ||
917 | </section> | ||
918 | |||
919 | <section id="managing_device_upgrade"> | ||
920 | <title>Managing the Device Upgrade</title> | ||
921 | |||
922 | <para>Before an install or upgrade can be completed, certain configuration | ||
923 | data must be set. Files also need to be uploaded to the Device Upgrade | ||
924 | image repository to upload to the device.</para> | ||
925 | |||
926 | <para>Launch the Device Upgrade management console by selecting | ||
927 | <literal>Devices</literal> -> <literal>Upgrade</literal> from the top | ||
928 | toolbar. The console when launched will contain the following | ||
929 | tabs:</para> | ||
930 | |||
931 | <itemizedlist> | ||
932 | <listitem> | ||
933 | <para><literal>Image Library</literal>. To add/delete an image.</para> | ||
934 | </listitem> | ||
935 | |||
936 | <listitem> | ||
937 | <para><literal>Upgrade Operations</literal>. See running upgrades, | ||
938 | cancel any upgrades in progress, start a device upgrade.</para> | ||
939 | </listitem> | ||
940 | |||
941 | <listitem> | ||
942 | <para><literal>Device Status</literal>. Shows the device | ||
943 | status.</para> | ||
944 | </listitem> | ||
945 | |||
946 | <listitem> | ||
947 | <para><literal>Configuration</literal>. Upgrade configuration | ||
948 | parameters.</para> | ||
949 | </listitem> | ||
950 | </itemizedlist> | ||
951 | |||
952 | <para>Press "Close" when the message <literal>File Uploaded | ||
953 | Successfully</literal> appears on the File Upload Screen.</para> | ||
954 | |||
955 | |||
956 | <section id="upload_image"> | ||
957 | <title>Image Library</title> | ||
958 | |||
959 | <para><emphasis role="bold">Add an image to the image | ||
960 | repository/library</emphasis></para> | ||
961 | |||
962 | <orderedlist> | ||
963 | <listitem> | ||
964 | <para>Select <literal>Devices</literal> -> | ||
965 | <literal>Upgrade</literal>.</para> | ||
966 | </listitem> | ||
967 | |||
968 | <listitem> | ||
969 | <para>Select <literal>Add</literal> from the <literal>Image | ||
970 | Library</literal> tab to add a new image file.</para> | ||
971 | </listitem> | ||
972 | |||
973 | <listitem> | ||
974 | <para>Click on <literal>Choose File</literal> to provide the path | ||
975 | to the image file. Select the target hardware platform | ||
976 | corresponding to the image being uploaded (xeon-d or | ||
977 | atomc-3000).</para> | ||
978 | </listitem> | ||
979 | |||
980 | <listitem> | ||
981 | <para>Click <literal>Send</literal> to upload the image to the | ||
982 | image repository.</para> | ||
983 | </listitem> | ||
984 | </orderedlist> | ||
985 | |||
986 | <para><emphasis role="bold">Delete an image from the image | ||
987 | repository</emphasis></para> | ||
988 | |||
989 | <orderedlist> | ||
990 | <listitem> | ||
991 | <para>Select <literal>Devices</literal> -> | ||
992 | <literal>Upgrade</literal>.</para> | ||
993 | </listitem> | ||
994 | |||
995 | <listitem> | ||
996 | <para>Select the image you want to delete from the <literal>Image | ||
997 | Library</literal> tab and then click | ||
998 | <literal>Delete</literal>.</para> | ||
999 | </listitem> | ||
1000 | </orderedlist> | ||
1001 | </section> | ||
1002 | |||
1003 | <section id="multi_device_install"> | ||
1004 | <title>Upgrade Operations</title> | ||
1005 | |||
1006 | <para>The Upgrade Operations tab allows a user to manage device | ||
1007 | upgrades in the system. It allows the user to see all the upgrades | ||
1008 | that are currently in progress, as well as listing the completed ones. | ||
1009 | If an upgrade succeeds or fails, then a row will be added to the completed | ||
1010 | upgrades table. If one fails, the failure message will be visible here.</para> | ||
1011 | |||
1012 | <note><para>The list of completed upgrade tasks resides in memory and will not | ||
1013 | persist across reboots of the server.</para></note> | ||
1014 | |||
1015 | <para><emphasis role="bold">How to Install/Upgrade immediately or schedule for later</emphasis></para> | ||
1016 | |||
1017 | <orderedlist> | ||
1018 | <listitem> | ||
1019 | <para>Select <literal>Devices</literal> -> | ||
1020 | <literal>Upgrade</literal>.</para> | ||
1021 | </listitem> | ||
1022 | |||
1023 | <listitem> | ||
1024 | <para>Select <literal>Upgrade Devices</literal> from the | ||
1025 | <literal>Upgrade Operations</literal> tab. This will launch a | ||
1026 | <literal>Multi Device Install Image</literal> screen that will | ||
1027 | allow the user to install and upgrade more than one device at a | ||
1028 | time or upgrade later.</para> | ||
1029 | |||
1030 | <para>The configurable parameters are:</para> | ||
1031 | |||
1032 | <itemizedlist> | ||
1033 | <listitem> | ||
1034 | <para><literal>Scheduling</literal>. Click this checkbox if | ||
1035 | the upgrade will be done later. Schedule the day, hour and | ||
1036 | minute for when to run the upgrade.</para> | ||
1037 | |||
1038 | <note> | ||
1039 | <para>The time zone is set to Eastern Standard Time | ||
1040 | (EST).</para> | ||
1041 | </note> | ||
1042 | </listitem> | ||
1043 | |||
1044 | <listitem> | ||
1045 | <para><literal>Description</literal>. An optional description | ||
1046 | of the operation. It is recommended to add a description so that | ||
1047 | different upgrades happening simultaneously can be | ||
1048 | distinguished.</para> | ||
1049 | </listitem> | ||
1050 | |||
1051 | <listitem> | ||
1052 | <para><literal>Image File</literal>. Click on <literal>Choose | ||
1053 | Image File</literal> to select the image file.</para> | ||
1054 | </listitem> | ||
1055 | |||
1056 | <listitem> | ||
1057 | <para><literal>Devices</literal>. The list of available | ||
1058 | devices is populated when an image file is chosen. The device(s) | ||
1059 | chooser is then populated with the list of devices that can | ||
1060 | accept that file. Press the <literal>></literal> button to | ||
1061 | move the devices to the right side of the chooser, which is | ||
1062 | the list of devices that will be upgraded.</para> | ||
1063 | </listitem> | ||
1064 | |||
1065 | <listitem> | ||
1066 | <para><literal>Upgrade Operation</literal>. Available options are:</para> | ||
1067 | |||
1068 | <itemizedlist> | ||
1069 | <listitem> | ||
1070 | <para><literal>Install and Activate</literal>. This will | ||
1071 | do an image installation as well as an upgrade.</para> | ||
1072 | </listitem> | ||
1073 | |||
1074 | <listitem> | ||
1075 | <para><literal>Install Only</literal>. This will do an | ||
1076 | image installation only. The image is copied to the device, | ||
1077 | and an upgrade will be done later either at a scheduled time or | ||
1078 | when the option <literal>Activate Only</literal> is selected.</para> | ||
1079 | </listitem> | ||
1080 | |||
1081 | <listitem> | ||
1082 | <para><literal>Activate Only</literal>. This will activate | ||
1083 | an already installed image on the device.</para> | ||
1084 | </listitem> | ||
1085 | </itemizedlist> | ||
1086 | </listitem> | ||
1087 | </itemizedlist> | ||
1088 | </listitem> | ||
1089 | </orderedlist> | ||
1090 | </section> | ||
1091 | |||
1092 | <section id="check_releases"> | ||
1093 | <title>Releases installed on a Device</title> | ||
1094 | |||
1095 | <para>The installed releases on a device can be viewed by selecting | ||
1096 | the device first, then from the top toolbar selecting | ||
1097 | <literal>Configuration</literal> -> <literal>Upgrade</literal>. The | ||
1098 | installed releases on the device, the release status, release state, | ||
1099 | commit-id and release version will be listed in a table.</para> | ||
1100 | </section> | ||
1101 | |||
1102 | <section id="check_device_status"> | ||
1103 | <title>Device Status</title> | ||
1104 | |||
1105 | <para>The status of the installation and upgrade can be viewed in the | ||
1106 | <literal>Device Status</literal> tab. Ongoing or scheduled upgrade | ||
1107 | operations can be viewed or cancelled.</para> | ||
1108 | |||
1109 | <para><emphasis role="bold">To view the status of an installation or upgrade | ||
1110 | operations</emphasis></para> | ||
1111 | |||
1112 | <orderedlist> | ||
1113 | <listitem> | ||
1114 | <para>Select <literal>Devices</literal> -> | ||
1115 | <literal>Upgrade</literal>.</para> | ||
1116 | </listitem> | ||
1117 | |||
1118 | <listitem> | ||
1119 | <para>Select <literal>Device Status</literal>. The ongoing | ||
1120 | operations are listed at the top and a history of failed or | ||
1121 | successful operations are listed at the bottom.</para> | ||
1122 | </listitem> | ||
1123 | </orderedlist> | ||
1124 | |||
1125 | <para><emphasis role="bold">To cancel an upgrade | ||
1126 | operation</emphasis></para> | ||
1127 | |||
1128 | <orderedlist> | ||
1129 | <listitem> | ||
1130 | <para>Select <literal>Devices</literal> -> <literal>Upgrade | ||
1131 | </literal> -> <literal> Upgrade Operations</literal>.</para> | ||
1132 | </listitem> | ||
1133 | |||
1134 | <listitem> | ||
1135 | <para>Select an operation from the list and press <literal>Cancel | ||
1136 | Upgrade</literal> and <literal>Confirm</literal>. The operation | ||
1137 | will now be deleted from the list.</para> | ||
1138 | </listitem> | ||
1139 | </orderedlist> | ||
1140 | </section> | ||
1141 | |||
1142 | <section id="device_upgrade_config"> | ||
1143 | <title>Configuration</title> | ||
1144 | |||
1145 | <note><para>The default values present in the configuration of each device are | ||
1146 | recommended for use. Modifying them is for an Advanced User only.</para></note> | ||
1147 | |||
1148 | <para><emphasis role="bold">How to Configure the uCPE device Upgrade | ||
1149 | </emphasis></para> | ||
1150 | |||
1151 | <orderedlist> | ||
1152 | <listitem> | ||
1153 | <para>Select <literal>Devices</literal> -> <literal>Upgrade</literal>.</para> | ||
1154 | </listitem> | ||
1155 | |||
1156 | <listitem> | ||
1157 | <para>Select <literal>Configuration</literal>.</para> | ||
1158 | </listitem> | ||
1159 | |||
1160 | <listitem> | ||
1161 | <para>The configurable parameters are:</para> | ||
1162 | |||
1163 | <itemizedlist> | ||
1164 | <listitem> | ||
1165 | <para><literal>deviceImageDir</literal>. This is the disk | ||
1166 | location of the device image repository. If an absolute path | ||
1167 | name such as <literal>/usr/local/deviceimage</literal> is given, then the | ||
1168 | absolute path name is used. If no absolute pathname is given | ||
1169 | it is considered to be relative to the installation | ||
1170 | directory.</para> | ||
1171 | </listitem> | ||
1172 | |||
1173 | <listitem> | ||
1174 | <para><literal>maxThreads</literal>. This number dictates how | ||
1175 | many upgrades the system can manage at one time, either | ||
1176 | individually launched or launched from the multi-device | ||
1177 | screens. This value defaults to 20, which means that 20 | ||
1178 | devices may be updated at one time.</para> | ||
1179 | </listitem> | ||
1180 | |||
1181 | <listitem> | ||
1182 | <para><literal>KeepAlive</literal>. This number represents the | ||
1183 | number of seconds that a thread will be kept alive before it | ||
1184 | is collected. If multiple installations are occurring, this will | ||
1185 | keep the thread alive for X seconds before it is released. If | ||
1186 | not released, it can be used by the internal scheduling system | ||
1187 | as soon as it has completed an upgrade.</para> | ||
1188 | </listitem> | ||
1189 | </itemizedlist> | ||
1190 | </listitem> | ||
1191 | </orderedlist> | ||
1192 | </section> | ||
1193 | </section> | ||
1194 | </section> | ||
1195 | |||
891 | <section id="vnf_management"> | 1196 | <section id="vnf_management"> |
892 | <title>VNF Management</title> | 1197 | <title>VNF Management</title> |
893 | 1198 | ||
@@ -1163,8 +1468,8 @@ | |||
1163 | <literal>Path</literal>. When a user uses the uCPE Manager to | 1468 | <literal>Path</literal>. When a user uses the uCPE Manager to |
1164 | create an instance for multiple VNFs, they will be prompted to | 1469 | create an instance for multiple VNFs, they will be prompted to |
1165 | provide a data file for each entry in this table. Each type of VNF | 1470 | provide a data file for each entry in this table. Each type of VNF |
1166 | will require different cloud-init files, e.g.: a license file. | 1471 | will require different cloud-init files, e.g.: a license |
1167 | </para> | 1472 | file.</para> |
1168 | </listitem> | 1473 | </listitem> |
1169 | </orderedlist> | 1474 | </orderedlist> |
1170 | 1475 | ||
@@ -1209,7 +1514,7 @@ | |||
1209 | <para>The last three properties are useful in conjuction with the | 1514 | <para>The last three properties are useful in conjuction with the |
1210 | <literal>vnfMgmt</literal> bridge type. They allow the user to map | 1515 | <literal>vnfMgmt</literal> bridge type. They allow the user to map |
1211 | the internal VNF management port to an external port, useful for VNF | 1516 | the internal VNF management port to an external port, useful for VNF |
1212 | configuration from WAN. </para> | 1517 | configuration from WAN.</para> |
1213 | 1518 | ||
1214 | <para>In the previous example, the internal TCP port 443 (HTTPS) was | 1519 | <para>In the previous example, the internal TCP port 443 (HTTPS) was |
1215 | mapped to the external port 60001, which allows the user to access | 1520 | mapped to the external port 60001, which allows the user to access |
@@ -1224,8 +1529,7 @@ | |||
1224 | 1529 | ||
1225 | <para>When a VNF is onboarded and available in the VNF catalog, it can | 1530 | <para>When a VNF is onboarded and available in the VNF catalog, it can |
1226 | be instantiated on connected uCPE devices. The configurations provided | 1531 | be instantiated on connected uCPE devices. The configurations provided |
1227 | when the VNF is onboarded, serve as a template for instantiation. | 1532 | when the VNF is onboarded, serve as a template for instantiation.</para> |
1228 | </para> | ||
1229 | 1533 | ||
1230 | <para>Follow the instructions below to instantiate a VNF:</para> | 1534 | <para>Follow the instructions below to instantiate a VNF:</para> |
1231 | 1535 | ||