AwsProvisioner (Taskcluster Client (java port) 1.0.1 API)

java.lang.Object
- org.mozilla.taskcluster.client.TaskClusterRequestHandler
- - org.mozilla.taskcluster.client.awsprovisioner.AwsProvisioner

```
public class AwsProvisioner
extends TaskClusterRequestHandler
```
The AWS Provisioner is responsible for provisioning instances on EC2 for use in TaskCluster. The provisioner maintains a set of worker configurations which can be managed with an API that is typically available at aws-provisioner.taskcluster.net. This API can also perform basic instance management tasks in addition to maintaining the internal state of worker type configuration information.
The Provisioner runs at a configurable interval. Each iteration of the provisioner fetches a current copy the state that the AWS EC2 api reports. In each iteration, we ask the Queue how many tasks are pending for that worker type. Based on the number of tasks pending and the scaling ratio, we may submit requests for new instances. We use pricing information, capacity and utility factor information to decide which instance type in which region would be the optimal configuration.
Each EC2 instance type will declare a capacity and utility factor. Capacity is the number of tasks that a given machine is capable of running concurrently. Utility factor is a relative measure of performance between two instance types. We multiply the utility factor by the spot price to compare instance types and regions when making the bidding choices.
See: http://docs.taskcluster.net/aws-provisioner/api-docs

Field Summary

Fields
Modifier and Type Field and Description

protected static String defaultBaseURL

Fields
Modifier and Type	Field and Description
`protected static String`	`defaultBaseURL`

Constructor Summary

Constructors
Constructor and Description
`AwsProvisioner()`
`AwsProvisioner(String baseURL)`
`AwsProvisioner(String clientId, String accessToken)`
`AwsProvisioner(String clientId, String accessToken, String certificate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CallSummary<EmptyPayload,EmptyPayload>`	`apiReference()` Get an API reference!
`CallSummary<EmptyPayload,EmptyPayload>`	`awsState()` DEPRECATED.
`CallSummary<GetSecretRequest,EmptyPayload>`	`createSecret(String token, GetSecretRequest payload)` Insert a secret into the secret storage.
`CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest>`	`createWorkerType(String workerType, CreateWorkerTypeRequest payload)` Create a worker type and ensure that all EC2 regions have the required KeyPair
`CallSummary<EmptyPayload,Object>`	`getLaunchSpecs(String workerType)` Return the EC2 LaunchSpecifications for all combinations of regions and instance types or a list of reasons why the launch specifications are not valid
`CallSummary<EmptyPayload,GetSecretResponse>`	`getSecret(String token)` Retreive a secret from storage.
`CallSummary<EmptyPayload,EmptyPayload>`	`instanceStarted(String instanceId, String token)` An instance will report in by giving its instance id as well as its security token.
`CallSummary<EmptyPayload,String[]>`	`listWorkerTypes()` List all known WorkerType names
`CallSummary<EmptyPayload,EmptyPayload>`	`ping()` Documented later…
`CallSummary<EmptyPayload,EmptyPayload>`	`removeSecret(String token)` Remove a secret.
`CallSummary<EmptyPayload,EmptyPayload>`	`removeWorkerType(String workerType)` Delete a WorkerType definition, submits requests to kill all instances and delete the KeyPair from all configured EC2 regions
`CallSummary<EmptyPayload,EmptyPayload>`	`state(String workerType)` Return the state of a given workertype as stored by the provisioner.
`CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest>`	`updateWorkerType(String workerType, CreateWorkerTypeRequest payload)` Update a workerType and ensure that all regions have the require KeyPair
`CallSummary<EmptyPayload,GetWorkerTypeRequest>`	`workerType(String workerType)` Retreive a WorkerType definition

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler
apiCall, configureHawk, setBaseURL

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultBaseURL
```
protected static final String defaultBaseURL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AwsProvisioner
```
public AwsProvisioner(String clientId,
                      String accessToken)
```
  - AwsProvisioner
```
public AwsProvisioner(String clientId,
                      String accessToken,
                      String certificate)
```
  - AwsProvisioner
```
public AwsProvisioner(String baseURL)
```
  - AwsProvisioner
```
public AwsProvisioner()
```
- Method Detail
  - createWorkerType
```
public CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest> createWorkerType(String workerType,
                                                                                  CreateWorkerTypeRequest payload)
                                                                           throws APICallFailure
```
    Create a worker type and ensure that all EC2 regions have the required KeyPair
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#createWorkerType
    
    Throws:
    
    APICallFailure
  - updateWorkerType
```
public CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest> updateWorkerType(String workerType,
                                                                                  CreateWorkerTypeRequest payload)
                                                                           throws APICallFailure
