Skip to content
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

Merged
merged 19 commits into from
Aug 8, 2024

Conversation

masseyke
Copy link
Member

@masseyke masseyke commented Aug 7, 2024

This adds documentation for the enterprise geoip downloader, added in #110844.

@masseyke masseyke added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP v8.15.0 v8.16.0 labels Aug 7, 2024
Copy link
Contributor

github-actions bot commented Aug 7, 2024

Documentation preview:

@masseyke masseyke marked this pull request as ready for review August 7, 2024 22:17
@elasticsearchmachine elasticsearchmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Aug 7, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

Copy link
Contributor

@mattc58 mattc58 left a 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
Copy link
Contributor

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."]
Copy link
Contributor

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?

Copy link
Contributor

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,
Copy link
Contributor

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?

Copy link
Member Author

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.

Copy link
Contributor

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!

Copy link
Contributor

@mattc58 mattc58 left a 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!

@masseyke masseyke merged commit c6a7537 into elastic:main Aug 8, 2024
5 checks passed
@masseyke masseyke deleted the ingest-download-databases-docs branch August 8, 2024 14:23
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.15

masseyke added a commit to masseyke/elasticsearch that referenced this pull request Aug 8, 2024
masseyke added a commit that referenced this pull request Aug 8, 2024
cbuescher pushed a commit to cbuescher/elasticsearch that referenced this pull request Sep 4, 2024
davidkyle pushed a commit to davidkyle/elasticsearch that referenced this pull request Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants