Update and add information about Terraform

- update
AWS + terraform
index
- add
Azure + terraform
vSpgere + terraform

docs/automation/index.rst

@@ -2,11 +2,6 @@
 VyOS Automation
 ###############
 
-
-  * Nornir
-  * startup scripts
-
-
 .. toctree::
    :maxdepth: 2
    

docs/automation/terraform/index.rst

@@ -2,17 +2,13 @@
 VyOS Terraform
 ##############
 
-
-  * Nornir
-  * startup scripts
-
-
 .. toctree::
    :maxdepth: 1
    :caption: Content
    
+   terraformvyos
    terraformAWS
-#   terraformAZ
+   terraformAZ
-#   terraformvSphere
+   terraformvSphere
-#   terraformGoogle
+   terraformGoogle
    

docs/automation/terraform/terraformAWS.rst

@@ -1,43 +1,11 @@
 :lastproofread: 2024-01-11
 
-.. _vyos-terraform:
+.. _terraformAWS:
 
-Terraform for VyOS
+Deploying VyOS in the AWS cloud
-==================
+===============================
 
-VyOS supports development infrastructure via Terraform and provisioning via Ansible.
+With the help of Terraform, you can quickly deploy VyOS-based infrastructure in the AWS cloud. If necessary, the infrastructure can be removed using terraform.
-Terraform allows you to automate the process of deploying instances on many cloud and virtual platforms. 
-In this article, we will look at using terraforms to deploy vyos on platforms - AWS, AZURE, and vSphere.
-More detailed about what is Terraform you can write using the link_.
-
-Need to install_ Terraform
-
-Structure of files in the standard Terraform project:
-
-.. code-block:: none
-
- .
- ├── main.tf             # The main script
- ├── version.tf          # File for the changing version of Terraform.
- ├── variables.tf        # The file of all variables in "main.tf"
- └── terraform.tfvars    # The value of all variables (passwords, login, ip adresses and so on)
-
-
-General commands that we will use for running Terraform scripts
-
-
-.. code-block:: none
-
-  #cd /<your folder>         # go to the Terrafom project
-  #terraform init          # install all addons and provider (aws az and so on)
-  #terraform plan          # show wtah is changing
-  #terraform apply         # run script
-  #yes                     # apply running
-
-
-Deploying vyos in the AWS cloud
--------------------------------
-With the help of terraforms, you can quickly deploy Vyos-based infrastructure in the AWS cloud. If necessary, the infrastructure can be removed using terraform.
 Also we will make provisioning using Ansible.
 
 
@@ -58,16 +26,16 @@ Step by step:
 AWS
 
 
-1.1 Create an account with AWS and get your "access_key", "secret key"
+  1 Create an account with AWS and get your "access_key", "secret key"
 
-1.2 Create a key pair_ and download your .pem key
+  2 Create a key pair_ and download your .pem key
 
 .. image:: /_static/images/keypairs.png
    :width: 50%
    :align: center
    :alt: Network Topology Diagram
 
-1.3 Create a security group_ for the new VyOS instance and open all traffic
+  3 Create a security group_ for the new VyOS instance and open all traffic
 
 .. image:: /_static/images/sg.png
    :width: 50%
@@ -83,36 +51,36 @@ AWS
 Terraform
 
 
-2.1 Create a0 UNIX or Windows instance
+  1 Create an UNIX or Windows instance
 
-2.2 Download and install Terraform
+  2 Download and install Terraform
 
-2.3 Create the folder for example /root/awsterraform
+  3 Create the folder for example /root/awsterraform
 
 .. code-block:: none
 
  mkdir /root/awsterraform
 
-2.4 Copy all files into your Terraform project "/root/awsterraform" (vyos.tf, var.tf, terraform.tfvars,version.tf), more detailed see `Structure of files Terrafom for AWS`_
+  4 Copy all files into your Terraform project "/root/awsterraform" (vyos.tf, var.tf, terraform.tfvars,version.tf), more detailed see `Structure of files Terrafom for AWS`_
 
-2.5 Type the commands :
+  5 Type the commands :
 
 .. code-block:: none
 
-   #cd /<your folder> 
+   cd /<your folder> 
-   #terraform init
+   terraform init
 
 
 Ansible
 
 
-3.1 Create a UNIX instance whenever you want (local, cloud, and so on)
+  1 Create an UNIX instance whenever you want (local, cloud, and so on)
 
