dc9c8d4e47
recommend .nomad.hcl for job files instead of .nomad (without .hcl) * nomad job init -> example.nomad.hcl * update docs
46 lines
1.5 KiB
Plaintext
46 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'Commands: job init'
|
|
description: |
|
|
The job init command is used to generate a skeleton jobspec template.
|
|
---
|
|
|
|
# Command: job init
|
|
|
|
**Alias: `nomad init`**
|
|
|
|
The `job init` command creates an example [job specification][jobspec] in the
|
|
current directory that demonstrates some common configurations for tasks, task
|
|
groups, runtime constraints, and resource allocation.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad job init [options] [filename]
|
|
```
|
|
|
|
You may optionally supply a filename for the example job to be written to. The
|
|
default filename for the generated file is "example.nomad.hcl".
|
|
|
|
Please refer to the [jobspec] and [drivers] pages to learn how to customize the
|
|
template.
|
|
|
|
## Init Options
|
|
|
|
- `-short`: If set, a minimal jobspec without comments is emitted.
|
|
- `-connect`: If set, the jobspec includes Consul Connect integration.
|
|
- `-template=<template>`: Specifies a predefined template to emit. Must be a Nomad Variable that lives at `nomad/job-templates/<template>` These are commonly created via the UI, and accessible with the -list-templates flag.
|
|
- `-list-templates`: Display a list of possible job templates to pass to -template. Reads from all variables pathed at `nomad/job-templates/<template>`.
|
|
|
|
## Examples
|
|
|
|
Generate an example job file:
|
|
|
|
```shell-session
|
|
$ nomad job init
|
|
Example job file written to example.nomad.hcl
|
|
```
|
|
|
|
[jobspec]: /nomad/docs/job-specification 'Nomad Job Specification'
|
|
[drivers]: /nomad/docs/drivers 'Nomad Task Drivers documentation'
|