Skip to content

Commit 2cbba30

Browse files
updated readme
1 parent f8b1efe commit 2cbba30

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ hyperv.ps1
1818
configs.example.ps1
1919
*lab*
2020
*test*
21-
21+
config.json

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,45 @@ You can then use this network setup to build your environment. Here is an exampl
3737
- Azure PowerShell Modules installed (specifically **Az.Accounts, Az.Resources ,Az.Network, Az.Storage, Az.Compute**)
3838
- Partial knowledge with PowerShell and Azure modules
3939

40+
41+
## Configurations
42+
43+
Below are explanations for each configuration.
44+
45+
- **IgnoreISECheck**: PowerShell ISE has issues with prompting for password during VYOS setup. Recommend running in PowerShell or VSCode.
46+
- **AzureGov**: changing to true, will use the Azure environment for gov
47+
- **LabPrefix**: identifier for names in lab
48+
- **domain**: just a name for now (no DC install....yet)
49+
- **Email**: used only in VM notification for VM auto shutdown settings
50+
- **VMAdminUser**: this is used to configure default username and password on Azure VM's
51+
- **VMAdminPassword**: this is used to configure default username and password on Azure VM's
52+
- **OnPremSubnetCIDR**: Always use /16
53+
- **OnPremSubnetCount**:
54+
- **TenantASiteName**:
55+
- **TenantAHubCIDR**: Always use /16
56+
- **TenantASpokeCIDR**: Always use /16; keep this subnet higher than hub (when incrementing)
57+
- **TenantASpokeSubnetCount**: keep this at 1 for now
58+
- **TenantBSiteName**:
59+
- **TenantBHubCIDR**: Always use /16
60+
- **TenantBSpokeCIDR**: Always use /16
61+
- **TenantBSpokeSubnetCount**: keep this at 1 for now
62+
- **DHCPLocation**: defaults to DHCP server not on router; assumes DHCP is on a server
63+
- **DNSServers**: if not specified; defaults to fourth IP in spoke subnet scope (eg. 10.22.1.4). This would be Azure's first available IP for VM if <router> is specified; google IP 8.8.8.8 will be used since no DNS server role exist on router
64+
- **HyperVVMLocation**: Leave as <default> for auto detect
65+
- **HyperVHDxLocation**: Leave as <default> for auto detect
66+
- **VyosIsoPath**: Add path (eg. 'E:\\ISOs\\VyOS-1.1.8-amd64.iso') or use <latest> to get the latest VyOS ISO (this is still in BETA)
67+
- **HyperVVmIsoPath**:
68+
- **UseBGP**: not required for VPN, but can help. Costs more.
69+
- **AzureVnetToVnetPeering**:
70+
- TenantASubscriptionID:
71+
- TenantATenantID:
72+
- TenantBSubscriptionID:
73+
- TenantBTenantID:
74+
- **RouterAutomationMode**: Uses Git, SSH and SCP to build VyOS router. 99% automated; but 90% successful
75+
- **SimpleAppendix**: Name appended to the simple S2S resources
76+
- **AzureLocation**: Azure location: supports East US, East US 2, West US, West US 2, Central US, North Central US, South Central US
77+
- **timeZone**:
78+
4079
## Scripts
4180

4281
- **configs.ps1**. <-- This script is used to answer script values; linked to all scripts

configs.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ If(!$NoVyosISOCheck){
370370
#============================================
371371
# CONFIGURATIONS
372372
#============================================
373-
Write-Host "Collectiing local data..." -NoNewline
373+
Write-Host "Collecting local data..." -NoNewline
374374
#region Hyper-V Configurations
375375
#------------------------------
376376
$HyperVConfig = @{

0 commit comments

Comments
 (0)