diff --git a/01-quickstart.md b/01-quickstart.md index 377563bb75c8dc74d572510fe9888c097258ff4f..e92b75beb6816efea956fb391dc08436027ede36 100644 --- a/01-quickstart.md +++ b/01-quickstart.md @@ -163,6 +163,7 @@ Before proceeding, make sure that you have a site with a VIM configured to run w - **OpenStack.** Check the following link to learn how to configure OpenStack to be used by OSM: [Openstack configuration](04-vim-setup.md#openstack) - **VMware vCloud Director.** Check the following link to learn how to configure VMware VCD to be used by OSM: [Configuring VMware vCloud Director](04-vim-setup.md#vmwares-vcloud-director) - **Amazon Web Services (AWS).** Check the following link to learn how to configure AWS (EC2 and Virtual Private Cloud) to be used by OSM: [Configuring AWS for OSM](04-vim-setup.md#amazon-web-services-aws) +- **Microsoft Azure** Check the following link to learn how to configure Microsoft Azure to be used by OSM: [Configuring Microsoft Azure for OSM](04-vim-setup.md#microsoft-azure) - **Eclipse fog05** Check the following link to learn how to configure Eclipse fog05 to be used by OSM: [Configuring Eclipse fog05 for OSM](04-vim-setup.md#fog05) OSM can manage external SDN controllers to perform the dataplane underlay network connectivity on behalf of the VIM. See [EPA and SDN assist](04-vim-setup.md#advanced-setups-for-high-io-performance-epa-and-sdn-assist) @@ -235,6 +236,19 @@ osm vim-create --name aws-site --user XXX --password YYY --auth_url https://aws. For advanced options, please refer to the [AWS Setup Guide](12-aws-configuration.md#add-aws-to-osm). +#### Microsoft Azure + +- Execute the following command, using the appropiate parameters (e.g `azure_client_id`: 'XXX', `azure_secret`: 'YYY', `azure_tenant`: 'tenantid', `azure_subscription_id`: 'ZZZ', regular expression of the flavors that will be used: `flavors_pattern`:'^Basic') + +```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', + vnet_name: 'osm_vnet', flavors_pattern: 'flavors_regex'}" +``` + +For advanced options, please refer to the [Microsoft Azure setup guide](04-vim-setup.md#microsoft-azure). + #### Eclipse fog05 site - Execute the following command, using the appropriate parameters (e.g. runtime supported: "hypervisor", cpu architecture: "arch", user: "XXX", password: "YYY") @@ -245,6 +259,7 @@ osm vim-create --name fos --auth_url :8080 --account_type fos --t For advanced options, please refer to the [Eclipse fog05 setup guide](13-fog05-configuration.md#add-eclipse-fog05-to-osm). + ### Adding VIMs through GUI Just access the *VIM Accounts* tab, click the *New VIM* button and fill the parameters accordingly. diff --git a/04-vim-setup.md b/04-vim-setup.md index ad14330dd2603d787dfc245fb372784a0e861feb..31684a8aec956c354a36363d7f1affbd687b0071 100644 --- a/04-vim-setup.md +++ b/04-vim-setup.md @@ -317,6 +317,66 @@ For specification of flavor info at time of datacenter creation use a parameter **NOTE:** Details on AWS flavors/instance types can be found at Amazon Web Services docs (). Flavors/instance types in AWS vary depending on the region of AWS account. Above mentioned link provides details on all possible instance types. However to get details on the instance types available for your region, use your AWS management console. +## Microsoft Azure + +### Preparation for using Azure in OSM + +#### 1. Obtain Azure credentials and tenant from Microsoft Azure + +Azure `subscription Id` is required to create the VIM target. Besides, it must obtained Azure `application Id` that will be used as `client Id` and `authentication Key` that will be used as `client secret`. + +It is also needed to create or obtain in the Microsoft portal the `tenant Id`. + +#### 2. Create Microsoft Azure Resource Group + +All Azure Resources for a VIM target will 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 + +The virtual networks created for the Azure VIM will all be created as subnets from a base virtual net. This base virtual net 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. + +It is also recommended to create a management network for the VIM network services. + +#### 4. Image selection + +Microsoft Azure has a repository with many images available to be used for instances. The images to be used must be selected from this repository. The creation of custom images it is not allowed. + +Image names to be used in Microsoft Azure have the following format: `publisher:offer:sku:version`. For example: `Canonical:UbuntuServer:18.04-LTS:18.04.201809110` + +#### 5. Flavor selection + +Microsoft Azure has many flavors available already precreated. The flavor to be used will be obtained based of the required characteristics for the virtual maquine: number of cpus, ram, disk. In the Azure portal there are defined different virtual machine tiers to be used for different purposes: e.g cheaper machine serie `Basic` with no guaranteed throughput or more expensive machines with guaranteed throughput. + +We have defined a flavors_pattern configuration parameter that allows virtual machine tier selection. This way, for example, a `Basic` cheaper tier can be selected for a development environment and a more advanced tier can be used for the production environment. + +### Adding Microsoft Azure as VIM target in OSM + +To create an Azure VIM target the following configuration parameters must be specified: + +```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', + vnet_name: 'osm_vnet', flavors_pattern: 'flavors_regex'}" +``` + +Azure credentials and tenant configuration: + +- `user`: Azure `application Id` +- `password`: Azure `authentication Key` +- `subscription_id`: Azure `subscription Id` +- `tenant`: Azure `tenant Id` + +Additional required configuration: + +- `region_name`: Region to be used for the deployment +- `resource_group`: Resource group to be used as base for all resources created for this VIM +- `vnet_name`: Virtual name used as a base for this VIM subnets + +Additional optional configuration: + +- `flavors_pattern`: Regular expression that be used during flavor selection to be able to select virtual machine tier. + ## Fog05 Eclipse fog05 (can be read as _fog-O-five_ or _fog-O-S_) is a different kind of VIM, designed to manage a fog/edge environment, thus it is completely distributed (no controller/master node) and pluggable, and available as FOSS from Eclipse: