Add tag for specifying reboot behavior on an instance by instance basis

Author: jonstacks

pkg/backup/manager.go

@@ -14,16 +14,18 @@ import (
 
 // ManagerOpts are options to configure the backup manager
 type ManagerOpts struct {
-	Client *ec2.EC2
+	client *ec2.EC2
 
-	BackupTagKey   string
-	BackupTagValue string
-	ImageTagKey    string
-	ImageTagValue  string
-	ImageNameTag   string
+	BackupTagKey     string
+	BackupTagValue   string
+	ImageTagKey      string
+	ImageTagValue    string
+	ImageNameTag     string
+	RebootOnImageTag string
 
 	DefaultImageNameTemplate *template.Template
 	DefaultMaxKeepImages     int
+	DefaultRebootOnImage     bool
 
 	Verbose bool
 }
@@ -33,13 +35,16 @@ type ManagerOpts struct {
 func NewManagerOptsFromConfig(client *ec2.EC2) (*ManagerOpts, error) {
 	var err error
 	opts := &ManagerOpts{
-		Client:         client,
-		BackupTagKey:   config.BackupTagKey(),
-		BackupTagValue: config.BackupTagValue(),
-		ImageTagKey:    config.ImageTagKey(),
-		ImageTagValue:  config.ImageTagValue(),
-		ImageNameTag:   config.ImageNameTag(),
-		Verbose:        true,
+		client:           client,
+		BackupTagKey:     config.BackupTagKey(),
+		BackupTagValue:   config.BackupTagValue(),
+		ImageTagKey:      config.ImageTagKey(),
+		ImageTagValue:    config.ImageTagValue(),
+		ImageNameTag:     config.ImageNameTag(),
+		RebootOnImageTag: config.RebootOnImageTag(),
+		Verbose:          true,
+
+		DefaultRebootOnImage: config.DefaultRebootOnImage(),
 	}
 
 	opts.DefaultImageNameTemplate, err = template.New("default-image-name").Parse(config.DefaultImageNameFormat())
@@ -53,22 +58,10 @@ func NewManagerOptsFromConfig(client *ec2.EC2) (*ManagerOpts, error) {
 
 // Manager manages backups/images of ec2 resources(volumes, instances, etc.)
 type Manager struct {
-	client *ec2.EC2
+	*ManagerOpts
 
 	volumes   []*ec2.Volume
 	instances []*ec2.Instance
-
-	BackupTagKey     string
-	BackupTagValue   string
-	ImageTagKey      string
-	ImageTagValue    string
-	ImageNameTag     string
-	MaxKeepImagesTag string
-
-	DefaultImageNameTemplate *template.Template
-	DefaultMaxKeepImages     int
-
-	Verbose bool
 }
 
 // NewManager creates a new backup manager from the provided options
@@ -77,19 +70,12 @@ func NewManager(opts *ManagerOpts) (*Manager, error) {
 		volumes:   make([]*ec2.Volume, 0),
 		instances: make([]*ec2.Instance, 0),
 	}
-	m.client = opts.Client
-	m.BackupTagKey = opts.BackupTagKey
-	m.BackupTagValue = opts.BackupTagValue
-	m.ImageTagKey = opts.ImageTagKey
-	m.ImageTagValue = opts.ImageTagValue
-	m.ImageNameTag = opts.ImageNameTag
-	m.Verbose = opts.Verbose
+
 	if opts.DefaultImageNameTemplate == nil {
 		return nil, fmt.Errorf("DefaultImageNameTemplate is a required field for ManagerOpts")
 	}
 
-	m.DefaultImageNameTemplate = opts.DefaultImageNameTemplate
-	m.DefaultMaxKeepImages = opts.DefaultMaxKeepImages
+	m.ManagerOpts = opts
 	return m, nil
 }
 
@@ -217,6 +203,7 @@ func (m *Manager) backupInstances() error {
 			image, err := m.client.CreateImage(&ec2.CreateImageInput{
 				InstanceId: i.InstanceId,
 				Name:       aws.String(imageName),
+				NoReboot:   aws.Bool(!m.instanceRebootParam(i)),
 			})
 			if err != nil {
 				m.logf(
@@ -300,6 +287,19 @@ func (m *Manager) formatImageName(i *ec2.Instance) (string, error) {
 	return buf.String(), err
 }
 
+func (m *Manager) instanceRebootParam(i *ec2.Instance) bool {
+	tags := utils.TagSliceToMap(i.Tags)
+	if rebootVal, ok := tags.Get(m.RebootOnImageTag); ok {
+		for _, v := range []string{"true", "True", "TRUE"} {
+			if rebootVal == v {
+				return true
+			}
+		}
+		return false
+	}
+	return m.DefaultRebootOnImage
+}
+
 func (m *Manager) log(v ...interface{}) {
 	if m.Verbose {
 		fmt.Println(v...)

pkg/config/config.go

@@ -17,6 +17,20 @@ func envDefaultInt(key, defaultValue string) (int, error) {
 	return strconv.Atoi(envDefault(key, defaultValue))
 }
 
+func envDefaultBool(key string, defaultValue bool) bool {
+	value := os.Getenv(key)
+	if value == "" {
+		return defaultValue
+	}
+
+	for _, v := range []string{"true", "True", "TRUE"} {
+		if value == v {
+			return true
+		}
+	}
+	return false
+}
+
 // BackupTagKey is the volume tag key to look for when determing if we should
 // perform a backup or not.
 func BackupTagKey() string {
@@ -61,8 +75,22 @@ func MaxKeepImagesTag() string {
 	return envDefault("MAX_KEEP_IMAGES_TAG", "lambda-ebs-backup/max-keep-images")
 }
 
-// MaxKeepImagesDefault is the default number of images to keep if not specified
+// DefaultMaxKeepImages is the default number of images to keep if not specified
 // on the instance via the MaxKeepImagesTag
 func DefaultMaxKeepImages() (int, error) {
 	return envDefaultInt("DEFAULT_MAX_KEEP_IMAGES", "2")
 }
+
+// RebootOnImageTag returns the name of the EC2 tag to look at to see if the
+// instance should be rebooted or not when an image is made. If not supplied,
+// the value will default to that of "DEFAULT_REBOOT_ON_IMAGE"
+func RebootOnImageTag() string {
+	return envDefault("REBOOT_ON_IMAGE_TAG", "lambda-ebs-backup/reboot-on-image")
+}
+
+// DefaultRebootOnImage determines the default behavior for rebooting when we
+// take an image of an ec2 instance. If not specified, it defaults to true as
+// this is the aws CreateImage default.
+func DefaultRebootOnImage() bool {
+	return envDefaultBool("DEFAULT_REBOOT_ON_IMAGE", true)
+}