Package com.yahoo.config.application.api

Class DeploymentInstanceSpec

java.lang.Object

com.yahoo.config.application.api.DeploymentSpec.Step

com.yahoo.config.application.api.DeploymentSpec.Steps

com.yahoo.config.application.api.DeploymentInstanceSpec

public final class DeploymentInstanceSpec
extends DeploymentSpec.Steps

The deployment spec for an application instance

Author:

bratseth

Constructor Summary

Constructors

Constructor

Description

DeploymentInstanceSpec(com.yahoo.config.provision.InstanceName name, com.yahoo.config.provision.Tags tags, List<DeploymentSpec.Step> steps, DeploymentSpec.UpgradePolicy upgradePolicy, DeploymentSpec.RevisionTarget revisionTarget, DeploymentSpec.RevisionChange revisionChange, DeploymentSpec.UpgradeRollout upgradeRollout, int minRisk, int maxRisk, int maxIdleHours, List<DeploymentSpec.ChangeBlocker> changeBlockers, Optional<com.yahoo.config.provision.AthenzService> athenzService, Map<com.yahoo.config.provision.CloudName,com.yahoo.config.provision.CloudAccount> cloudAccounts, Optional<Duration> hostTTL, Notifications notifications, List<Endpoint> endpoints, Map<com.yahoo.config.provision.ClusterSpec.Id,Map<com.yahoo.config.provision.zone.ZoneId,com.yahoo.config.provision.ZoneEndpoint>> zoneEndpoints, Bcp bcp, Instant now)

Method Summary

Modifier and Type	Method	Description
Optional<com.yahoo.config.provision.AthenzService>	athenzService(com.yahoo.config.provision.Environment environment, com.yahoo.config.provision.RegionName region)	Returns the athenz service for environment/region if configured, defaulting to that of the instance
Bcp	bcp()	Returns the BCP spec of this instance, or BcpSpec.empty() if none.
boolean	canChangeRevisionAt(Instant instant)	Returns whether an application revision change for these instances can occur at the given instant
boolean	canUpgradeAt(Instant instant)	Returns whether the instances in this step can upgrade at the given instant
List<DeploymentSpec.ChangeBlocker>	changeBlocker()	Returns time windows where upgrades are disallowed for these instances
Map<com.yahoo.config.provision.CloudName,com.yahoo.config.provision.CloudAccount>	cloudAccounts(com.yahoo.config.provision.Environment environment, com.yahoo.config.provision.RegionName region)	Returns the cloud accounts to use for given environment and region, if any
boolean	deploysTo(com.yahoo.config.provision.Environment environment, com.yahoo.config.provision.RegionName region)	Returns whether this instance deploys to the given zone, either implicitly or explicitly
List<Endpoint>	endpoints()	Returns the rotations configuration of these instances
boolean	equals(Object o)
int	hashCode()
Optional<Duration>	hostTTL(com.yahoo.config.provision.Environment environment, Optional<com.yahoo.config.provision.RegionName> region)	Returns the host TTL to use for given environment and region, if any
int	maxIdleHours()
int	maxRisk()	Maximum cumulative risk that will automatically roll out to this instance, as long as this is possible. 0 by default.
int	minRisk()	Minimum cumulative, enqueued risk required for a new revision to roll out to this instance. 0 by default.
com.yahoo.config.provision.InstanceName	name()
Notifications	notifications()	Returns the notification configuration of these instances
DeploymentSpec.RevisionChange	revisionChange()	Returns the revision change strategy of this, which is DeploymentSpec.RevisionChange.whenFailing by default
DeploymentSpec.RevisionTarget	revisionTarget()	Returns the revision target choice of this, which is DeploymentSpec.RevisionTarget.latest by default
String	toString()
DeploymentSpec.UpgradePolicy	upgradePolicy()	Returns the upgrade policy of this, which is DeploymentSpec.UpgradePolicy.defaultPolicy by default
DeploymentSpec.UpgradeRollout	upgradeRollout()	Returns the upgrade rollout strategy of this, which is DeploymentSpec.UpgradeRollout.separate by default
Map<com.yahoo.config.provision.ClusterSpec.Id,com.yahoo.config.provision.ZoneEndpoint>	zoneEndpoints(com.yahoo.config.provision.zone.ZoneId zone)	The zone endpoints in the given zone, possibly default values.

Methods inherited from class com.yahoo.config.application.api.DeploymentSpec.Steps

concerns, delay, steps, zones

Methods inherited from class com.yahoo.config.application.api.DeploymentSpec.Step

