Commit fd42759a authored by garciadeblas's avatar garciadeblas Committed by Francisco-Javier Ramon Salguero
Browse files

Support of autogenerated HTML documentation via Sphinx and minor fixes

parent dfd69722
Loading
Loading
Loading
Loading

.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line
_build
+3 −3
Original line number Diff line number Diff line
@@ -458,7 +458,7 @@ vnfd:vnfd-catalog:
           cp: eth0
```

**`alpinens.yaml`**
**`alpinens.yaml`**:

```yaml
nsd:nsd-catalog:
@@ -996,7 +996,7 @@ dfcd6ca2-4768-11e7-8f07-00163e1229e4 mydc 2017-06-02T07:55:41

#### Adding a port mapping

A sample of sdn port mapping can be found in RO/sdn/sdn_port_mapping.yaml
A sample of sdn port mapping can be found in `RO/sdn/sdn_port_mapping.yaml`

```bash
root@RO:~# tail -n 24 RO/sdn/sdn_port_mapping.yaml
+14 −9
Original line number Diff line number Diff line
@@ -249,6 +249,11 @@ With the previous hackfest example, according [VNF data model](http://osm-downlo
     volumes:
        - name: Storage1
          size: 'Size of the volume'
```

Then:

```bash
osm ns-create --ns_name h1 --nsd_name hackfest1-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: hackfest1VM, volume: [ {name: Storage1, vim-volume-id: 8ab156fd-0f8e-4e01-b434-a0fce63ce1cf} ] } ] } ] }'
```

@@ -306,7 +311,7 @@ There are two types of charms:
- Native charms: the set of scripts run inside the VNF components. This kind of charms are new in Release 7.
- Proxy charms: the set of scripts run in LXC containers in an OSM-managed machine (which could be where OSM resides), which use ssh or other methods to get into the VNF instances and configure them.

![OSM Proxy Charms](assets/800px-Osm_proxycharms.png)
![OSM Proxy Charms](assets/800px-OSM_proxycharms.png)

These charms can run with three scopes:

@@ -693,7 +698,7 @@ vdu:
        vnf-monitoring-param-ref: vnf_cpu_util
```

Regarding how to configure alarms through VNFDs for the auto-scaling use case, follow the [auto-scaling documentation](06-03-03-autoscaling.md)
Regarding how to configure alarms through VNFDs for the auto-scaling use case, follow the [auto-scaling documentation](#autoscaling)

#### Experimental functionality

@@ -757,7 +762,7 @@ docker run --rm --name curator --net host --entrypoint curator_cli bobrik/curato

### Autoscaling

### Reference diagram
#### Reference diagram

The following diagram summarizes the feature:

@@ -765,9 +770,9 @@ The following diagram summarizes the feature:

- Scaling descriptors can be included and be tied to automatic reaction to VIM/VNF metric thresholds.
- Supported metrics are both VIM and VNF metrics. More information about metrics collection can be found at the [Performance Management documentation](#performance-management)
- An internal alarm manager has been added to MON through the 'mon-evaluator' module, so that both VIM and VNF metrics can also trigger threshold-violation alarms and scaling actions. More information about this module can be found at the [Fault Management documentation](fault-management)
- An internal alarm manager has been added to MON through the 'mon-evaluator' module, so that both VIM and VNF metrics can also trigger threshold-violation alarms and scaling actions. More information about this module can be found at the [Fault Management documentation](#fault-management)

### Scaling Descriptor
#### Scaling Descriptor

The scaling descriptor is part of a VNFD. Like the example below shows, it mainly specifies:

@@ -798,7 +803,7 @@ scaling-group-descriptor:
        vdu-id-ref: vdu01
```

### Example
#### Example

This will launch a Network Service formed by an HAProxy load balancer and an (autoscalable) Apache web server. Please check:

@@ -835,7 +840,7 @@ osm ns-show web01
Testing:

1. To ensure the NS is working, visit the Load balancer's IP at the public network using a browser, the page should show an OSM logo and active VDUs.
2. To check metrics at Prometheus, visit `http://[OSM_IP]:9091` and look for osm_cpu_utilization and `osm_average_memory_utilization` (initial values could take some some minutes depending on your telemetry system's granularity).
2. To check metrics at Prometheus, visit `http://[OSM_IP]:9091` and look for `osm_cpu_utilization` and `osm_average_memory_utilization` (initial values could take some some minutes depending on your telemetry system's granularity).
3. To check metrics at Grafana, just install the OSM preconfigured version (`./install_osm.sh -o pm_stack`) and visit `http://[OSM_IP]:3000` (`admin`/`admin`), you will find a sample dashboard (the two top charts correspond to this example).
4. To increase CPU in this example to auto-scale the web server, install Apache Bench in a client within reach (could be the OSM host) and run it towards `test.php`.

+22 −15
Original line number Diff line number Diff line
@@ -456,7 +456,16 @@ primitive_params: dict # Optional. Maps [NSD.ns-configuration or VNFD.vnf-conf
  - Example of content:

```json
'{scaleType: SCALE_VNF, scaleVnfData: {scaleVnfType: SCALE_OUT, scaleByStepData: {member-vnf-index: <nsd:constituent-vnfd:member-vnf-index>, scaling-group-descriptor: <vnfd:scaling-group-descriptor:name>} } }' # Use SCALE_IN instead of SCALE OUT depending of desired type.
{
  scaleType: SCALE_VNF,
  scaleVnfData: {
    scaleVnfType: SCALE_OUT|SCALE_IN,
    scaleByStepData: {
      member-vnf-index: <nsd:constituent-vnfd:member-vnf-index>,
      scaling-group-descriptor: <vnfd:scaling-group-descriptor:name>
    }
  }
}
```

`/nslcm/v1/ns_instances/nsi_lcm_op_occs`. (rbac: `ns_instances:opps`)
@@ -530,14 +539,12 @@ NetSlice Instance Lifecycle Management
ssh_keys: comma separated list of keys to inject to vnfs
nsiDescription: description of the Network Slice Instance
additionalParamsForNsi: {param: value, ...}
    netslice-subnet: [ Same content as section #NSLCM_Details /nslcm/v1/ns_instances_content
    ],
    netslice-vld: [
                   name: TEXT,
netslice-subnet: [ Same content as section #NSLCM_Details /nslcm/v1/ns_instances_content ],
netslice-vld:
-   name: TEXT,
    vim-network-name: TEXT or DICT with the name for each vim account: {vimAccountId: network-name, ...},
    vim-network-id: TEXT or DICT with the id for each vim account {vimAccountId: network-id},
    ip-profile: Profile of the vld
    ]
```

`/nsilcm/v1/netslice_instances_content/`. (rbac: `slice_instances:id`)
+1 −1
Original line number Diff line number Diff line
@@ -780,7 +780,7 @@ openvim host-add /opt/openvim/test/hosts/host-example3.yaml
openvim host-list                        #-v,-vv,-vvv for verbosity levels
```

In `normal` or `host only` mode, the process is a bit more complex. First, you need to configure appropriately the host following these [guidelines](10-01-openvim-compute-install.md). The current process is manual, although we are working on an automated process. For the moment, follow these instructions:
In `normal` or `host only` mode, the process is a bit more complex. First, you need to configure appropriately the host following these [guidelines](#setting-up-compute-nodes-for-openvim). The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

```bash
#copy /opt/openvim/scripts/host-add.sh and run at compute host for gather all the information
Loading