-3.2 Download and install Ansible
+  2 Download and install Ansible
 
-3.3 Create the folder for example /root/aws/
+  3 Create the folder for example /root/aws/
 
-3.4 Copy all files into your Ansible project "/root/aws/" (ansible.cfg, instance.yml, mykey.pem and "all"), more detailed see `Structure of files Ansible for AWS`_
+  4 Copy all files into your Ansible project "/root/aws/" (ansible.cfg, instance.yml, mykey.pem and "all"), more detailed see `Structure of files Ansible for AWS`_
 
 mykey.pem you have to get using step 1.2
 
@@ -120,14 +88,14 @@ mykey.pem you have to get using step 1.2
 Start 
 
 
-4.1 Type the commands on your Terrafom instance:
+Type the commands on your Terrafom instance:
    
 .. code-block:: none
 
-   #cd /<your folder>
+   cd /<your folder>
-   #terraform plan  
+   terraform plan  
-   #terraform apply  
+   terraform apply  
-   #yes
+   yes
 
 
 Start creating an AWS instance and check the result 
@@ -265,14 +233,14 @@ Start creating an AWS instance and check the result
   null_resource.SSHconnection2: Still creating... [40s elapsed]
   null_resource.SSHconnection2: Still creating... [50s elapsed]
   null_resource.SSHconnection2: Still creating... [1m0s elapsed]
-  null_resource.SSHconnection2 (remote-exec): ok: [54.144.84.120]
+  null_resource.SSHconnection2 (remote-exec): ok: [54.xxx.xxx.xxx]
   
   null_resource.SSHconnection2 (remote-exec): TASK [Configure general settings for the vyos hosts group] *********************
   null_resource.SSHconnection2: Still creating... [1m10s elapsed]
-  null_resource.SSHconnection2 (remote-exec): changed: [54.144.84.120]
+  null_resource.SSHconnection2 (remote-exec): changed: [54.xxx.xxx.xxx]
   
   null_resource.SSHconnection2 (remote-exec): PLAY RECAP *********************************************************************
-  null_resource.SSHconnection2 (remote-exec): 54.144.84.120              : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
+  null_resource.SSHconnection2 (remote-exec): 54.xxx.xxx.xxx              : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
   
   null_resource.SSHconnection2: Creation complete after 1m16s [id=4902256962410024771]
   
@@ -280,7 +248,7 @@ Start creating an AWS instance and check the result
   
   Outputs:
   
-  my_IP = "54.144.84.120"
+  my_IP = "54.xxx.xxx.xxx"
   
 
 
@@ -289,17 +257,17 @@ If you need to delete the instance please type the command:
 
 .. code-block:: none
 
-   #terraform destroy
+   terraform destroy
 
 
 Troubleshooting
 ---------------
 
-1. Ansible doesn't connect via SSH to your AWS instance: you have to check that your SSH key has copied into the path /root/aws/.
+  1 Ansible doesn't connect via SSH to your AWS instance: you have to check that your SSH key has copied into the path /root/aws/.
 Also, increase the time in the file instance.yml from 300 sec to 500 sec or more. (It depends on your location).
 Make sure that you have opened access to the instance in the security group.
 
-2. Terraform doesn't connect via SSH to your Ansible instance: you have to check the correct login and password in the part of the file vyos. tf
+  2 Terraform doesn't connect via SSH to your Ansible instance: you have to check the correct login and password in the part of the file VyOS. tf
 
 .. code-block:: none
 
@@ -320,8 +288,8 @@ Structure of files Terrafom for AWS
 
  .
  ├── vyos.tf				# The main script
- ├── var.tf					# File for the changing version of Terraform.
+ ├── var.tf					# The file of all variables in "vyos.tf"
- ├── versions.tf			# The file of all variables in "vyos.tf"
+ ├── versions.tf			# File for the changing version of Terraform.
  └── terraform.tfvars		# The value of all variables (passwords, login, ip adresses and so on)
  
 
@@ -533,7 +501,7 @@ instance.yml
   ##############################################################################
   # About tasks:
   # "Wait 300 seconds, but only start checking after 60 seconds" - try to make ssh connection every 60 seconds until 300 seconds
-  # "Configure general settings for the vyos hosts group" - make provisioning into AWS VyOS node
+  # "Configure general settings for the VyOS hosts group" - make provisioning into AWS VyOS node
   # You have to add all necessary cammans of VyOS under the block "lines:"
   ##############################################################################
 
