Skip to content

Clarify ingest-geoip database_file docs #64340

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

Merged

Conversation

jasontedor
Copy link
Member

The docs for the geoip processor database_file option appear to indicate that all geoip databases are in the config directory. This is leftover legacy from when this was the case when ingest-geoip was a plugin, but it is no longer true as the built-in databases now ship inside the ingest-geoip module that is bundled by default. This commit clarifies those docs.

Closes #64203

The docs for the geoip processor database_file option appear to indicate
that all geoip databases are in the config directory. This is leftover
legacy from when this was the case when ingest-geoip was a plugin, but
it is no longer true as the built-in databases now ship inside the
ingest-geoip module that is bundled by default. This commit clarifies
those docs.
@jasontedor jasontedor added >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP v7.10.0 v7.11.0 v6.8.14 labels Oct 29, 2020
@jasontedor jasontedor requested a review from jakommo October 29, 2020 12:59
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Ingest)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

Adding further details to the description to increase visibility of the allowed filenames and extensions.
Copy link
Contributor

@jakommo jakommo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick PR Jason!
I've added another sentence to the third paragraph, as I think this makes the behavior more visible and clear to a user reading the doc, but feel free to reject it if you disagree.
Your change LGTM!

@jasontedor jasontedor merged commit 0d4494f into elastic:master Oct 29, 2020
jasontedor added a commit that referenced this pull request Oct 29, 2020
The docs for the geoip processor database_file option appear to indicate
that all geoip databases are in the config directory. This is leftover
legacy from when this was the case when ingest-geoip was a plugin, but
it is no longer true as the built-in databases now ship inside the
ingest-geoip module that is bundled by default. This commit clarifies
those docs.

Co-authored-by: Jakob Reiter <jakommo@users.noreply.github.com>
jasontedor added a commit that referenced this pull request Oct 29, 2020
The docs for the geoip processor database_file option appear to indicate
that all geoip databases are in the config directory. This is leftover
legacy from when this was the case when ingest-geoip was a plugin, but
it is no longer true as the built-in databases now ship inside the
ingest-geoip module that is bundled by default. This commit clarifies
those docs.

Co-authored-by: Jakob Reiter <jakommo@users.noreply.github.com>
@jasontedor jasontedor added v8.0.0 and removed v6.8.14 labels Oct 29, 2020
@jasontedor jasontedor deleted the clarify-ingest-geoip-database-path branch October 29, 2020 17:31
@jasontedor
Copy link
Member Author

@jakommo Thanks. Please take a look at the final change I merged and let me know if you have any concerns.

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 v7.10.0 v7.11.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding a GeoIP2 database in $ES_CONFIG/ingest-geoip results in node not starting if using default filename
4 participants