nomad-client-rs 0.1.2

A HashiCorp Nomad's HTTP API client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Nomad Client

[![License](https://img.shields.io/crates/l/nomad-client-rs)](https://gitlab.com/buildline-gmbh/nomad_client_rs)
[![Lines of code](https://tokei.rs/b1/gitlab/buildline-gmbh/nomad_client_rs?category=code)](https://gitlab.com/buildline-gmbh/nomad_client_rs)
[![Crates.io](https://img.shields.io/crates/v/nomad-client-rs)](https://crates.io/crates/nomad-client-rs)
[![Crates.io](https://img.shields.io/crates/d/nomad-client-rs)](https://crates.io/crates/nomad-client-rs)

Nomad HTTP API Client

## Table of contents

- [Overview](#Overview)
- [Quick start](#Quick-start)
- [Documentation for API Endpoints](#Documentation-for-API-Endpoints)

## Overview

[HTTP API Version](https://developer.hashicorp.com/nomad/api-docs) : v1.4.x

## Quick start

- `cargo add nomad-client-rs`
- Put the package under your project folder and add the following to `Cargo.toml`:

```toml
[dependencies]
nomad-client-rs = "x.x.x"
```

## Documentation for implemented API Endpoints

| Class      | Method                     | HTTP Request                                    |
|------------|----------------------------|-------------------------------------------------|
| client     | client_list_files          | GET /client/fs/ls/{alloc_id}                    |
| client     | client_get_file            | GET /client/fs/cat/{alloc_id}?path={file_path}  |
| client     | client_get_file_info       | GET /client/fs/stat/{alloc_id}?path={file_path} |
| deployment | deployment_list            | GET /deployments                                |
| deployment | deployment_get             | GET /deployments/{id}                           |
| deployment | deployment_allocation_list | GET /deployment/allocations/{id}                |
| deployment | deployment_fail            | POST /deployment/fail/{id}                      |
| event      | events_subscribe           | GET /event/stream                               |         
| job        | job_dispatch               | POST /job/{job_name}/dispatch                   |
| job        | job_parse                  | POST /job/parse                                 |
| namespace  | namespace_list             | GET /namespaces                                 |
| namespace  | namespace_get              | GET /namespace/{namespace}                      |
| namespace  | namespace_create           | POST /namespace                                 |
| namespace  | namespace_delete           | DELETE /namespace/{namespace}                   |
| status     | status_get_peers           | GET /status/peers                               |
| status     | status_get_leader          | GET /status/leader                              |

## ToDo's

- [ ] authentication
- [ ] more tests