github.com/hspak/nomad@v0.7.2-0.20180309000617-bc4ae22a39a5/website/source/api/ui.html.md (about)

     1  ---
     2  layout: api
     3  page_title: UI
     4  sidebar_current: ui
     5  description: |-
     6    The /ui namespace is used to access the Nomad web user interface.
     7  ---
     8  
     9  # Nomad Web UI
    10  
    11  Starting in v0.7, the Nomad UI is accessible at `/ui`. It is not namespaced by version. A request to `/`
    12  will also redirect to `/ui`.
    13  
    14  
    15  ## List Jobs
    16  
    17  This page lists all known jobs in a paginated, searchable, and sortable table.
    18  
    19  | Path       | Produces    |
    20  | ---------- | ----------- |
    21  | `/ui/jobs` | `text/html` |
    22  
    23  ### Parameters
    24  
    25  - `namespace` `(string: "")` - Specifies the namespace all jobs should be a member
    26    of. This is specified as a querystring parameter. Namespaces are an enterprise feature.
    27  
    28  - `sort` `(string: "")` - Specifies the property the list of jobs should be sorted by.
    29    This is specified as a querystring parameter.
    30  
    31  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
    32    or ascending. This is specified as a querystring parameter.
    33  
    34  - `search` `(string: "")` - Specifies a regular expression uses to filter the list of
    35    visible jobs. This is specified as a querystring parameter.
    36  
    37  - `page` `(int: 0)` - Specifies the page in the jobs list that should be visible. This
    38    is specified as a querystring parameter.
    39  
    40  
    41  ## Job Detail
    42  
    43  This page shows an overview of a specific job. Details include name, status, type,
    44  priority, allocation statuses, and task groups. Additionally, if there is a running
    45  deployment for the job, it will be shown on the overview.
    46  
    47  | Path               | Produces    |
    48  | ------------------ | ----------- |
    49  | `/ui/jobs/:job_id` | `text/html` |
    50  
    51  ### Parameters
    52  
    53  - `sort` `(string: "")` - Specifies the property the list of task groups should be
    54    sorted by. This is specified as a querystring parameter.
    55  
    56  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
    57    or ascending. This is specified as a querystring parameter.
    58  
    59  - `page` `(int: 0)` - Specifies the page in the task groups list that should be visible. This
    60    is specified as a querystring parameter.
    61  
    62  
    63  ### Job Definition
    64  
    65  This page shows the definition of a job as pretty-printed, syntax-highlighted, JSON.
    66  
    67  | Path                          | Produces    |
    68  | ----------------------------- | ----------- |
    69  | `/ui/jobs/:job_id/definition` | `text/html` |
    70  
    71  
    72  ### Job Versions
    73  
    74  This page lists all available versions for a job in a timeline view. Each version in
    75  the timeline can be expanded to show a pretty-printed, syntax-highlighted diff between
    76  job versions.
    77  
    78  | Path                          | Produces    |
    79  | ----------------------------- | ----------- |
    80  | `/ui/jobs/:job_id/versions`   | `text/html` |
    81  
    82  
    83  ### Job Deployments
    84  
    85  This page lists all available deployments for a job when the job has deployments. The
    86  deployments are listed in a timeline view. Each deployment shows pertinent information
    87  such as deployment ID, status, associated version, and submit time. Each deployment can
    88  also be expanded to show detail information regarding canary placements, allocation
    89  placements, healthy and unhealthy allocations, as well the current description for the
    90  status. A table of task groups is also present in the detail view, which shows allocation
    91  metrics by task group. Lastly, each expanded deployment lists all associated allocations
    92  in a table to drill into for task events.
    93  
    94  | Path                             | Produces    |
    95  | -------------------------------- | ----------- |
    96  | `/ui/jobs/:job_id/deployments`   | `text/html` |
    97  
    98  
    99  ## Task Group Detail
   100  
   101  This page shows an overview of a specific task group. Details include the number of tasks, the aggregated amount of reserved CPU, memory, and disk, all associated allocations broken
   102  down by status, and a list of allocations. The list of allocations include details such as
   103  status, the node the allocation was placed on, and the current CPU and Memory usage of the
   104  allocations.
   105  
   106  | Path                                | Produces    |
   107  | ----------------------------------- | ----------- |
   108  | `/ui/jobs/:job_id/:task_group_name` | `text/html` |
   109  
   110  ### Parameters
   111  
   112  - `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
   113    This is specified as a querystring parameter.
   114  
   115  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
   116    or ascending. This is specified as a querystring parameter.
   117  
   118  - `search` `(string: "")` - Specifies a regular expression uses to filter the list of
   119    visible allocations. This is specified as a querystring parameter.
   120  
   121  - `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
   122    is specified as a querystring parameter.
   123  
   124  
   125  ## Allocation Detail
   126  
   127  This page shows details and events for an allocation. Details include the job the allocation
   128  belongs to, the node the allocation is placed on, a list of all tasks, and lists of task
   129  events per task. Each task in the task list includes the task name, state, last event, time,
   130  and addresses. Each task event in a task history list includes the time, type, and
   131  description of the event.
   132  
   133  | Path                        | Produces    |
   134  | --------------------------- | ----------- |
   135  | `/ui/allocations/:alloc_id` | `text/html` |
   136  
   137  ### Parameters
   138  
   139  - `sort` `(string: "")` - Specifies the property the list of tasks should be sorted by.
   140    This is specified as a querystring parameter.
   141  
   142  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
   143    or ascending. This is specified as a querystring parameter.
   144  
   145  
   146  ## Nodes List
   147  
   148  This page lists all nodes in the Nomad cluster in a sortable, searchable, paginated
   149  table.
   150  
   151  | Path        | Produces    |
   152  | ----------- | ----------- |
   153  | `/ui/nodes` | `text/html` |
   154  
   155  ### Parameters
   156  
   157  - `sort` `(string: "")` - Specifies the property the list of client nodes should be sorted by.
   158    This is specified as a querystring parameter.
   159  
   160  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
   161    or ascending. This is specified as a querystring parameter.
   162  
   163  - `search` `(string: "")` - Specifies a regular expression uses to filter the list of
   164    visible client nodes. This is specified as a querystring parameter.
   165  
   166  - `page` `(int: 0)` - Specifies the page in the client nodes list that should be visible. This
   167    is specified as a querystring parameter.
   168  
   169  
   170  ## Node Detail
   171  
   172  This page shows the details of a node, including the node name, status, full ID,
   173  address, port, datacenter, allocations, and attributes.
   174  
   175  | Path                 | Produces    |
   176  | -------------------- | ----------- |
   177  | `/ui/nodes/:node_id` | `text/html` |
   178  
   179  ### Parameters
   180  
   181  - `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by.
   182    This is specified as a querystring parameter.
   183  
   184  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
   185    or ascending. This is specified as a querystring parameter.
   186  
   187  - `search` `(string: "")` - Specifies a regular expression uses to filter the list of
   188    visible allocations. This is specified as a querystring parameter.
   189  
   190  - `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This
   191    is specified as a querystring parameter.
   192  
   193  
   194  ## Servers List
   195  
   196  This page lists all servers in the Nomad cluster in a sortable table. Details for each
   197  server include the server status, address, port, datacenter, and whether or not it is
   198  the leader.
   199  
   200  | Path          | Produces    |
   201  | ------------- | ----------- |
   202  | `/ui/servers` | `text/html` |
   203  
   204  ### Parameters
   205  
   206  - `sort` `(string: "")` - Specifies the property the list of server agents should be sorted by.
   207    This is specified as a querystring parameter.
   208  
   209  - `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending
   210    or ascending. This is specified as a querystring parameter.
   211  
   212  - `page` `(int: 0)` - Specifies the page in the server agents list that should be visible. This
   213    is specified as a querystring parameter.
   214  
   215  
   216  ## Server Detail
   217  
   218  This page lists all tags associated with a server.
   219  
   220  | Path                     | Produces    |
   221  | ------------------------ | ----------- |
   222  | `/ui/servers/:server_id` | `text/html` |
   223  
   224  
   225  ## ACL Tokens
   226  
   227  This page lets you enter an ACL token (both accessor ID and secret ID) to use with the UI.
   228  If the cluster does not have ACLs enabled, this page is unnecessary. If the cluster has an
   229  anonymous policy that grants cluster-wide read access, this page is unnecessary. If the
   230  anonymous policy only grants partial read access, then providing an ACL Token will
   231  authenticate all future requests to allow read access to additional resources.
   232  
   233  | Path                  | Produces    |
   234  | --------------------- | ----------- |
   235  | `/ui/settings/tokens` | `text/html` |