#!/usr/bin/env python
# coding: utf-8

# # Modifying a Template in Python

# Community templates offers large varity from Azure QuickStart Templates (four hundreds templates) and enables one-click Azure service deployments by importing existing templates yet modifications are required to have customized infrastructure with particular configurations.
# 
# Simple Azure allows you to write/edit a template in Python with an editor package (python-editor). The changed template can be saved for future use by an export function.

# ## Example: Changing *101-vm-sshkey* template to deploy 3 VMs

# In the previous tutorial, *101-vm-sshkey* template was introduced to deploy a Ubuntu VM with a ssh key from Azure QuickStart Templates. Now, we may want to deploy three VMs using the template therefore a VM image and size are identical within a same virtual network. This also may help install hadoop clusters, for example if we want to setup [NIST Fingerprint Matching](https://github.com/cloudmesh/example-project-nist-fingerprint-matching) with Apache Drill and HBase. Deploying software stacks on top of multiple VMs will be explained in the next tutorial.

# ## Load 101-vm-sshkey template

# First step is to load a *101-vm-sshkey* template to make changes.

# In[1]:


from simpleazure import SimpleAzure


# In[ ]:


import os
os.environ['AZURE_SUBSCRIPTION_ID'] = $sid
os.environ['AZURE_CLIENT_SECRET'] = $password
os.environ['AZURE_TENANT_ID'] = $tid
os.environ['AZURE_CLIENT_ID'] = $cid


# In[3]:


saz = SimpleAzure()
vm_sshkey = saz.aqst.get_template('101-vm-sshkey')


# ## Edit a Template using System's Editor

# Editor module provides an interface to modify your JSON template via System's editor e.g. vim, nano or emacs. The following function **edit()** opens an editor in your python although it is not supported in IPython Notebook. Screenshot is attached instead.

# In[11]:


# This call is valid on a python interactive shell, not on IPython Notebook
# updated_vm_sshkey = vm_sshkey.edit()


# ![alt python-editor](https://raw.githubusercontent.com/lee212/simpleazure/master/ipynb/files/python-editor.png 'python-editor')

# ### Multiple Instances using Azure Template Iteration Function

# Azure Template offers **copy** loop function to iterate resource items in Template. This is useful if we want to create multiple instances with a same properties e.g. VM image and size but different names with index. We will try to use the **copy** loop in this tutorial to create three VM instances from the **101-vm-sshkey** base template. For more information, see the documenation [here](https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-multiple/).

# ### Resources to be changed

# A VM (Microsoft.Compute/virtualMachines) starts with a network interface (Microsoft.Network/networkInterfaces) and a public IP address (Microsoft.Network/publicIPAddresses) in this template where the **copy** loop is also applied.
# 
# - Microsoft.Compute/virtualMachines
# - Microsoft.Network/networkInterfaces
# - Microsoft.Network/publicIPAddresses

# For your convenience, updated template is provided in the files folder. If you'd like to see the template, try to run this in ipython cell:
# 
# - %load /home/jovyan/work/files/101-vm-sshkey-for-3vms.json

# ### Resource not to be changed

# The following resources are not changed as one resource is shared:
#     
#     - Microsoft.Network/networkSecurityGroups
#     - Microsoft.Network/virtualNetworks

# ## Diff Two Templates

# To quickly review changes, a helper function is provided for a template comparison. 
# 
# **[template object].diff()** function compares two templates and shows differences. Before we compare the original vm_sshkey (``101-vm-sshkey``) and the new updated_vm_sshkey (``101-vm-sshkey-for-3vms``) templates, we load the updated template from a file in this tutorial. This can be skipped if you manually updated the original template using a system editor with edit() function. The updated template is identical to the 101-vm-sshkey template except deploying 3 vms.

# In[65]:


from simpleazure.template.template import Template
updated_vm_sshkey = Template()
updated_vm_sshkey.read_template("/home/jovyan/work/files/101-vm-sshkey-for-3vms.json")


# Provide the update template object to the original using **diff** method. Output is similar to system diff command.

# In[32]:


vm_sshkey.diff(updated_vm_sshkey)


# Review the lines with **+** and **-** where **+** indicates an updated line and **-** indicates an original line.
# 
# For example, a new parameter **numberOfInstances** is added to specify a number of vms to start, 3 is given in this example to produce 3 vms. (find the *numberOfInstances* at the last part of the content )
# 
# The resources- virtualMachines, networkInterfaces, and publicIPAddresses- are now described with **copy** loop function to iterate a resource creation witn an index for unique name (copyindex() is used for index). For example, virtualMachine names are described with template functions: **concat( [variables('vmName')], copyindex())** and actual values are like sshvm1, sshvm2 and sshvm3.
# 
# Number of virtual machines
# - Original: 1 vm
# - Updated: 3 vms
# - Change:  
#     * +u'copy': {u'count': u"[parameters('numberOfInstances')]", u'name': u'virtualMachineLoop'},
# 
# Virtual machine Names
# - Original: sshvm
# - Updated: sshvm1, sshvm2, sshvm3
# - Change:    
#     * -u'name': u"[variables('vmName')]",
#     *  +u'name': u"[concat(variables('vmName'), copyindex())]",
#     
# Public IP address names
# - Original: sshPublicIP
# - Updated: sshPublicIP1, sshPublicIP2, sshPublicIP3
# - Change:
#     * -u'name': u"[variables('publicIPAddressName')]",
#     * +u'name': u"[concat(variables('publicIPAddressName'), copyindex())]",
#     
# Network interface names
# - Original: sshNIC
# - Updated: sshNIC1, sshNIC2, sshNIC3
# - change:
#    * -u'name': u"[variables('nicName')]",
#    * +u'name': u"[concat(variables('nicName'), copyindex())]",
# 
# Similar changes are made towards networkInterfaces and publicIPAddresses because these resources depend on virual machines.

