Janitor Settings
With these properties you can control how janitor monkey operates.
By default Janitor Monkey wakes up every hour and runs only between 11am and 12pm. The properties below override the values set in simianarmy.properties.
simianarmy.scheduler.frequency = 1
simianarmy.scheduler.frequencyUnit = HOURS
simianarmy.scheduler.threads = 1
simianarmy.calendar.openHour = 11
simianarmy.calendar.closeHour = 11
simianarmy.calendar.timezone = America/Los_Angeles
####simianarmy.calendar.isMonkeyTime To ease debug/dryrun, you can set this property to true so the monkey will always be able to run. This property also overrides the value in simianarmy.properties. If set to false, normal MonkeyCalendar logic is executed to determine when the monkey should run. The default value is false.
simianarmy.calendar.isMonkeyTime = false
This property allows the Janitor Monkey to run. The default is "true". Note that an enabled Janitor Monkey does not mean it is also allowed to clean up resources. It must also have the leashed property set to "false".
simianarmy.janitor.enabled = true
This is effectively a "dryrun" option. If leashed is "true" then it will look for unused resources, but it will not be able to terminate clean up any resources. The default value is "true".
simianarmy.janitor.leashed = true
This property specifies the SimpleDB domain for storing the resources managed by the Janitor Monkey. The default is SIMIAN_ARMY.
simianarmy.janitor.resources.sdb.domain = SIMIAN_ARMY
This property specifies the source email address that is used to send notifications about resource cleanup. Its value needs to be a valid email address. If it is not set or is not a valid email address, no notification will be sent and no cleanup will be done.
simianarmy.janitor.notification.sourceEmail = foo@bar.com
This property specifies the email address to receive the summary email of Janitor Monkey after each run. If it is not set or is invalid, no summary email about the Janitor Monkey run will be sent.
simianarmy.janitor.summaryEmail.to = foo@bar.com
This property specifies the email address to receive notification about cleanup when Janitor Monkey is not able to find the owner email of the resource it wants to clean up. When the value is not set or is not a valid email address, no notification will be sent and no cleanup will be done for the resource. When you first run Janitor Monkey, it is likely that you don't have owner emails set for your cloud resources. If you still want Janitor Monkey to be able to clean up resources, you can set this property to your team's email list so that your team members are able to receive Janitor Monkey notifications.
simianarmy.janitor.notification.defaultEmail = foo@bar.com
This property specifies the number of business days that a notification is sent before the expected termination time. For example, if a resource is scheduled to be cleaned up by Janitor Monkey on 12/13/2012, Thursday and the property is set to 2, the owner will receive notification about the cleanup on 12/11/2012, Tuesday, which is 2 business days before the termination date. If you want Janitor Monkey to clean up any unused resources without wait, you can set the value to 0. The reason to wait for a few days before a resource is cleaned up is because the resource owner may want to keep the resource longer even it is not needed for now. The owner can use our REST API to flag the resource as 'not to clean' by Janitor Monkey during this period. The default value of this property is 2.
Details of flagging a resource as not being managed by Janitor Monkey (opt out) or bring a resource back to be managed by Janitor Monkey (opt in) can be found at Janitor REST API
simianarmy.janitor.notification.daysBeforeTermination = 2
This property specifies the resource types that Janitor Monkey manages. Currently Janitor Monkey can clean up instances, auto scaling groups, EBS volumes, EBS snapshots, launch configurations, and images. By default all these resource types are enabled for Janitor Monkey to manage.
simianarmy.janitor.enabledResources = Instance, ASG, EBS_Volume, EBS_Snapshot, Launch_Config, Image
The properties below are used to configure the rule used to clean up orphaned instances that are not in any auto scaling group.
This property specifies whether Janitor monkey will clean up orphaned instances. If you do not want to clean up orphaned instances, you can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.orphanedInstanceRule.enabled = true
An orphaned instance is marked as cleanup candidate if it has launched for more than the number of days specified in this property. The default value is 2, which means orphaned instance is marked as cleanup candidate and scheduled to be terminated if it has launched for more than 2 days.
simianarmy.janitor.rule.orphanedInstanceRule.instanceAgeThreshold = 2
This property specifies the number of business days the instance is retained after a notification is sent about the termination when the instance has an owner. The default value is 3.
simianarmy.janitor.rule.orphanedInstanceRule.retentionDaysWithOwner = 3
This property specifies the number of business days the instance is retained after a notification is sent about the termination when the instance does not have an owner. The default value is 8.
simianarmy.janitor.rule.orphanedInstanceRule.retentionDaysWithoutOwner = 8
The properties below are used to configure the rule used for cleaning up volumes that have been detached from instances for certain days. Since AWS does not provide a way to track when an EBS volume is detached, we provide a companion monkey called Volume Tagging Monkey for tracking this information. You can modify volumeTagging.properties file to enable it. Details can be found at Configure Volume Tagging Monkey.
This property specifies whether Janitor monkey will clean up detached volumes. If you do not want to clean up detached volumes, you can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.oldDetachedVolumeRule.enabled = true
A volume is considered a cleanup candidate after being detached for the number of days specified in this property. The default value is 30.
simianarmy.janitor.rule.oldDetachedVolumeRule.detachDaysThreshold = 30
This property specifies the number of business days the volume is retained after a notification is sent about the termination. The default value is 7.
simianarmy.janitor.rule.oldDetachedVolumeRule.retentionDays = 7
The properties below are used to configure the rule used for cleaning up snapshots that have no existing images generated from them and launched for certain days.
This property specifies whether Janitor monkey will clean up unreferenced snapshots. You can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.noGeneratedAMIRule.enabled = true
A unreferenced snapshot is considered a cleanup candidate after launching for the number of days specified in this property. The default value is 30.
simianarmy.janitor.rule.noGeneratedAMIRule.ageThreshold = 30
This property specifies the number of business days the snapshot is retained after a notification is sent about the termination. The default value is 7.
simianarmy.janitor.rule.noGeneratedAMIRule.retentionDays = 7
This property specifies an override owner email when cleaning EBS Snapshots with this rule. This will enable notification emails to be sent to a different email target rather than the resource owner. This could be useful for organizations that create a lot of snapshots as part of their build process and notifying owners is unnecessary.
The default value for this property is null meaning the resource owner will be notified and not the override value.
simianarmy.janitor.rule.noGeneratedAMIRule.ownerEmail = null
The properties below are used to configure the rule used for cleaning up auto scaling groups that have no active instances and the launch configuration is more than certain days old.
The property below specifies whether or not Eureka/Discovery is available for Janitor monkey to use. Discovery/Eureka is used in the rules for cleaning up auto scaling groups to determine if an auto scaling group has an 'active' instance, i.e. an instance that is registered and up in Discovery/Eureka. You should set this property to false if you do not have Discovery/Eureka set up in your environment. The default value of this property is false.
simianarmy.janitor.Eureka.enabled = false
This property specifies whether Janitor monkey will clean up empty auto scaling groups. You can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.oldEmptyASGRule.enabled = true
An an auto-scaling group without active instances is considered a cleanup candidate when its launch configuration is older than the number of days specified in this property. The default value is 50.
simianarmy.janitor.rule.oldEmptyASGRule.launchConfigAgeThreshold = 50
The number of business days an empty auto-scaling group is retained after a notification is sent for the termination. The default value is 10.
simianarmy.janitor.rule.oldEmptyASGRule.retentionDays = 10
The properties below are used to configure the rule used for cleaning up auto-scaling groups that have no active instances and have been suspended from the associated ELB traffic for certain days.
This property specifies whether Janitor monkey will clean up suspended auto scaling groups. You can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.suspendedASGRule.enabled = true
An auto scaling group without active instances is considered a cleanup candidate when it has been suspended from the associated ELB traffic for the number of days specified in this property, the default value is 2.
simianarmy.janitor.rule.suspendedASGRule.suspensionAgeThreshold = 2
This property specifies the number of business days the auto scaling group is retained after a notification is sent for the termination. The default value is 5.
simianarmy.janitor.rule.suspendedASGRule.retentionDays = 5
The following properties are used by the Janitor rule for cleaning up launch configurations that are not used by any auto scaling group or instances and are older than certain days.
This property specifies whether Janitor monkey will clean up unused launch configurations that are more than certain days old. You can set the property to false to disable the rule. The default value is true.
simianarmy.janitor.rule.oldUnusedLaunchConfigRule.enabled = true
An unused launch configuration is considered a cleanup candidate when it is older than the number of days specified in the property below. The default value is 4.
simianarmy.janitor.rule.oldUnusedLaunchConfigRule.ageThreshold = 4
This property specifies the number of business days the launch configuration is kept after a notification is sent for the termination. The default value is 3.
simianarmy.janitor.rule.oldUnusedLaunchConfigRule.retentionDays = 3
The following properties are used by the Janitor rule for cleaning up images.
The property below specifies the number of days to look back in the history when crawling the last reference information of the images. By default we look back up to 60 days.
simianarmy.janitor.image.crawler.lookBackDays = 60
The property below specifies the owner id that images have for being managed by Janitor Monkey. If no owner id is set, all images under the AWS account are returned. By default the line is commented and no owner id is set.
#simianarmy.janitor.image.ownerId = 1234567890
This rule is used by the Janitor rule for cleaning up images that have not been used by any instances and launch configurations, and and not used to create other images, in the last certain days. This rule is by default disabled, you need to have Edda running and enabled for using this rule since the image's history is needed to determine the last time when the images was referenced.
simianarmy.janitor.rule.unusedImageRule.enabled = false
An unused image is considered a cleanup candidate when it is not referenced for than the number of days specified in the property below. The default value is 45.
simianarmy.janitor.rule.unusedImageRule.lastReferenceDaysThreshold = 45
The property below specifies the number of business days the image is kept after a notification is sent for the termination. The default value is 3.
simianarmy.janitor.rule.unusedImageRule.retentionDays = 3
The following properties are used to configure Edda for Janitor Monkey to get the history of resources.
The property specifies whether Edda is enabled and started. By default Edda is not enabled.
simianarmy.janitor.edda.enabled = false
The property specifies the Edda endpoint in each region.
#simianarmy.janitor.edda.endpoint.us-east-1 = http://localhost:8080
The properties below are used to configure the Edda REST client.
The property specifies the timeout value (in miliseconds) of RESTful request to Edda. The default value is 30 seconds.
simianarmy.janitor.edda.client.timeout = 30000
The property specifies the number of retries for each request. The default value is 3.
simianarmy.janitor.edda.client.retries = 3
The property specifies the time interval (in miliseconds) between retry of requests. The default value is 1 second.
simianarmy.janitor.edda.client.retryInterval = 1000