Skip to content

Commit b346016

Browse files
pierotofypierotofy
authored
Merge pull request #120 from cjgarson/master
Update AWS ASR documentation for private address parameter updates
2 parents 3375048 + 130c383 commit b346016

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

‎docs/aws.md‎

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ the on-demand instance cost - you'll always pay the current market price, not yo
3737
"vpc": "",
3838
"subnet": "",
3939
"securityGroup": "CHANGEME!",
40-
40+
"usePrivateAddress": false,
41+
"assignPrivateAddressOnly": false,
4142
"monitoring": false,
4243
"maxRuntime": -1,
4344
"maxUploadTime": -1,
@@ -65,28 +66,29 @@ the on-demand instance cost - you'll always pay the current market price, not yo
6566
}
6667
```
6768

68-
| Field | Description |
69-
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
70-
| accessKey | AWS Access Key |
71-
| secretKey | AWS Secret Key |
72-
| s3 | S3 bucket configuration. |
73-
| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. |
74-
| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. |
75-
| usePrivateAddress | Set to true to use the private IP address when communicating with auto-scaled nodes. Useful if ClusterODM is on the same vpc as the auto-scaled nodes. |
76-
| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. |
77-
| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. |
78-
| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. |
79-
| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. |
80-
| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. |
81-
| region | Region identifier where the instances should be created. |
82-
| zone | Zone identifier where the instances should be created. |
83-
| ami | The AMI (machine image) to launch this instance from. |
84-
| tags | Comma-separated list of key,value tags to associate to the instance. |
85-
| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. |
86-
| imageSizeMapping | Max images count to instance size mapping. (See below.) |
87-
| addSwap | Optionally add this much swap space to the instance as a factor of total RAM (`RAM * addSwap`). A value of `1` sets a swapfile equal to the available RAM. |
88-
| dockerImage | Docker image to launch |
89-
| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. |
69+
| Field | Description |
70+
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
71+
| accessKey | AWS Access Key |
72+
| secretKey | AWS Secret Key |
73+
| s3 | S3 bucket configuration. |
74+
| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. |
75+
| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. |
76+
| usePrivateAddress | Set to true to use the private IP address when communicating with auto-scaled nodes. Useful if ClusterODM is on the same vpc as the auto-scaled nodes. |
77+
| assignPrivateAddressOnly | Set to true to ensure that only a private IP address is assigned to the created node. Only has effect if usePrivateAddress is true. Avoids extra charges. |
78+
| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. |
79+
| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. |
80+
| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. |
81+
| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. |
82+
| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. |
83+
| region | Region identifier where the instances should be created. |
84+
| zone | Zone identifier where the instances should be created. |
85+
| ami | The AMI (machine image) to launch this instance from. |
86+
| tags | Comma-separated list of key,value tags to associate to the instance. |
87+
| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. |
88+
| imageSizeMapping | Max images count to instance size mapping. (See below.) |
89+
| addSwap | Optionally add this much swap space to the instance as a factor of total RAM (`RAM * addSwap`). A value of `1` sets a swapfile equal to the available RAM. |
90+
| dockerImage | Docker image to launch |
91+
| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. |
9092

9193
## Image Size Mapping
9294

@@ -100,4 +102,4 @@ instance able to process the requested number of images is always selected.
100102
| maxImages | The maximum number of images this instance size can handle. |
101103
| slug | EC2 instance type to request (for example, `t3.medium`). |
102104
| storage | Amount of storage to allocate to this instance's EBS root volume, in GB. |
103-
| spotPrice | The maximum hourly price you're willing to bid for this instance (if spot instances are enabled). |
105+
| spotPrice | The maximum hourly price you're willing to bid for this instance (if spot instances are enabled). |

0 commit comments

Comments
 (0)