Merge pull request #73 from ovh/dev/aamstutz/pci-distant-snapshot

feat: Add cloud instance snapshots commands

Author: rbeuque74

doc/ovhcloud_cloud_instance_create.md

@@ -61,7 +61,7 @@ ovhcloud cloud instance create <region (e.g. GRA9, BHS5, SBG3)> [flags]
       --backup-cron string                                      Autobackup Unix Cron pattern (eg: '0 0 * * *')
       --backup-rotation int                                     Number of backups to keep
       --billing-period string                                   Billing period (hourly, monthly), default is hourly (default "hourly")
-      --boot-from.image string                                  Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID)
+      --boot-from.image string                                  Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID or 'ovhcloud cloud instance snapshot ls' to get the snapshots)
       --boot-from.volume string                                 Volume ID to boot from
       --bulk int                                                Number of instances to create
       --editor                                                  Use a text editor to define parameters

doc/ovhcloud_cloud_instance_snapshot.md

@@ -32,4 +32,7 @@ Manage snapshots of the given instance
 * [ovhcloud cloud instance](ovhcloud_cloud_instance.md)	 - Manage instances in the given cloud project
 * [ovhcloud cloud instance snapshot abort](ovhcloud_cloud_instance_snapshot_abort.md)	 - Abort the snapshot creation of the given instance
 * [ovhcloud cloud instance snapshot create](ovhcloud_cloud_instance_snapshot_create.md)	 - Create a snapshot of the given instance
+* [ovhcloud cloud instance snapshot delete](ovhcloud_cloud_instance_snapshot_delete.md)	 - Delete a specific instance snapshot in the current cloud project
+* [ovhcloud cloud instance snapshot get](ovhcloud_cloud_instance_snapshot_get.md)	 - Get a specific instance snapshot in the current cloud project
+* [ovhcloud cloud instance snapshot list](ovhcloud_cloud_instance_snapshot_list.md)	 - List all instance snapshots in the current cloud project
 

doc/ovhcloud_cloud_instance_snapshot_create.md

@@ -9,7 +9,9 @@ ovhcloud cloud instance snapshot create <instance_id> <snapshot_name> [flags]
 ### Options
 
 ```
-  -h, --help   help for create
+      --distant-region-name string     Name of the distant region (for cross region snapshot)
+      --distant-snapshot-name string   Name of the snapshot in the distant region (for cross region snapshot)
+  -h, --help                           help for create
 ```
 
 ### Options inherited from parent commands

doc/ovhcloud_cloud_instance_snapshot_delete.md

@@ -0,0 +1,37 @@
+## ovhcloud cloud instance snapshot delete
+
+Delete a specific instance snapshot in the current cloud project
+
+```
+ovhcloud cloud instance snapshot delete <snapshot_id> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for delete
+```
+
+### Options inherited from parent commands
+
+```
+      --cloud-project string   Cloud project ID
+  -d, --debug                  Activate debug mode (will log all HTTP requests details)
+  -f, --format string          Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
+                               Examples:
+                                 --format 'id' (to extract a single field)
+                                 --format 'nested.field.subfield' (to extract a nested field)
+                                 --format '[id, 'name']' (to extract multiple fields as an array)
+                                 --format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
+                                 --format 'name+","+type' (to extract and concatenate fields in a string)
+                                 --format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
+  -e, --ignore-errors          Ignore errors in API calls when it is not fatal to the execution
+  -i, --interactive            Interactive output
+  -j, --json                   Output in JSON
+  -y, --yaml                   Output in YAML
+```
+
+### SEE ALSO
+
+* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md)	 - Manage snapshots of the given instance
+

doc/ovhcloud_cloud_instance_snapshot_get.md

@@ -0,0 +1,37 @@
+## ovhcloud cloud instance snapshot get
+
+Get a specific instance snapshot in the current cloud project
+
+```
+ovhcloud cloud instance snapshot get <snapshot_id> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for get
+```
+
+### Options inherited from parent commands
+
+```
+      --cloud-project string   Cloud project ID
+  -d, --debug                  Activate debug mode (will log all HTTP requests details)
+  -f, --format string          Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
+                               Examples:
+                                 --format 'id' (to extract a single field)
+                                 --format 'nested.field.subfield' (to extract a nested field)
+                                 --format '[id, 'name']' (to extract multiple fields as an array)
+                                 --format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
+                                 --format 'name+","+type' (to extract and concatenate fields in a string)
+                                 --format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
+  -e, --ignore-errors          Ignore errors in API calls when it is not fatal to the execution
+  -i, --interactive            Interactive output
+  -j, --json                   Output in JSON
+  -y, --yaml                   Output in YAML
+```
+
+### SEE ALSO
+
+* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md)	 - Manage snapshots of the given instance
+

doc/ovhcloud_cloud_instance_snapshot_list.md

