Skip to content

add elasticsearch API key support #934

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
merged 1 commit into from
Apr 22, 2020

Conversation

colinsurprenant
Copy link
Contributor

@colinsurprenant colinsurprenant commented Apr 16, 2020

Related to elastic/logstash#11788
Fixes #908

  • Add support for elasticsearch API key authentication using the api_key option
    • SSL must be enabled
    • Only one authentication method must be specified out of (user/password, cloud_auth and api_key)
  • Related specs
  • Manually tested against a cloud cluster

TODO

@yaauie yaauie assigned yaauie and unassigned elasticsearch-bot Apr 16, 2020
Copy link
Contributor

@karenzone karenzone 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 adding the docs. What you have here builds cleanly and renders correctly.

From the issue description: "Only one authentication method must be specified out of (user/password, cloud_auth and api_key)". That info would be nice to call out in the docs. I suggest adding an "Authentication" section on par with "Retry Policy," "DLQ policy," and "ILM" to surface this information, and also making a note in each option about the alternatives that are excluded.

I can take this on in a subsequent PR if you would like. Let's discuss.

@colinsurprenant
Copy link
Contributor Author

Thanks @karenzone - I just pushed some docs updates, LMKWYT.

Copy link
Contributor

@karenzone karenzone 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 docs change, Colin. Docs still build and render correctly, so LGTM.

@colinsurprenant
Copy link
Contributor Author

@kares following our conversation about the logstash license checker, I refactored to call the plugin validation methods from within build_client which now enables https://github.com/elastic/logstash#11818

LMKWYT

@colinsurprenant
Copy link
Contributor Author

@yaauie let me know if this looks good to you too plus if the requirement on explicit ssl => true seems reasonable (and defer solving the unreliable SSL auto-detection in another PR).

Copy link
Contributor

@yaauie yaauie left a comment

Choose a reason for hiding this comment

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

LGTM 👍

bump version to 10.5.0
@colinsurprenant colinsurprenant merged commit d5f1782 into logstash-plugins:master Apr 22, 2020
@colinsurprenant colinsurprenant deleted the api_key branch April 22, 2020 17:59
@colinsurprenant
Copy link
Contributor Author

v10.5.0 published. Thanks @yaauie @kares @karenzone for the reviews!

@AMITKHETAN
Copy link

Hi, Its fixed but I still need to pass both API_ID and API_KEY value as "<API_ID>:<API_KEY>

@colinsurprenant
Copy link
Contributor Author

@AMITKHETAN can you please open an issue about this and explain your use-case and how & why you would prefer to pass the API_ID and API_KEY values? Thanks,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support authentication with API keys
6 participants