@@ -549,15 +517,15 @@ instance.yml
           delay: 60
           timeout: 300
   
-      - name: "Configure general settings for the vyos hosts group"
+      - name: "Configure general settings for the VyOS hosts group"
         vyos_config:
           lines:
-            - set system name-server 8.8.8.8
+            - set system name-server xxx.xxx.xxx.xxx
           save:
             true
 
 
-all
+group_vars/all
 
 .. code-block:: none
 

docs/automation/terraform/terraformAZ.rst

@@ -0,0 +1,488 @@
+:lastproofread: 2024-03-03
+
+.. _terraformAZ:
+
+Deploying VyOS in the Azure cloud
+=================================
+
+With the help of Terraform, you can quickly deploy VyOS-based infrastructure in the Azure cloud. If necessary, the infrastructure can be removed using terraform.
+Also we will make provisioning using Ansible.
+
+In this case, we'll create the necessary files for Terraform and Ansible next using Terraform we'll create a single instance on the Azure cloud and make provisioning using Ansible.
+
+Preparation steps for deploying VyOS on Azure 
+---------------------------------------------
+
+How to create a single instance and install your configuration using Terraform+Ansible+Azure 
+Step by step:
+
+Azure
+
+  1 Create an account with Azure
+
+Terraform
+
+
+  1 Create an UNIX or Windows instance
+
+  2 Download and install Terraform
+
+  3 Create the folder for example /root/azvyos/
+
+.. code-block:: none
+
+ mkdir /root/azvyos
+
+  4 Copy all files into your Terraform project "/root/azvyos" (vyos.tf, var.tf, terraform.tfvars), more detailed see `Structure of files Terrafom for Azure`_
+
+  5 Login with Azure  using the command 
+
+.. code-block:: none
+
+   az login
+
+2.6 Type the commands :
+
+.. code-block:: none
+
+   cd /<your folder> 
+   terraform init
+
+Ansible
+
+
+  1 Create an UNIX instance whenever you want (local, cloud, and so on)
+
+  2 Download and install Ansible
+
+  3 Create the folder for example /root/az/
+
+  4 Copy all files into your Ansible project "/root/az/" (ansible.cfg, instance.yml,"all"), more detailed see `Structure of files Ansible for Azure`_
+
+
+Start 
+
+
+Type the commands on your Terrafom instance:
+   
+.. code-block:: none
+
+   cd /<your folder>
+   terraform plan  
+   terraform apply  
+   yes
+
+After executing all the commands you will have your VyOS instance on the Azure cloud with your configuration, it's a very convenient desition.
+If you need to delete the instance please type the command:
+
+.. code-block:: none
+
+   terraform destroy
+   
+Structure of files Terrafom for Azure
+-------------------------------------
+
+.. code-block:: none
+
+ .
+ ├── vyos.tf				# The main script
+ ├── var.tf					# File for the changing version of Terraform.
+ └── terraform.tfvars		# The value of all variables (passwords, login, ip adresses and so on)
+
+File contents of Terrafom for Azure
+-----------------------------------
+
+vyos.tf
+
+.. code-block:: none
+
+
+  ##############################################################################
+  # HashiCorp Guide to Using Terraform on Azure
+  # This Terraform configuration will create the following:
+  # Resource group with a virtual network and subnet
+  # An VyOS server without ssh key (only login+password)
+  ##############################################################################
+  
+  # Chouse a provider
+  
+  provider "azurerm" {
+    features {}
+  }
+  
+  # Create a resource group. In Azure every resource belongs to a 
+  # resource group. 
+  
+  resource "azurerm_resource_group" "azure_vyos" {
+    name     = "${var.resource_group}"
+    location = "${var.location}"
+  }
+  
+  # The next resource is a Virtual Network.
+  
+  resource "azurerm_virtual_network" "vnet" {
+    name                = "${var.virtual_network_name}"
+    location            = "${var.location}"
+    address_space       = ["${var.address_space}"]
+    resource_group_name = "${var.resource_group}"
+  }
+  
+  # Build a subnet to run our VMs in.
+  
+  resource "azurerm_subnet" "subnet" {
+    name                 = "${var.prefix}subnet"
+    virtual_network_name = "${azurerm_virtual_network.vnet.name}"
+    resource_group_name = "${var.resource_group}"
+    address_prefixes       = ["${var.subnet_prefix}"]
+  }
+  
+  ##############################################################################
+  # Build an VyOS VM from the Marketplace
+  # To finde nessesery image use the command:
+  #
+  # az vm image list --offer vyos --all
+  #
+  # Now that we have a network, we'll deploy an VyOS server.
+  # An Azure Virtual Machine has several components. In this example we'll build
+  # a security group, a network interface, a public ip address, a storage 
+  # account and finally the VM itself. Terraform handles all the dependencies 
+  # automatically, and each resource is named with user-defined variables.
+  ##############################################################################
+  
+  
+  # Security group to allow inbound access on port 22 (ssh)
+  
+  resource "azurerm_network_security_group" "vyos-sg" {
+    name                = "${var.prefix}-sg"
+    location            = "${var.location}"
+    resource_group_name = "${var.resource_group}"
+  
+    security_rule {
+      name                       = "SSH"
+      priority                   = 100
+      direction                  = "Inbound"
+      access                     = "Allow"
+      protocol                   = "Tcp"
+      source_port_range          = "*"
+      destination_port_range     = "22"
+      source_address_prefix      = "${var.source_network}"
+      destination_address_prefix = "*"
+    }
+  }
+  
+  # A network interface.
+  
+  resource "azurerm_network_interface" "vyos-nic" {
+    name                      = "${var.prefix}vyos-nic"
+    location                  = "${var.location}"
+    resource_group_name       = "${var.resource_group}"
+  
+    ip_configuration {
+      name                          = "${var.prefix}ipconfig"
+      subnet_id                     = "${azurerm_subnet.subnet.id}"
+      private_ip_address_allocation = "Dynamic"
+      public_ip_address_id          = "${azurerm_public_ip.vyos-pip.id}"
+    }
+  }
+  
+  # Add a public IP address.
+  
+  resource "azurerm_public_ip" "vyos-pip" {
+    name                         = "${var.prefix}-ip"
+    location                     = "${var.location}"
+    resource_group_name          = "${var.resource_group}"
+    allocation_method            = "Dynamic"
+  }
+  
+  # Build a virtual machine. This is a standard VyOS instance from Marketplace.
+  
+  resource "azurerm_virtual_machine" "vyos" {
+    name                = "${var.hostname}-vyos"
+    location            = "${var.location}"
+    resource_group_name = "${var.resource_group}" 
+    vm_size             = "${var.vm_size}"
+  
+    network_interface_ids         = ["${azurerm_network_interface.vyos-nic.id}"]
+    delete_os_disk_on_termination = "true"
+  
+  # To finde an information about the plan use the command:
+  # az vm image list --offer vyos --all
+  
+    plan {
+      publisher = "sentriumsl"
+      name      = "vyos-1-3"
+      product   = "vyos-1-2-lts-on-azure"
+    }
+  
+    storage_image_reference {
+      publisher = "${var.image_publisher}"
+      offer     = "${var.image_offer}"
+      sku       = "${var.image_sku}"
+      version   = "${var.image_version}"
+    }
+  
+    storage_os_disk {
+      name              = "${var.hostname}-osdisk"
+      managed_disk_type = "Standard_LRS"
+      caching           = "ReadWrite"
+      create_option     = "FromImage"
+    }
+  
+    os_profile {
+      computer_name  = "${var.hostname}"
+      admin_username = "${var.admin_username}"
+      admin_password = "${var.admin_password}"
+    }
+  
+    os_profile_linux_config {
+      disable_password_authentication = false
+    }
+  }
+  
+  data "azurerm_public_ip" "example" {
+    depends_on = ["azurerm_virtual_machine.vyos"]
+    name                = "vyos-ip"
+    resource_group_name = "${var.resource_group}"
+  }
+  output "public_ip_address" {
+    value = data.azurerm_public_ip.example.ip_address
+  }
+  
+  # IP of AZ instance copied to a file ip.txt in local system
+  
+  resource "local_file" "ip" {
+      content  = data.azurerm_public_ip.example.ip_address
+      filename = "ip.txt"
+  }
+  
+  #Connecting to the Ansible control node using SSH connection
+  
+  resource "null_resource" "nullremote1" {
+  depends_on = ["azurerm_virtual_machine.vyos"] 
+  connection {
+   type     = "ssh"
+   user     = "root"
+   password = var.password
+       host = var.host
+  }
+  
+  # Copying the ip.txt file to the Ansible control node from local system 
+  
+   provisioner "file" {
+      source      = "ip.txt"
+      destination = "/root/az/ip.txt"
+         }
+  }
+  
+  resource "null_resource" "nullremote2" {
+  depends_on = ["azurerm_virtual_machine.vyos"]  
+  connection {
+  	type     = "ssh"
+  	user     = "root"
+  	password = var.password
+      	host = var.host
+  }
+  
+  # Command to run ansible playbook on remote Linux OS
+  
+  provisioner "remote-exec" {
+      
+      inline = [
+  	"cd /root/az/",
+  	"ansible-playbook instance.yml"
+  ]
+  }
+  }
+
+
+var.tf
+
+.. code-block:: none
+
+  ##############################################################################
+  # Variables File
+  # 
+  # Here is where we store the default values for all the variables used in our
+  # Terraform code.
+  ##############################################################################
+  
+  variable "resource_group" {
+    description = "The name of your Azure Resource Group."
+    default     = "my_resource_group"
+  }
+  
+  variable "prefix" {
+    description = "This prefix will be included in the name of some resources."
+    default     = "vyos"
+  }
+  
+  variable "hostname" {
+    description = "Virtual machine hostname. Used for local hostname, DNS, and storage-related names."
+    default     = "vyos_terraform"
+  }
+  
+  variable "location" {
+    description = "The region where the virtual network is created."
+    default     = "centralus"
+  }
+  
+  variable "virtual_network_name" {
+    description = "The name for your virtual network."
+    default     = "vnet"
+  }
+  
+  variable "address_space" {
+    description = "The address space that is used by the virtual network. You can supply more than one address space. Changing this forces a new resource to be created."
+    default     = "10.0.0.0/16"
+  }
+  
+  variable "subnet_prefix" {
+    description = "The address prefix to use for the subnet."
+    default     = "10.0.10.0/24"
+  }
+  
+  variable "storage_account_tier" {
+    description = "Defines the storage tier. Valid options are Standard and Premium."
+    default     = "Standard"
+  }
+  
+  variable "storage_replication_type" {
+    description = "Defines the replication type to use for this storage account. Valid options include LRS, GRS etc."
+    default     = "LRS"
+  }
+  
+  # The most chippers size
+  
+  variable "vm_size" {
+    description = "Specifies the size of the virtual machine."
+    default     = "Standard_B1s"
+  }
+  
+  variable "image_publisher" {
+    description = "Name of the publisher of the image (az vm image list)"
+    default     = "sentriumsl"
+  }
+  
+  variable "image_offer" {
+    description = "Name of the offer (az vm image list)"
+    default     = "vyos-1-2-lts-on-azure"
+  }
+  
+  variable "image_sku" {
+    description = "Image SKU to apply (az vm image list)"
+    default     = "vyos-1-3"
+  }
+  
+  variable "image_version" {
+    description = "Version of the image to apply (az vm image list)"
+    default     = "1.3.3"
+  }
+  
+  variable "admin_username" {
+    description = "Administrator user name"
+    default     = "vyos"
+  }
+  
+  variable "admin_password" {
+    description = "Administrator password"
+    default     = "Vyos0!"
+  }
+  
+  variable "source_network" {
+    description = "Allow access from this network prefix. Defaults to '*'."
+    default     = "*"
+  }
+  
+  variable "password" {
+     description = "pass for Ansible"
+     type = string
+     sensitive = true
+  }
+  variable "host"{
+     description = "IP of my Ansible"
+  }
+
+terraform.tfvars
+
+.. code-block:: none
+
+  password  = ""   # password for Ansible SSH
+  host      = ""   # IP of my Ansible
+
+
+Structure of files Ansible for Azure
+------------------------------------
+
+.. code-block:: none
+
+ .
+ ├── group_vars
+     └── all
+ ├── ansible.cfg
+ └── instance.yml
+
+
+File contents of Ansible for Azure
+----------------------------------
+
+ansible.cfg
+
+.. code-block:: none
+
+  [defaults]
+  inventory = /root/az/ip.txt
+  host_key_checking= False
+  remote_user=vyos
+
+
+instance.yml
+
+
+.. code-block:: none
+
+  ##############################################################################
+  # About tasks:
+  # "Wait 300 seconds, but only start checking after 60 seconds" - try to make ssh connection every 60 seconds until 300 seconds
+  # "Configure general settings for the VyOS hosts group" - make provisioning into Azure VyOS node
+  # You have to add all necessary cammans of VyOS under the block "lines:"
+  ##############################################################################
+
+
+  - name: integration of terraform and ansible
+    hosts: all
+    gather_facts: 'no'
+  
+    tasks:
+  
+      - name: "Wait 300 seconds, but only start checking after 60 seconds"
+        wait_for_connection:
+          delay: 60
+          timeout: 300
+  
+      - name: "Configure general settings for the VyOS hosts group"
+        vyos_config:
+          lines:
+            - set system name-server xxx.xxx.xxx.xxx
+          save:
+            true
+
+
+group_vars/all
+
+.. code-block:: none
+
+  ansible_connection: ansible.netcommon.network_cli
+  ansible_network_os: vyos.vyos.vyos
+  
+  # user and password gets from terraform variables "admin_username" and "admin_password" in the file /root/azvyos/var.tf
+  ansible_user: vyos
+  ansible_ssh_pass: Vyos0!
+
+Sourse files for Azure from GIT
+-------------------------------
+
+All files about the article can be found here_
+
+.. _here: https://github.com/vyos/vyos-automation/tree/main/TerraformCloud/Azure_terraform_ansible_single_vyos_instance-main
+
+

