Merge pull request #5 from carceneaux-forks/dev

README.md updates
anthonyspiteri · Mar 3, 2020 · d81789f · d81789f
2 parents 0bc237e + 889f543
commit d81789f
Showing 1 changed file with 45 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,14 @@
-# Veeam Proxy Auto Deploy (Project Ōtosukēru) 
+# Veeam Proxy Auto Deploy (Project Ōtosukēru)
 
-![enter image description here](https://sociorocketnewsen.files.wordpress.com/2017/12/gp-41.png)
+![Project Ōtosukēru](https://sociorocketnewsen.files.wordpress.com/2017/12/gp-41.png)
 
 ## Description
-The initial aim of this project was to have Veeam Proxies automtically deployed and configured for ephemeral use by Veeam Backup & Replication jobs. It has the ability to deploy Veeam Backup Proxy VMs to vSphere and configures them in Veeam Backup & Replication and also the ability to remove the configuration and destory the VMs. A pre and post script can be configured within the Veeam Job and run everytime the job is executed.
 
-As the scopy of the project grew, the focus shifted to the ability to deploy Veeam Proxies automatically, but then have the ability to scale the number up or down dynamically. It also have the ability to deploy and scale new NAS File Proxies.
+The initial aim of this project was to have Veeam Proxies automtically deployed and configured for ephemeral use by Veeam Backup & Replication jobs. It has the ability to deploy Veeam Backup Proxy VMs to vSphere and configures them in Veeam Backup & Replication and also the ability to remove the configuration and destroy the VMs. A pre and post script can be configured within the Veeam Job and run everytime the job is executed.
 
-There is a master PowerShell script that executes all the code as does the following:
+As the scope of the project grew, the focus shifted to the ability to deploy Veeam Proxies automatically, but then have the ability to scale the number up or down dynamically. It also has the ability to deploy and scale new NAS File Proxies.
+
+There is a master PowerShell script that executes all the code and does the following:
 
 - Connects to a Veeam Backup & Replication Server
 - Gets all Backup Jobs and derives the number of VMs total being backed up
@@ -32,24 +33,26 @@ There is a master PowerShell script that executes all the code as does the follo
 7. Update CentOS and Ubuntu values in the 'maps.tf' file under proxy_linux
 8. Update path in 'pre.bat' and 'post.bat
 
-* Veeam Backup & Replication 9.5 Update 4b tested and supported for Windows Proxy Only
-* Veeam Backup & Replication v10 tested with support for Windows and Linux Proxy
-* Should be run from VBR Server to ensure Console Versions are compatible
-* Require Execution Policy set to Bypass - Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
+- Veeam Backup & Replication 9.5 Update 4b tested and supported for Windows Proxy Only
+- Veeam Backup & Replication v10 tested with support for Windows and Linux Proxy
+- Should be run from VBR Server to ensure Console Versions are compatible
+- Require Execution Policy set to Bypass - `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass`
+
+## Known Issues and Limitations
 
-## Known Issues and Limitations:
 - vSphere API timeouts can happen during apply/destroy phase of Terraform. See Log file to troubleshoot.
 - Speed of Proxy deployment depends on underlying infrastructure as well as VM Template. (Testing has shown 5 Windows Proxies can be deployed in 5 minutes)
 - Bug on first run where Scale Down might take affect. Rerun with same commands to workaround.
 - Minimum number of proxies to deploy is 2. Deploying 1 will result in failure.
 
-#### Version 1.2
-> 0.2 - First pre release for testing 
+### Version 1.2
+
+> 0.2 - First pre release for testing
 
 > 0.4 - Added support for Linux Server to be added and removed to VBR Inventory in preperation for v10 Proxy PowerShell
       - Added Error Checking on VBR Connection that will exist if not sucessfull on conneciton
 
-> 0.9 - Added support for Ubuntu or CentOS (Ubuntu default now in variable examples) 
+> 0.9 - Added support for Ubuntu or CentOS (Ubuntu default now in variable examples)
       - Added remote-exec Terraform entry to add port 2500 to Linux FW in readiness for v10
       - Added error checking for VBR connectivity, Job VM Count and Terraform deployment issues
       - Added experimental support for -SetProxyCount parameter
@@ -142,33 +145,35 @@ To Destroy and Destroy Proxies:
 or to run from Veeam Backup Job
 
     ./post.bat 
-    
+
 Modification can be made to pre/post script. Requires editing of path relative to local environment. Example execution for Windows and Linux contained. If you have a HCI configuration you might want to look at -ProxyPerHost as an additional parameter. For DHCP configuration you need to add -DHCP as an additional parameter.
-    
+
 ## Configuration
 
 ## config.json Breakdown
-All of the variables are configured in the config.json file. Nothing is required to be changed in the main depply script. The autodeploy user is created with the first.ps1 script used for Windows Workgroup deployments.
+
+All of the variables are configured in the config.json file. Nothing is required to be changed in the main deploy script. The autodeploy user is created with the first.ps1 script used for Windows Workgroup deployments.
 
     {
     "LinuxProxy": {
-		    "Username": "root",
-		    "LocalUsername":"root",
-		    "LocalPasswordUbuntu":"password$12"
+            "Username": "root",
+            "LocalUsername":"root",
+            "LocalPasswordUbuntu":"password$12"
             "LocalPasswordCentOS":"password$12"
-		},
+        },
 
     "VBRDetails": {
-		    "Server":"TPM03-VBR01.AperatureLabs.biz",
-		    "Username":"APLABS\\service.veeam",
-		    "Password":"password$12",
+            "Server":"TPM03-VBR01.AperatureLabs.biz",
+            "Username":"APLABS\\service.veeam",
+            "Password":"password$12",
             "Username2":"autodeploy",
             "Password2":"Veeam1!"
-	    }
+        }
     }
 
 ## terraform.tfvars Breakdown
