nomad-client-rs 0.3.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# 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)
- [Usage](#usage)
  - [Implemented API Endpoints](#implemented-api-endpoints)
- [Environment](#environment)
    - [Variables](#variables)

## Overview

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

## Quick start

Install the package over cli

```bash
cargo add nomad-client-rs
```

or add the following to your `Cargo.toml`

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

## Usage

Default nomad client uses [environment variables / default values](#variables)

```rust
let client = NomadClient::default();
```

Nomad client with custom config

```rust
let client_config = Config {
  base_url: "http://example".into(),
  port: 1234,
  api_version: "v1".into(),
  token: None,
};

let client = NomadClient::new(client_config);
```

### Implemented API Endpoints

| Class      | Method                     | HTTP Request                                    |
|------------|----------------------------|-------------------------------------------------|
| allocation | allocation_restart         | POST /client/allocation/{alloc_id}/restart      |
| client     | client_list_files          | GET /client/fs/ls/{alloc_id}?path={file_path}   |
| 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                                 |
| job        | job_create                 | POST /jobs                                      |
| job        | job_list_allocations       | GET /job/{job_name}/allocations                 |
| 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                              |
| variable   | variables_list             | GET /vars                                       |
| variable   | variable_get               | GET /var/{var_path}                             |
| variable   | variable_create            | PUT /var/{var_path}                             |
| variable   | variable_delete            | DELETE /var/{var_path}                          |

## Environment

### Variables

NomadClient can be configured by env variables. <br/>
If env variable is not available it will use specified default value.

| Variable           | Default          |
|--------------------|------------------|
| NOMAD_BASE_URL     | http://localhost |
| NOMAD_PORT         | 4646             |
| NOMAD_API_VERSION  | v1               |
| NOMAD_SECRET_TOKEN |                  |