improvements

Author: thomas-tacquet

jobs/instances-snapshot-cleaner/README.md

@@ -72,7 +72,8 @@ You can exercice by adding the following features:
 
 - Add tags to exclude
 - Add alerts if a Job goes in error
-- Use secret manager
+- Use Secret Manager instead of job environment variables
+- Support multiple zones dans projects
 
 # Additional content
 

jobs/instances-snapshot-cleaner/go.mod

@@ -2,6 +2,6 @@ module github.com/scaleway/serverless-examples/jobs/instances-snapshot
 
 go 1.23
 
-require github.com/scaleway/scaleway-sdk-go v1.0.0-beta.31
+require github.com/scaleway/scaleway-sdk-go v1.0.0-beta.32
 
 require gopkg.in/yaml.v2 v2.4.0 // indirect

jobs/instances-snapshot-cleaner/go.sum

@@ -1,9 +1,7 @@
 github.com/dnaeon/go-vcr v1.2.0 h1:zHCHvJYTMh1N7xnV7zf1m1GPBF9Ad0Jk/whtQ1663qI=
 github.com/dnaeon/go-vcr v1.2.0/go.mod h1:R4UdLID7HZT3taECzJs4YgbbH6PIGXB6W/sc5OLb6RQ=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30 h1:yoKAVkEVwAqbGbR8n87rHQ1dulL25rKloGadb3vm770=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30/go.mod h1:sH0u6fq6x4R5M7WxkoQFY/o7UaiItec0o1LinLCJNq8=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.31 h1:Fj7jPyu9TQjqfXcLylINK5PANSzOWXIX4QtGmfp67AY=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.31/go.mod h1:kzh+BSAvpoyHHdHBCDhmSWtBc1NbLMZ2lWHqnBoxFks=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.32 h1:4+LP7qmsLSGbmc66m1s5dKRMBwztRppfxFKlYqYte/c=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.32/go.mod h1:kzh+BSAvpoyHHdHBCDhmSWtBc1NbLMZ2lWHqnBoxFks=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=

jobs/instances-snapshot-cleaner/main.go

@@ -81,7 +81,10 @@ func main() {
 	}
 }
 
+// cleanSnapshots when called will clean snapshots in the project (if specified)
+// that are older than the number of days.
 func cleanSnapshots(days int, instanceAPI *instance.API) error {
+	// Get the list of all snapshots
 	snapshotsList, err := instanceAPI.ListSnapshots(&instance.ListSnapshotsRequest{
 		Zone:    scw.Zone(os.Getenv(envZone)),
 		Project: scw.StringPtr(os.Getenv(envProjectID)),
@@ -95,10 +98,13 @@ func cleanSnapshots(days int, instanceAPI *instance.API) error {
 
 	currentTime := time.Now()
 
+	// For each snapshot, check conditions
 	for _, snapshot := range snapshotsList.Snapshots {
+		// Check if snapshot is in ready state and if it's older than the number of days definied.
 		if snapshot.State == instance.SnapshotStateAvailable && (currentTime.Sub(*snapshot.CreationDate).Hours()/hoursPerDay) > float64(days) {
 			fmt.Printf("\nDeleting snapshot <%s>:%s created at: %s\n", snapshot.ID, snapshot.Name, snapshot.CreationDate.Format(time.RFC3339))
 
+			// Delete snapshot found.
 			err := instanceAPI.DeleteSnapshot(&instance.DeleteSnapshotRequest{
 				SnapshotID: snapshot.ID,
 				Zone:       snapshot.Zone,
@@ -112,6 +118,7 @@ func cleanSnapshots(days int, instanceAPI *instance.API) error {
 	return nil
 }
 
+// Check for mandatory variables before starting to work.
 func init() {
 	mandatoryVariables := [...]string{envOrgID, envAccessKey, envSecretKey, envZone, envProjectID}