com.netflix.spinnaker.keel.clouddriver.model.ActiveServerGroup.kt Maven / Gradle / Ivy
The newest version!
package com.netflix.spinnaker.keel.clouddriver.model
import com.fasterxml.jackson.annotation.JsonAlias
import com.fasterxml.jackson.annotation.JsonCreator
import com.netflix.spinnaker.keel.api.Moniker
import com.netflix.spinnaker.keel.api.plugins.ServerGroupIdentity
import com.netflix.spinnaker.keel.api.support.Tag
import com.netflix.spinnaker.keel.clouddriver.CloudDriverCache
import com.netflix.spinnaker.kork.exceptions.SystemException
data class ServerGroupCollection(
val accountName: String,
val serverGroups: Set
)
/**
* Fields common to all of the different kinds of server groups (EC2, Titus)
*/
interface BaseServerGroup {
val name: String
val region: String
val targetGroups: Set
val loadBalancers: Set
val capacity: Capacity
val cloudProvider: String
val securityGroups: Set
val moniker: Moniker
val disabled: Boolean
get() = false
val instanceCounts: InstanceCounts
val createdTime: Long
}
data class InstanceCounts(
val total: Int,
val up: Int,
val down: Int,
val unknown: Int,
val outOfService: Int,
val starting: Int
)
/**
* Fields common to classes that model EC2 server groups
*/
interface BaseEc2ServerGroup : BaseServerGroup {
val zones: Set
val image: ActiveServerGroupImage
/**
* One of these two fields is always null, and the other is always
* non-null.
*
* If AWS launch templates are enabled in clouddriver for this app,
* associated with this server group, then the launchTemplate
* field will be populated.
*
* Otherwise, the launchConfig field will be populated.
*/
val launchConfig: LaunchConfig?
val launchTemplate: LaunchTemplate?
val asg: AutoScalingGroup
val scalingPolicies: List
val vpcId: String
val buildInfo: BuildInfo?
}
/**
* Objects that are returned when querying for all of the ec2 server groups associated with a cluster.
*
* Two differences from [ActiveServerGroup]:
* - disabled flag
* - no accountName field (since this is defined on the parent [ServerGroupCollection] object
*/
data class ServerGroup(
override val name: String,
override val region: String,
override val zones: Set,
override val image: ActiveServerGroupImage,
override val launchConfig: LaunchConfig? = null,
override val launchTemplate: LaunchTemplate? = null,
override val asg: AutoScalingGroup,
override val scalingPolicies: List,
override val vpcId: String,
override val targetGroups: Set,
override val loadBalancers: Set,
override val capacity: Capacity,
override val cloudProvider: String,
override val securityGroups: Set,
override val moniker: Moniker,
override val buildInfo: BuildInfo? = null,
override val disabled: Boolean,
override val instanceCounts: InstanceCounts,
override val createdTime: Long
) : BaseEc2ServerGroup, ServerGroupIdentity {
init {
ensureLaunchConfigInfoIsPresent(this)
}
}
/**
* Clouddriver should always return either a launchConfig field or a launchTemplate
* field for an EC2 server group.
*
* This is a helper function that asserts that one of these fields must be present.
* It is intended to be called from the init block of classes that implement BaseEc2ServerGroup
*/
fun ensureLaunchConfigInfoIsPresent(sg : BaseEc2ServerGroup) {
if(sg.launchConfig == null && sg.launchTemplate == null) {
throw SystemException("Server group info contains neither launchConfig nor launchTemplate fields: ${sg.name}")
}
}
fun ServerGroup.toActive(accountName: String) =
ActiveServerGroup(
name = name,
region = region,
zones = zones,
image = image,
launchConfig = launchConfig,
launchTemplate = launchTemplate,
asg = asg,
scalingPolicies = scalingPolicies,
vpcId = vpcId,
targetGroups = targetGroups,
loadBalancers = loadBalancers,
capacity = capacity,
cloudProvider = cloudProvider,
securityGroups = securityGroups,
accountName = accountName,
moniker = moniker,
buildInfo = buildInfo,
instanceCounts = instanceCounts,
createdTime = createdTime
)
// todo eb: this should be more general so that it works for all server groups, not just ec2
data class ActiveServerGroup(
override val name: String,
override val region: String,
override val zones: Set,
override val image: ActiveServerGroupImage,
override val launchConfig: LaunchConfig? = null,
override val launchTemplate: LaunchTemplate? = null,
override val asg: AutoScalingGroup,
override val scalingPolicies: List,
override val vpcId: String,
override val targetGroups: Set,
override val loadBalancers: Set,
override val capacity: Capacity,
override val cloudProvider: String,
override val securityGroups: Set,
val accountName: String,
override val moniker: Moniker,
override val buildInfo: BuildInfo? = null,
override val instanceCounts: InstanceCounts,
override val createdTime: Long
) : BaseEc2ServerGroup {
init {
ensureLaunchConfigInfoIsPresent(this)
}
}
fun ActiveServerGroup.subnet(cloudDriverCache: CloudDriverCache): String =
asg.vpczoneIdentifier.substringBefore(",").let { subnetId ->
cloudDriverCache
.subnetBy(subnetId)
.purpose ?: error("Subnet $subnetId has no purpose!")
}
data class ActiveServerGroupImage(
val imageId: String,
val appVersion: String?,
val baseImageName: String?,
val name: String,
val imageLocation: String,
val description: String?
) {
@JsonCreator
constructor(
imageId: String,
name: String,
imageLocation: String,
description: String?,
tags: List>
) : this(
imageId = imageId,
appVersion = tags.getTag("appversion")?.substringBefore("/"),
baseImageName = extractBaseImageName(description),
name = name,
imageLocation = imageLocation,
description = description
)
}
private fun List>.getTag(key: String) =
firstOrNull { it["key"] == key }
?.get("value")
?.toString()
class RequiredTagMissing(tagName: String, imageId: String) :
SystemException("Required tag \"$tagName\" was not found on AMI $imageId")
/**
* @return the base image name extracted from the `image/description` field on CloudDriver's
* representation of a server group. If [description] is `null` or does not contain the base image
* name, this function returns `null`.
*
* On a [NamedImage] this is available as a tag, but not on a server group.
*/
fun extractBaseImageName(description: String?): String? =
description?.let {
"""ancestor_name=([\w-]+)"""
.toRegex()
.find(it)
?.destructured
?.let { (baseAmiName) -> baseAmiName }
}
data class LaunchConfig(
val ramdiskId: String?,
val ebsOptimized: Boolean,
val imageId: String,
val instanceType: String,
val keyName: String,
val iamInstanceProfile: String,
val instanceMonitoring: InstanceMonitoring
)
data class LaunchTemplate(
val launchTemplateData: LaunchTemplateData
)
/**
* This class models a subset of the AWS::EC2::LaunchTemplate LaunchTemplateData
*
* For a complete list, see:
* https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html
*/
data class LaunchTemplateData(
val ebsOptimized: Boolean,
val imageId: String,
val instanceType: String,
val keyName: String,
val iamInstanceProfile: IamInstanceProfile,
val monitoring: InstanceMonitoring,
val ramDiskId: String?,
val metadataOptions: Map = emptyMap()
)
data class IamInstanceProfile(
val name: String
)
data class AutoScalingGroup(
val autoScalingGroupName: String,
val defaultCooldown: Long,
val healthCheckType: String,
val healthCheckGracePeriod: Long,
val suspendedProcesses: Set,
val enabledMetrics: Set,
val tags: Set,
val terminationPolicies: Set,
val vpczoneIdentifier: String
)
// https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_ScalingPolicy.html
data class ScalingPolicy(
val autoScalingGroupName: String,
val policyName: String,
val policyType: String,
val estimatedInstanceWarmup: Int,
val adjustmentType: String? = null, // step scaling only
val minAdjustmentStep: Int? = null, // step scaling only
val minAdjustmentMagnitude: Int? = null, // step only
val stepAdjustments: List? = null,
val metricAggregationType: String? = null,
val targetTrackingConfiguration: TargetTrackingConfiguration? = null,
val alarms: List
)
// https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_StepAdjustment.html
data class StepAdjustmentModel(
val metricIntervalLowerBound: Double? = null,
val metricIntervalUpperBound: Double? = null,
val scalingAdjustment: Int
)
// these are managed by EC2 for target tracking policies, but client provided for step policies
data class ScalingPolicyAlarm(
val actionsEnabled: Boolean = true,
val comparisonOperator: String,
val dimensions: List? = emptyList(),
val evaluationPeriods: Int,
val period: Int,
val threshold: Int,
val metricName: String,
val namespace: String,
val statistic: String
)
// https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html
data class TargetTrackingConfiguration(
val targetValue: Double,
val disableScaleIn: Boolean? = null,
val customizedMetricSpecification: CustomizedMetricSpecificationModel? = null,
val predefinedMetricSpecification: PredefinedMetricSpecificationModel? = null
)
// https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CustomizedMetricSpecification.html
data class CustomizedMetricSpecificationModel(
val metricName: String,
val namespace: String,
val statistic: String,
val unit: String? = null,
val dimensions: List? = emptyList()
)
// https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredefinedMetricSpecification.html
data class PredefinedMetricSpecificationModel(
val predefinedMetricType: String,
val resourceLabel: String? = null
)
data class MetricDimensionModel(
val name: String,
val value: String
)
data class SuspendedProcess(
val processName: String,
val suspensionReason: String? = null
)
data class InstanceMonitoring(
val enabled: Boolean
)
data class BuildInfo(
@JsonAlias("package_name")
val packageName: String?
)