Diviner Phabricator Tech Docs DrydockWorkingCopyBlueprintImplementation

final class DrydockWorkingCopyBlueprintImplementation
Phabricator Technical Documentation (Drydock)

This class is not documented.

Tasks

Lease Acquisition

public function canAcquireLeaseOnResource($blueprint, $resource, $lease)
public function acquireLease($blueprint, $resource, $lease)
public function activateLease($blueprint, $resource, $lease)
public function didReleaseLease($blueprint, $resource, $lease)
public function destroyLease($blueprint, $resource, $lease)
public function shouldAllocateSupplementalResource($blueprint, $resource, $lease) — Return true to try to allocate a new resource and expand the resource pool instead of permitting an otherwise valid acquisition on an existing resource.

Resource Allocation

public function canAnyBlueprintEverAllocateResourceForLease($lease)
public function canEverAllocateResourceForLease($blueprint, $lease)
public function canAllocateResourceForLease($blueprint, $lease)
public function allocateResource($blueprint, $lease)
public function activateResource($blueprint, $resource)
public function destroyResource($blueprint, $resource)
public function getResourceName($blueprint, $resource)

Resource Interfaces

No methods for this task.

Logging

No methods for this task.

Other Methods

public function getType()
public function isEnabled()
public function getBlueprintName()
public function getDescription()
public function getBlueprintIcon()
public function getFieldSpecifications()
protected function getCustomFieldSpecifications()
public function getViewer()
public function getInterface($blueprint, $resource, $lease, $type)
public static function getAllBlueprintImplementations()
public static function getNamedImplementation($class)
protected function newResourceTemplate($blueprint)
protected function newLease($blueprint)
protected function requireActiveLease($lease)
protected function shouldUseConcurrentResourceLimit()
protected function getConcurrentResourceLimit($blueprint) — Get the effective concurrent resource limit for this blueprint.
protected function getConcurrentResourceLimitSlotLock($blueprint)
protected function shouldLimitAllocatingPoolSize($blueprint) — Apply standard limits on resource allocation rate.
private function getLeaseSlotLock($resource)
private function loadRepositories($phids)
private function loadHostLease($resource)
private function applyMerge($lease, $interface, $merge)
public function getCommandError($lease)
private function execxv($interface, $commands, $arguments)
private function newExecvFuture($interface, $commands, $arguments)

Methods

public function getType()

This method is not documented.

Return

wild

public function isEnabled()

This method is not documented.

Return

wild

public function getBlueprintName()

This method is not documented.

Return

wild

public function getDescription()

This method is not documented.

Return

wild

public function getBlueprintIcon()

This method is not documented.

Return

wild

public function getFieldSpecifications()
Inherited

This method is not documented.

Return

wild

protected function getCustomFieldSpecifications()

This method is not documented.

Return

wild

public function getViewer()
Inherited

This method is not documented.

Return

wild

public function canAcquireLeaseOnResource($blueprint, $resource, $lease)

DrydockBlueprintImplementation

Enforce basic checks on lease/resource compatibility. Allows resources to reject leases if they are incompatible, even if the resource types match.

For example, if a resource represents a 32-bit host, this method might reject leases that need a 64-bit host. The blueprint might also reject a resource if the lease needs 8GB of RAM and the resource only has 6GB free.

This method should not acquire locks or expect anything to be locked. This is a coarse compatibility check between a lease and a resource.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Concrete blueprint to allocate for.
DrydockResource	$resource	Candidate resource to allocate the lease on.
DrydockLease	$lease	Pending lease that wants to allocate here.

Return

bool	True if the resource and lease are compatible.

public function acquireLease($blueprint, $resource, $lease)

DrydockBlueprintImplementation

Acquire a lease. Allows resources to perform setup as leases are brought online.

If acquisition fails, throw an exception.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which built the resource.
DrydockResource	$resource	Resource to acquire a lease on.
DrydockLease	$lease	Requested lease.

Return

void

public function activateLease($blueprint, $resource, $lease)

This method is not documented.

Parameters

DrydockBlueprint	$blueprint
DrydockResource	$resource
DrydockLease	$lease

Return

void

public function didReleaseLease($blueprint, $resource, $lease)

DrydockBlueprintImplementation

React to a lease being released.

This callback is primarily useful for automatically releasing resources once all leases are released.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which built the resource.
DrydockResource	$resource	Resource a lease was released on.
DrydockLease	$lease	Recently released lease.

Return

void

public function destroyLease($blueprint, $resource, $lease)

DrydockBlueprintImplementation

Destroy any temporary data associated with a lease.

If a lease creates temporary state while held, destroy it here.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which built the resource.
DrydockResource	$resource	Resource the lease is acquired on.
DrydockLease	$lease	The lease being destroyed.

Return

void

public function shouldAllocateSupplementalResource($blueprint, $resource, $lease)
Inherited

DrydockBlueprintImplementation

Return true to try to allocate a new resource and expand the resource pool instead of permitting an otherwise valid acquisition on an existing resource.

