[Docs] Include MaxMind license key configuration requirement for GeoIP database for 9.x versions
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- elasticsearch
- Domain
- documentation
Research direction
Open the current GeoIP database API documentation and compare it with the linked 8.15 page. Add the missing MaxMind license-key secure-setting, cluster-wide, validation, and restart guidance, then verify that the configuration requirements are clear in the rendered documentation.
Written by the indexing model from the issue text.
Description
Please update the GeoIP database API documentation to include the same guidance that existed in earlier documentation versions regarding MaxMind commercial license keys.
The following information appears in the 8.15 docs but is missing or unclear in newer versions:
The MaxMind account ID requires a license key. Because the license key is sensitive information, it must be stored as a secure setting in Elasticsearch named `ingest.geoip.downloader.maxmind.license_key`. Only one MaxMind license key is allowed per Elasticsearch cluster. A valid license key must be present in the secure settings to download databases from MaxMind. The license key setting does not take effect until all nodes are restarted.
Previous documentation (8.15): https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-geoip-database-api.html
- Dominant language
- Ruby
- Stars
- 265
- Forks
- 347
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
docs-build
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100