@@ -0,0 +1,44 @@
+## ovhcloud cloud instance snapshot list
+
+List all instance snapshots in the current cloud project
+
+```
+ovhcloud cloud instance snapshot list [flags]
+```
+
+### Options
+
+```
+      --filter stringArray   Filter results by any property using https://github.com/PaesslerAG/gval syntax
+                             Examples:
+                               --filter 'state="running"'
+                               --filter 'name=~"^my.*"'
+                               --filter 'nested.property.subproperty>10'
+                               --filter 'startDate>="2023-12-01"'
+                               --filter 'name=~"something" && nbField>10'
+  -h, --help                 help for list
+```
+
+### Options inherited from parent commands
+
+```
+      --cloud-project string   Cloud project ID
+  -d, --debug                  Activate debug mode (will log all HTTP requests details)
+  -f, --format string          Output value according to given format (expression using https://github.com/PaesslerAG/gval syntax)
+                               Examples:
+                                 --format 'id' (to extract a single field)
+                                 --format 'nested.field.subfield' (to extract a nested field)
+                                 --format '[id, 'name']' (to extract multiple fields as an array)
+                                 --format '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
+                                 --format 'name+","+type' (to extract and concatenate fields in a string)
+                                 --format '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
+  -e, --ignore-errors          Ignore errors in API calls when it is not fatal to the execution
+  -i, --interactive            Interactive output
+  -j, --json                   Output in JSON
+  -y, --yaml                   Output in YAML
+```
+
+### SEE ALSO
+
+* [ovhcloud cloud instance snapshot](ovhcloud_cloud_instance_snapshot.md)	 - Manage snapshots of the given instance
+

doc/ovhcloud_cloud_rancher_edit.md

