diff --git a/04-vim-setup.md b/04-vim-setup.md index 37a6d12776ef27ce0c9d2127d4ac1bec8e89e056..b5a6f351db2758edcb099399fe7b1f64c41e327a 100644 --- a/04-vim-setup.md +++ b/04-vim-setup.md @@ -329,50 +329,35 @@ For specification of flavor info at time of datacenter creation use a parameter In order to use a VIM target based on Azure, the following information needs to be gathered: - Azure `subscription Id`. -- Azure `application Id`, to be used as `client Id` -- The `authentication key` to be used as `client secret`. - The `tenant Id`, to be created or obtained in the Microsoft portal. +- Access credentials: + - `client_id`: In the case of a service principal (recommended for production deployments), this attribute corresponds to the Azure `application Id`. For regular users, this value is simply the `username` (this approach can be more convenient for casual OSM testing). + - The `authentication Key`. +- Resource Group: all Azure resources for a VIM target will be created into the same `resource_group`. Said resource group could exist before or, in case it did not exist, OSM would try to create it upon the creation of the VIM target (the latter would require that your user/service principal had sufficient privileges in the subscription - check with your administrator). -#### 2. Create Microsoft Azure Resource Group +The above data can be accessed through the Azure portal, but can also be obtained through the CLI. For instance, once logged in, the command `az account list` returns, among other information, `application Id`, `username`, `tenant Id` and `subscription Id`. -All Azure resources for a VIM target will be created in the same `resource group`. This `resource group` should be created before adding the VIM target and will be provided as a configuration parameter. In case it has not been previously created, this `resource group` will be created implicitly. - -#### 3. Create Microsoft Azure Virtual Network +#### 2. Create Microsoft Azure Virtual Network The virtual networks created for the Azure VIM will all be created as subnets from a base virtual network. This base virtual network should be created before adding the VIM target and will also be provided as a configuration parameter. -In case it has not been previously created this `resource group` will be created implicitly. - It is also recommended to create a management network for the VIM network services. -#### 4. Image selection - -Azure does not allow the creation of custom images, so you need to make sure that your VNF packages include a reference to an appropriate alternative image in Microsoft Azure's image repository. - -**NOTE:** In case you are creating a VNF Package from scratch, please note you should use the full Azure image name: `publisher:offer:sku:version` (e.g. `Canonical:UbuntuServer:18.04-LTS:18.04.201809110`). - -#### 5. Flavor selection and machine tier - -Microsoft Azure has a number of pre-created flavors available that cannot be changed. Hence, OSM will determine the flavor to be used based of the VDU requirements in the package, in terms of number of CPUs, RAM and disk. - -In the Azure portal there are also different virtual machine tiers available, intended for different purposes: e.g cheaper machine serie `Basic` with no guaranteed throughput or more expensive machines with guaranteed throughput. For that reason, OSM allows to specificy such machine tiers in the VIM target definition by using the `flavors_pattern` parameter. For example, a `Basic` cheaper tier can be selected when defining the VIM target of a development environment, and specify a more advanced tier -for the VIM target of the production environment. - ### Adding 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: ```bash -osm vim-create --name azure --account_type azure --auth_url http://www.azure.com --tenant "tenantid" - --user "XXX" --password "azurepwd" --description "Azure site" - --config "{region_name: westeurope, resource_group: 'osmRG', subscription_id: 'azuresubs', +osm vim-create --name azure --account_type azure --auth_url http://www.azure.com --tenant "tenant_id" + --user "client_id" --password "client_secret" --description "Azure site" + --config "{region_name: westeurope, resource_group: 'osmRG', subscription_id: 'subscription_id', vnet_name: 'osm_vnet', flavors_pattern: 'flavors_regex'}" ``` -Azure credentials and tenant configuration: +where: -- `user`: Azure `application Id` -- `password`: Azure `authentication Key` +- `client_id`: Corresponds to the `application id` (for service principals) or the `username` (for regular users). +- `client secret: `authentication key` (for a service principal) or `password`(for regular users). - `subscription_id`: Azure `subscription Id` - `tenant`: Azure `tenant Id` @@ -384,7 +369,9 @@ Additional required configuration: Additional optional configuration: -- `flavors_pattern`: Regular expression to be used during flavor selection. This allows to select the desired virtual machine tier. +- `flavors_pattern`: Regular expression to be used during flavor selection. This allows to select the desired virtual machine tier. Microsoft Azure has a number of pre-created flavors available that cannot be changed. Hence, OSM will determine the flavor to be used based of the VDU requirements in the package, in terms of number of CPUs, RAM and disk. In the Azure portal there are also different virtual machine tiers available, intended for different purposes: e.g cheaper machine serie `Basic` with no guaranteed throughput or more expensive machines with guaranteed throughput. For that reason, OSM allows to specificy such machine tiers in the VIM target definition by using the `flavors_pattern` parameter. For example, a `Basic` cheaper tier can be selected when defining the VIM target of a development environment, and specify a more advanced tier for the VIM target of the production environment. + +**NOTE for VNF Onboarding:** You need to make sure that your VNF packages include a reference to an appropriate alternative image in Microsoft Azure's image repository. In case you are creating a VNF Package from scratch, please note you should use the full Azure image name: `publisher:offer:sku:version` (e.g. `Canonical:UbuntuServer:18.04-LTS:18.04.201809110`). ## Eclipse fog05