From 4c3cf4c65170aa15b7e7c2c396aadee5efdfe0fb Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Tue, 25 Jun 2024 10:08:51 -0400 Subject: [PATCH] Fix 'API key' link to point to Fleet & Agent instructions (#1138) * Fix 'API key' link to point to Fleet & Agent instructions * small fixes to the API key page * Update tutorials --- .../examples/config-file-example-apache.asciidoc | 4 ++-- .../configuration/examples/config-file-example-nginx.asciidoc | 4 ++-- .../example-standalone-monitor-nginx-ess.asciidoc | 2 +- .../example-standalone-monitor-nginx-serverless.asciidoc | 2 +- .../elastic-agent/grant-access-to-elasticsearch.asciidoc | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-apache.asciidoc b/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-apache.asciidoc index e5190b8e7..efa2f82f7 100644 --- a/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-apache.asciidoc +++ b/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-apache.asciidoc @@ -68,7 +68,7 @@ inputs: <7> <1> For available output settings, refer to <>. <2> For settings specific to the {es} output, refer to <>. <3> The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -<4> An {kibana-ref}/api-keys.html[API key] used to authenticate with the {es} cluster. +<4> An <> used to authenticate with the {es} cluster. <5> For available download settings, refer to <>. <6> For available monitoring settings, refer to <>. <7> For available input settings, refer to <>. @@ -120,7 +120,7 @@ inputs: <7> <1> For available output settings, refer to <>. <2> For settings specific to the {es} output, refer to <>. <3> The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -<4> An {kibana-ref}/api-keys.html[API key] used to authenticate with the {es} cluster. +<4> An <> used to authenticate with the {es} cluster. <5> For available download settings, refer to <>. <6> For available monitoring settings, refer to <>. <7> For available input settings, refer to <>. diff --git a/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-nginx.asciidoc b/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-nginx.asciidoc index e55b99d3a..4258ffa15 100644 --- a/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-nginx.asciidoc +++ b/docs/en/ingest-management/elastic-agent/configuration/examples/config-file-example-nginx.asciidoc @@ -73,7 +73,7 @@ inputs: <7> <1> For available output settings, refer to <>. <2> For settings specific to the {es} output, refer to <>. <3> The URL of the {es} cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -<4> An {kibana-ref}/api-keys.html[API key] used to authenticate with the {es} cluster. +<4> An <> used to authenticate with the {es} cluster. <5> For available download settings, refer to <>. <6> For available monitoring settings, refer to <>. <7> For available input settings, refer to <>. @@ -127,7 +127,7 @@ inputs: <7> <1> For available output settings, refer to <>. <2> For settings specific to the {es} output, refer to <>. <3> The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -<4> An {kibana-ref}/api-keys.html[API key] used to authenticate with the {es} cluster. +<4> An <> used to authenticate with the {es} cluster. <5> For available download settings, refer to <>. <6> For available monitoring settings, refer to <>. <7> For available input settings, refer to <>. diff --git a/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-ess.asciidoc b/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-ess.asciidoc index 9bb95ef15..b98f71ee5 100644 --- a/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-ess.asciidoc +++ b/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-ess.asciidoc @@ -67,7 +67,7 @@ image::images/guide-sign-up-trial.png["Start your free Elastic Cloud trial",widt [discrete] [[nginx-guide-create-api-key-ess]] -=== Step 3: Create an {ecloud} API key +=== Step 3: Create an {es} API key . From the {kib} menu and go to *Stack Management* -> *API keys*. diff --git a/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-serverless.asciidoc b/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-serverless.asciidoc index 72521d366..d0c49f6d8 100644 --- a/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-serverless.asciidoc +++ b/docs/en/ingest-management/elastic-agent/example-standalone-monitor-nginx-serverless.asciidoc @@ -71,7 +71,7 @@ image::images/guide-sign-up-trial.png["Start your free Elastic Cloud trial",widt [discrete] [[nginx-guide-create-api-key-serverless]] -=== Step 3: Create an {ecloud} API key +=== Step 3: Create an {es} API key . When your {serverless-short} project is ready, open the {kib} menu and go to **Project settings** -> **Management -> API keys**. diff --git a/docs/en/ingest-management/elastic-agent/grant-access-to-elasticsearch.asciidoc b/docs/en/ingest-management/elastic-agent/grant-access-to-elasticsearch.asciidoc index 606b6b951..1a2ba1f9a 100644 --- a/docs/en/ingest-management/elastic-agent/grant-access-to-elasticsearch.asciidoc +++ b/docs/en/ingest-management/elastic-agent/grant-access-to-elasticsearch.asciidoc @@ -36,11 +36,11 @@ If you are using link:{serverless-docs}[{serverless-full}], API key authenticati To create an API key for {agent}: -. In an {ecloud} or premises environment, in {kib} navigate to *{stack-manage-app} > API keys* and click *Create API key*. +. In an {ecloud} or on premises environment, in {kib} navigate to *{stack-manage-app} > API keys* and click *Create API key*. + In a {serverless-short} environment, in {kib} navigate to *Project settings* > *Management* > *API keys* and click *Create API key*. -. Enter a name for your API key and select *Restrict privileges* (in a {serverless-short} environment, *Control security privileges*). +. Enter a name for your API key and select *Control security privileges*. . In the role descriptors box, copy and paste the following JSON. This example creates an API key with privileges for ingesting logs, metrics, traces, and synthetics: +