# ## Load Updated Template for ARM

# The updated template (updated_vm_sshkey) is ready to deploy 3 vms. Let's use Azure Resource Manager (ARM) in Simple Azure.
# 
# Note: template validation is not supported in the current version.

# In[66]:


saz.arm.load_template(updated_vm_sshkey)


# ### Confirm Paramters

# Just to make sure what parameters are given. For example, review login username (adminUsername) and public ssh key string (sshKeyData).

# In[67]:


saz.arm.parameters


# ### Update Parameter

# Let's change a login user name to 'simpleazure' just for a practice.

# In[68]:


saz.arm.add_parameter({"adminUsername":'simpleazure'})


# Remember, **simpleazure** login name will be used in SSH client.

# ## Deploy New Version

# It's time to deploy 3 VMs using the updated template. Just wait and see its deployment. It may take 2-3 minutes.

# In[40]:


saz.arm.deploy()


# It took about 3 minutes and deployed resources are also visible at the portal.

# ![alt Screenshot of deployed resources](https://raw.githubusercontent.com/lee212/simpleazure/master/ipynb/files/deployed-3vms.png 'Screenshot of deployed resources')
# 

# ## Access Information

# Public IP addresses are provided to get access launched VMs.

# In[52]:


saz.arm.view_info()


# ### Sample SSH Access

# ```
# $ ssh simpleazure@40.77.67.172
# The authenticity of host '40.77.67.172 (40.77.67.172)' can't be established.
# ECDSA key fingerprint is ec:98:eb:c9:eb:2c:b5:f2:b3:9e:64:36:d1:b4:38:2b.
# Are you sure you want to continue connecting (yes/no)? yes
# Warning: Permanently added '40.77.67.172' (ECDSA) to the list of known hosts.
# Welcome to Ubuntu 14.04.4 LTS (GNU/Linux 3.19.0-65-generic x86_64)
# 
#  * Documentation:  https://help.ubuntu.com/
# 
#   System information as of Thu Oct 27 04:58:18 UTC 2016
# 
#   System load: 0.39              Memory usage: 1%   Processes:       90
#   Usage of /:  39.6% of 1.94GB   Swap usage:   0%   Users logged in: 0
# 
#   Graph this data and manage this system at:
#     https://landscape.canonical.com/
# 
#   Get cloud support with Ubuntu Advantage Cloud Guest:
#     http://www.ubuntu.com/business/services/cloud
# 
# 0 packages can be updated.
# 0 updates are security updates.
# 
# 
# 
# The programs included with the Ubuntu system are free software;
# the exact distribution terms for each program are described in the
# individual files in /usr/share/doc/*/copyright.
# 
# Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by
# applicable law.
# 
# simpleazure@sshvm0:~$
# ```

# ## Export Template

# Simple Azure allows you to save your new template therefore it can be used for the future deployments. Or additional changes can be made from the updated template, for example, customscript to run initial script. 
# 
# Note: customscript is Azure Extensions to run a script after its provisioning. See more from [documentation](https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-windows-extensions-customscript/) or [example](https://github.com/Azure/azure-quickstart-templates/blob/master/201-discover-private-ip-dynamically/azuredeploy.json)

# **export_template()** returns a loaded template from ARM object.

# In[69]:


saz.arm.export_template()


# export_template() returns Simple Azure Template class object.
# 
# Therefore if you'd like to obtain a deploy template only (like azuredeploy.json), then use ['``azuredeploy``'] like:

# In[71]:


saz.arm.export_template()['azuredeploy']


# This does not include parameter settings that you specified e.g. adminUserame, numberOfInstances and sshKeyData.
# 
# Use ['parameters'] if you'd like to obtain a template for parameters like azuredeploy.parameters.json.

# In[72]:


saz.arm.export_template()['parameters']


# ### Save to a File

# Provide a filepath to store.

# In[ ]:


saz.arm.export_template().save("/home/jovyan/work/files/updated_template_for_3vms.json")


# ## Terminate All Resources

# Removing a resource group deletes all deployed resources. Warning: it may cause other issues if you have multiple deployments.

# In[70]:


saz.arm.remove_resource_group()


# Template is useful to reproduce infrastructure and Azure QuickStart Templates shares well developed community templates.
# Simple Azure offers Template loading/editing/exporting in Python therefore Azure Template users can use, modify and save their work on Templates.
# 
# Simple Azure is under development which means that new features are added constantly, please report any issues on Github and give any feedbacks to improve.
# 
# In the next tutorial, we will explore how to deploy software stacks after provisiong infrastructure. Ansible automation tool is also introduced.