Skip to content

Commit 522ad69

Browse files
FJEANNOTFJEANNOT
committed
feat: add support for docker additionnal args
1 parent 8d178d2 commit 522ad69

File tree

4 files changed

+29
-25
lines changed

4 files changed

+29
-25
lines changed

‎docs/aws.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -67,31 +67,32 @@ the on-demand instance cost - you'll always pay the current market price, not yo
6767
}
6868
```
6969

70-
| Field | Description |
71-
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
72-
| accessKey | AWS Access Key |
73-
| secretKey | AWS Secret Key |
74-
| s3 | S3 bucket configuration. |
75-
| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. |
76-
| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. |
77-
| 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. |
78-
| 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. |
79-
| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. |
80-
| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. |
81-
| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. |
82-
| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. |
83-
| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. |
84-
| region | Region identifier where the instances should be created. |
85-
| zone | Zone identifier where the instances should be created. |
86-
| ami | The AMI (machine image) to launch this instance from. Note that AMIs are region-specific. |
87-
| engineInstallUrl | Specify installer for Docker engine. This can be cleared if AMI already has Docker engine installed. |
88-
| tags | Comma-separated list of key,value tags to associate to the instance. |
89-
| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. |
90-
| imageSizeMapping | Max images count to instance size mapping. (See below.) |
91-
| 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. |
92-
| dockerImage | Docker image to launch |
93-
| dockerDataDirMountPath | Path on node host to map to NodeODM data directory (/var/www/data). Use local instance storage for much faster I/O. |
94-
| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. |
70+
| Field | Description |
71+
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
72+
| accessKey | AWS Access Key |
73+
| secretKey | AWS Secret Key |
74+
| s3 | S3 bucket configuration. |
75+
| vpc | The virtual private cloud in which the instances operate. Not providing this assumes a default setting for VPC within the AWS environment. |
76+
| subnet | The subnet supporting the instances. Not providing this assumes a default setting for the subnet within the AWS environment. |
77+
| 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. |
78+
| 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. |
79+
| securityGroup | AWS Security Group name (not ID). Must exist and allow incoming connections from your ClusterODM host on port TCP/3000. |
80+
| createRetries | Number of attempts to create a droplet before giving up. Defaults to 1. |
81+
| maxRuntime | Maximum number of seconds an instance is allowed to run ever. Set to -1 for no limit. |
82+
| maxUploadTime | Maximum number of seconds an instance is allowed to receive file uploads. Set to -1 for no limit. |
83+
| monitoring | Set to true to enable detailed Cloudwatch monitoring for the instance. |
84+
| region | Region identifier where the instances should be created. |
85+
| zone | Zone identifier where the instances should be created. |
86+
| ami | The AMI (machine image) to launch this instance from. Note that AMIs are region-specific. |
87+
| engineInstallUrl | Specify installer for Docker engine. This can be cleared if AMI already has Docker engine installed. |
88+
| tags | Comma-separated list of key,value tags to associate to the instance. |
89+
| spot | Whether to request spot instances. If this is true, a `spotPrice` needs to be provided in the `imageSizeMapping`. |
90+
| imageSizeMapping | Max images count to instance size mapping. (See below.) |
91+
| 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. |
92+
| dockerImage | Docker image to launch |
93+
| dockerDataDirMountPath | Path on node host to map to NodeODM data directory (/var/www/data). Use local instance storage for much faster I/O. |
94+
| dockerAdditionalArgs | Additional args to pass to docker run command. For instance `--gpu all` to enable GPU acceleration |
95+
| nodeSetupCmd | Can be optionally used to run a setup command on auto-scaled nodes right before we run ODM. |
9596

9697
## Image Size Mapping
9798

‎docs/digitalocean.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,5 @@ Example configuration file:
6060
| minImages | Minimum number of images that a dataset needs to have for the autoscaler to be used (-1 = no minimum). |
6161
| addSwap | Optionally add this much swap space to the droplet as a factor of total RAM (`RAM * addSwap`). A value of `1` sets a swapfile equal to the available RAM. |
6262
| dockerImage | Docker image to launch
63+
| dockerAdditionalArgs | Additional args to pass to docker run command. For instance `--gpu all` to enable GPU acceleration |
6364
|

‎docs/hetzner.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,4 @@ Example configuration file:
7171
| minImages | Minimum number of images that a dataset needs to have for the autoscaler to be used (-1 = no minimum). |
7272
| addSwap | Optionally add this much swap space to the machine as a factor of total RAM (`RAM * addSwap`). A value of `1` sets a swapfile equal to the available RAM. |
7373
| dockerImage | Docker image to launch |
74+
| dockerAdditionalArgs | Additional args to pass to docker run command. For instance `--gpu all` to enable GPU acceleration |

‎docs/scaleway.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,4 @@ Example configuration file:
6666
| minImages | Minimum number of images that a dataset needs to have for the autoscaler to be used (-1 = no minimum). |
6767
| addSwap | Optionally add this much swap space to the machine as a factor of total RAM (`RAM * addSwap`). A value of `1` sets a swapfile equal to the available RAM. |
6868
| dockerImage | Docker image to launch |
69+
| dockerAdditionalArgs | Additional args to pass to docker run command. For instance `--gpu all` to enable GPU acceleration |

0 commit comments

Comments
 (0)