Terraform variables details
===========================

Each pulsar endpoint infrastructure can be configured editing the ``vars.tf``, located in the Terraform workspace directory.

Navigate in the Pulsar infrastructure directory:

::

  cd pulsar-deployment

and edit the file ``tf/vars.tf`` with your favourite text editor.


Configuration options
*********************

-----------------
``nfs_disk_size``
-----------------

:Description:
	Size of the NFS storage drive. We suggest at least 300 GB of storage. The NFS will store all data that is
	processed at a given time. This includes input, output, intermediate data and Singularity images (if Singularity is used).

:Example:

	::

	  variable "nfs_disk_size" {
	    default = 300
	  }

-----------
``flavors``
-----------

:Description:
	Instance flavours names of the available flavours on your OpenStack tenant.
	``central-manager`` and ``nfs-server`` have minimal requirements, e.g. 4 virtual CPUs and 8 GB of RAM for each of them.
        The ``exec-node`` configures the HTCondor worker nodes. Its configuration depends on the availability on your Cloud provider.
        At least 16 vCPUs and 32 GB RAM are recommended, but in the end it depends on the tools/workflows you want to process on your puslar
        endpoint. The ``gpu-node`` is optional and identifies the size of the GPU nodes.

:Example:
	::

	  variable "flavors" {
	    type = "map"
	    default = {
	      "central-manager" = "m1.medium"
	      "nfs-server" = "m1.medium"
	      "exec-node" = "m1.medium"
	      "gpu-node" = "m1.medium"
	    }
	  }

-------------------
``exec_node_count``
-------------------

:Description:
	Set the number of HTCondor Compute Worker Nodes.

:Example:

	::
	  
	  variable "exec_node_count" {
	    default = 2
	  }

------------------
``gpu_node_count``
------------------

:Description:
        Set the number of HTCondor GPU Worker Nodes.

:Example:
	::

	  variable "gpu_node_count" {
	    default = 0
	  }
	 
---------
``image``
---------

:Description:
	Set the VGCN image to use. Terraform expects to find on OpenStack with the name specified in this field.
	More on VGCN image `here <https://github.com/usegalaxy-eu/vgcn>`_.
        The image ``name`` must match the name of the image on the OpenStack tenant.
	This field can be left unchanged.

:Example:
	::
 
	  variable "image" {
	    type = "map"
	    default = {
	      "name" = "vggp-v31-j132-4ab83d5ffde9-master"
	      "image_source_url" = "https://usegalaxy.eu/static/vgcn/vggp-v31-j132-4ab83d5ffde9-master.raw"
	      "container_format" = "bare"
	      "disk_format" = "raw"
	     }
	  }

-------------
``gpu_image``
-------------

:Description:
        Set the VGCN GPU image to use. Terraform expects to find on OpenStack with the name specified in this field.
        The image ``name`` must match the name of the image on the OpenStack tenant.
        This field can be left unchanged.

:Example:
        ::
        
          variable "gpu_image" {
            type = map
            default = {
              "name"             = "vggp-gpu-v60-j16-4b8cbb05c6db-dev"
              "image_source_url" = "https://usegalaxy.eu/static/vgcn/vggp-gpu-v60-j16-4b8cbb05c6db-dev.raw"
              // you can check for the latest image on https://usegalaxy.eu/static/vgcn/ and replace this
              "container_format" = "bare"
              "disk_format"      = "raw"
            }
          }

--------------
``public_key``
--------------

:Description:
	Defines a SSH public key, which will be inserted in the Central Manager VM, allowing the user to access it.
	The SSH public key has to be copied in the ``pubkey`` field.

:Example:	 
	::
 
	  variable "public_key" {
	    type = "map"
	    default = {
	      name = "key_label"
	      pubkey = "ssh-rsa blablablabla..."
	    }
	  }

---------------
``name_prefix``
---------------

:Description:
	Defines the name prefix for the resources created on OpenStack.
	This field can be left unchanged.

:Example:
	::
 
	  variable "name_prefix" {
	    default = "vgcn-"
	  }

-------------------
``name_suffix``
-------------------

:Description:
        Defines the name suffix for the resources created on OpenStack.
	This field can be left unchanged.

:Example:
	::
	  
	  variable "name_suffix" {
	    default = ".pulsar"
	  }

-------------------
``secgroups_cm``
-------------------

:Description:
	Defines the security groups of the Central Manager VM.
	This field can be left unchanged.

:Example:
	::
	  
	  variable "secgroups_cm" {
	    type = "list"
	    default = [
	      "vgcn-public-ssh",
	      "vgcn-ingress-private",
	      "vgcn-egress-public",
	    ]
	  }

-------------
``secgroups``
-------------

:Description:
	Defines the security groups for NFS server, Compute Nodes nodes and GPU nodes.
	This field can be left unchanged.

:Example:
	::
	  
	  variable "secgroups" {
	    type = "list"
	    default = [
	      "vgcn-ingress-private",
	      "vgcn-egress-public",
	    ]
	  }

------------------
``public_network``
------------------

:Description:
	Defines the name of the public network, allowing to access the Internet. Depending on the Cloud Provider IaaS configuration, if the network is already existing, the ``default`` value should match the name of the public net.

:Example:
	::
	  
	  variable "public_network" {
	    default  = "public"
	  }

-------------------
``private_network``
-------------------

:Description:
        Defines the name of the private network among the nodes. Depending on the Cloud Provider IaaS configuration, if the network is already existing, the ``name`` should match the name of the private net and the ``subnet_name`` should match the name of the subnet. The associated subnet ``cidr4`` needs also to be configured to match the private_subnet range.

:Example:
	::
	  
	  variable "private_network" {
	    type = "map"
	    default  = {
	      name = "vgcn-private"
	      subnet_name = "vgcn-private-subnet"
	      cidr4 = "192.168.199.0/24"
	    }
	  }

------------
``ssh-port``
------------

:Description:
	Defines the SSH port. The default is set to ``22``.
	This field can be left unchanged.

:Example:
	::
	  
	  variable "ssh-port" {
	    default = "22"
	  }


------------
``pvt_key``
------------

:Description:
        Defines the path to the SSH private key, corresponding to the ``public_key``, allowing user to move among the VMs deployed. Can be defined during the terraform apply step.

:Example:
        ::

         //set these variables during execution terraform apply -var "pvt_key=<~/.ssh/my_private_key>" -var "condor_pass=<MyCondorPassword>"
         variable "pvt_key" {}


---------------
``condor_pass``
---------------

:Description:
        Defines the HTCondor password for CM and executors. Can be defined during the terraform apply step.

:Example:
        ::
        
          variable "condor_pass" {}


------------
``mq_string``
------------

:Description:
        Defines the message queue url for configuring the pulsar endpoint. Can be defined during the terraform apply step.

:Example:
        ::

          variable "mq_string" {}