From e89a55ec2784e84a96dc95a4944f543dfa277a1c Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Mon, 29 Oct 2018 13:12:48 -0400 Subject: [PATCH] website: add missing `@` to example (#5560) * website: remove mention of `@` in command The command does not contain the mentioned `@` symbol and can be confusing. * docs: use `policy-name` instead of `my-policy` Just making things consistent. --- website/source/docs/concepts/policies.html.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/website/source/docs/concepts/policies.html.md b/website/source/docs/concepts/policies.html.md index aea8b131fa..e053ff6993 100644 --- a/website/source/docs/concepts/policies.html.md +++ b/website/source/docs/concepts/policies.html.md @@ -564,10 +564,6 @@ policy in Vault: $ vault policy write policy-name policy-file.hcl ``` --> The `@` tells Vault to read from a file on disk. In the example above, Vault --will read the contents of `my-policy.hcl` in the current working directory into --the value for that parameter. - or via the API: ```sh @@ -575,10 +571,10 @@ $ curl \ --request POST \ --header "X-Vault-Token: ..." \ --data '{"policy":"path \"...\" {...} "}' \ - https://vault.hashicorp.rocks/v1/sys/policy/my-policy + https://vault.hashicorp.rocks/v1/sys/policy/policy-name ``` -In both examples, the name of the policy is "my-policy". You can think of this +In both examples, the name of the policy is "policy-name". You can think of this name as a pointer or symlink to the policy ACLs. Tokens are attached policies by name, which are then mapped to the set of rules corresponding to that name. @@ -607,7 +603,7 @@ $ curl \ Existing policies may be deleted via the CLI or API. To delete a policy: ```sh -$ vault delete sys/policy/my-policy +$ vault delete sys/policy/policy-name ``` or via the API: @@ -616,7 +612,7 @@ or via the API: $ curl \ --request DELETE \ --header "X-Vault-Token: ..." \ - https://vault.hashicorp.rocks/v1/sys/policy/my-policy + https://vault.hashicorp.rocks/v1/sys/policy/policy-name ``` This is an idempotent operation. Vault will not return an error when deleting a