github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/website/pages/api-docs/ui.mdx (about)

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