Commit 547dec41 authored by rahulkumarr's avatar rahulkumarr
Browse files

Documentation for feature_11038_enhancement_of_vertical_scale_and_merge_in_update_API

parent c2a0511a
Loading
Loading
Loading
Loading
Loading
+59 −0
Original line number Diff line number Diff line
@@ -2340,3 +2340,62 @@ sudo nc -l -p 90
sudo nc <dest_vnf_ip_address> 90
# All the packets from src vnf to dest vnf should route only through the mid vnf.
```

## How to perform Vertical Scaling of VNFs in OSM
#### Functionality Overview
- Vertical scaling allows you to dynamically adjust the resource allocation (CPU, memory, storage) of a deployed VNF instance to meet changing demands. This can improve resource utilization and application performance.

#### VNFD Requirements

The VNFD is a critical component for vertical scaling. It must include the following elements:

- software-version: 
  - Vertical scaling often involves changing the VNF software version to accommodate different resource requirements. The VNFD should allow specifying the software version associated with each flavor.
- virtual-compute-desc: 
  - The VNFD should define the VDUs (virtualized components) that make up the VNF. Each VDU should specify the supported flavor options with varying resource configurations (CPU, memory).
- virtual-storage-desc:
  - The VNFD should define the required virtual storage under the aformention key.  

```yaml
  software-version: 2.9
  virtual-compute-desc:
    - id: hackfest_basic-VM-compute
      virtual-cpu:
        num-virtual-cpu: 1
      virtual-memory:
        size: '1'
  virtual-storage-desc:
    - id: hackfest_basic-VM-storage
      size-of-storage: 10
```

#### Vertical Scaling Operations

There are two primary ways to trigger vertical scaling of a VNF instance in OSM.

**Important Note:** Regardless of the chosen method (OSM client or NGUI), ensure the new flavor provides sufficient resources for the VNF to function correctly.

1. OSM Client: 

    - The OSM client provides a command-line interface for various operations, including vertical scaling. You can use the following command to initiate vertical scaling:

      ```yaml
      osm ns-update <NS_NAME> --updateType VERTICAL_SCALE --vnf <MEMBER_VNF_INDEX|VNFINSTANCEID> --vnfd-name <VNFDID|VNFD_NAME> --vdu <VDUID>
      ```

    - Parameters:
      - NS_NAME: Name of the OSM Network Service instance.
      - MEMBER_VNF_INDEX (or VNFINSTANCEID): Identifier of the VNF member within the NS or the VNFD instance ID.
      - VNFDID (or VNFD_NAME): Identifier of the VNFD or its name.
      - VDUID: ID of the specific VDU within the VNFD to be scaled.

2. NGUI (Next Generation User Interface): 

    - If available in your OSM deployment, the NGUI offer's a graphical interface to trigger vertical scaling operations.
    - Navigate to OSM dashboard and click Action button then chose `NS Update` option, this will opn a new window shown below in image.
    - In `NS Update` option provide the inputs and click on apply, this will trigger the Vertical scale opertaion for the selected VNFs vdu. 

 - ![vertical_scale_update](assets/600px_vertical_scale_update.png)

- ![vertical_scale_update2](assets/600px_vertical_scale_update_2.png)
  
 No newline at end of file
+43 KiB
Loading image diff...
+34.3 KiB
Loading image diff...