Add support for Metadata-related fields (#330)

linode · Jul 11, 2023 · 6055d53 · 6055d53
1 parent 5ab3942
commit 6055d53
Show file tree

Hide file tree

Showing 16 changed files with 99,229 additions and 1,794 deletions.
diff --git a/go.work.sum b/go.work.sum
@@ -90,6 +90,7 @@ github.com/linode/linodego v0.20.1 h1:Kw5Qes0E0wlKVx5EbITI+F/ambO6G+PQyK0Yi7i4Ey
 github.com/linode/linodego v0.20.1/go.mod h1:XOWXRHjqeU2uPS84tKLgfWIfTlv3TYzCS0io4GOQzEI=
 github.com/mailru/easyjson v0.0.0-20160728113105-d5b7844b561a/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e h1:hB2xlXdHp/pmPZq0y3QnmWAArdw9PqbmotexnWx/FU8=
+github.com/maxatome/go-testdeep v1.11.0/go.mod h1:011SgQ6efzZYAen6fDn4BqQ+lUR72ysdyKe7Dyogw70=
 github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
 github.com/moby/spdystream v0.2.0 h1:cjW1zVyyoiM0T7b6UoySUFqzXMoqRckQtXwGPiBhOM8=
 github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
@@ -133,12 +134,8 @@ golang.org/x/sys v0.0.0-20191022100944-742c48ecaeb7/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
-golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.10.0 h1:3R7pNqamzBraeqj/Tj8qt1aQ2HpmlC+Cx/qL/7hn4/c=
-golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o=
 golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/tools v0.0.0-20181011042414-1f849cf54d09/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20181030221726-6c7e314b6563/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

diff --git a/images.go b/images.go
@@ -24,25 +24,27 @@ const (
 
 // Image represents a deployable Image object for use with Linode Instances
 type Image struct {
-	ID          string      `json:"id"`
-	CreatedBy   string      `json:"created_by"`
-	Label       string      `json:"label"`
-	Description string      `json:"description"`
-	Type        string      `json:"type"`
-	Vendor      string      `json:"vendor"`
-	Status      ImageStatus `json:"status"`
-	Size        int         `json:"size"`
-	IsPublic    bool        `json:"is_public"`
-	Deprecated  bool        `json:"deprecated"`
-	Created     *time.Time  `json:"-"`
-	Expiry      *time.Time  `json:"-"`
+	ID           string      `json:"id"`
+	CreatedBy    string      `json:"created_by"`
+	Capabilities []string    `json:"capabilities"`
+	Label        string      `json:"label"`
+	Description  string      `json:"description"`
+	Type         string      `json:"type"`
+	Vendor       string      `json:"vendor"`
+	Status       ImageStatus `json:"status"`
+	Size         int         `json:"size"`
+	IsPublic     bool        `json:"is_public"`
+	Deprecated   bool        `json:"deprecated"`
+	Created      *time.Time  `json:"-"`
+	Expiry       *time.Time  `json:"-"`
 }
 
 // ImageCreateOptions fields are those accepted by CreateImage
 type ImageCreateOptions struct {
 	DiskID      int    `json:"disk_id"`
 	Label       string `json:"label"`
 	Description string `json:"description,omitempty"`
+	CloudInit   bool   `json:"cloud_init,omitempty"`
 }
 
 // ImageUpdateOptions fields are those accepted by UpdateImage
@@ -62,13 +64,15 @@ type ImageCreateUploadOptions struct {
 	Region      string `json:"region"`
 	Label       string `json:"label"`
 	Description string `json:"description,omitempty"`
+	CloudInit   bool   `json:"cloud_init,omitempty"`
 }
 
 // ImageUploadOptions fields are those accepted by UploadImage
 type ImageUploadOptions struct {
 	Region      string `json:"region"`
 	Label       string `json:"label"`
 	Description string `json:"description,omitempty"`
+	CloudInit   bool   `json:"cloud_init"`
 	Image       io.Reader
 }
 
@@ -229,6 +233,7 @@ func (c *Client) UploadImage(ctx context.Context, opts ImageUploadOptions) (*Ima
 		Label:       opts.Label,
 		Region:      opts.Region,
 		Description: opts.Description,
+		CloudInit:   opts.CloudInit,
 	})
 	if err != nil {
 		return nil, err

diff --git a/instances.go b/instances.go
@@ -50,6 +50,7 @@ type Instance struct {
 	Label           string          `json:"label"`
 	Type            string          `json:"type"`
 	Status          InstanceStatus  `json:"status"`
+	HasUserData     bool            `json:"has_user_data"`
 	Hypervisor      string          `json:"hypervisor"`
 	HostUUID        string          `json:"host_uuid"`
 	Specs           *InstanceSpec   `json:"specs"`
@@ -96,6 +97,13 @@ type InstanceTransfer struct {
 	Quota int `json:"quota"`
 }
 
+// InstanceMetadataOptions specifies various Instance creation fields
+// that relate to the Linode Metadata service.
+type InstanceMetadataOptions struct {
+	// UserData expects a Base64-encoded string
+	UserData string `json:"user_data,omitempty"`
+}
+
 // InstanceCreateOptions require only Region and Type
 type InstanceCreateOptions struct {
 	Region          string                    `json:"region"`
@@ -113,6 +121,7 @@ type InstanceCreateOptions struct {
 	BackupsEnabled  bool                      `json:"backups_enabled,omitempty"`
 	PrivateIP       bool                      `json:"private_ip,omitempty"`
 	Tags            []string                  `json:"tags,omitempty"`
+	Metadata        *InstanceMetadataOptions  `json:"metadata,omitempty"`
 
 	// Creation fields that need to be set explicitly false, "", or 0 use pointers
 	SwapSize *int  `json:"swap_size,omitempty"`
@@ -169,13 +178,14 @@ type InstanceCloneOptions struct {
 	Type   string `json:"type,omitempty"`
 
 	// LinodeID is an optional existing instance to use as the target of the clone
-	LinodeID       int    `json:"linode_id,omitempty"`
-	Label          string `json:"label,omitempty"`
-	Group          string `json:"group,omitempty"`
-	BackupsEnabled bool   `json:"backups_enabled"`
-	Disks          []int  `json:"disks,omitempty"`
-	Configs        []int  `json:"configs,omitempty"`
-	PrivateIP      bool   `json:"private_ip,omitempty"`
+	LinodeID       int                      `json:"linode_id,omitempty"`
+	Label          string                   `json:"label,omitempty"`
+	Group          string                   `json:"group,omitempty"`
+	BackupsEnabled bool                     `json:"backups_enabled"`
+	Disks          []int                    `json:"disks,omitempty"`
+	Configs        []int                    `json:"configs,omitempty"`
+	PrivateIP      bool                     `json:"private_ip,omitempty"`
+	Metadata       *InstanceMetadataOptions `json:"metadata,omitempty"`
 }
 
 // InstanceResizeOptions is an options struct used when resizing an instance
@@ -337,13 +347,14 @@ func (c *Client) RebootInstance(ctx context.Context, linodeID int, configID int)
 
 // InstanceRebuildOptions is a struct representing the options to send to the rebuild linode endpoint
 type InstanceRebuildOptions struct {
-	Image           string            `json:"image,omitempty"`
-	RootPass        string            `json:"root_pass,omitempty"`
-	AuthorizedKeys  []string          `json:"authorized_keys,omitempty"`
-	AuthorizedUsers []string          `json:"authorized_users,omitempty"`
-	StackScriptID   int               `json:"stackscript_id,omitempty"`
-	StackScriptData map[string]string `json:"stackscript_data,omitempty"`
-	Booted          *bool             `json:"booted,omitempty"`
+	Image           string                   `json:"image,omitempty"`
+	RootPass        string                   `json:"root_pass,omitempty"`
+	AuthorizedKeys  []string                 `json:"authorized_keys,omitempty"`
+	AuthorizedUsers []string                 `json:"authorized_users,omitempty"`
+	StackScriptID   int                      `json:"stackscript_id,omitempty"`
+	StackScriptData map[string]string        `json:"stackscript_data,omitempty"`
+	Booted          *bool                    `json:"booted,omitempty"`
+	Metadata        *InstanceMetadataOptions `json:"metadata,omitempty"`
 }
 
 // RebuildInstance Deletes all Disks and Configs on this Linode,