github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/data/docs-navigation.js (about) 1 // The root folder for this documentation category is `pages/docs` 2 // 3 // - A string refers to the name of a file 4 // - A "category" value refers to the name of a directory 5 // - All directories must have an "index.mdx" file to serve as 6 // the landing page for the category 7 8 export default [ 9 { 10 category: 'install', 11 content: [ 12 'quickstart', 13 { 14 category: 'production', 15 content: [ 16 'requirements', 17 { 18 title: 'Reference Architecture', 19 href: 20 'https://learn.hashicorp.com/tutorials/nomad/production-reference-architecture-vm-with-consul', 21 }, 22 { 23 title: 'Deployment Guide', 24 href: 25 'https://learn.hashicorp.com/tutorials/nomad/production-deployment-guide-vm-with-consul', 26 }, 27 ], 28 }, 29 'windows-service', 30 ], 31 }, 32 { category: 'upgrade', content: ['upgrade-specific'] }, 33 { 34 category: 'integrations', 35 content: ['consul-integration', 'consul-connect', 'vault-integration'], 36 }, 37 '-----------', 38 { 39 category: 'internals', 40 content: [ 41 'architecture', 42 { 43 category: 'plugins', 44 content: ['base', 'task-drivers', 'devices', 'csi'], 45 }, 46 { 47 category: 'scheduling', 48 content: ['scheduling', 'preemption'], 49 }, 50 'consensus', 51 'filesystem', 52 'gossip', 53 'security', 54 ], 55 }, 56 { 57 category: 'configuration', 58 content: [ 59 'acl', 60 'audit', 61 'autopilot', 62 'client', 63 'consul', 64 'plugin', 65 'sentinel', 66 'server', 67 'server_join', 68 'telemetry', 69 'tls', 70 'vault', 71 ], 72 }, 73 { 74 category: 'commands', 75 content: [ 76 { 77 category: 'acl', 78 content: [ 79 'bootstrap', 80 'policy-apply', 81 'policy-delete', 82 'policy-info', 83 'policy-list', 84 'token-create', 85 'token-delete', 86 'token-info', 87 'token-list', 88 'token-self', 89 'token-update', 90 ], 91 }, 92 'agent', 93 'agent-info', 94 { 95 category: 'alloc', 96 content: ['exec', 'fs', 'logs', 'restart', 'signal', 'status', 'stop'], 97 }, 98 { 99 category: 'deployment', 100 content: [ 101 'fail', 102 'list', 103 'pause', 104 'promote', 105 'resume', 106 'status', 107 'unblock', 108 ], 109 }, 110 'eval-status', 111 { 112 category: 'job', 113 content: [ 114 'deployments', 115 'dispatch', 116 'eval', 117 'history', 118 'init', 119 'inspect', 120 'plan', 121 'periodic-force', 122 'promote', 123 'revert', 124 'run', 125 'scale', 126 'scaling-events', 127 'status', 128 'stop', 129 'validate', 130 ], 131 }, 132 { 133 category: 'license', 134 content: ['get', 'put'], 135 }, 136 'monitor', 137 { 138 category: 'namespace', 139 content: ['apply', 'delete', 'inspect', 'list', 'status'], 140 }, 141 { 142 category: 'node', 143 content: ['config', 'drain', 'eligibility', 'status'], 144 }, 145 { 146 category: 'operator', 147 content: [ 148 'autopilot-get-config', 149 'autopilot-set-config', 150 'debug', 151 'keygen', 152 'keyring', 153 'metrics', 154 'raft-list-peers', 155 'raft-remove-peer', 156 'snapshot-agent', 157 'snapshot-inspect', 158 'snapshot-restore', 159 'snapshot-save', 160 ], 161 }, 162 { category: 'plugin', content: ['status'] }, 163 { 164 category: 'quota', 165 content: ['apply', 'delete', 'init', 'inspect', 'list', 'status'], 166 }, 167 { 168 category: 'recommendation', 169 content: ['apply', 'dismiss', 'info', 'list'], 170 }, 171 { category: 'scaling', content: ['policy-info', 'policy-list'] }, 172 { category: 'sentinel', content: ['apply', 'delete', 'list', 'read'] }, 173 { category: 'server', content: ['force-leave', 'join', 'members'] }, 174 'status', 175 { category: 'system', content: ['gc', 'reconcile-summaries'] }, 176 'ui', 177 'version', 178 { 179 category: 'volume', 180 content: ['deregister', 'detach', 'status', 'register'], 181 }, 182 ], 183 }, 184 '----------', 185 { 186 category: 'job-specification', 187 content: [ 188 { 189 category: 'hcl2', 190 content: [ 191 'expressions', 192 { 193 category: 'functions', 194 content: [ 195 { 196 category: 'collection', 197 name: 'Collection Functions', 198 content: [ 199 'chunklist', 200 'coalesce', 201 'coalescelist', 202 'compact', 203 'concat', 204 'contains', 205 'distinct', 206 'element', 207 'flatten', 208 'index-fn', 209 'keys', 210 'length', 211 'lookup', 212 'merge', 213 'range', 214 'reverse', 215 'setintersection', 216 'setproduct', 217 'setunion', 218 'slice', 219 'sort', 220 'values', 221 'zipmap', 222 ], 223 }, 224 { 225 category: 'conversion', 226 name: 'Type Conversion Functions', 227 content: ['can', 'convert', 'try'], 228 }, 229 { 230 category: 'crypto', 231 name: 'Hash and Crypto Functions', 232 content: [ 233 'bcrypt', 234 'md5', 235 'rsadecrypt', 236 'sha1', 237 'sha256', 238 'sha512', 239 ], 240 }, 241 { 242 category: 'datetime', 243 name: 'Date and Time Functions', 244 content: ['formatdate', 'timeadd'], 245 }, 246 { 247 category: 'encoding', 248 name: 'Encoding Functions', 249 content: [ 250 'base64decode', 251 'base64encode', 252 'csvdecode', 253 'jsondecode', 254 'jsonencode', 255 'urlencode', 256 'yamldecode', 257 'yamlencode', 258 ], 259 }, 260 { 261 category: 'file', 262 name: 'Filesystem Functions', 263 content: [ 264 'abspath', 265 'basename', 266 'dirname', 267 'file', 268 'fileexists', 269 'fileset', 270 'pathexpand', 271 ], 272 }, 273 { 274 category: 'ipnet', 275 name: 'IP Network Functions', 276 content: [ 277 'cidrhost', 278 'cidrnetmask', 279 'cidrsubnet', 280 'cidrsubnets', 281 ], 282 }, 283 { 284 category: 'numeric', 285 name: 'Numeric Functions', 286 content: [ 287 'abs', 288 'ceil', 289 'floor', 290 'log', 291 'max', 292 'min', 293 'parseint', 294 'pow', 295 'signum', 296 ], 297 }, 298 { 299 category: 'string', 300 name: 'String Functions', 301 content: [ 302 'chomp', 303 'format', 304 'formatlist', 305 'indent', 306 'join', 307 'lower', 308 'regex_replace', 309 'replace', 310 'split', 311 'strrev', 312 'substr', 313 'title', 314 'trim', 315 'trimprefix', 316 'trimspace', 317 'trimsuffix', 318 'upper', 319 ], 320 }, 321 { 322 category: 'uuid', 323 name: 'UUID Functions', 324 content: ['uuidv4', 'uuidv5'], 325 }, 326 ], 327 }, 328 'locals', 329 'syntax', 330 'variables', 331 ], 332 }, 333 'artifact', 334 'affinity', 335 'check_restart', 336 'connect', 337 'constraint', 338 'csi_plugin', 339 'device', 340 'dispatch_payload', 341 'env', 342 'ephemeral_disk', 343 'expose', 344 'gateway', 345 'group', 346 'job', 347 'lifecycle', 348 'logs', 349 'meta', 350 'migrate', 351 'multiregion', 352 'network', 353 'parameterized', 354 'periodic', 355 'proxy', 356 'reschedule', 357 'resources', 358 'restart', 359 'scaling', 360 'service', 361 'sidecar_service', 362 'sidecar_task', 363 'spread', 364 'task', 365 'template', 366 'update', 367 'upstreams', 368 'vault', 369 'volume', 370 'volume_mount', 371 ], 372 }, 373 { 374 category: 'drivers', 375 content: [ 376 'docker', 377 'exec', 378 'java', 379 'podman', 380 'qemu', 381 'raw_exec', 382 { 383 category: 'external', 384 content: [ 385 'containerd', 386 'firecracker-task-driver', 387 'jail-task-driver', 388 'lxc', 389 'pot', 390 'rkt', 391 'singularity', 392 'nspawn', 393 'iis', 394 ], 395 }, 396 ], 397 }, 398 { 399 category: 'devices', 400 content: [ 401 'nvidia', 402 { 403 category: 'external', 404 content: [ 405 'usb' 406 ] 407 } 408 ], 409 }, 410 'schedulers', 411 { category: 'runtime', content: ['environment', 'interpolation'] }, 412 { 413 category: 'autoscaling', 414 content: [ 415 'agent', 416 'api', 417 'cli', 418 'policy', 419 'telemetry', 420 { 421 category: 'plugins', 422 content: ['apm', 'strategy', 'target'], 423 }, 424 { 425 category: 'internals', 426 content: ['checks'], 427 }, 428 ], 429 }, 430 { 431 category: 'operations', 432 content: [ 433 'nomad-agent', 434 'telemetry', 435 'metrics', 436 { 437 title: 'Cluster Management', 438 href: 'https://learn.hashicorp.com/collections/nomad/manage-clusters', 439 }, 440 { 441 title: 'Transport Security', 442 href: 443 'https://learn.hashicorp.com/collections/nomad/transport-security', 444 }, 445 { 446 title: 'Access Control', 447 href: 'https://learn.hashicorp.com/collections/nomad/access-control', 448 }, 449 ], 450 }, 451 '------------', 452 { 453 category: 'nomad-vs-kubernetes', 454 content: ['alternative', 'supplement'], 455 }, 456 'ecosystem', 457 'who-uses-nomad', 458 'enterprise', 459 'faq', 460 ]