Fixed some bugs for Mgmt Driver

Tested the Mgmt Driver in the Yoga version and found some bugs.

To fix these bugs, the following things have been done in this
patch:

1. When checking whether the node has k8s installed, since the
   value of result.get_stderr() is a list, an error will occur
   in the if branch, and the value needs to be modified.
2. Use the _init_commander_and_send_install_scripts function
   instead of the RemoteCommandExecutor function to prevent the
   VM from getting an error when the connection fails during
   the startup phase.
3. Added the type of exceptions caught by the
   _init_commander_and_send_install_scripts function.
4. Change the scale_stack_id to scale_out_id_list uniformly to
   solve the parameter mismatch between the input values for
   mgmt_drvier in vnflcm_driver and mgmt_driver.
5. Add modify_information_start and modify_information_end to
   Mgmt Driver.
6. When using the Mgmt Driver to modify the content of the
   haproxy configuration file, use the exact match of grep to
   find the corresponding line number.

Closes-Bug: #1976440
Change-Id: I94f011fd5061b04dff0840bf90ca10ae2a677874

samples/free5gc/cnf/sample_free5gc_cnf_package/Scripts/free5gc_mgmt_cnf.py

@@ -783,3 +783,13 @@ class Free5gcMgmtDriverCnf(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/cnf_on_vm/no_affinity/sample_free5gc_cnf_on_vm_package/Scripts/kubernetes_mgmt_free5gc.py

@@ -2182,3 +2182,11 @@ class KubernetesFree5gcMgmtDriver(
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/cnf_on_vm/no_affinity/sample_free5gc_cnf_package/Scripts/free5gc_mgmt_cnf.py

@@ -783,3 +783,13 @@ class Free5gcMgmtDriverCnf(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/vnf/Affinity_Anti-Affinity/VNF/sample_free5gc_vnf_package_scope_nfvi_node/Scripts/free5gc_mgmt.py

@@ -720,3 +720,13 @@ class Free5gcMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/vnf/Affinity_Anti-Affinity/VNF/sample_free5gc_vnf_package_scope_zone/Scripts/free5gc_mgmt.py

@@ -720,3 +720,13 @@ class Free5gcMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/vnf/Affinity_Anti-Affinity/VNF/sample_free5gc_vnf_package_scope_zone_old/Scripts/free5gc_mgmt.py

@@ -720,3 +720,13 @@ class Free5gcMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/vnf/change_ext_conn/Scripts/free5gc_mgmt.py

@@ -899,3 +899,13 @@ class Free5gcMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
                     commander.close_session()
                 else:
                     pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/free5gc/vnf/sample_free5gc_vnf_package/Scripts/free5gc_mgmt.py

@@ -720,3 +720,13 @@ class Free5gcMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/mgmt_driver/ansible/ansible_driver.py

@@ -196,7 +196,7 @@ class AnsibleDriver(object):
         ]
 
         if action in scaling_actions:
-            stack_id = kwargs["scale_stack_id"]
+            stack_id = kwargs["scale_out_id_list"]
         else:
             stack_id = self._vnf_instance.instantiated_vnf_info.instance_id
 

samples/mgmt_driver/kubernetes/kubernetes_mgmt.py

@@ -136,7 +136,7 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
                     return []
                 raise exceptions.MgmtDriverRemoteCommandError(err_info=err)
         elif type == 'check_node':
-            err = result.get_stderr()
+            err = result.get_stderr()[0].replace('\n', '')
             if result.get_return_code() == 0:
                 pass
             elif (result.get_return_code() != 0 and
@@ -477,12 +477,13 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
                     user=user, password=password, host=host,
                     timeout=K8S_INSTALL_TIMEOUT)
                 return commander
-            except paramiko.SSHException as e:
+            except (exceptions.NotAuthorized, paramiko.SSHException,
+                    paramiko.ssh_exception.NoValidConnectionsError) as e:
                 LOG.debug(e)
                 retry -= 1
                 if retry == 0:
                     LOG.error(e)
-                    raise paramiko.SSHException()
+                    raise exceptions.MgmtDriverOtherError(error_message=e)
                 time.sleep(SERVER_WAIT_COMPLETE_TIME)
 
     def _init_commander(self, user, password, host, retry=4):
@@ -735,9 +736,8 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
         user = vm_dict.get('ssh', {}).get('username')
         password = vm_dict.get('ssh', {}).get('password')
         host = vm_dict.get('ssh', {}).get('ipaddr')
-        commander = cmd_executer.RemoteCommandExecutor(
-            user=user, password=password,
-            host=host, timeout=K8S_CMD_TIMEOUT)
+        commander = self._init_commander_and_send_install_scripts(
+            user, password, host)
         ssh_command = f"kubectl get node | grep {master_name}"
         result = self._execute_command(commander, ssh_command,
                                        K8S_CMD_TIMEOUT, 'check_node', 0)

samples/mgmt_driver/kubernetes/kubespray/cnf_nodeport_setting/cnf_nodeport_mgmt.py

@@ -361,3 +361,13 @@ class CnfNodePortMgmt(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver):
             change_ext_conn_request, grant,
             grant_request, **kwargs):
         pass
+
+    @log.log
+    def modify_information_start(self, context, vnf_instance,
+                                 modify_vnf_request, **kwargs):
+        pass
+
+    @log.log
+    def modify_information_end(self, context, vnf_instance,
+                               modify_vnf_request, **kwargs):
+        pass

samples/mgmt_driver/kubernetes/kubespray/cnf_nodeport_setting/configure_lb.sh

@@ -93,14 +93,17 @@ EOF
     done
 }
 
