-
Notifications
You must be signed in to change notification settings - Fork 24.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ingest download databases docs #111688
Ingest download databases docs #111688
Conversation
Just a consistency nit, api docs don't typically have '-api' at the end of their filename.
We should figure out a way to test these more cleanly without leaking a enterprise-geoip-downloader task, and also we need to be absolutely sure we're not hitting any real download APIs.
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-data-management (Team:Data Management) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny change for ip
-> IP
and then a couple of questions
|
||
[discrete] | ||
[[ingest-stat-apis]] | ||
=== Stat APIs | ||
|
||
Use the following APIs to get statistics about ingest processing: | ||
|
||
* <<geoip-stats-api>> to get download statistics for GeoIP2 databases used with | ||
* <<geoip-stats-api>> to get download statistics for ip geolocation databases used with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IP
instead of ip
. There's a few instances in this PR that need to be changed.
[[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."] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this true still? We're in Tech Preview in 8.15.0
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nevermind: confirmed still Tech Preview
|
||
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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to link directly to this new setting in the docs? And when you navigate to the "secure settings" docs page, there are links at the bottom that go to specific docs pages for other features (e.g. Azure repository). Do we have one of those pages for this feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The secure settings page is a little odd, in that more than half of it is dedicated specifically to reloadable secure settings, and all of those settings are listed there because they are reloadable settings. I'll see if I can find a place to highlight ngest.geoip.downloader.maxmind.license_key
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok disregard this for now then, thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1. Thanks Keith and Joe!
💚 Backport successful
|
Co-authored-by: Joe Gallo <[email protected]>
Co-authored-by: Joe Gallo <[email protected]>
Co-authored-by: Joe Gallo <[email protected]>
Co-authored-by: Joe Gallo <[email protected]>
This adds documentation for the enterprise geoip downloader, added in #110844.