diff --git a/website/source/docs/commands/inspect.html.md.erb b/website/source/docs/commands/inspect.html.md.erb new file mode 100644 index 00000000000..8fc5db6b1ed --- /dev/null +++ b/website/source/docs/commands/inspect.html.md.erb @@ -0,0 +1,147 @@ +--- +layout: "docs" +page_title: "Commands: inspect" +sidebar_current: "docs-commands-inspect" +description: > + The inspect command is used to inspect a submitted job. +--- + +# Command: inspect + +The `inspect` command is used to inspect the content of a submitted job. + +## Usage + +``` +nomad inspect [options] +``` + +The `inspect` command requires a single argument, a submitted job's name, and +will retrieve the JSON version of the job. This JSON is valid to be submitted to +the [Job HTTP API](/docs/http/job.html). This command is useful to inspect what +version of a job Nomad is running. + +## General Options + +<%= general_options_usage %> + +## Examples + +Inspect a submitted job: + +``` +$ nomad inspect redis +{ + "Job": { + "Region": "global", + "ID": "redis + "Name": "redis + "Type": "service", + "Priority": 50, + "AllAtOnce": false, + "Datacenters": [ + "dc1" + ], + "Constraints": [ + { + "LTarget": "${attr.kernel.name}", + "RTarget": "linux", + "Operand": "=" + } + ], + "TaskGroups": [ + { + "Name": "cache", + "Count": 1, + "Constraints": null, + "Tasks": [ + { + "Name": "redis", + "Driver": "docker", + "User": "", + "Config": { + "image": "redis:latest", + "port_map": [ + { + "db": 6379 + } + ] + }, + "Constraints": null, + "Env": null, + "Services": [ + { + "Id": "", + "Name": "cache-redis", + "Tags": [ + "global", + "cache" + ], + "PortLabel": "db", + "Checks": [ + { + "Id": "", + "Name": "alive", + "Type": "tcp", + "Command": "", + "Args": null, + "Path": "", + "Protocol": "", + "Interval": 10000000000, + "Timeout": 2000000000 + } + ] + } + ], + "Resources": { + "CPU": 500, + "MemoryMB": 256, + "DiskMB": 300, + "IOPS": 0, + "Networks": [ + { + "Public": false, + "CIDR": "", + "ReservedPorts": null, + "DynamicPorts": [ + { + "Label": "db", + "Value": 0 + } + ], + "IP": "", + "MBits": 10 + } + ] + }, + "Meta": null, + "KillTimeout": 5000000000, + "LogConfig": { + "MaxFiles": 10, + "MaxFileSizeMB": 10 + }, + "Artifacts": null + } + ], + "RestartPolicy": { + "Interval": 300000000000, + "Attempts": 10, + "Delay": 25000000000, + "Mode": "delay" + }, + "Meta": null + } + ], + "Update": { + "Stagger": 10000000000, + "MaxParallel": 1 + }, + "Periodic": null, + "Meta": null, + "Status": "running", + "StatusDescription": "", + "CreateIndex": 5, + "ModifyIndex": 7 + } +} +``` diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 639d478dfff..718a92a16ae 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -126,6 +126,9 @@ > init + > + inspect + > node-drain