docs: adding instructions for how how to build the Windows VHD for di… (

#3911)
Azure · Oct 8, 2020 · 33f8735 · 33f8735
1 parent c1d004e
commit 33f8735
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 2 deletions.
diff --git a/.pipelines/vhd-builder-windows.yaml b/.pipelines/vhd-builder-windows.yaml
@@ -40,7 +40,7 @@ jobs:
       -e BUILD_ID=$(Build.BuildId) \
       -e BUILD_NUMBER=$(Build.BuildNumber) \
       -e CONTAINER_RUNTIME=$(CONTAINER_RUNTIME) \
-      -e WINDOWS-SERVER-VERSION=2019 \
+      -e WINDOWS_SERVER_VERSION=2019 \
       ${DEIS_GO_DEV_IMAGE} make run-packer-windows
     displayName: Building windows VHD
 

diff --git a/docs/howto/README.md b/docs/howto/README.md
@@ -4,5 +4,6 @@ Here you’ll find short answers to “How do I….?” types of questions. Thes
 
 - [Troubleshooting](troubleshooting.md)
 - [Building Windows Kubernetes Binaries](building-windows-kubernetes-binaries.md)
+- [Building VHDs](building-vhds.md)
 - [Large Kubernetes Clusters with AKS Engine](kubernetes-large-clusters.md)
 - [Using HTTP Ingress Routing in a Mixed Cluster](mixed-cluster-ingress.md)
diff --git a/docs/howto/building-vhds.md b/docs/howto/building-vhds.md
@@ -0,0 +1,36 @@
+# How to build VHDs
+
+## Windows VHD
+
+To build the Windows VHD
+
+1. Enter our dev container
+
+    ```bash
+    make dev
+    ```
+
+1. Set the following environment varibles
+
+    |   |   |
+    |---|---|
+    | CLIENT_ID | Azure service princicle ID |
+    | CLIENT_SECRET | Azure service principle secret |
+    | TENANT_ID | Azure tennant ID |
+    |  AZURE_RESOURCE_GROUP_NAME | Resource group name to use / create |
+    | AZURE_LOCATION | Azure region to use |
+    | AZURE_VM_SIZE | VM size packer will use (Standard_D4s_v3 is recommended) |
+    | CONTAINER_RUNTIME | Container runtime VHD will be generated for (Docker or Containerd) |
+    | WINDOWS_SERVER_VERSION | Windows Server OS version vHD will be generated for (2019 or 2004) |
+
+1. Run packer
+
+   ```bash
+   make run-packer-windows
+   ```
+
+Once complete, packer will output a URI to the VHD it created.
+
+## Linux VHD
+
+TODO
diff --git a/packer.mk b/packer.mk
@@ -5,7 +5,7 @@ build-packer-ubuntu-gen2:
 	@packer build -var-file=vhd/packer/settings.json vhd/packer/vhd-image-builder-ubuntu-gen2.json
 
 build-packer-windows:
-	@packer build -var-file=vhd/packer/settings.json -var-file=vhd/packer/windows-${WINDOWS-SERVER-VERSION}-vars.json vhd/packer/windows-vhd-builder.json
+	@packer build -var-file=vhd/packer/settings.json -var-file=vhd/packer/windows-${WINDOWS_SERVER_VERSION}-vars.json vhd/packer/windows-vhd-builder.json
 
 init-packer:
 	@./vhd/packer/init-variables.sh