-All variables are configured in the terraform.tfvars file and passed through to the TF configuration files. There is one config file for Windows and Linux Proxy deployment. Each contained in the repective folders. 
+
+All variables are configured in the terraform.tfvars file and passed through to the TF configuration files. There is one config file for Windows and Linux Proxy deployment. Each contained in the repective folders.
 
 ### vCenter connection
 
@@ -225,7 +230,7 @@ The following variables can be adjusted dependant on installation vSphere platfo
     vsphere_tag_category ="TPM03"
     vsphere_tag_name ="TPM03-NO-BACKUP"
 
-### Proxy Configuration 
+### Proxy Configuration
 
 The varibales below dictate the number of nodes (if run outside of PowerShell Proxy Logic), the first three octects of the IP Subnet and then the starting host address of proxies. The names and IP addresses of Proxies are incremented based on the number of Proxies being deployed. The Linux Distro variable is used as a default (if run outside of PowerShell Proxy Logic) but is setup through the -CentOS or Ubuntu parameter
 
@@ -234,8 +239,9 @@ The varibales below dictate the number of nodes (if run outside of PowerShell Pr
     vsphere_ipv4_address_proxy_network = "10.0.30."
     vsphere_ipv4_address_proxy_host ="210"
 
-## maps.tf Breakdown (proxy_linux)
-To make Linux deployment more streamlined, there is a seperate maps.tf file from which to set specific distro variables. The MAPs are then used depending on the vsphere_linux_distro variable that is set in 'terraform.tfvars' (if run outside of PowerShell) or set at the time of Terraform apply. Example below is for Ubuntu and CentOS and sets remote_exec command for FW rules 2500, the template location and the template password.
+## `maps.tf` Breakdown (proxy_linux)
+
+To make Linux deployment more streamlined, there is a seperate `maps.tf` file from which to set specific distro variables. The MAPs are then used depending on the vsphere_linux_distro variable that is set in 'terraform.tfvars' (if run outside of PowerShell) or set at the time of Terraform apply. Example below is for Ubuntu and CentOS and sets remote_exec command for FW rules 2500, the template location and the template password.
 
     variable "remote_exec" {
         default = {
@@ -258,23 +264,23 @@ To make Linux deployment more streamlined, there is a seperate maps.tf file from
 
 ## To Do
 
- - [X] Complete option for Linux Proxy deployment and configuration (waiting for PowerShell commands in v10)
- - [X] Add option to choose DCHP or Static IP Allocation
- - [X] Add ability to scale Proxies outside of pre and post job scripts
- - [X] Add error checking to ensure correct exit conditions
- - [X] Add option to not join GuestOS to domain
- - [ ] Fix compatability issues with Terraform 0.12.x - main issue is JSON output not being correct format for PowerShell import
- - [ ] Improve basic Proxy sizing logic
- - [X] Create new feature to scale Proxies up or down once initial deployment has been completed
+- [X] Complete option for Linux Proxy deployment and configuration (waiting for PowerShell commands in v10)
+- [X] Add option to choose DCHP or Static IP Allocation
+- [X] Add ability to scale Proxies outside of pre and post job scripts
+- [X] Add error checking to ensure correct exit conditions
+- [X] Add option to not join GuestOS to domain
+- [ ] Fix compatability issues with Terraform 0.12.x - main issue is JSON output not being correct format for PowerShell import
+- [ ] Improve basic Proxy sizing logic
+- [X] Create new feature to scale Proxies up or down once initial deployment has been completed
 
- ## ✍ Contributions
+## ✍ Contributions
 
 We welcome contributions from the community! We encourage you to create [issues](https://github.com/VeeamHub/veeam-proxy-autodeploy/issues/new/choose) for Bugs & Feature Requests and submit Pull Requests. For more detailed information, refer to our [Contributing Guide](CONTRIBUTING.md).
 
 ## 🤝🏾 License
 
-* [MIT License](LICENSE)
+- [MIT License](LICENSE)
 
 ## 🤔 Questions
 
-If you have any questions or something is unclear, please don't hesitate to [create an issue](https://github.com/VeeamHub/veeam-proxy-autodeploy/issues/new/choose) and let us know!
+If you have any questions or something is unclear, please don't hesitate to [create an issue](https://github.com/VeeamHub/veeam-proxy-autodeploy/issues/new/choose) and let us know!