@@ -9,6 +9,7 @@ ovhcloud cloud rancher edit <rancher_id> [flags]
 ### Options
 
 ```
+      --editor             Use a text editor to define parameters
   -h, --help               help for edit
       --iam-auth-enabled   Allow Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
       --name string        Name of the managed Rancher service

internal/cmd/cloud_instance.go

@@ -75,7 +75,7 @@ There are three ways to define the creation parameters:
 	instanceCreateCmd.Flags().StringVar(&cloud.InstanceCreationParameters.Name, "name", "", "Instance name")
 
 	// Boot options
-	instanceCreateCmd.Flags().StringVar(&cloud.InstanceCreationParameters.BootFrom.ImageID, "boot-from.image", "", "Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID)")
+	instanceCreateCmd.Flags().StringVar(&cloud.InstanceCreationParameters.BootFrom.ImageID, "boot-from.image", "", "Image ID to boot from (you can use 'ovhcloud cloud reference list-images' to get the image ID or 'ovhcloud cloud instance snapshot ls' to get the snapshots)")
 	instanceCreateCmd.Flags().StringVar(&cloud.InstanceCreationParameters.BootFrom.VolumeID, "boot-from.volume", "", "Volume ID to boot from")
 	instanceCreateCmd.MarkFlagsMutuallyExclusive("boot-from.image", "boot-from.volume")
 
@@ -367,12 +367,16 @@ There are three ways to define the installation parameters:
 	}
 	instanceCmd.AddCommand(snapshotCmd)
 
-	snapshotCmd.AddCommand(&cobra.Command{
+	snapshotCreateCmd := &cobra.Command{
 		Use:   "create <instance_id> <snapshot_name>",
 		Short: "Create a snapshot of the given instance",
 		Run:   cloud.CreateInstanceSnapshot,
 		Args:  cobra.ExactArgs(2),
-	})
+	}
+	snapshotCreateCmd.Flags().StringVar(&cloud.InstanceSnapshotSpec.DistantSnapshotName, "distant-snapshot-name", "", "Name of the snapshot in the distant region (for cross region snapshot)")
+	snapshotCreateCmd.Flags().StringVar(&cloud.InstanceSnapshotSpec.DistantRegionName, "distant-region-name", "", "Name of the distant region (for cross region snapshot)")
+	snapshotCreateCmd.MarkFlagsRequiredTogether("distant-snapshot-name", "distant-region-name")
+	snapshotCmd.AddCommand(snapshotCreateCmd)
 
 	snapshotCmd.AddCommand(&cobra.Command{
 		Use:   "abort <instance_id>",
@@ -381,5 +385,27 @@ There are three ways to define the installation parameters:
 		Args:  cobra.ExactArgs(1),
 	})
 
+	snapshotCmd.AddCommand(withFilterFlag(&cobra.Command{
+		Use:     "list",
+		Aliases: []string{"ls"},
+		Short:   "List all instance snapshots in the current cloud project",
+		Run:     cloud.ListInstanceSnapshots,
+		Args:    cobra.NoArgs,
+	}))
+
+	snapshotCmd.AddCommand(&cobra.Command{
+		Use:   "get <snapshot_id>",
+		Short: "Get a specific instance snapshot in the current cloud project",
+		Run:   cloud.GetInstanceSnapshot,
+		Args:  cobra.ExactArgs(1),
+	})
+
+	snapshotCmd.AddCommand(&cobra.Command{
+		Use:   "delete <snapshot_id>",
+		Short: "Delete a specific instance snapshot in the current cloud project",
+		Run:   cloud.DeleteInstanceSnapshot,
+		Args:  cobra.ExactArgs(1),
+	})
+
 	cloudCmd.AddCommand(instanceCmd)
 }

internal/services/cloud/cloud_instance.go

@@ -115,6 +115,12 @@ var (
 		} `json:"sshKeyCreate,omitzero"`
 		UserData string `json:"userData,omitempty"`
 	}{}
+
+	InstanceSnapshotSpec struct {
+		SnapshotName        string `json:"snapshotName,omitempty"`
+		DistantSnapshotName string `json:"distantSnapshotName,omitempty"`
+		DistantRegionName   string `json:"distantRegionName,omitempty"`
+	}
 )
 
 func ListInstances(_ *cobra.Command, _ []string) {
@@ -807,19 +813,25 @@ func CreateInstanceSnapshot(_ *cobra.Command, args []string) {
 		return
 	}
 
-	body := map[string]any{
-		"snapshotName": args[1],
+	// Fetch instance details to get its region
+	endpoint := fmt.Sprintf("/cloud/project/%s/instance/%s", projectID, url.PathEscape(args[0]))
+	var instance map[string]any
+	if err := httpLib.Client.Get(endpoint, &instance); err != nil {
+		display.OutputError(&flags.OutputFormatConfig, "failed to fetch instance details: %s", err)
+		return
 	}
+	region := instance["region"].(string)
 
-	endpoint := fmt.Sprintf("/cloud/project/%s/instance/%s/snapshot", projectID, url.PathEscape(args[0]))
+	InstanceSnapshotSpec.SnapshotName = args[1]
 
+	endpoint = fmt.Sprintf("/cloud/project/%s/region/%s/instance/%s/snapshot", projectID, url.PathEscape(region), url.PathEscape(args[0]))
 	var response map[string]any
-	if err := httpLib.Client.Post(endpoint, body, &response); err != nil {
+	if err := httpLib.Client.Post(endpoint, InstanceSnapshotSpec, &response); err != nil {
 		display.OutputError(&flags.OutputFormatConfig, "error creating snapshot for instance %q: %s", args[0], err)
 		return
 	}
 
-	display.OutputInfo(&flags.OutputFormatConfig, response, "✅ Snapshot created successfully with ID: %s", response["snapshotId"])
+	display.OutputInfo(&flags.OutputFormatConfig, response, "✅ Snapshot created successfully with ID: %s", response["imageId"])
 }
 
 func AbortInstanceSnapshot(_ *cobra.Command, args []string) {
@@ -847,3 +859,40 @@ func AbortInstanceSnapshot(_ *cobra.Command, args []string) {
 
 	display.OutputInfo(&flags.OutputFormatConfig, nil, "✅ Snapshot aborted successfully")
 }
+
+func ListInstanceSnapshots(_ *cobra.Command, _ []string) {
+	projectID, err := getConfiguredCloudProject()
+	if err != nil {
+		display.OutputError(&flags.OutputFormatConfig, "%s", err)
+		return
+	}
+
+	common.ManageListRequestNoExpand(fmt.Sprintf("/cloud/project/%s/snapshot", projectID), []string{"id", "name", "type", "status", "region"}, flags.GenericFilters)
+}
+
+func GetInstanceSnapshot(_ *cobra.Command, args []string) {
+	projectID, err := getConfiguredCloudProject()
+	if err != nil {
+		display.OutputError(&flags.OutputFormatConfig, "%s", err)
+		return
+	}
+
+	common.ManageObjectRequest(fmt.Sprintf("/cloud/project/%s/snapshot", projectID), args[0], "")
+}
+
+func DeleteInstanceSnapshot(_ *cobra.Command, args []string) {
+	projectID, err := getConfiguredCloudProject()
+	if err != nil {
+		display.OutputError(&flags.OutputFormatConfig, "%s", err)
+		return
+	}
+
+	endpoint := fmt.Sprintf("/cloud/project/%s/snapshot/%s", projectID, url.PathEscape(args[0]))
+
+	if err := httpLib.Client.Delete(endpoint, nil); err != nil {
+		display.OutputError(&flags.OutputFormatConfig, "error deleting snapshot %q: %s", args[0], err)
+		return
+	}
+
+	display.OutputInfo(&flags.OutputFormatConfig, nil, "✅ Snapshot successfully deleted")
+}