co.cask.coopr.provisioner

Class TenantProvisionerService

java.lang.Object

co.cask.coopr.provisioner.TenantProvisionerService

public class TenantProvisionerService
extends Object

Service for managing provisioners.

Method Summary

Methods

Modifier and Type	Method and Description
void	bootstrapTenant(String tenantId)
void	deleteProvisioner(String provisionerId) Delete the given provisioner, queueing a job to reassign its workers to different provisioners.
void	deleteTenantByName(String name) Delete the given tenant.
Collection<Provisioner>	getAllProvisioners() Get an immutable collection of all provisioners for external display, with tenant ids mapped to tenant names.
Collection<TenantSpecification>	getAllTenantSpecifications() Get an unmodifiable collection of all tenant specifications.
Provisioner	getProvisioner(String provisionerId) Get the provisioner for the given id for external display, with tenant ids mapped to tenant names, or null if none exists.
TenantSpecification	getTenantSpecification(String name) Get a tenant specification by tenant name.
void	handleHeartbeat(String provisionerId, ProvisionerHeartbeat heartbeat) Handle the heartbeat of a provisioner, updating the last heartbeat time of the provisioner and updating the number of live workers running on the provisioner for each tenant it is responsible for.
void	rebalanceTenantWorkers(String tenantId) Rebalance workers for the tenant across the provisioners.
boolean	satisfiesTenantQuotas(String tenantId, int additionalClusters, int additionalNodes) Verify that tenant cluster and node quotas would not be exceeded if the given number of additional clusters and nodes would be added.
boolean	satisfiesTenantQuotas(Tenant tenant, int additionalClusters, int additionalNodes) Verify that tenant cluster and node quotas would not be exceeded if the given number of additional clusters and nodes would be added.
void	syncResources(Account account) Get a snapshot of what plugin resources are slated to be active on the provisioners that are running workers for the given account, and push those resources to the provisioners.
void	timeoutProvisioners(long timeoutTs) Delete and reassign workers for provisioners that have not sent a heartbeat since the given timestamp in milliseconds.
void	writeProvisioner(Provisioner provisioner) Write a provisioner, and queue jobs to rebalance workers for all tenants in the system.
String	writeTenantSpecification(TenantSpecification tenantSpecification) Write the tenant to the store and balance the tenant workers across provisioners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAllTenantSpecifications

public Collection<TenantSpecification> getAllTenantSpecifications()
                                                           throws IOException

Get an unmodifiable collection of all tenant specifications.

Returns:

Unmodifiable collection of all tenant specifications

Throws:

IOException

getTenantSpecification

public TenantSpecification getTenantSpecification(String name)
                                           throws IOException

Get a tenant specification by tenant name.

Parameters:

name - Name of the tenant to get

Returns:

Tenant for the given name, or null if none exists

Throws:

IOException

getAllProvisioners

public Collection<Provisioner> getAllProvisioners()
                                           throws IOException

Get an immutable collection of all provisioners for external display, with tenant ids mapped to tenant names.

Returns:

Immutable collection of all provisioners for external display, with tenant ids mapped to tenant names

Throws:

IOException

getProvisioner

public Provisioner getProvisioner(String provisionerId)
                           throws IOException

Get the provisioner for the given id for external display, with tenant ids mapped to tenant names, or null if none exists.

Parameters:

provisionerId - Id of the provisioner to get

Returns:

Provisioner for the given id with tenant ids mapped to tenant names, or null if none exists

Throws:

IOException

writeTenantSpecification

public String writeTenantSpecification(TenantSpecification tenantSpecification)
                                throws IOException,
                                       CapacityException,
                                       QuotaException

Write the tenant to the store and balance the tenant workers across provisioners. Returns the id of the tenant that was written.

Parameters:

tenantSpecification - Tenant to write

Returns:

Id of the written tenant

Throws:

IOException - if there was an exception persisting the tenant

CapacityException - if there is not enough capacity to support all tenant workers

QuotaException - if a tenant quota would be violated by the change

satisfiesTenantQuotas

public boolean satisfiesTenantQuotas(String tenantId,
                            int additionalClusters,
                            int additionalNodes)
                              throws IOException

Verify that tenant cluster and node quotas would not be exceeded if the given number of additional clusters and nodes would be added.

Parameters:

tenantId - Id of the tenant to verify quotas for

additionalClusters - Number of clusters that would be added

additionalNodes - Number of nodes that would be added

Returns:

true if the tenant quotas would be satisfied, false if they would be exceeded.

Throws:

IOException

satisfiesTenantQuotas

public boolean satisfiesTenantQuotas(Tenant tenant,
                            int additionalClusters,
                            int additionalNodes)
                              throws IOException

Verify that tenant cluster and node quotas would not be exceeded if the given number of additional clusters and nodes would be added.

Parameters:

tenant - Tenant to verify quotas for

additionalClusters - Number of clusters that would be added

additionalNodes - Number of nodes that would be added

Returns:

true if the tenant quotas would be satisfied, false if they would be exceeded.

Throws:

IOException

deleteTenantByName

public void deleteTenantByName(String name)
                        throws IllegalStateException,
                               IOException

Delete the given tenant. A tenant must not have any assigned workers in order for deletion to be allowed.

Parameters:

name - Name of the tenant to delete

Throws:

IllegalStateException - if the tenant has one or more assigned workers

IOException - if there was an exception persisting the deletion

deleteProvisioner

public void deleteProvisioner(String provisionerId)
                       throws IOException

Delete the given provisioner, queueing a job to reassign its workers to different provisioners.

Parameters:

provisionerId - Id of the provisioner to delete

Throws:

IOException

handleHeartbeat

public void handleHeartbeat(String provisionerId,
                   ProvisionerHeartbeat heartbeat)
                     throws IOException,
                            MissingEntityException

Handle the heartbeat of a provisioner, updating the last heartbeat time of the provisioner and updating the number of live workers running on the provisioner for each tenant it is responsible for.

Parameters:

provisionerId - Id of the provisioner that sent the heartbeat

heartbeat - The heartbeat containing live worker information

Throws:

IOException - if there was an exception persisting the data

MissingEntityException - if there is no provisioner for the given id

writeProvisioner

public void writeProvisioner(Provisioner provisioner)
                      throws IOException

Write a provisioner, and queue jobs to rebalance workers for all tenants in the system.

Parameters:

provisioner - Provisioner to write

Throws:

IOException

rebalanceTenantWorkers

public void rebalanceTenantWorkers(String tenantId)
                            throws IOException,
                                   CapacityException

Rebalance workers for the tenant across the provisioners.

Parameters:

tenantId - Id of the tenant whose workers need to be rebalanced

Throws:

CapacityException - if there is not enough capacity to rebalance tenant workers

IOException - if there was an exception persisting the worker rebalance

syncResources

public void syncResources(Account account)
                   throws IOException

Get a snapshot of what plugin resources are slated to be active on the provisioners that are running workers for the given account, and push those resources to the provisioners.

Parameters:

account - Account to sync

Throws:

IOException

timeoutProvisioners

public void timeoutProvisioners(long timeoutTs)
                         throws IOException

Delete and reassign workers for provisioners that have not sent a heartbeat since the given timestamp in milliseconds.

Parameters:

timeoutTs - Timestamp in milliseconds to use as a cut off for deleting provisioners.

Throws:

IOException

bootstrapTenant

public void bootstrapTenant(String tenantId)
                     throws IOException,
                            IllegalAccessException

Throws:

IOException

IllegalAccessException