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

Add new documentation IP2Geo processor automatic updating feature #4095

Closed
wants to merge 80 commits into from

Conversation

vagimeli
Copy link
Contributor

Description

Add new documentation about GeoIP automatic updating feature

Issues Resolved

#3524

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: vagimeli <[email protected]>
@vagimeli vagimeli added 2 - In progress Issue/PR: The issue or PR is in progress. v2.8.0 labels May 17, 2023
@vagimeli vagimeli self-assigned this May 17, 2023
Signed-off-by: vagimeli <[email protected]>
@vagimeli vagimeli linked an issue May 18, 2023 that may be closed by this pull request
4 tasks
@vagimeli vagimeli added v2.9.0 and removed v2.8.0 labels May 18, 2023
vagimeli added 5 commits May 22, 2023 14:37
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Signed-off-by: vagimeli <[email protected]>
@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels May 23, 2023
@vagimeli
Copy link
Contributor Author

@heemin32 The first-pass draft is ready for your technical review. Please review for technical accuracy, gaps in information, and other technical-related information. You're welcome to schedule a meeting with me to talk through this content. Thanks!

Signed-off-by: vagimeli <[email protected]>
Copy link
Contributor

@heemin32 heemin32 left a comment

Choose a reason for hiding this comment

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

Please consider if having a separate page for datasource + separate pages for each create, update, read, and delete APIs would be better for readability.

_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/geoip.md Outdated Show resolved Hide resolved
vagimeli and others added 3 commits May 24, 2023 12:33
Co-authored-by: Heemin Kim <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heemin Kim <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heemin Kim <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved

| Key | Description | Default |
|--------------------|-------------|---------|
| plugins.geospatial.ip2geo.datasource.endpoint | Default endpoint for creating the data source API. | Defaults to https://geoip.maps.opensearch.org/v1/geolite2-city/manifest.json. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like the terminating period shouldn't be part of the link.

_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved
_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved
| `datasource` | Required | - | The data source name to use to look up geographical information. |
| `properties` | Optional | All fields in `datasource`. | The field that controls what properties are added to `target_field` from `datasource`. |
| `target_field` | Optional | ip2geo | The field that holds the geographical information looked up from the data source. |
| `ignore_missing` | Optional | false | If `true` and `field` does not exist, the processor quietly exits without modifying the document. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

The end of the description is a bit oddly worded. Do we just mean "the processor does not modify the document"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised to read: If set to true, the processor does not modify the document if the field does not exist or is null. Default is false.

_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved
```
{% include copy-curl.html %}

**Step 2: Ingest a document into the index.**
Copy link
Collaborator

Choose a reason for hiding this comment

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

"an index" instead of "the index"?


**Step 2: Ingest a document into the index.**

The following query ingests a document into the index named `my-index`:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"an index" instead of "the index"?

_api-reference/ingest-apis/ip2geo.md Outdated Show resolved Hide resolved
vagimeli and others added 18 commits August 23, 2023 08:53
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli vagimeli added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels Aug 23, 2023
@vagimeli vagimeli added Closed - Duplicate or Cancelled Issue: Nothing to be done and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Sep 18, 2023
@hdhalter hdhalter removed the v2.10.0 label Sep 22, 2023
@Naarcha-AWS Naarcha-AWS closed this Nov 8, 2023
@Naarcha-AWS Naarcha-AWS deleted the geoIP branch March 28, 2024 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Duplicate or Cancelled Issue: Nothing to be done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]GeoIP processor
6 participants