Merge branch '15107-prefer-domain-for-username'
[arvados.git] / doc / admin / spot-instances.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: Using Preemptible instances
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 This page describes how to enable preemptible instances.  Preemptible instances typically offer lower cost computation with a tradeoff of lower service guarantees.  If a compute node is preempted, Arvados will restart the computation on a new instance.
14
15 Currently Arvados supports preemptible instances using AWS spot instances.
16
17 h2. Configuration
18
19 To use preemptible instances, set @UsePreemptibleInstances: true@ and add entries to @InstanceTypes@ with @Preemptible: true@ to @config.yml@.  Typically you want to add both preemptible and non-preemptible entries for each cloud provider VM type.  The @Price@ for preemptible instances is the maximum bid price, the actual price paid is dynamic and may be lower.  For example:
20
21 <pre>
22 Clusters:
23   uuid_prefix:
24     Containers:
25       UsePreemptibleInstances: true
26     InstanceTypes:
27       m4.large:
28         Preemptible: false
29         ProviderType: m4.large
30         VCPUs: 2
31         RAM: 8GiB
32         AddedScratch: 32GB
33         Price: 0.1
34       m4.large.spot:
35         Preemptible: true
36         ProviderType: m4.large
37         VCPUs: 2
38         RAM: 8GiB
39         AddedScratch: 32GB
40         Price: 0.1
41 </pre>
42
43 When @UsePreemptibleInstances@ is enabled, child containers (workflow steps) will automatically be made preemptible.  Note that because preempting the workflow runner would cancel the entire workflow, the workflow runner runs in a reserved (non-preemptible) instance.
44
45 If you are using "crunch-dispatch-cloud":{{site.baseurl}}/install/install-dispatch-cloud.html no additional configuration is required.
46
47 If you are using the legacy Nodemanager, "see below":#nodemanager .
48
49 h2. Preemptible instances on AWS
50
51 For general information, see "using Amazon EC2 spot instances":https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html .
52
53 h3. Permissions
54
55 When requesting spot instances, Amazon's API may return an authorization error depending on how users and permissions are set on the account. If this is the case check logs for this error:
56
57 <pre>
58 BaseHTTPError: AuthFailure.ServiceLinkedRoleCreationNotPermitted: The provided credentials do not have permission to create the service-linked role for EC2 Spot Instances.
59 </pre>
60
61 The account needs to have a service linked role created. This can be done by logging into the AWS account, go to _IAM Management_ &rarr; _Roles_ and create the @AWSServiceRoleForEC2Spot@ role by clicking on the @Create@ button, selecting @EC2@ service and @EC2 - Spot Instances@ use case.
62
63 h3. Cost Tracking
64
65 Amazon's Spot instances prices are declared at instance request time and defined by the maximum price that the user is willing to pay per hour. By default, this price is the same amount as the on-demand version of each instance type, and this setting is the one that nodemanager uses for now, as it doesn't include any pricing data to the spot instance request.
66
67 The real price that a spot instance has at any point in time is discovered at the end of each usage hour, depending on instance demand. For this reason, AWS provides a data feed subscription to get hourly logs, as described on "Amazon's User Guide":https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html.
68
69 h2(#nodemanager). Nodemanager
70
71 If you are using the legacy Nodemanager, its config file must also declare preemptible instance sizes, which must match the API server's @InstanceTypes@:
72
73 <pre>
74 [Size m4.large]
75 cores = 2
76 scratch = 32000
77
78 [Size m4.large.spot]
79 cores = 2
80 instance_type = m4.large
81 preemptible = true
82 scratch = 32000
83 </pre>