From b35fb0fceba4e5f0ccf108456975cb2999d1030a Mon Sep 17 00:00:00 2001 From: Guillermo Calvino Date: Thu, 13 Apr 2023 17:53:01 +0200 Subject: [PATCH 1/2] VIM setup as Diataxis Signed-off-by: Guillermo Calvino --- 04-vim-setup.md | 49 ++++++++++++++++++++----------------------------- 1 file changed, 20 insertions(+), 29 deletions(-) diff --git a/04-vim-setup.md b/04-vim-setup.md index ae059ff..8962fa0 100644 --- a/04-vim-setup.md +++ b/04-vim-setup.md @@ -88,7 +88,7 @@ ADVANCED configuration: 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. @@ -112,13 +112,13 @@ With respect to a regular Openstack, these additional configuration parameteres 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`) @@ -127,9 +127,9 @@ osm vim-create --name openvim-site --auth_url http://10.10.10.10:9080/openvim -- --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: @@ -185,7 +185,7 @@ Crated new network test and uuid: bac9f9c6-6d1b-4af2-8211-b6258659dfb1 +--------------------------------------+--------------+ ``` -#### 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. @@ -231,7 +231,7 @@ If image is uploaded at vCloud, reference it using the image name at VNFD descri 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.** @@ -261,7 +261,7 @@ The content of config is a yaml format text. The recommendation is to use a comm ## 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 @@ -295,7 +295,7 @@ AWS provides a default `security_group` defining a set of rules that allow conne 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: @@ -325,7 +325,7 @@ For specification of flavor info at time of datacenter creation use a parameter ## Microsoft Azure -### Preparation for using Azure in OSM +### How to set up an Azure environment #### 1. Obtain Azure credentials and tenant from Microsoft Azure @@ -350,7 +350,7 @@ It is also recommended to create a management subnet in that virtual network for 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: @@ -382,7 +382,7 @@ Additional optional configuration: ## 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 @@ -403,7 +403,7 @@ gcloud compute networks create osm-net --subnet-mode=custom 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: @@ -427,7 +427,7 @@ where: - `:`: equivalent to `: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. @@ -461,7 +461,7 @@ Detailed documentation is available at and - -## 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. -- GitLab From 9a2f68de90fe80dae2e0072f176170379fd29960 Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Tue, 27 Jun 2023 14:59:27 +0000 Subject: [PATCH 2/2] Update 04-vim-setup.md --- 04-vim-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/04-vim-setup.md b/04-vim-setup.md index 8962fa0..97936e1 100644 --- a/04-vim-setup.md +++ b/04-vim-setup.md @@ -461,7 +461,7 @@ Detailed documentation is available at and