Skip to content

Commit

Permalink
Merge pull request #6752 from hashicorp/docs-vault-token_period
Browse files Browse the repository at this point in the history
docs: vault integration docs should reference new token_period field
  • Loading branch information
shoenig committed Dec 2, 2019
2 parents d92aa6d + 7687ac0 commit 76c6437
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions dev/vault/nomad-cluster-role.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"disallowed_policies": "nomad-server",
"explicit_max_ttl": 0,
"token_explicit_max_ttl": 0,
"name": "nomad-cluster",
"orphan": false,
"period": 259200,
"token_period": 259200,
"renewable": true
}
4 changes: 2 additions & 2 deletions e2e/vault/consts_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ var (
// role is the recommended nomad cluster role
role = map[string]interface{}{
"disallowed_policies": "nomad-server",
"explicit_max_ttl": 0,
"explicit_max_ttl": 0, // use old name for vault compatibility
"name": "nomad-cluster",
"orphan": false,
"period": 259200,
"period": 259200, // use old name for vault compatibility
"renewable": true,
}

Expand Down
4 changes: 2 additions & 2 deletions website/source/data/vault/nomad-cluster-role.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"disallowed_policies": "nomad-server",
"explicit_max_ttl": 0,
"token_explicit_max_ttl": 0,
"name": "nomad-cluster",
"orphan": true,
"period": 259200,
"token_period": 259200,
"renewable": true
}
8 changes: 4 additions & 4 deletions website/source/docs/vault-integration/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,10 @@ An example token role definition is given below:
```json
{
"disallowed_policies": "nomad-server",
"explicit_max_ttl": 0,
"token_explicit_max_ttl": 0,
"name": "nomad-cluster",
"orphan": true,
"period": 259200,
"token_period": 259200,
"renewable": true
}
```
Expand Down Expand Up @@ -171,7 +171,7 @@ documentation for all possible fields and more complete documentation.
Nomad. This was remedied in 0.6.5 and does not effect earlier versions
of Vault.

* `explicit_max_ttl` - Specifies the max TTL of a token. **Must be set to `0`** to
* `token_explicit_max_ttl` - Specifies the max TTL of a token. **Must be set to `0`** to
allow periodic tokens.

* `name` - Specifies the name of the policy. We recommend using the name
Expand All @@ -196,7 +196,7 @@ documentation for all possible fields and more complete documentation.
making bootstrapping and upgrading simpler. As such, **setting `orphan = true`
is the recommended setting**.

* `period` - Specifies the length the TTL is extended by each renewal in
* `token_period` - Specifies the length the TTL is extended by each renewal in
seconds. It is suggested to set this value on the order of magnitude of 3 days
(259200 seconds) to avoid a large renewal request rate to Vault. **Must be set
to a positive value**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,10 @@ submitted to Nomad. We will use the following token role:
```json
{
"allowed_policies": "access-tables",
"explicit_max_ttl": 0,
"token_explicit_max_ttl": 0,
"name": "nomad-cluster",
"orphan": true,
"period": 259200,
"token_period": 259200,
"renewable": true
}
```
Expand All @@ -210,10 +210,10 @@ disallowed policies group. An example of this is shown below:
```json
{
"disallowed_policies": "nomad-server",
"explicit_max_ttl": 0,
"token_explicit_max_ttl": 0,
"name": "nomad-cluster",
"orphan": true,
"period": 259200,
"token_period": 259200,
"renewable": true
}
```
Expand Down

0 comments on commit 76c6437

Please sign in to comment.