From 4f1890b5feabcec4f440f6f035f617941317dac0 Mon Sep 17 00:00:00 2001 From: Seth Hoenig Date: Thu, 21 Nov 2019 14:18:06 -0600 Subject: [PATCH 1/2] docs: vault integration docs should reference new token_period field --- dev/vault/nomad-cluster-role.json | 2 +- website/source/data/vault/nomad-cluster-role.json | 2 +- website/source/docs/vault-integration/index.html.md | 4 ++-- .../guides/integrations/vault-integration/index.html.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/dev/vault/nomad-cluster-role.json b/dev/vault/nomad-cluster-role.json index 37728363f..3017ae36e 100644 --- a/dev/vault/nomad-cluster-role.json +++ b/dev/vault/nomad-cluster-role.json @@ -3,6 +3,6 @@ "explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": false, - "period": 259200, + "token_period": 259200, "renewable": true } diff --git a/website/source/data/vault/nomad-cluster-role.json b/website/source/data/vault/nomad-cluster-role.json index dc2621524..21909d50c 100644 --- a/website/source/data/vault/nomad-cluster-role.json +++ b/website/source/data/vault/nomad-cluster-role.json @@ -3,6 +3,6 @@ "explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": true, - "period": 259200, + "token_period": 259200, "renewable": true } diff --git a/website/source/docs/vault-integration/index.html.md b/website/source/docs/vault-integration/index.html.md index fff3434f1..0871043db 100644 --- a/website/source/docs/vault-integration/index.html.md +++ b/website/source/docs/vault-integration/index.html.md @@ -141,7 +141,7 @@ An example token role definition is given below: "explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": true, - "period": 259200, + "token_period": 259200, "renewable": true } ``` @@ -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**. diff --git a/website/source/guides/integrations/vault-integration/index.html.md b/website/source/guides/integrations/vault-integration/index.html.md index 07b5c1c8f..3803efcf9 100644 --- a/website/source/guides/integrations/vault-integration/index.html.md +++ b/website/source/guides/integrations/vault-integration/index.html.md @@ -192,7 +192,7 @@ submitted to Nomad. We will use the following token role: "explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": true, - "period": 259200, + "token_period": 259200, "renewable": true } ``` @@ -213,7 +213,7 @@ disallowed policies group. An example of this is shown below: "explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": true, - "period": 259200, + "token_period": 259200, "renewable": true } ``` From 7687ac0e3aeb36b9b18a8e2d973256c8890cded7 Mon Sep 17 00:00:00 2001 From: Seth Hoenig Date: Mon, 2 Dec 2019 13:09:58 -0600 Subject: [PATCH 2/2] docs: vault integration docs should reference new token_explicit_max_ttl field --- dev/vault/nomad-cluster-role.json | 2 +- e2e/vault/consts_test.go | 4 ++-- website/source/data/vault/nomad-cluster-role.json | 2 +- website/source/docs/vault-integration/index.html.md | 4 ++-- .../guides/integrations/vault-integration/index.html.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dev/vault/nomad-cluster-role.json b/dev/vault/nomad-cluster-role.json index 3017ae36e..69403f042 100644 --- a/dev/vault/nomad-cluster-role.json +++ b/dev/vault/nomad-cluster-role.json @@ -1,6 +1,6 @@ { "disallowed_policies": "nomad-server", - "explicit_max_ttl": 0, + "token_explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": false, "token_period": 259200, diff --git a/e2e/vault/consts_test.go b/e2e/vault/consts_test.go index f62eae073..2ad417895 100644 --- a/e2e/vault/consts_test.go +++ b/e2e/vault/consts_test.go @@ -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, } diff --git a/website/source/data/vault/nomad-cluster-role.json b/website/source/data/vault/nomad-cluster-role.json index 21909d50c..033ea30c1 100644 --- a/website/source/data/vault/nomad-cluster-role.json +++ b/website/source/data/vault/nomad-cluster-role.json @@ -1,6 +1,6 @@ { "disallowed_policies": "nomad-server", - "explicit_max_ttl": 0, + "token_explicit_max_ttl": 0, "name": "nomad-cluster", "orphan": true, "token_period": 259200, diff --git a/website/source/docs/vault-integration/index.html.md b/website/source/docs/vault-integration/index.html.md index 0871043db..7faeefc14 100644 --- a/website/source/docs/vault-integration/index.html.md +++ b/website/source/docs/vault-integration/index.html.md @@ -138,7 +138,7 @@ 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, "token_period": 259200, @@ -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 diff --git a/website/source/guides/integrations/vault-integration/index.html.md b/website/source/guides/integrations/vault-integration/index.html.md index 3803efcf9..744beac7a 100644 --- a/website/source/guides/integrations/vault-integration/index.html.md +++ b/website/source/guides/integrations/vault-integration/index.html.md @@ -189,7 +189,7 @@ 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, "token_period": 259200, @@ -210,7 +210,7 @@ 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, "token_period": 259200,