This allows the blueprint to provide a soft hint about when the resource pool should grow.

Returning "true" in all cases generally makes sense when a blueprint controls a fixed pool of resources, like a particular number of physical hosts: you want to put all the hosts in service, so whenever it is possible to allocate a new host you want to do this.

Returning "false" in all cases generally make sense when a blueprint has a flexible pool of expensive resources and you want to pack leases onto them as tightly as possible.

Parameters

DrydockBlueprint	$blueprint	The blueprint for an existing resource being acquired.
DrydockResource	$resource	The resource being acquired, which we may want to build a supplemental resource for.
DrydockLease	$lease	The current lease performing acquisition.

Return

bool	True to prefer allocating a supplemental resource.

public function canAnyBlueprintEverAllocateResourceForLease($lease)

DrydockBlueprintImplementation

Enforce fundamental implementation/lease checks. Allows implementations to reject a lease which no concrete blueprint can ever satisfy.

For example, if a lease only builds ARM hosts and the lease needs a PowerPC host, it may be rejected here.

This is the earliest rejection phase, and followed by canEverAllocateResourceForLease().

This method should not actually check if a resource can be allocated right now, or even if a blueprint which can allocate a suitable resource really exists, only if some blueprint may conceivably exist which could plausibly be able to build a suitable resource.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockLease

$lease

Requested lease.

Return

bool	True if some concrete blueprint of this implementation's type might ever be able to build a resource for the lease.

public function canEverAllocateResourceForLease($blueprint, $lease)

DrydockBlueprintImplementation

Enforce basic blueprint/lease checks. Allows blueprints to reject a lease which they can not build a resource for.

This is the second rejection phase. It follows canAnyBlueprintEverAllocateResourceForLease() and is followed by canAllocateResourceForLease().

This method should not check if a resource can be built right now, only if the blueprint as configured may, at some time, be able to build a suitable resource.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which may be asked to allocate a resource.
DrydockLease	$lease	Requested lease.

Return

bool	True if this blueprint can eventually build a suitable resource for the lease, as currently configured.

public function canAllocateResourceForLease($blueprint, $lease)

DrydockBlueprintImplementation

Enforce basic availability limits. Allows blueprints to reject resource allocation if they are currently overallocated.

This method should perform basic capacity/limit checks. For example, if it has a limit of 6 resources and currently has 6 resources allocated, it might reject new leases.

This method should not acquire locks or expect locks to be acquired. This is a coarse check to determine if the operation is likely to succeed right now without needing to acquire locks.

It is expected that this method will sometimes return true (indicating that a resource can be allocated) but find that another allocator has eaten up free capacity by the time it actually tries to build a resource. This is normal and the allocator will recover from it.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	The blueprint which may be asked to allocate a resource.
DrydockLease	$lease	Requested lease.

Return

bool	True if this blueprint appears likely to be able to allocate a suitable resource.

public function allocateResource($blueprint, $lease)

DrydockBlueprintImplementation

Allocate a suitable resource for a lease.

This method MUST acquire, hold, and manage locks to prevent multiple allocations from racing. World state is not locked before this method is called. Blueprints are entirely responsible for any lock handling they need to perform.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	The blueprint which should allocate a resource.
DrydockLease	$lease	Requested lease.

Return

DrydockResource

Allocated resource.

public function activateResource($blueprint, $resource)

This method is not documented.

Parameters

DrydockBlueprint	$blueprint
DrydockResource	$resource

Return

wild

public function destroyResource($blueprint, $resource)

DrydockBlueprintImplementation

Destroy any temporary data associated with a resource.

If a resource creates temporary state when allocated, destroy that state here. For example, you might shut down a virtual host or destroy a working copy on disk.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which built the resource.
DrydockResource	$resource	Resource being destroyed.

Return

void

public function getResourceName($blueprint, $resource)

DrydockBlueprintImplementation

Get a human readable name for a resource.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Parameters

DrydockBlueprint	$blueprint	Blueprint which built the resource.
DrydockResource	$resource	Resource to get the name of.

Return

string

Human-readable resource name.

public function getInterface($blueprint, $resource, $lease, $type)

This method is not documented.

Parameters

DrydockBlueprint	$blueprint
DrydockResource	$resource
DrydockLease	$lease
	$type

Return

wild

public static function getAllBlueprintImplementations()
Inherited

This method is not documented.

Return

wild

public static function getNamedImplementation($class)
Inherited

This method is not documented.

Parameters

$class

Return

wild

protected function newResourceTemplate($blueprint)
Inherited

This method is not documented.

Parameters

DrydockBlueprint

$blueprint

Return

wild

protected function newLease($blueprint)
Inherited

This method is not documented.

Parameters

DrydockBlueprint

$blueprint

Return

wild

protected function requireActiveLease($lease)
Inherited

This method is not documented.

Parameters

DrydockLease

$lease

Return

wild

protected function shouldUseConcurrentResourceLimit()

