Added support for Private Image Sharing (#391)

Author: ezilber-akamai

.web-docs/components/builder/linode/README.md

@@ -127,6 +127,9 @@ can also be supplied to override the typical auto-generated key:
 
 - `image_regions` ([]string) - The regions where the outcome image will be replicated to.
 
+- `image_share_group_ids` ([]int) - Image Share Group IDs to add the newly created private image to
+  immediately after image creation.
+
 - `interface_generation` (string) - Specifies the interface type for the Linode. The value can be either
   `legacy_config` or `linode`. The default value is determined by the
   `interfaces_for_new_linodes` setting in the account settings.
@@ -426,6 +429,7 @@ source "linode" "example" {
   image             = "linode/debian11"
   image_description = "My Private Image"
   image_label       = "private-image-${local.timestamp}"
+  image_share_group_ids = [12345]
   instance_label    = "temporary-linode-${local.timestamp}"
   instance_type     = "g6-nanode-1"
   linode_token      = "YOUR API TOKEN"
@@ -453,6 +457,7 @@ build {
         "instance_label": "temporary-linode-{{timestamp}}",
         "image_label": "private-image-{{timestamp}}",
         "image_description": "My Private Image",
+        "image_share_group_ids": [12345],
         "ssh_username": "root"
       }
     }

builder/linode/builder_test.go

@@ -696,3 +696,34 @@ func TestBuilderPrepare_MetadataTagsFirewallID(t *testing.T) {
 		t.Errorf("got %v, expected %v", b.config.Tags, expectedTags)
 	}
 }
+
+func TestBuilderPrepare_ImageShareGroupIDs(t *testing.T) {
+	var b Builder
+	config := testConfig()
+
+	delete(config, "image_share_group_ids")
+	_, warnings, err := b.Prepare(config)
+	if len(warnings) > 0 {
+		t.Fatalf("bad: %#v", warnings)
+	}
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if len(b.config.ImageShareGroupIDs) != 0 {
+		t.Errorf("expected nil or empty, got %v", b.config.ImageShareGroupIDs)
+	}
+
+	expected := []int{101, 202, 303}
+	config["image_share_group_ids"] = expected
+	b = Builder{}
+	_, warnings, err = b.Prepare(config)
+	if len(warnings) > 0 {
+		t.Fatalf("bad: %#v", warnings)
+	}
+	if err != nil {
+		t.Fatalf("should not have error: %s", err)
+	}
+	if !reflect.DeepEqual(b.config.ImageShareGroupIDs, expected) {
+		t.Errorf("got %v, expected %v", b.config.ImageShareGroupIDs, expected)
+	}
+}

builder/linode/config.go

@@ -159,6 +159,10 @@ type Config struct {
 	// The regions where the outcome image will be replicated to.
 	ImageRegions []string `mapstructure:"image_regions" required:"false"`
 
+	// Image Share Group IDs to add the newly created private image to
+	// immediately after image creation.
+	ImageShareGroupIDs []int `mapstructure:"image_share_group_ids" required:"false"`
+
 	// Specifies the interface type for the Linode. The value can be either
 	// `legacy_config` or `linode`. The default value is determined by the
 	// `interfaces_for_new_linodes` setting in the account settings.

builder/linode/config.hcl2spec.go

@@ -2,6 +2,7 @@ package linode
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/hashicorp/packer-plugin-sdk/multistep"
 	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
@@ -45,6 +46,39 @@ func (s *stepCreateImage) Run(ctx context.Context, state multistep.StateBag) mul
 		return handleError("Failed to wait for image creation", err)
 	}
 
+	// Add the image to Image Share Groups, if configured
+	if len(c.ImageShareGroupIDs) > 0 {
+		for _, shareGroupID := range c.ImageShareGroupIDs {
+			ui.Say(fmt.Sprintf(
+				"Adding image %s to image share group %d...",
+				image.ID,
+				shareGroupID,
+			))
+
+			_, err := s.client.ImageShareGroupAddImages(
+				ctx,
+				shareGroupID,
+				linodego.ImageShareGroupAddImagesOptions{
+					Images: []linodego.ImageShareGroupImage{
+						{
+							ID: image.ID,
+						},
+					},
+				},
+			)
+			if err != nil {
+				return handleError(
+					fmt.Sprintf(
+						"Failed to add image %s to image share group %d",
+						image.ID,
+						shareGroupID,
+					),
+					err,
+				)
+			}
+		}
+	}
+
 	if len(c.ImageRegions) > 0 {
 		image, err = s.client.ReplicateImage(ctx, image.ID, linodego.ImageReplicateOptions{
 			Regions: c.ImageRegions,

builder/linode/step_create_image.go

@@ -186,6 +186,7 @@ source "linode" "example" {
   image             = "linode/debian11"
   image_description = "My Private Image"
   image_label       = "private-image-${local.timestamp}"
+  image_share_group_ids = [12345]
   instance_label    = "temporary-linode-${local.timestamp}"
   instance_type     = "g6-nanode-1"
   linode_token      = "YOUR API TOKEN"
@@ -213,6 +214,7 @@ build {
         "instance_label": "temporary-linode-{{timestamp}}",
         "image_label": "private-image-{{timestamp}}",
         "image_description": "My Private Image",
+        "image_share_group_ids": [12345],
         "ssh_username": "root"
       }
     }