github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/website/pages/partials/envvars.mdx (about) 1 <table> 2 <thead> 3 <tr> 4 <th>Variable</th> 5 <th>Description</th> 6 </tr> 7 </thead> 8 <tbody> 9 <tr> 10 <td> 11 <code>NOMAD_ALLOC_DIR</code> 12 </td> 13 <td> 14 The path to the shared <code>alloc/</code> directory. See 15 <a href="/docs/runtime/environment#task-directories"> 16 here for more 17 </a> information. 18 </td> 19 </tr> 20 <tr> 21 <td> 22 <code>NOMAD_TASK_DIR</code> 23 </td> 24 <td> 25 The path to the task <code>local/</code> directory. See 26 <a href="/docs/runtime/environment#task-directories">here</a> for more information. 27 </td> 28 </tr> 29 <tr> 30 <td> 31 <code>NOMAD_SECRETS_DIR</code> 32 </td> 33 <td> 34 Path to the task's secrets directory. See 35 <a href="/docs/runtime/environment#task-directories">here</a> for more information. 36 </td> 37 </tr> 38 <tr> 39 <td> 40 <code>NOMAD_MEMORY_LIMIT</code> 41 </td> 42 <td>Memory limit in MB for the task</td> 43 </tr> 44 <tr> 45 <td> 46 <code>NOMAD_CPU_LIMIT</code> 47 </td> 48 <td>CPU limit in MHz for the task</td> 49 </tr> 50 <tr> 51 <td> 52 <code>NOMAD_ALLOC_ID</code> 53 </td> 54 <td>Allocation ID of the task</td> 55 </tr> 56 <tr> 57 <td> 58 <code>NOMAD_ALLOC_NAME</code> 59 </td> 60 <td>Allocation name of the task</td> 61 </tr> 62 <tr> 63 <td> 64 <code>NOMAD_ALLOC_INDEX</code> 65 </td> 66 <td> 67 Allocation index; useful to distinguish instances of task groups. From 0 68 to (count - 1). The index is unique within a given version of a job, but 69 canaries or failed tasks in a deployment may reuse the index. 70 </td> 71 </tr> 72 <tr> 73 <td> 74 <code>NOMAD_TASK_NAME</code> 75 </td> 76 <td>Task's name</td> 77 </tr> 78 <tr> 79 <td> 80 <code>NOMAD_GROUP_NAME</code> 81 </td> 82 <td>Group's name</td> 83 </tr> 84 <tr> 85 <td> 86 <code>NOMAD_JOB_NAME</code> 87 </td> 88 <td>Job's name</td> 89 </tr> 90 <tr> 91 <td> 92 <code>NOMAD_DC</code> 93 </td> 94 <td>Datacenter in which the allocation is running</td> 95 </tr> 96 <tr> 97 <td> 98 <code>NOMAD_NAMESPACE</code> 99 </td> 100 <td>Namespace in which the allocation is running</td> 101 </tr> 102 <tr> 103 <td> 104 <code>NOMAD_REGION</code> 105 </td> 106 <td>Region in which the allocation is running</td> 107 </tr> 108 <tr> 109 <td> 110 <code>NOMAD_META_<key></code> 111 </td> 112 <td> 113 The metadata value given by <code>key</code> on the task's metadata. 114 Note that this is different from 115 <a href="/docs/runtime/interpolation#node-variables-"> 116 <code>${meta.<key>}</code> 117 </a> 118 which are keys in the node's metadata. 119 </td> 120 </tr> 121 <tr> 122 <td> 123 <code>VAULT_TOKEN</code> 124 </td> 125 <td> 126 The task's Vault token. See 127 <a href="/docs/vault-integration">Vault Integration</a> 128 for more details 129 </td> 130 </tr> 131 <tr> 132 <th colspan="2">Network-related Variables</th> 133 </tr> 134 <tr> 135 <td> 136 <code>NOMAD_IP_<label></code> 137 </td> 138 <td> 139 Host IP for the given port <code>label</code>. See 140 <a href="/docs/job-specification/network">here for more</a> information. 141 </td> 142 </tr> 143 <tr> 144 <td> 145 <code>NOMAD_PORT_<label></code> 146 </td> 147 <td> 148 Port for the given port <code>label</code>. Driver-specified port when a 149 port map is used, otherwise the host's static or dynamic port 150 allocation. Services should bind to this port. See 151 <a href="/docs/job-specification/network">here for more</a> information. 152 </td> 153 </tr> 154 <tr> 155 <td> 156 <code>NOMAD_ADDR_<label></code> 157 </td> 158 <td> 159 Host <code>IP:Port</code> pair for the given port <code>label</code>. 160 </td> 161 </tr> 162 <tr> 163 <td> 164 <code>NOMAD_HOST_PORT_<label></code> 165 </td> 166 <td> 167 Port on the host for the port <code>label</code>. See 168 <a href="/docs/job-specification/network#mapped-ports">here</a> for more 169 information. 170 </td> 171 </tr> 172 <tr> 173 <td> 174 <code>NOMAD_IP_<task>_<label></code> 175 </td> 176 <td> 177 Host IP for the given port <code>label</code> and <code>task</code> for 178 tasks in the same task group. 179 </td> 180 </tr> 181 <tr> 182 <td> 183 <code>NOMAD_PORT_<task>_<label></code> 184 </td> 185 <td> 186 Port for the given port <code>label</code> and <code>task</code> for 187 tasks in the same task group. Driver-specified port when a port map is 188 used, otherwise the host's static or dynamic port allocation. Services 189 should bind to this port. 190 </td> 191 </tr> 192 <tr> 193 <td> 194 <code>NOMAD_ADDR_<task>_<label></code> 195 </td> 196 <td> 197 Host <code>IP:Port</code> pair for the given port <code>label</code> and 198 <code>task</code> for tasks in the same task group. 199 </td> 200 </tr> 201 <tr> 202 <td> 203 <code>NOMAD_HOST_PORT_<task>_<label></code> 204 </td> 205 <td> 206 Port on the host for the port <code>label</code> and <code>task</code> 207 for tasks in the same task group. 208 </td> 209 </tr> 210 <tr> 211 <td> 212 <code>NOMAD_UPSTREAM_IP_<service></code> 213 </td> 214 <td> 215 IP for the given <code>service</code> when defined as a Consul Connect 216 <a href="/docs/job-specification/upstreams">upstream</a>. 217 </td> 218 </tr> 219 <tr> 220 <td> 221 <code>NOMAD_UPSTREAM_PORT_<service></code> 222 </td> 223 <td> 224 Port for the given <code>service</code> when defined as a Consul Connect 225 <a href="/docs/job-specification/upstreams">upstream</a>. 226 </td> 227 </tr> 228 <tr> 229 <td> 230 <code>NOMAD_UPSTREAM_ADDR_<service></code> 231 </td> 232 <td> 233 Host <code>IP:Port</code> for the given <code>service</code> when 234 defined as a Consul Connect 235 <a href="/docs/job-specification/upstreams">upstream</a>. 236 </td> 237 </tr> 238 <tr> 239 <td> 240 <code>NOMAD_ENVOY_ADMIN_ADDR_<service></code> 241 </td> 242 <td> 243 Local address <code>localhost:Port</code> for the admin port of the 244 envoy sidecar for the given <code>service</code> when defined as a 245 Consul Connect enabled service. 246 </td> 247 </tr> 248 </tbody> 249 </table>