docs/automation/terraform/terraformvSphere.rst

@@ -0,0 +1,400 @@
+:lastproofread: 2024-03-03
+
+.. _terraformvSphere:
+
+Deploying VyOS in the vSphere infrastructure
+============================================
+
+With the help of Terraform, you can quickly deploy VyOS-based infrastructure in the vSphere.
+Also we will make provisioning using Ansible.
+
+In this case, we'll create the necessary files for Terraform and Ansible next using Terraform we'll create a single instance on the vSphere cloud and make provisioning using Ansible.
+
+Preparation steps for deploying VyOS on vSphere 
+-----------------------------------------------
+
+How to create a single instance and install your configuration using Terraform+Ansible+vSphere 
+Step by step:
+
+
+vSphere
+
+
+  1 Collect all data in to file "terraform.tfvars" and create resources for example "terraform"
+
+
+Terraform
+
+
+  1 Create an UNIX or Windows instance
+
+  2 Download and install Terraform
+
+  3 Create the folder for example /root/vsphereterraform
+
+.. code-block:: none
+
+ mkdir /root/vsphereterraform
+ 
+
+  4 Copy all files into your Terraform project "/root/vsphereterraform" (vyos.tf, var.tf, terraform.tfvars,version.tf), more detailed see `Structure of files Terrafom for vSphere`_
+
+  5 Type the commands :
+
+.. code-block:: none
+
+   cd /<your folder> 
+   terraform init
+
+
+Ansible
+
+
+  1 Create an UNIX instance whenever you want (local, cloud, and so on)
+
+  2 Download and install Ansible
+
+  3 Create the folder for example /root/vsphereterraform/
+
+  4 Copy all files into your Ansible project "/root/vsphereterraform/" (ansible.cfg, instance.yml,"all"), more detailed see `Structure of files Ansible for vSphere`_
+
+
+Start 
+
+
+Type the commands on your Terrafom instance:
+   
+.. code-block:: none
+
+   cd /<your folder>
+   terraform plan  
+   terraform apply  
+   yes
+
+
+After executing all the commands you will have your VyOS instance on the vSphere with your configuration, it's a very convenient desition.
+If you need to delete the instance please type the command:
+
+.. code-block:: none
+
+   terraform destroy
+
+   
+Structure of files Terrafom for vSphere
+---------------------------------------
+
+.. code-block:: none
+
+ .
+ ├── vyos.tf				# The main script
+ ├── versions.tf			# File for the changing version of Terraform.
+ ├── var.tf					# File for the changing version of Terraform.
+ └── terraform.tfvars		# The value of all variables (passwords, login, ip adresses and so on)
+
+
+File contents of Terrafom for vSphere
+-------------------------------------
+
+vyos.tf
+
+.. code-block:: none
+
+  provider "vsphere" {
+    user           = var.vsphere_user
+    password       = var.vsphere_password
+    vsphere_server = var.vsphere_server
+    allow_unverified_ssl = true
+  }
+  
+  data "vsphere_datacenter" "datacenter" {
+    name = var.datacenter
+  }
+  
+  data "vsphere_datastore" "datastore" {
+    name          = var.datastore
+    datacenter_id = data.vsphere_datacenter.datacenter.id
+  }
+  
+  data "vsphere_compute_cluster" "cluster" {
+    name          = var.cluster
+    datacenter_id = data.vsphere_datacenter.datacenter.id
+  }
+  
+  data "vsphere_resource_pool" "default" {
+    name          = format("%s%s", data.vsphere_compute_cluster.cluster.name, "/Resources/terraform")  # set as you need
+    datacenter_id = data.vsphere_datacenter.datacenter.id
+  }
+  
+  data "vsphere_host" "host" {
+    name          = var.host
+    datacenter_id = data.vsphere_datacenter.datacenter.id
+  }
+  
+  data "vsphere_network" "network" {
+    name          = var.network_name
+    datacenter_id = data.vsphere_datacenter.datacenter.id
+  }
+  
+  # Deployment of VM from Remote OVF
+  resource "vsphere_virtual_machine" "vmFromRemoteOvf" {
+    name                 = var.remotename
+    datacenter_id        = data.vsphere_datacenter.datacenter.id
+    datastore_id         = data.vsphere_datastore.datastore.id
+    host_system_id       = data.vsphere_host.host.id
+    resource_pool_id     = data.vsphere_resource_pool.default.id
+    network_interface {
+      network_id = data.vsphere_network.network.id
+    }
+    wait_for_guest_net_timeout = 2
+    wait_for_guest_ip_timeout  = 2
+  
+    ovf_deploy {
+      allow_unverified_ssl_cert = true
+      remote_ovf_url            = var.url_ova
+      disk_provisioning         = "thin"
+      ip_protocol               = "IPv4"
+      ip_allocation_policy = "dhcpPolicy"
+      ovf_network_map = {
+        "Network 1" = data.vsphere_network.network.id
+        "Network 2" = data.vsphere_network.network.id
+      }
+    }
+    vapp {
+      properties = {
+         "password"          = "12345678",
+         "local-hostname"    = "terraform_vyos"
+      }
+    }
+  }
+  
+  output "ip" {
+    description = "default ip address of the deployed VM"
+    value       = vsphere_virtual_machine.vmFromRemoteOvf.default_ip_address
+  }
+  
+  # IP of vSphere instance copied to a file ip.txt in local system
+  
+  resource "local_file" "ip" {
+      content  = vsphere_virtual_machine.vmFromRemoteOvf.default_ip_address
+      filename = "ip.txt"
+  }
+  
+  #Connecting to the Ansible control node using SSH connection
+  
+  resource "null_resource" "nullremote1" {
+  depends_on = ["vsphere_virtual_machine.vmFromRemoteOvf"]
+  connection {
+   type     = "ssh"
+   user     = "root"
+   password = var.ansiblepassword
+   host = var.ansiblehost
+  
+  }
+  
+  # Copying the ip.txt file to the Ansible control node from local system
+  
+   provisioner "file" {
+      source      = "ip.txt"
+      destination = "/root/vsphere/ip.txt"
+         }
+  }
+  
+  resource "null_resource" "nullremote2" {
+  depends_on = ["vsphere_virtual_machine.vmFromRemoteOvf"]
+  connection {
+          type     = "ssh"
+          user     = "root"
+          password = var.ansiblepassword
+          host = var.ansiblehost
+  }
+  
+  # Command to run ansible playbook on remote Linux OS
+  
+  provisioner "remote-exec" {
+  
+      inline = [
+          "cd /root/vsphere/",
+          "ansible-playbook instance.yml"
+  ]
+  }
+  }
+
+
+versions.tf
+
+.. code-block:: none
+
+  # Copyright (c) HashiCorp, Inc.
+  # SPDX-License-Identifier: MPL-2.0
+  
+  terraform {
+    required_providers {
+      vsphere = {
+        source  = "hashicorp/vsphere"
+        version = "2.4.0"
+      }
+    }
+  }
+
+var.tf
+
+.. code-block:: none
+
+  # Copyright (c) HashiCorp, Inc.
+  # SPDX-License-Identifier: MPL-2.0
+  
+  variable "vsphere_server" {
+    description = "vSphere server"
+    type        = string
+  }
+  
+  variable "vsphere_user" {
+    description = "vSphere username"
+    type        = string
+  }
+  
+  variable "vsphere_password" {
+    description = "vSphere password"
+    type        = string
+    sensitive   = true
+  }
+  
+  variable "datacenter" {
+    description = "vSphere data center"
+    type        = string
+  }
+  
+  variable "cluster" {
+    description = "vSphere cluster"
+    type        = string
+  }
+  
+  variable "datastore" {
+    description = "vSphere datastore"
+    type        = string
+  }
+  
+  variable "network_name" {
+    description = "vSphere network name"
+    type        = string
+  }
+  
+  variable "host" {
+    description = "name if yor host"
+    type        = string
+  }
+  
+  variable "remotename" {
+    description = "the name of you VM"
+    type        = string
+  }
+  
+  variable "url_ova" {
+    description = "the URL to .OVA file or cloude store"
+    type        = string
+  }
+  
+  variable "ansiblepassword" {
+    description = "Ansible password"
+    type        = string
+  }
+  
+  variable "ansiblehost" {
+    description = "Ansible host name or IP"
+    type        = string
+  }
+
+terraform.tfvars
+
+.. code-block:: none
+
+  vsphere_user       = ""
+  vsphere_password   = ""
+  vsphere_server     = ""
+  datacenter         = ""
+  datastore          = ""
+  cluster            = ""
+  network_name       = ""
+  host               = ""
+  url_ova            = ""
+  ansiblepassword    = ""
+  ansiblehost        = ""
+  remotename         = ""
+
+
+Structure of files Ansible for vSphere
+--------------------------------------
+
+.. code-block:: none
+
+ .
+ ├── group_vars
+     └── all
+ ├── ansible.cfg
+ └── instance.yml
+
+
+File contents of Ansible for vSphere
+------------------------------------
+
+ansible.cfg
+
+.. code-block:: none
+
+  [defaults]
+  inventory = /root/vsphere/ip.txt
+  host_key_checking= False
+  remote_user=vyos
+
+
+instance.yml
+
+.. code-block:: none
+
+  ##############################################################################
+  # About tasks:
+  # "Wait 300 seconds, but only start checking after 60 seconds" - try to make ssh connection every 60 seconds until 300 seconds
+  # "Configure general settings for the VyOS hosts group" - make provisioning into vSphere VyOS node
+  # You have to add all necessary cammans of VyOS under the block "lines:"
+  ##############################################################################
+
+
+  - name: integration of terraform and ansible
+    hosts: all
+    gather_facts: 'no'
+  
+    tasks:
+  
+      - name: "Wait 300 seconds, but only start checking after 60 seconds"
+        wait_for_connection:
+          delay: 60
+          timeout: 300
+  
+      - name: "Configure general settings for the VyOS hosts group"
+        vyos_config:
+          lines:
+            - set system name-server 8.8.8.8
+          save:
+            true
+
+
+group_vars/all
+
+.. code-block:: none
+
+  ansible_connection: ansible.netcommon.network_cli
+  ansible_network_os: vyos.vyos.vyos
+  
+  # user and password gets from terraform variables "admin_username" and "admin_password"
+  ansible_user: vyos
+  # get from vyos.tf "vapp"
+  ansible_ssh_pass: 12345678
+
+
+Sourse files for vSphere from GIT
+---------------------------------
+
+All files about the article can be found here_
+
+.. _here: https://github.com/vyos/vyos-automation/tree/main/TerraformCloud/Vsphere_terraform_ansible_single_vyos_instance-main
+