concerns, hostTTL, isOrdered, isTest

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DeploymentInstanceSpec

public DeploymentInstanceSpec(com.yahoo.config.provision.InstanceName name,
 com.yahoo.config.provision.Tags tags,
 List<DeploymentSpec.Step> steps,
 DeploymentSpec.UpgradePolicy upgradePolicy,
 DeploymentSpec.RevisionTarget revisionTarget,
 DeploymentSpec.RevisionChange revisionChange,
 DeploymentSpec.UpgradeRollout upgradeRollout,
 int minRisk,
 int maxRisk,
 int maxIdleHours,
 List<DeploymentSpec.ChangeBlocker> changeBlockers,
 Optional<com.yahoo.config.provision.AthenzService> athenzService,
 Map<com.yahoo.config.provision.CloudName,com.yahoo.config.provision.CloudAccount> cloudAccounts,
 Optional<Duration> hostTTL,
 Notifications notifications,
 List<Endpoint> endpoints,
 Map<com.yahoo.config.provision.ClusterSpec.Id,Map<com.yahoo.config.provision.zone.ZoneId,com.yahoo.config.provision.ZoneEndpoint>> zoneEndpoints,
 Bcp bcp,
 Instant now)

Method Details

name

public com.yahoo.config.provision.InstanceName name()

upgradePolicy

public DeploymentSpec.UpgradePolicy upgradePolicy()

Returns the upgrade policy of this, which is DeploymentSpec.UpgradePolicy.defaultPolicy by default

revisionTarget

public DeploymentSpec.RevisionTarget revisionTarget()

Returns the revision target choice of this, which is DeploymentSpec.RevisionTarget.latest by default

revisionChange

public DeploymentSpec.RevisionChange revisionChange()

Returns the revision change strategy of this, which is DeploymentSpec.RevisionChange.whenFailing by default

upgradeRollout

public DeploymentSpec.UpgradeRollout upgradeRollout()

Returns the upgrade rollout strategy of this, which is DeploymentSpec.UpgradeRollout.separate by default

minRisk

public int minRisk()

Minimum cumulative, enqueued risk required for a new revision to roll out to this instance. 0 by default.

maxRisk

public int maxRisk()

Maximum cumulative risk that will automatically roll out to this instance, as long as this is possible. 0 by default.

maxIdleHours

public int maxIdleHours()

changeBlocker

public List<DeploymentSpec.ChangeBlocker> changeBlocker()

Returns time windows where upgrades are disallowed for these instances

canUpgradeAt

public boolean canUpgradeAt(Instant instant)

Returns whether the instances in this step can upgrade at the given instant

canChangeRevisionAt

public boolean canChangeRevisionAt(Instant instant)

Returns whether an application revision change for these instances can occur at the given instant

athenzService

public Optional<com.yahoo.config.provision.AthenzService> athenzService(com.yahoo.config.provision.Environment environment,
 com.yahoo.config.provision.RegionName region)

Returns the athenz service for environment/region if configured, defaulting to that of the instance

cloudAccounts

public Map<com.yahoo.config.provision.CloudName,com.yahoo.config.provision.CloudAccount> cloudAccounts(com.yahoo.config.provision.Environment environment,
 com.yahoo.config.provision.RegionName region)

Returns the cloud accounts to use for given environment and region, if any

hostTTL

public Optional<Duration> hostTTL(com.yahoo.config.provision.Environment environment,
 Optional<com.yahoo.config.provision.RegionName> region)

Returns the host TTL to use for given environment and region, if any

notifications

public Notifications notifications()

Returns the notification configuration of these instances

endpoints

public List<Endpoint> endpoints()

Returns the rotations configuration of these instances

bcp

public Bcp bcp()

Returns the BCP spec of this instance, or BcpSpec.empty() if none.

deploysTo

public boolean deploysTo(com.yahoo.config.provision.Environment environment,
 com.yahoo.config.provision.RegionName region)

Returns whether this instance deploys to the given zone, either implicitly or explicitly

zoneEndpoints

public Map<com.yahoo.config.provision.ClusterSpec.Id,com.yahoo.config.provision.ZoneEndpoint> zoneEndpoints(com.yahoo.config.provision.zone.ZoneId zone)

The zone endpoints in the given zone, possibly default values.

equals

public boolean equals(Object o)

Overrides:

equals in class DeploymentSpec.Steps

hashCode

public int hashCode()

Overrides:

hashCode in class DeploymentSpec.Steps

toString

public String toString()

Overrides:

toString in class DeploymentSpec.Steps