diff --git a/docs/aws.md b/docs/aws.md index b81cb0b..fd72324 100644 --- a/docs/aws.md +++ b/docs/aws.md @@ -37,7 +37,8 @@ the on-demand instance cost - you'll always pay the current market price, not yo "vpc": "", "subnet": "", "securityGroup": "CHANGEME!", - + "usePrivateAddress": false, + "assignPrivateAddressOnly": false, "monitoring": false, "maxRuntime": -1, "maxUploadTime": -1, @@ -65,28 +66,29 @@ the on-demand instance cost - you'll always pay the current market price, not yo } ``` -| Field | Description | -|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| accessKey | AWS Access Key | -| secretKey | AWS Secret Key | -| s3 | S3 bucket configuration. | -| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. | -| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. | -| 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. | -| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. | -| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. | -| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. | -| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. | -| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. | -| region | Region identifier where the instances should be created. | -| zone | Zone identifier where the instances should be created. | -| ami | The AMI (machine image) to launch this instance from. | -| tags | Comma-separated list of key,value tags to associate to the instance. | -| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. | -| imageSizeMapping | Max images count to instance size mapping. (See below.) | -| 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. | -| dockerImage | Docker image to launch | -| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. | +| Field | Description | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| accessKey | AWS Access Key | +| secretKey | AWS Secret Key | +| s3 | S3 bucket configuration. | +| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. | +| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. | +| 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. | +| 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. | +| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. | +| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. | +| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. | +| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. | +| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. | +| region | Region identifier where the instances should be created. | +| zone | Zone identifier where the instances should be created. | +| ami | The AMI (machine image) to launch this instance from. | +| tags | Comma-separated list of key,value tags to associate to the instance. | +| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. | +| imageSizeMapping | Max images count to instance size mapping. (See below.) | +| 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. | +| dockerImage | Docker image to launch | +| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. | ## Image Size Mapping @@ -100,4 +102,4 @@ instance able to process the requested number of images is always selected. | maxImages | The maximum number of images this instance size can handle. | | slug | EC2 instance type to request (for example, `t3.medium`). | | storage | Amount of storage to allocate to this instance's EBS root volume, in GB. | -| spotPrice | The maximum hourly price you're willing to bid for this instance (if spot instances are enabled). | \ No newline at end of file +| spotPrice | The maximum hourly price you're willing to bid for this instance (if spot instances are enabled). |