-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ebbf836
commit 57b935d
Showing
2 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
layout: docs | ||
page_title: ui Block - Job Specification | ||
description: |- | ||
The "ui" block allows lets users add description and helpful links to their | ||
job page in the Nomad Web UI. | ||
--- | ||
|
||
# `ui` Block | ||
|
||
<Placement | ||
groups={[ | ||
['job', 'ui'], | ||
]} | ||
/> | ||
|
||
The `ui` block provides options to modify the presentation of the Job index page | ||
in the Web UI. When specified, a description and any number of links will be | ||
added to the top of the job page in question. | ||
|
||
The following will provide the Web UI with a job description and a pair of links: | ||
|
||
## `ui` Parameters | ||
|
||
- `description` `(string: "")` - The markdown-enabled description of the job | ||
- `link` `(map<string|string>: nil)` - A link that should show up in the header | ||
of the job index page in the Web UI. A job can have any number of links, and | ||
they must contain both a string `label` and `url`. | ||
|
||
## `ui` Example | ||
|
||
```hcl | ||
job "docs" { | ||
ui { | ||
description = "A job that uses **Nomad Variables**" | ||
link { | ||
label = "Learn more about Nomad" | ||
url = "https://developer.hashicorp.com/nomad" | ||
} | ||
link { | ||
label = "Nomad on Github" | ||
url = "https://github.com/hashicorp/nomad" | ||
} | ||
} | ||
# ... | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters