luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Fix docs up to current standards

Browse source 
Signed-off-by: Nicolas Corrarello <nicolas@corrarello.com>
This commit is contained in:
Nicolas Corrarello 2017-11-29 16:53:42 +00:00
parent b3799697a2
commit 7b14f41872
No known key found for this signature in database
GPG key ID: 6FD0D0E272A30401
1 changed files with 60 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
website/source/api/secret/nomad/index.html.md
View file

@ -52,13 +52,39 @@ $ curl \
https://vault.rocks/v1/nomad/config/access
```
## Read Access Configuration
This endpoint queries for information about the Nomad connection.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `GET` | `/nomad/config/access` | `200 application/json` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
https://vault.rocks/v1/nomad/config/access
```
### Sample Response
```json
[...]
"data": {
"address": "http://localhost:4646/"
}
[...]
```
## Configure Lease
This endpoint configures the lease settings for generated tokens.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `POST` | `/nomad/config/lease` | `204 (empty body)` |
| `POST` | `/nomad/config/lease` | `204 (empty body)` |
### Parameters
@ -85,6 +111,33 @@ $ curl \
https://vault.rocks/v1/nomad/config/lease
```
## Read Lease Configuration
This endpoint queries for information about the Lease TTL for the specified mount.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `GET` | `/nomad/config/lease` | `200 application/json` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
https://vault.rocks/v1/nomad/config/lease
```
### Sample Response
```json
[...]
"data": {
"max_ttl": 86400,
"ttl": 86400
},
[...]
```
## Create/Update Role
This endpoint creates or updates the Nomad role definition in Vault. If the role does not exist, it will be created. If the role already exists, it will receive
@ -157,7 +210,7 @@ $ curl \
```json
{
"auth": null,
[...]
"data": {
"lease": "0s",
"policies": [
@ -165,12 +218,7 @@ $ curl \
],
"token_type": "client"
},
"lease_duration": 0,
"lease_id": "",
"renewable": false,
"request_id": "f4c7ee18-72aa-3b20-a910-93b6274a9dc0",
"warnings": null,
"wrap_info": null
[...]
}
```
@ -196,18 +244,13 @@ $ curl \
```json
{
"auth": null,
[...]
"data": {
"keys": [
"example"
]
},
"lease_duration": 0,
"lease_id": "",
"renewable": false,
"request_id": "d7bb167b-81c5-9606-c214-b34fcda45634",
"warnings": null,
"wrap_info": null
[...]
}
```
@ -260,16 +303,11 @@ $ curl \
```json
{
"auth": null,
[...]
"data": {
"accessor_id": "c834ba40-8d84-b0c1-c084-3a31d3383c03",
"secret_id": "65af6f07-7f57-bb24-cdae-a27f86a894ce"
},
"lease_duration": 2764800,
"lease_id": "nomad/creds/example/c2686da3-2431-b6d6-7bbf-c5b9496dd6d7",
"renewable": true,
"request_id": "37a06ca1-8a1d-7f17-bda8-4661289c392b",
"warnings": null,
"wrap_info": null
[...]
}
```