Allow to configure --concurrency for pulling (#111)

* Allow to configure `--concurrency` for pulling * fixed docs
cirruslabs · Feb 7, 2024 · 1ac6c3e · 1ac6c3e
1 parent fcb9346
commit 1ac6c3e
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 6 deletions.
diff --git a/.web-docs/components/builder/tart/README.md b/.web-docs/components/builder/tart/README.md
@@ -30,6 +30,7 @@ Below we'll go through available options of this Packer plugin.
 ### Optional Configuration
 
 - `allow_insecure` (boolean) — When cloning the image, connect to the OCI registry via an insecure HTTP protocol.
+- `pull_concurrency` (boolean) — Amount of layers to pull concurrently from an OCI registry when pulling the image. Default is 4 for Tart 2.0.0+.
 - `cpu_count` (number) - Amount of virtual CPUs to use for the new VM. Overrides `tart create` default value when using `from_ipsw` and `from_iso` and VM settings when using `vm_base_name`.
 - `create_grace_time` (duration string | ex: "1h5m2s") — Time to wait after finishing the installation process. Can be used to work around the issue when Virtualization.Framework's installation process is still running in the background for some time after `tart create` had already finished.
 - `disk_size_gb` — Disk size in GB to use for the new VM. Overrides `tart create` default value when using `from_ipsw` and `from_iso` and VM settings when using `vm_base_name`.

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Packer Plugin Tart
 
 The `Tart` multi-component plugin can be used with HashiCorp [Packer](https://www.packer.io)
-to create custom macOS images. For the full list of available features for this plugin see [docs](https://developer.hashicorp.com/packer/plugins/builders/tart).
+to create custom macOS images. For the full list of available features for this plugin see [docs](https://developer.hashicorp.com/packer/integrations/cirruslabs/tart/latest/components/builder/tart).
 
 ## Installation
 

diff --git a/builder/tart/builder.go b/builder/tart/builder.go
@@ -26,11 +26,12 @@ type Config struct {
 	commonsteps.HTTPConfig `mapstructure:",squash"`
 	CommunicatorConfig     communicator.Config `mapstructure:",squash"`
 
-	FromIPSW      string   `mapstructure:"from_ipsw"`
-	FromISO       []string `mapstructure:"from_iso"`
-	VMBaseName    string   `mapstructure:"vm_base_name"`
-	VMName        string   `mapstructure:"vm_name"`
-	AllowInsecure bool     `mapstructure:"allow_insecure"`
+	FromIPSW        string   `mapstructure:"from_ipsw"`
+	FromISO         []string `mapstructure:"from_iso"`
+	VMBaseName      string   `mapstructure:"vm_base_name"`
+	VMName          string   `mapstructure:"vm_name"`
+	AllowInsecure   bool     `mapstructure:"allow_insecure"`
+	PullConcurrency uint16   `mapstructure:"pull_concurrency"`
 
 	CpuCount        uint8         `mapstructure:"cpu_count"`
 	CreateGraceTime time.Duration `mapstructure:"create_grace_time"`

diff --git a/builder/tart/builder.hcl2spec.go b/builder/tart/builder.hcl2spec.go
diff --git a/builder/tart/step_clone_vm.go b/builder/tart/step_clone_vm.go
@@ -22,6 +22,10 @@ func (s *stepCloneVM) Run(ctx context.Context, state multistep.StateBag) multist
 		cmdArgs = append(cmdArgs, "--insecure")
 	}
 
+	if config.PullConcurrency > 0 {
+		cmdArgs = append(cmdArgs, "--concurrency", fmt.Sprintf("%d", config.PullConcurrency))
+	}
+
 	if _, err := TartExec(ctx, cmdArgs...); err != nil {
 		err := fmt.Errorf("Error cloning VM: %s", err)
 		state.Put("error", err)

diff --git a/docs/builders/tart.mdx b/docs/builders/tart.mdx
@@ -39,6 +39,7 @@ Below we'll go through available options of this Packer plugin.
 ### Optional Configuration
 
 - `allow_insecure` (boolean) — When cloning the image, connect to the OCI registry via an insecure HTTP protocol.
+- `pull_concurrency` (boolean) — Amount of layers to pull concurrently from an OCI registry when pulling the image. Default is 4 for Tart 2.0.0+.
 - `cpu_count` (number) - Amount of virtual CPUs to use for the new VM. Overrides `tart create` default value when using `from_ipsw` and `from_iso` and VM settings when using `vm_base_name`.
 - `create_grace_time` (duration string | ex: "1h5m2s") — Time to wait after finishing the installation process. Can be used to work around the issue when Virtualization.Framework's installation process is still running in the background for some time after `tart create` had already finished.
 - `disk_size_gb` — Disk size in GB to use for the new VM. Overrides `tart create` default value when using `from_ipsw` and `from_iso` and VM settings when using `vm_base_name`.