DrydockBlueprintImplementation

Does this implementation use concurrent resource limits?

Implementations can override this method to opt into standard limit behavior, which provides a simple concurrent resource limit.

DrydockWorkingCopyBlueprintImplementation

This method is not documented.

Return

bool	True to use limits.

protected function getConcurrentResourceLimit($blueprint)
Inherited

DrydockBlueprintImplementation

Get the effective concurrent resource limit for this blueprint.

Parameters

DrydockBlueprint

$blueprint

Blueprint to get the limit for.

Return

int|null

Limit, or `null` for no limit.

protected function getConcurrentResourceLimitSlotLock($blueprint)
Inherited

This method is not documented.

Parameters

DrydockBlueprint

$blueprint

Return

wild

protected function shouldLimitAllocatingPoolSize($blueprint)
Inherited

DrydockBlueprintImplementation

Apply standard limits on resource allocation rate.

Parameters

DrydockBlueprint

$blueprint

The blueprint requesting an allocation.

Return

bool	True if further allocations should be limited.

private function getLeaseSlotLock($resource)

This method is not documented.

Parameters

DrydockResource

$resource

Return

wild

private function loadRepositories($phids)

This method is not documented.

Parameters

array

$phids

Return

wild

private function loadHostLease($resource)

This method is not documented.

Parameters

DrydockResource

$resource

Return

wild

private function applyMerge($lease, $interface, $merge)

This method is not documented.

Parameters

DrydockLease	$lease
DrydockCommandInterface	$interface
array	$merge

Return

wild

public function getCommandError($lease)

This method is not documented.

Parameters

DrydockLease

$lease

Return

wild

private function execxv($interface, $commands, $arguments)

This method is not documented.

Parameters

DrydockCommandInterface	$interface
array	$commands
array	$arguments

Return

wild

private function newExecvFuture($interface, $commands, $arguments)

This method is not documented.

Parameters

DrydockCommandInterface	$interface
array	$commands
array	$arguments

Return

wild

Defined: src/applications/drydock/blueprint/DrydockWorkingCopyBlueprintImplementation.php:3
Extends: DrydockBlueprintImplementation

final class DrydockWorkingCopyBlueprintImplementationPhabricator Technical Documentation (Drydock)

Tasks

Lease Acquisition

Resource Allocation

Resource Interfaces

Logging

Other Methods

Methods

public function getType()

public function isEnabled()

public function getBlueprintName()

public function getDescription()

public function getBlueprintIcon()

public function getFieldSpecifications()Inherited

protected function getCustomFieldSpecifications()

public function getViewer()Inherited

public function canAcquireLeaseOnResource($blueprint, $resource, $lease)

public function acquireLease($blueprint, $resource, $lease)

public function activateLease($blueprint, $resource, $lease)

public function didReleaseLease($blueprint, $resource, $lease)

public function destroyLease($blueprint, $resource, $lease)

public function shouldAllocateSupplementalResource($blueprint, $resource, $lease)Inherited

public function canAnyBlueprintEverAllocateResourceForLease($lease)

public function canEverAllocateResourceForLease($blueprint, $lease)

public function canAllocateResourceForLease($blueprint, $lease)

public function allocateResource($blueprint, $lease)

public function activateResource($blueprint, $resource)

public function destroyResource($blueprint, $resource)

public function getResourceName($blueprint, $resource)

public function getInterface($blueprint, $resource, $lease, $type)

public static function getAllBlueprintImplementations()Inherited

public static function getNamedImplementation($class)Inherited

protected function newResourceTemplate($blueprint)Inherited

protected function newLease($blueprint)Inherited

protected function requireActiveLease($lease)Inherited

protected function shouldUseConcurrentResourceLimit()

protected function getConcurrentResourceLimit($blueprint)Inherited

protected function getConcurrentResourceLimitSlotLock($blueprint)Inherited

protected function shouldLimitAllocatingPoolSize($blueprint)Inherited

private function getLeaseSlotLock($resource)

private function loadRepositories($phids)

private function loadHostLease($resource)

private function applyMerge($lease, $interface, $merge)

public function getCommandError($lease)

private function execxv($interface, $commands, $arguments)

private function newExecvFuture($interface, $commands, $arguments)

final class DrydockWorkingCopyBlueprintImplementation
Phabricator Technical Documentation (Drydock)

public function getFieldSpecifications()
Inherited

public function getViewer()
Inherited

public function shouldAllocateSupplementalResource($blueprint, $resource, $lease)
Inherited

public static function getAllBlueprintImplementations()
Inherited

public static function getNamedImplementation($class)
Inherited

protected function newResourceTemplate($blueprint)
Inherited

protected function newLease($blueprint)
Inherited

protected function requireActiveLease($lease)
Inherited

protected function getConcurrentResourceLimit($blueprint)
Inherited

protected function getConcurrentResourceLimitSlotLock($blueprint)
Inherited

protected function shouldLimitAllocatingPoolSize($blueprint)
Inherited