```
    Update a workerType and ensure that all regions have the require KeyPair
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#updateWorkerType
    
    Throws:
    
    APICallFailure
  - workerType
```
public CallSummary<EmptyPayload,GetWorkerTypeRequest> workerType(String workerType)
                                                          throws APICallFailure
```
    Retreive a WorkerType definition
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#workerType
    
    Throws:
    
    APICallFailure
  - removeWorkerType
```
public CallSummary<EmptyPayload,EmptyPayload> removeWorkerType(String workerType)
                                                        throws APICallFailure
```
    Delete a WorkerType definition, submits requests to kill all instances and delete the KeyPair from all configured EC2 regions
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#removeWorkerType
    
    Throws:
    
    APICallFailure
  - listWorkerTypes
```
public CallSummary<EmptyPayload,String[]> listWorkerTypes()
                                                   throws APICallFailure
```
    List all known WorkerType names
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#listWorkerTypes
    
    Throws:
    
    APICallFailure
  - createSecret
```
public CallSummary<GetSecretRequest,EmptyPayload> createSecret(String token,
                                                               GetSecretRequest payload)
                                                        throws APICallFailure
```
    Insert a secret into the secret storage. This should not normally be done through this API, but is provided for testing and completeness
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#createSecret
    
    Throws:
    
    APICallFailure
  - getSecret
```
public CallSummary<EmptyPayload,GetSecretResponse> getSecret(String token)
                                                      throws APICallFailure
```
    Retreive a secret from storage. It is important that this secret is deleted by the consumer, or else the secrets will be visible to any process which can read HTTP on the worker localhost interface.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#getSecret
    
    Throws:
    
    APICallFailure
  - instanceStarted
```
public CallSummary<EmptyPayload,EmptyPayload> instanceStarted(String instanceId,
                                                              String token)
                                                       throws APICallFailure
```
    An instance will report in by giving its instance id as well as its security token. The token is given and checked to ensure that it matches a real token that exists to ensure that random machines do not check in. We could generate a different token but that seems like overkill
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#instanceStarted
    
    Throws:
    
    APICallFailure
  - removeSecret
```
public CallSummary<EmptyPayload,EmptyPayload> removeSecret(String token)
                                                    throws APICallFailure
```
    Remove a secret. It is very important that the consumer of a secret delete the secret from storage before handing over control to another process or else it could read the HTTP UserData endpoint and use the getSecrete() api here to get the secrets
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#removeSecret
    
    Throws:
    
    APICallFailure
  - getLaunchSpecs
```
public CallSummary<EmptyPayload,Object> getLaunchSpecs(String workerType)
                                                throws APICallFailure
```
    Return the EC2 LaunchSpecifications for all combinations of regions and instance types or a list of reasons why the launch specifications are not valid
    This API end-point is experimental and may be subject to change without warning.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#getLaunchSpecs
    
    Throws:
    
    APICallFailure
  - awsState
```
public CallSummary<EmptyPayload,EmptyPayload> awsState()
                                                throws APICallFailure
```
    DEPRECATED.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#awsState
    
    Throws:
    
    APICallFailure
  - state
```
public CallSummary<EmptyPayload,EmptyPayload> state(String workerType)
                                             throws APICallFailure
```
    Return the state of a given workertype as stored by the provisioner. This state is stored as three lists: 1 for all instances, 1 for requests which show in the ec2 api and 1 list for those only tracked internally in the provisioner.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#state
    
    Throws:
    
    APICallFailure
  - ping
```
public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure
```
    Documented later…
    Warning this api end-point is not stable.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#ping
    
    Throws:
    
    APICallFailure
  - apiReference
```
public CallSummary<EmptyPayload,EmptyPayload> apiReference()
                                                    throws APICallFailure
```
    Get an API reference!
    Warning this api end-point is not stable.
    See http://docs.taskcluster.net/aws-provisioner/api-docs/#apiReference
    
    Throws:
    
    APICallFailure

Class AwsProvisioner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler

Methods inherited from class java.lang.Object

Field Detail

defaultBaseURL

Constructor Detail

AwsProvisioner

AwsProvisioner

AwsProvisioner

AwsProvisioner

Method Detail

createWorkerType

updateWorkerType

workerType

removeWorkerType

listWorkerTypes

createSecret

getSecret

instanceStarted

removeSecret

getLaunchSpecs

awsState

state

ping

apiReference