Merge pull request #92 from Parallels/macvm-builders-update-docs

Add docs for ipsw and macvm builders
Parallels · Aug 22, 2023 · dae43f5 · dae43f5
2 parents 65c8b7f + 4f437cc
commit dae43f5
Show file tree

Hide file tree

Showing 4 changed files with 631 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -10,22 +10,33 @@ The plugin comes with multiple builders able to create Parallels machines,
 depending on the strategy you want to use to build the image. Packer supports
 the following Parallels builders:
 
-- [parallels-iso](/docs/builders/parallels-iso.mdx) - Starts from an ISO
+- [parallels-iso](/docs/builders/iso.mdx) - Starts from an ISO
   file, creates a brand new Parallels VM, installs an OS, provisions software
   within the OS, then exports that machine to create an image. This is best
   for people who want to start from scratch.
 
-- [parallels-pvm](/docs/builders/parallels-pvm.mdx) - This builder imports
+- [parallels-pvm](/docs/builders/pvm.mdx) - This builder imports
   an existing PVM file, runs provisioners on top of that VM, and exports that
   machine to create an image. This is best if you have an existing Parallels
   VM export you want to use as the source. As an additional benefit, you can
   feed the artifact of this builder back into itself to iterate on a machine.
 
-## Requirements
+- [parallels-ipsw](/docs/builders/ipsw.mdx) - Starts from an IPSW
+  file, creates a brand new Parallels Mac OS VM, installs an OS, provisions software
+  within the OS, then exports that machine to create an image. This is best
+  for people who want to start from scratch.
+
+- [parallels-macvm](/docs/builders/macvm.mdx) - This builder imports
+  an existing Mac VM file, runs provisioners on top of that VM, and exports that
+  machine to create an image. This is best if you have an existing Parallels
+  Mac VM export you want to use as the source. As an additional benefit, you can
+  feed the artifact of this builder back into itself to iterate on a machine.
+
+## Requirements for Parallels Desktop v18 or Below
 
 In addition to [Parallels Desktop for
 Mac](https://www.parallels.com/products/desktop/) this requires the [Parallels
-Virtualization SDK](https://www.parallels.com/downloads/desktop/).
+Virtualization SDK](https://www.parallels.com/downloads/desktop/) only if you are using Parallels Desktop for Mac v18 or below.
 
 The SDK can be installed by downloading and following the instructions in the
 dmg.

diff --git a/docs/builders/index.mdx b/docs/builders/index.mdx
@@ -27,7 +27,18 @@ the following Parallels builders:
   VM export you want to use as the source. As an additional benefit, you can
   feed the artifact of this builder back into itself to iterate on a machine.
 
-## Requirements
+- [parallels-ipsw](/packer/plugins/builders/parallels/ipsw) - Starts from an IPSW
+  file, creates a brand new Parallels Mac OS VM, installs an OS, provisions software
+  within the OS, then exports that machine to create an image. This is best
+  for people who want to start from scratch.
+
+- [parallels-macvm](/packer/plugins/builders/parallels/macvm) - This builder imports
+  an existing Mac VM file, runs provisioners on top of that VM, and exports that
+  machine to create an image. This is best if you have an existing Parallels
+  Mac VM export you want to use as the source. As an additional benefit, you can
+  feed the artifact of this builder back into itself to iterate on a machine.
+
+## Requirements for Parallels Desktop v18 or Below
 
 In addition to [Parallels Desktop for
 Mac](https://www.parallels.com/products/desktop/) this requires the [Parallels