From 7ada899ee2137df334ec8d0ca88ebae3ab49e04c Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Thu, 17 Sep 2020 10:46:24 -0700 Subject: [PATCH] docs: link to APM privs for API keys (#20911) --- libbeat/docs/command-reference.asciidoc | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/libbeat/docs/command-reference.asciidoc b/libbeat/docs/command-reference.asciidoc index 1c1ab339f28..86c94cf9234 100644 --- a/libbeat/docs/command-reference.asciidoc +++ b/libbeat/docs/command-reference.asciidoc @@ -156,18 +156,7 @@ Create an API Key with the specified privilege(s). No required flags. + The user requesting to create an API Key needs to have APM privileges used by the APM Server. A superuser, by default, has these privileges. For other users, -you can create them. Create a role that is then assigned to the user: -+ -["source","sh",subs="attributes"] ----- -PUT /_security/role/apm-privileges { - "applications": [{ - "application": "apm", - "privileges": ["sourcemap:write", "event:write", "config_agent:read"], - "resources": ["*"] - }] -} ----- +you can create them. See <> for required privileges. *`info`*:: Query API Key(s). `--id` or `--name` required. @@ -252,7 +241,7 @@ the credentials required by your cloud service provider. ---- *`FUNCTION_NAME`*:: -Specifies the name of the function to deploy. +Specifies the name of the function to deploy. *FLAGS* @@ -498,7 +487,7 @@ ifeval::["{beatname_lc}"=="functionbeat"] [[package-command]] ==== `package` command -{package-command-short-desc}. +{package-command-short-desc}. *SYNOPSIS* @@ -513,7 +502,7 @@ ifeval::["{beatname_lc}"=="functionbeat"] Shows help for the `package` command. *`-o, --output`*:: -Specifies the full path pattern to use when creating the packages. +Specifies the full path pattern to use when creating the packages. {global-flags} @@ -538,7 +527,7 @@ the credentials required by your cloud service provider. ---- *`FUNCTION_NAME`*:: -Specifies the name of the function to remove. +Specifies the name of the function to remove. *FLAGS* @@ -949,7 +938,7 @@ the credentials required by your cloud service provider. ---- *`FUNCTION_NAME`*:: -Specifies the name of the function to update. +Specifies the name of the function to update. *FLAGS*