summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
blob: 58435ff569c5d31f9d2668b01ee0faab5bd77a7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-changes">
  <title>Main Changes</title>

  <para>Below you'll find information about the new features and updates made
  in this release, as well as details on the provided packages and the
  backwards compatibility with previous versions of Enea NFV Access if
  applicable.</para>

  <section id="relinfo-changes-other">
    <title>New Features</title>

    <itemizedlist>
      <listitem>
        <para>Use of OpenJDK as the Java Engine in the uCPE Manager.</para>
      </listitem>

      <listitem>
        <para>USB Installer Web User Interface.</para>
      </listitem>

      <listitem>
        <para>Support of ZTP extensions through custom scripting.</para>
      </listitem>

      <listitem>
        <para>Support for uCPE device software management from the Enea uCPE
        Manager.</para>
      </listitem>

      <listitem>
        <para>Support for Layer 3 networking configuration from the Enea uCPE
        Manager.</para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="open_source">
    <title>Open Source</title>

    <para>For more information about the Open Source packages included, please
    refer to the Enea NFV Access Open Source Reports provided with this
    release.</para>
  </section>

  <section id="relinfo-backward-compat">
    <title>Compatibility</title>

    <para condition="hidden">In the development of any complex software
    platform, there is a need to strike a balance between backwards
    compatibility and new development. In most cases, compatibility will be
    maintained as long as reasonably possible. Necessary compatibility breaks
    will be done only as needed and in major releases.</para>  

    <para><remark>LXCR-9773</remark>Following REST API changes were added:</para>

    <itemizedlist>
      <listitem>
        <para>The <literal>uploadCustomScript()</literal> method included in the 
          <literal>CustomScripts</literal> module takes in an
        additional argument (device module name).</para>
      </listitem>

      <listitem>
        <para>A new <literal>-- upload() --</literal> method has been added to
          the Device Upgrade module to allow for uploads of NFV Access software 
          images to the uCPE Manager.</para>
      </listitem>

      <listitem>
        <para>A new <literal>-- upload() --</literal> method has been added to
          the <literal>VnfManager</literal> module to allow uploads of VNF 
          images to the uCPE Manager as part of the onboarding process.</para>
      </listitem>
    </itemizedlist>

    <para>The <literal>VcpeAgent</literal> (i.e. the NFV Access device module)
    was redesigned:</para>

    <itemizedlist>
      <listitem>
        <para> The <literal>system-attributes</literal> config table was split
        into <literal>system-attributes-state</literal> (operational data) and
        <literal>system-attributes</literal> (configuration data).</para>

        <itemizedlist>
          <listitem>
            <para> The configuration data still contains the attributes:
            <literal>device-name</literal>,
            <literal>device-description</literal> and
            <literal>initial-configuration-complete</literal>.</para>
          </listitem>

          <listitem>
            <para>The fields <literal>device-type</literal>,
            <literal>device-version</literal>, <literal>device-id</literal>,
            <literal>device-latitude</literal>, and
            <literal>device-longitude</literal> are now operational data.
            <literal>device-ip-address</literal> has been added as oper
            data.</para>
          </listitem>

          <listitem>
            <para>The <literal>customer-tag</literal> in release version 2.2.1
            was a config leaf-list, it is now a leaf called
            <literal>device-customer-tags</literal> (comma-separated).</para>
          </listitem>

          <listitem>
            <para>The <literal>mgmt-ip-address</literal> has been added as
            oper data. This attribute was configured within an ovs-bridge of
            type <literal>inband-mgmt</literal>.</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>The <literal>external-interface-capabilities</literal>
        operational table now has <literal>wan</literal> and
        <literal>mgmt</literal> Booleans.</para>
      </listitem>

      <listitem>
        <para>The <literal>external-interface</literal> configuration table
        now has a choice of <literal>wan</literal>. </para>

        <para>New fields for this type are <literal>mgmt-interface</literal>,
        <literal>address-assignment</literal>, <literal>ip-address</literal>,
        <literal>gateway</literal>, and <literal>netmask</literal> (only
        considered if static).</para>
      </listitem>

      <listitem>
        <para>In an <literal>ovs-bridge</literal>, for the choice of
        <literal>inband-mgmt</literal>, the <literal>mgmt-address</literal>
        and <literal>mgmt-port</literal> fields have been removed (there are
        no fields left in this choice).</para>
      </listitem>

      <listitem>
        <para>In the Host operational table, there are a couple of
        changes:</para>

        <itemizedlist>
          <listitem>
            <para>The <literal>name</literal> field has been removed, however,
            there is still a <literal>host-name</literal> field.</para>
          </listitem>

          <listitem>
            <para>A <literal>machine-type</literal> field has been
            added.</para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
    
    <para>REST clients should see only some minor changes when upgrading from 
      NFV Access 2.2.1 to NFV Access 2.2.2. Code that deals with the 
      system-attributes table, in-band management OVS bridges, or the host 
      operational data may need to be modified.</para>
    
    <para>The new WAN interface type needs a <literal>wan-mgmt</literal> 
      interface configured to create the <literal>in-band mgmt</literal> bridge. 
      This should typically happen automatically as part of initial installation
      or upgrade and should not affect the REST clients.</para>
  </section>
</chapter>