From a6e845ee1158d34b611f58747456004c5ab9c6d4 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:23:34 -0500 Subject: [PATCH 01/13] Rename these files to reflect new API --- ...asciidoc => delete-ip-location-database.asciidoc} | 0 ...se.asciidoc => get-ip-location-database.asciidoc} | 0 docs/reference/ingest/apis/index.asciidoc | 12 ++++++------ ...se.asciidoc => put-ip-location-database.asciidoc} | 0 4 files changed, 6 insertions(+), 6 deletions(-) rename docs/reference/ingest/apis/{delete-geoip-database.asciidoc => delete-ip-location-database.asciidoc} (100%) rename docs/reference/ingest/apis/{get-geoip-database.asciidoc => get-ip-location-database.asciidoc} (100%) rename docs/reference/ingest/apis/{put-geoip-database.asciidoc => put-ip-location-database.asciidoc} (100%) diff --git a/docs/reference/ingest/apis/delete-geoip-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc similarity index 100% rename from docs/reference/ingest/apis/delete-geoip-database.asciidoc rename to docs/reference/ingest/apis/delete-ip-location-database.asciidoc diff --git a/docs/reference/ingest/apis/get-geoip-database.asciidoc b/docs/reference/ingest/apis/get-ip-location-database.asciidoc similarity index 100% rename from docs/reference/ingest/apis/get-geoip-database.asciidoc rename to docs/reference/ingest/apis/get-ip-location-database.asciidoc diff --git a/docs/reference/ingest/apis/index.asciidoc b/docs/reference/ingest/apis/index.asciidoc index e068f99ea0ad3..15cd50561f772 100644 --- a/docs/reference/ingest/apis/index.asciidoc +++ b/docs/reference/ingest/apis/index.asciidoc @@ -32,9 +32,9 @@ preview::["The commercial IP geolocation database download management APIs are i Use the following APIs to configure and manage commercial IP geolocation database downloads: -* <> to create or update a database configuration -* <> to retrieve a database configuration -* <> to delete a database configuration +* <> to create or update a database configuration +* <> to retrieve a database configuration +* <> to delete a database configuration include::put-pipeline.asciidoc[] include::get-pipeline.asciidoc[] @@ -42,6 +42,6 @@ include::delete-pipeline.asciidoc[] include::simulate-pipeline.asciidoc[] include::simulate-ingest.asciidoc[] include::geoip-stats.asciidoc[] -include::put-geoip-database.asciidoc[] -include::get-geoip-database.asciidoc[] -include::delete-geoip-database.asciidoc[] +include::put-ip-location-database.asciidoc[] +include::get-ip-location-database.asciidoc[] +include::delete-ip-location-database.asciidoc[] diff --git a/docs/reference/ingest/apis/put-geoip-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc similarity index 100% rename from docs/reference/ingest/apis/put-geoip-database.asciidoc rename to docs/reference/ingest/apis/put-ip-location-database.asciidoc From cb4dd543fa2c0f628d946f3a0c1e4624963c95b5 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:24:09 -0500 Subject: [PATCH 02/13] Change the header for these APIs and remove the technical preview note --- docs/reference/ingest/apis/index.asciidoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/reference/ingest/apis/index.asciidoc b/docs/reference/ingest/apis/index.asciidoc index 15cd50561f772..35adc47821978 100644 --- a/docs/reference/ingest/apis/index.asciidoc +++ b/docs/reference/ingest/apis/index.asciidoc @@ -25,10 +25,8 @@ Use the following APIs to get statistics about ingest processing: the <>. [discrete] -[[ingest-geoip-database-apis]] -=== Ingest GeoIP Database APIs - -preview::["The commercial IP geolocation database download management APIs are in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but this feature is not subject to the support SLA of official GA features."] +[[ingest-ip-location-database-apis]] +=== Ingest IP Location Database APIs Use the following APIs to configure and manage commercial IP geolocation database downloads: From 651bff7bcb262336a4d971117dce4f35887f79b8 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:27:34 -0500 Subject: [PATCH 03/13] Update the slugs to reflect the new API names --- .../apis/delete-ip-location-database.asciidoc | 14 +++++++------- .../apis/get-ip-location-database.asciidoc | 14 +++++++------- .../apis/put-ip-location-database.asciidoc | 18 +++++++++--------- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc index 957e59f0f0de4..13136d9b87c81 100644 --- a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc @@ -1,4 +1,4 @@ -[[delete-geoip-database-api]] +[[delete-ip-location-database-api]] === Delete geoip database configuration API ++++ Delete geoip database configuration @@ -13,18 +13,18 @@ DELETE /_ingest/geoip/database/my-database-id // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] -[[delete-geoip-database-api-request]] +[[delete-ip-location-database-api-request]] ==== {api-request-title} `DELETE /_ingest/geoip/database/` -[[delete-geoip-database-api-prereqs]] +[[delete-ip-location-database-api-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have the `manage` <> to use this API. -[[delete-geoip-database-api-path-params]] +[[delete-ip-location-database-api-path-params]] ==== {api-path-parms-title} ``:: @@ -35,17 +35,17 @@ DELETE /_ingest/geoip/database/my-database-id -- -[[delete-geoip-database-api-query-params]] +[[delete-ip-location-database-api-query-params]] ==== {api-query-parms-title} include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -[[delete-geoip-database-api-example]] +[[delete-ip-location-database-api-example]] ==== {api-examples-title} -[[delete-geoip-database-api-specific-ex]] +[[delete-ip-location-database-api-specific-ex]] ===== Delete a specific geoip database configuration [source,console] diff --git a/docs/reference/ingest/apis/get-ip-location-database.asciidoc b/docs/reference/ingest/apis/get-ip-location-database.asciidoc index f055e3e759db8..8b325ca2f23e0 100644 --- a/docs/reference/ingest/apis/get-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/get-ip-location-database.asciidoc @@ -1,4 +1,4 @@ -[[get-geoip-database-api]] +[[get-ip-location-database-api]] === Get geoip database configuration API ++++ Get geoip database configuration @@ -14,20 +14,20 @@ GET /_ingest/geoip/database/my-database-id -[[get-geoip-database-api-request]] +[[get-ip-location-database-api-request]] ==== {api-request-title} `GET /_ingest/geoip/database/` `GET /_ingest/geoip/database` -[[get-geoip-database-api-prereqs]] +[[get-ip-location-database-api-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have the `manage` <> to use this API. -[[get-geoip-database-api-path-params]] +[[get-ip-location-database-api-path-params]] ==== {api-path-parms-title} ``:: @@ -38,17 +38,17 @@ supported. To get all database configurations, omit this parameter or use `*`. -[[get-geoip-database-api-query-params]] +[[get-ip-location-database-api-query-params]] ==== {api-query-parms-title} include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] -[[get-geoip-database-api-example]] +[[get-ip-location-database-api-example]] ==== {api-examples-title} -[[get-geoip-database-api-specific-ex]] +[[get-ip-location-database-api-specific-ex]] ===== Get information for a specific geoip database configuration [source,console] diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 311c303002387..be6c845f88476 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -1,4 +1,4 @@ -[[put-geoip-database-api]] +[[put-ip-location-database-api]] === Create or update geoip database configuration API ++++ Create or update geoip database configuration @@ -23,19 +23,19 @@ PUT _ingest/geoip/database/my-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] -[[put-geoip-database-api-request]] +[[put-ip-location-database-api-request]] ==== {api-request-title} `PUT /_ingest/geoip/database/` -[[put-geoip-database-api-prereqs]] +[[put-ip-location-database-api-prereqs]] ==== {api-prereq-title} * If the {es} {security-features} are enabled, you must have the `manage` <> to use this API. -[[put-geoip-database-api-path-params]] +[[put-ip-location-database-api-path-params]] ==== {api-path-parms-title} ``:: @@ -43,15 +43,15 @@ PUT _ingest/geoip/database/my-database-id __ (Required, string) ID of the database configuration to create or update. -[[put-geoip-database-api-query-params]] +[[put-ip-location-database-api-query-params]] ==== {api-query-parms-title} include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] -[[put-geoip-database-api-request-body]] +[[put-ip-location-database-api-request-body]] ==== {api-request-body-title} -// tag::geoip-database-object[] +// tag::ip-location-database-object[] `name`:: (Required, string) The provider-assigned name of the IP geolocation database to download. @@ -63,9 +63,9 @@ the database, as well as any provider-specific configuration necessary for such + At present, the only supported provider is `maxmind`, and the maxmind provider requires that an `account_id` (string) is configured. -// end::geoip-database-object[] +// end::ip-location-database-object[] -[[geoip-database-configuration-licensing]] +[[ip-location-database-configuration-licensing]] ==== Licensing Downloading databases from third party providers is a commercial feature that requires an From 0fbacfb4189a46926edc21d1018f7316cb90a696 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:30:40 -0500 Subject: [PATCH 04/13] Use a value that reads more like an example here --- docs/reference/ingest/apis/put-ip-location-database.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index be6c845f88476..5dc34607c6949 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -17,7 +17,7 @@ PUT _ingest/geoip/database/my-database-id { "name": "GeoIP2-Domain", "maxmind": { - "account_id": "1025402" + "account_id": "1234567" } } ---- From 75e64737bc98af02734c59f78633a985396f441d Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:31:09 -0500 Subject: [PATCH 05/13] Update the paths for the examples --- .../ingest/apis/delete-ip-location-database.asciidoc | 6 +++--- .../ingest/apis/get-ip-location-database.asciidoc | 8 ++++---- .../ingest/apis/put-ip-location-database.asciidoc | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc index 13136d9b87c81..5aaf639343e5a 100644 --- a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc @@ -8,7 +8,7 @@ Deletes a geoip database configuration. [source,console] ---- -DELETE /_ingest/geoip/database/my-database-id +DELETE /_ingest/ip_location/database/my-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] @@ -16,7 +16,7 @@ DELETE /_ingest/geoip/database/my-database-id [[delete-ip-location-database-api-request]] ==== {api-request-title} -`DELETE /_ingest/geoip/database/` +`DELETE /_ingest/ip_location/database/` [[delete-ip-location-database-api-prereqs]] ==== {api-prereq-title} @@ -50,6 +50,6 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [source,console] ---- -DELETE /_ingest/geoip/database/example-database-id +DELETE /_ingest/ip_location/database/example-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] diff --git a/docs/reference/ingest/apis/get-ip-location-database.asciidoc b/docs/reference/ingest/apis/get-ip-location-database.asciidoc index 8b325ca2f23e0..3721617ba6c6d 100644 --- a/docs/reference/ingest/apis/get-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/get-ip-location-database.asciidoc @@ -8,7 +8,7 @@ Returns information about one or more geoip database configurations. [source,console] ---- -GET /_ingest/geoip/database/my-database-id +GET /_ingest/ip_location/database/my-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] @@ -17,9 +17,9 @@ GET /_ingest/geoip/database/my-database-id [[get-ip-location-database-api-request]] ==== {api-request-title} -`GET /_ingest/geoip/database/` +`GET /_ingest/ip_location/database/` -`GET /_ingest/geoip/database` +`GET /_ingest/ip_location/database` [[get-ip-location-database-api-prereqs]] ==== {api-prereq-title} @@ -53,7 +53,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [source,console] ---- -GET /_ingest/geoip/database/my-database-id +GET /_ingest/ip_location/database/my-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 5dc34607c6949..1b01fea709251 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -13,7 +13,7 @@ to download from Maxmind. The license key setting does not take effect until all [source,console] ---- -PUT _ingest/geoip/database/my-database-id +PUT _ingest/ip_location/database/my-database-id { "name": "GeoIP2-Domain", "maxmind": { @@ -26,7 +26,7 @@ PUT _ingest/geoip/database/my-database-id [[put-ip-location-database-api-request]] ==== {api-request-title} -`PUT /_ingest/geoip/database/` +`PUT /_ingest/ip_location/database/` [[put-ip-location-database-api-prereqs]] ==== {api-prereq-title} From 9107d2468840aa19dffdeb317179cd7356fb186f Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:38:33 -0500 Subject: [PATCH 06/13] Whitespace --- docs/reference/ingest/apis/delete-ip-location-database.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc index 5aaf639343e5a..98a3c899e2270 100644 --- a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc @@ -1,5 +1,5 @@ [[delete-ip-location-database-api]] -=== Delete geoip database configuration API +=== Delete geoip database configuration API ++++ Delete geoip database configuration ++++ From 6b045b51ef867ff13e7e9072abe7f308b4686026 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:40:40 -0500 Subject: [PATCH 07/13] Update the descriptive text, too --- .../ingest/apis/delete-ip-location-database.asciidoc | 8 ++++---- .../ingest/apis/get-ip-location-database.asciidoc | 8 ++++---- .../ingest/apis/put-ip-location-database.asciidoc | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc index 98a3c899e2270..c3a10a914d2f4 100644 --- a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc @@ -1,10 +1,10 @@ [[delete-ip-location-database-api]] -=== Delete geoip database configuration API +=== Delete IP geolocation database configuration API ++++ -Delete geoip database configuration +Delete IP geolocation database configuration ++++ -Deletes a geoip database configuration. +Deletes a IP geolocation database configuration. [source,console] ---- @@ -46,7 +46,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] [[delete-ip-location-database-api-specific-ex]] -===== Delete a specific geoip database configuration +===== Delete a specific IP geolocation database configuration [source,console] ---- diff --git a/docs/reference/ingest/apis/get-ip-location-database.asciidoc b/docs/reference/ingest/apis/get-ip-location-database.asciidoc index 3721617ba6c6d..26e9ddc1eee50 100644 --- a/docs/reference/ingest/apis/get-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/get-ip-location-database.asciidoc @@ -1,10 +1,10 @@ [[get-ip-location-database-api]] -=== Get geoip database configuration API +=== Get IP geolocation database configuration API ++++ -Get geoip database configuration +Get IP geolocation database configuration ++++ -Returns information about one or more geoip database configurations. +Returns information about one or more IP geolocation database configurations. [source,console] ---- @@ -49,7 +49,7 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout] [[get-ip-location-database-api-specific-ex]] -===== Get information for a specific geoip database configuration +===== Get information for a specific IP geolocation database configuration [source,console] ---- diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 1b01fea709251..09ce461b71e50 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -1,7 +1,7 @@ [[put-ip-location-database-api]] -=== Create or update geoip database configuration API +=== Create or update IP geolocation database configuration API ++++ -Create or update geoip database configuration +Create or update IP geolocation database configuration ++++ Creates or updates an IP geolocation database configuration. From fdd441c20805d08c09264c5aaebc501f059bce74 Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:47:40 -0500 Subject: [PATCH 08/13] Add an ipinfo example --- .../ingest/apis/put-ip-location-database.asciidoc | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 09ce461b71e50..15e6dd948ad65 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -13,7 +13,7 @@ to download from Maxmind. The license key setting does not take effect until all [source,console] ---- -PUT _ingest/ip_location/database/my-database-id +PUT _ingest/ip_location/database/my-database-1 { "name": "GeoIP2-Domain", "maxmind": { @@ -23,6 +23,18 @@ PUT _ingest/ip_location/database/my-database-id ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] +[source,console] +---- +PUT _ingest/ip_location/database/my-database-2 +{ + "name": "standard_location", + "ipinfo": { + } +} +---- +// TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] + + [[put-ip-location-database-api-request]] ==== {api-request-title} From 2790b487df1893380734749c6bce6f15f3e66f7c Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:49:15 -0500 Subject: [PATCH 09/13] Expand the docs to cover the ipinfo provider as well --- docs/reference/ingest/apis/put-ip-location-database.asciidoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 15e6dd948ad65..6917f72ddcb55 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -73,8 +73,9 @@ The provider-assigned name of the IP geolocation database to download. The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. + -At present, the only supported provider is `maxmind`, and the maxmind provider -requires that an `account_id` (string) is configured. +At present, the only supported providers are `maxmind` and `ipinfo`. The maxmind provider +requires that an `account_id` (string) is configured. The ipinfo provider does not require +additional configuration in the request body. // end::ip-location-database-object[] [[ip-location-database-configuration-licensing]] From dcfbb13c23b41812d95363fb067adbb6c3e4998c Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:54:38 -0500 Subject: [PATCH 10/13] Reference that it's possible to reload secure settings --- docs/reference/ingest/apis/put-ip-location-database.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 6917f72ddcb55..4f10f5ef5bd39 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -9,7 +9,8 @@ Creates or updates an IP geolocation database configuration. IMPORTANT: The Maxmind `account_id` shown below requires a license key. Because the license key is sensitive information, it is stored as a <> in {es} named `ingest.geoip.downloader.maxmind.license_key`. Only one Maxmind license key is currently allowed per {es} cluster. A valid license key must be in the secure settings in order -to download from Maxmind. The license key setting does not take effect until all nodes are restarted. +to download from Maxmind. The license key setting does not take effect until all nodes are restarted or a +<> request is executed. [source,console] ---- From c23c3c6a507cf9fe1dd709ec2bdfd49cf7bf140d Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 11:54:58 -0500 Subject: [PATCH 11/13] Document the existence of the IPinfo token secure setting --- .../reference/ingest/apis/put-ip-location-database.asciidoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index 4f10f5ef5bd39..e42d84752694c 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -24,6 +24,12 @@ PUT _ingest/ip_location/database/my-database-1 ---- // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.] +IMPORTANT: The IPinfo configuration shown below requires a token. Because the token is sensitive information, +it is stored as a <> in {es} named `ingest.ip_location.downloader.ipinfo.token`. Only +one IPinfo token is currently allowed per {es} cluster. A valid token must be in the secure settings in order +to download from IPinfo. The token setting does not take effect until all nodes are restarted or a +<> request is executed. + [source,console] ---- PUT _ingest/ip_location/database/my-database-2 From c8df1f819ab71c73d2d9a85103dd4d4e22e08cac Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 12:15:39 -0500 Subject: [PATCH 12/13] Add redirects for the previous slugs --- docs/reference/redirects.asciidoc | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index e0568f500f268..506dff7891ad2 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -1926,4 +1926,19 @@ Refer to <>. [role="exclude",id="remote-clusters-privileges"] === Configure roles and users for remote clusters -Refer to <>. \ No newline at end of file +Refer to <>. + +[role="exclude",id="put-geoip-database-api"] +=== Create or update geoip database configuration API + +Refer to <>. + +[role="exclude",id="get-geoip-database-api"] +=== Get geoip database configuration + +Refer to <>. + +[role="exclude",id="delete-geoip-database-api"] +=== Delete geoip database configuration API + +Refer to <>. From 71752498073df5ddcc7965f23762bac42bd46faa Mon Sep 17 00:00:00 2001 From: Joe Gallo Date: Mon, 11 Nov 2024 12:23:10 -0500 Subject: [PATCH 13/13] Add a changelog entry --- docs/changelog/114548.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/changelog/114548.yaml diff --git a/docs/changelog/114548.yaml b/docs/changelog/114548.yaml new file mode 100644 index 0000000000000..b9692bcb2d10c --- /dev/null +++ b/docs/changelog/114548.yaml @@ -0,0 +1,5 @@ +pr: 114548 +summary: Support IPinfo database configurations +area: Ingest Node +type: enhancement +issues: []