+# When executing terminate cnf, it will operate on haproxy.cfg.
+# Find two lines that exactly match the specified strings $start_str
+# and $end_str, and then delete all the content between the two lines.
 function delete_haproxy_conf {
     for(( i=0;i<${#NODEPORTS[@]};i++)); do
         split_node_port=(${NODEPORTS[i]//,/ })
         start_str=${split_node_port[0]}_${split_node_port[1]}
         end_str='default_backend      kubernetes-nodeport'
-        start_line_no=`grep -n "$start_str" /etc/haproxy/haproxy.cfg | \
+        start_line_no=`grep -w -n "$start_str" /etc/haproxy/haproxy.cfg | \
         cut -d ":" -f 1`
-        end_line_no=`grep -n "$end_str" /etc/haproxy/haproxy.cfg | head -1 |\
+        end_line_no=`grep -w -n "$end_str" /etc/haproxy/haproxy.cfg | head -1 |\
         cut -d ":" -f 1`
         sudo sed -i "${start_line_no},${end_line_no}d" /etc/haproxy/haproxy.cfg
     done

tacker/vnflcm/vnflcm_driver.py

@@ -552,6 +552,11 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
                 except Exception as e:
                     LOG.error('Invalid format operationParams')
                     raise exceptions.InvalidInput(str(e))
+            # NOTE(fengyi): Please be careful not to modify the parameters
+            # in kwargs, because MgmtDriver will depend on the
+            # parameters here, you can add parameters, but do not
+            # modify the original, unless you know that your
+            # modification has no effect on other MgmtDrivers.
             kwargs = {"old_vnf_package_path": old_vnf_package_path,
                       "configmap_secret_paths": cm_secret_paths}
 
@@ -625,6 +630,12 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
             # passed from conductor to vnflcm_driver, thus we put Null
             # value to grant_reqeust temporary.
             # This part will be updated in next release.
+            #
+            # NOTE(fengyi): Please be careful not to modify the parameters
+            # in kwargs, because MgmtDriver will depend on the parameters
+            # here, you can add parameters, but do not modify the original,
+            # unless you know that your modification has no effect on
+            # other MgmtDrivers.
             kwargs = {'vnf': copy.deepcopy(vnf_dict)}
             self._mgmt_manager.invoke(
                 self._load_vnf_interface(
@@ -656,6 +667,12 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
             # passed from conductor to vnflcm_driver, thus we put Null
             # value to grant and grant_reqeust temporary.
             # This part will be updated in next release.
+            #
+            # NOTE(fengyi): Please be careful not to modify the parameters
+            # in kwargs, because MgmtDriver will depend on the
+            # parameters here, you can add parameters, but do not
+            # modify the original, unless you know that your
+            # modification has no effect on other MgmtDrivers.
             kwargs = {'vnf': copy.deepcopy(vnf_dict)}
             self._mgmt_manager.invoke(
                 self._load_vnf_interface(
@@ -933,6 +950,12 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
             # passed from conductor to vnflcm_driver, thus we put Null
             # value to grant and grant_reqeust temporary.
             # This part will be updated in next release.
+            #
+            # NOTE(fengyi): Please be careful not to modify the parameters
+            # in kwargs, because MgmtDriver will depend on the
+            # parameters here, you can add parameters, but do not
+            # modify the original, unless you know that your
+            # modification has no effect on other MgmtDrivers.
             kwargs = {'vnf': copy.deepcopy(vnf_dict)}
             self._mgmt_manager.invoke(
                 self._load_vnf_interface(
@@ -983,8 +1006,13 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
                 # This part will be updated in next release.
                 if len(scale_id_list) != 0 or \
                         vim_connection_info.vim_type == 'kubernetes':
+                    # NOTE(fengyi): Please be careful not to modify the
+                    # parameters in kwargs, because MgmtDriver will depend
+                    # on the parameters here, you can add parameters, but
+                    # do not modify the original, unless you know that your
+                    # modification has no effect on other MgmtDrivers.
                     kwargs = {'scale_name_list': scale_name_list,
-                              'scale_stack_id': scale_id_list,
+                              'scale_out_id_list': scale_id_list,
                               'vnf': copy.deepcopy(vnf_info)}
                     self._mgmt_manager.invoke(
                         self._load_vnf_interface(
@@ -1052,7 +1080,12 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
                 # This part will be updated in next release.
                 if len(id_list) != 0 or \
                         vim_connection_info.vim_type == 'kubernetes':
-                    kwargs = {'scale_stack_id': id_list,
+                    # NOTE(fengyi): Please be careful not to modify the
+                    # parameters in kwargs, because MgmtDriver will depend
+                    # on the parameters here, you can add parameters, but
+                    # do not modify the original, unless you know that your
+                    # modification has no effect on other MgmtDrivers.
+                    kwargs = {'scale_out_id_list': id_list,
                               'vnf': copy.deepcopy(vnf_info)}
                     self._mgmt_manager.invoke(
                         self._load_vnf_interface(
@@ -1595,6 +1628,11 @@ class VnfLcmDriver(abstract_driver.VnfInstanceAbstractDriver):
                     vnf_instance.instantiated_vnf_info.flavour_id)
                 vnf_info['action'] = 'in'
                 if len(scale_id_list) != 0:
+                    # NOTE(fengyi): Please be careful not to modify the
+                    # parameters in kwargs, because MgmtDriver will depend
+                    # on the parameters here, you can add parameters, but
+                    # do not modify the original, unless you know that your
+                    # modification has no effect on other MgmtDrivers.
                     kwargs = {'scale_name_list': scale_name_list}
                     # TODO(LiangLu): grant_request here is planned to pass
                     # as a parameter, however due to grant_request are not

tacker/vnfm/mgmt_drivers/constants.py

@@ -17,7 +17,7 @@
 # key
 KEY_ACTION = 'action'
 KEY_KWARGS = 'kwargs'
-KEY_SCALE = 'scale_stack_id'
+KEY_SCALE = 'scale_out_id_list'
 
 # ACTION type
 ACTION_CREATE_VNF = 'create_vnf'