VIM setup as Diataxis

The content of the config is a text formatted in yaml. The recommendation is to use a comma separated list between curly brackets `{}` and quotes `""`.

#### Adding a VMware Integrated OpenStack (VIO) as VIM target

#### How to add a VMware Integrated OpenStack (VIO) as VIM target in OSM

Although VIO works as a regular OpenStack in practice, additional options may be needed to add a VIO VIM to OSM, so that OSM has all the credentials that it needs.

For common options, you may refer to the general OpenStack Setup Guide.

## OpenVIM

## OpenVIM (Deprecated)

### Setting up an OpenVIM environment

### How to set up an OpenVIM environment

A full step-by step guide for installing an OpenVIM environment from scratch can be found in [a specific chapter](13-openvim-installation.md).

### Adding OpenVIM as VIM target to OSM

### How to add OpenVIM as VIM target in OSM

To add and OpenVIM account as VIM target, you shoulld execute the following command, using the appropriate parameters (e.g. site name: `openvim-site`, IP address: `10.10.10.10`, VIM tenant: `osm`)

   --description "Openvim site" --tenant osm --user dummy --password dummy

```

## VMware's vCloud Director

## VMware's vCloud Director (Deprecated)

### Preparing your vCloud Director to be used by OSM

### How to set up a vCloud Director environment

- In order to get the `vim-tenant_name` from vCloud Director and/or the tenant UUID, you should execute:

+--------------------------------------+--------------+

```

#### Image preparation for VMware

#### How to upload images in vCloud Director environment

If a user needs on-board image that is not a VMware compatible disk image format such as qcow. User need to convert qcow image to an OVF.

If not, use a path of an existing image at host where OSM is running

### Adding vCD as VIM target to OSM

### How to add vCloud Director as VIM target in OSM

**Note: Be aware that vCD connector for VMware vCloud Director is no longer maintained and is offered as best-effort code with no guarantees. No bug fixes will be provided from the community on vCD connector. If you are interested in contributing and leading its evolution, please feel free to contact TSC mailing list [OSM_TECH@list.etsi.org](https://mail.google.com/mail/?view=cm&fs=1&tf=1&to=OSM_TECH@list.etsi.org). or RO MDL via Slack.**

## Amazon Web Services (AWS)

### Preparation for using AWS in OSM

### How to set up an AWS environment

#### 1. Get `AWS_ACCESS_KEY_ID` and `AWS_SECRET_KEY` for your AWS account

Default `security_group` doesn't allow user to SSH into the instances. This behavior is not recommended by OSM, as VCA requires a path to interact with instances. Hence, it is recommended that you create a new group that contains the rules/conditions required to SSH into the instances deployed by this NS. You can also modify the default security group to allow TCP port 22 or, however, creation of a custom security\_group is recommended.

### Adding AWS as VIM target to OSM

### How to add AWS as VIM target in OSM

You will need to specify some options at VIM target creation/association by using the `--config` parameter. For instance:

## Microsoft Azure

### Preparation for using Azure in OSM

### How to set up an Azure environment

#### 1. Obtain Azure credentials and tenant from Microsoft Azure

az network vnet create --resource-group osmRG --name osm_net --subnet-name internal --subnet-prefixes "10.0.0.0/24"

```

### Adding Microsoft Azure as VIM target in OSM

### How to add Microsoft Azure as VIM target in OSM

To sum up, in order to defice a VIM target with Azure, the following command and options should be used:

## Google Cloud Platform

### Preparation for using GCP in OSM

### How to set up a GCP environment

#### 1. Obtain GCP credentials and project from Google GCP

gcloud compute networks subnets create internal --network=osm-net --range=10.10.0.0/24 --region=region_id

```

### Adding GCP as VIM target in OSM

### How to add GCP as VIM target in OSM

To sum up, in order to register a GCP VIM target in OSM, the following command and options should be used:

- `<image_project>:<image>`: equivalent to `<image_project>:image:<image>` (e.g. `ubuntu-os-cloud:ubuntu-1804-bionic-v20210928`)

## What if I do not have a VIM at hand? Use of sandboxes

## Reference: Sandboxes 

Sometimes, casual testers of OSM may not have a fully fledged VIM at hand, either on premises or in a public cloud. In those cases, it is also possible using a VIM sandbox which, although limited and hence not appropriate for production services, it can be an option good enough for beginners.

## Advanced setups for high I/O performance: EPA and SDN Assist

### Overview

### Explanation: Overview

OSM supports EPA (Enhanced Platform Awareness) since Rel ZERO (May 2016) and usage of multiple NUMA nodes with Rel THIRTEEN (Dec 2022) which are already defined in OSM's VNF descriptors. OSM allows to utilize EPA features like mem-policy, hugepages memory, NUMA pinning, cpu thread policy, CPU pinning, setting resource quotas (CPU, memory, storage and interface). Besides, it supports the usage of passthrough and SR-IOV interfaces. Please see the [EPA Parameters](https://osm.etsi.org/docs/user-guide/latest/21-reference.html#EPA-Parameters) to check the details of supported parameters.

### SDN Assist

#### Why SDN Assist

#### Explanation: Why SDN Assist

SDN Assist works as follows to overcome the limitations of the VIM with respect to the underlay:

The module in charge of this workflow is the RO (Resource Orchestrator), which is provided transparently to the user. It uses an internal library to manage the underlay connectivity via SDN. The current library includes plugins for FloodLight, ONOS and OpenDayLight.

#### General requirements

#### Reference: General requirements

The general requirements are:

In addition to the general requirements, every VIM will have to be properly configured.

#### VIM configuration for SDN Assist

You should do extra configuration to configure your VIM for running VNFs which use SR-IOV or passthrough interfaces.

You can find a thorough [configuration guide for OpenStack VIMs with EPA](#configure-openstack-for-full-epa-support-in-osm) later in this same chapter. For other types of VIMs, this guide can be also taken as model to understand the EPA properties that might be expected.

### Using SDN Assist

### How to use SDN Assist

#### Adding a SDN controller to OSM

Note: detaching a SDN controller from the VIM is mandatory before deleting the SDN controller

### Configure Openstack for full EPA support in OSM

### How to configure Openstack for full EPA support in OSM

Besides the instructions above for any Openstack, you should do extra configuration to configure Openstack for running VNFs which use SR-IOV interfaces.

- <https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/network_functions_virtualization_configuration_guide/>

- <https://docs.openstack.org/newton/networking-guide/config-sriov.html>

## Distributed VCA

You can configure the VIM to use a Distributed VCA instead of using the default one. **[This section](06-osm-platform-configuration.html#distributed-vca)** explains the details on how to set everything up.