docs/automation/terraform/terraformvyos.rst

@@ -0,0 +1,39 @@
+:lastproofread: 2024-03-03
+
+.. _terraformvyos:
+
+Terraform for VyOS
+==================
+
+VyOS supports development infrastructure via Terraform and provisioning via Ansible.
+Terraform allows you to automate the process of deploying instances on many cloud and virtual platforms. 
+In this article, we will look at using terraforms to deploy VyOS on platforms - AWS, Azure, and vSphere.
+For more details about Terraform please have a look here link_.
+
+Need to install_ Terraform
+
+Structure of files in the standard Terraform project:
+
+.. code-block:: none
+
+ .
+ ├── main.tf             # The main script
+ ├── version.tf          # File for the changing version of Terraform.
+ ├── variables.tf        # The file of all variables in "main.tf"
+ └── terraform.tfvars    # The value of all variables (passwords, login, ip adresses and so on)
+
+
+General commands that we will use for running Terraform scripts
+
+
+.. code-block:: none
+
+  cd /<your folder>       # go to the Terrafom project
+  terraform init          # install all addons and provider (aws az and so on)
+  terraform plan          # show what is changing
+  terraform apply         # run script
+  yes                     # apply running
+
+
+.. _link: https://developer.hashicorp.com/terraform/intro
+.. _install: https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli