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

[Logstash-output-opensearch] Add 1.1.0 version of rubygems links to website #235

Open
peterzhuamazon opened this issue Oct 5, 2021 · 14 comments
Assignees
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. logstash

Comments

@peterzhuamazon
Copy link
Member

Is your feature request related to a problem? Please describe.
[Logstash-output-opensearch] Add 1.1.0 version of rubygems links to website
https://rubygems.org/gems/logstash-output-opensearch/versions/1.1.0-java

1.1.0 version if out current with only the gem, no tar, no docker.
We need to have a way add it to the website.

Describe the solution you'd like
See above.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

@stockholmux
Copy link
Member

Do we want to provide a direct link to the ruby gem on for the Logstash output plugin? I'm not sure.

On one hand, it's kinda hard to find the standalone output plugin.
On the other hand, we don't really list libraries on the downloads page.

@VijayanB and @elfisher Thoughts on this?

@elfisher
Copy link
Contributor

I'd prefer starting with docs and the project README. @aetter for the docs, do is there already a link to the GEM URL for the Logstash output plugin?

@aetter
Copy link
Contributor

aetter commented Oct 11, 2021

We don't, no. Is the goal here "if you have an OSS Logstash install and want to add the opensearch output plugin to it, do the following"?

If so, pretty easy addition to the documentation -- it looks like the the command is just ./bin/logstash-plugin install logstash-output-opensearch, and we can link to the gem page while we're at it.

@stockholmux
Copy link
Member

@aetter Sounds good. Can I transfer this to documentation-website?

@VijayanB
Copy link
Member

@aetter I also believe we need to provide documentation for upgrade logstash-output-opensearch as well.

@stockholmux stockholmux transferred this issue from opensearch-project/project-website Oct 20, 2021
@elfisher
Copy link
Contributor

@aetter I also believe we need to provide documentation for upgrade logstash-output-opensearch as well.

@VijayanB what is the best practice for upgrade? Swap the binaries and load logstash with the OpenSearch output?

@VijayanB
Copy link
Member

VijayanB commented Oct 21, 2021

@elfisher It depends on how the plugin is installed.
if plugin is installed from rubygems.org, then one can update using following command

bin/logstash-plugin update  #to update all
bin/logstash-plugin update logstash-output-opensearch # to update individual plugin

if someone has downloaded logstash-with-output-opensearch-plugin, they have to do following

bin/logstash-plugin remove logstash-output-opensearch # since it was installed manually and shipped
bin/logstash-plugin install logstash-output-opensearch # to install latest from ruby gems 

@hdhalter hdhalter added the 1 - Backlog Issue: The issue is unassigned or assigned but not started label May 25, 2022
@hdhalter hdhalter added this to the 2022-Q3 milestone May 25, 2022
@hdhalter
Copy link
Contributor

We'll look into this. The documentation on logstash is here: https://opensearch.org/docs/latest/clients/logstash/index/

@Naarcha-AWS Naarcha-AWS removed this from the 2022-Q3 milestone Oct 10, 2022
@hdhalter
Copy link
Contributor

@VijayanB - Is this still an issue in the docs? If so, can you please help to add this info in the appropriate location? Thanks.

@hdhalter hdhalter added needs-more-info and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Nov 23, 2023
@VijayanB
Copy link
Member

@hdhalter We can update documentation on how to update logstash plugin after installation too if it is not already added.

@hdhalter
Copy link
Contributor

That sounds good, @VijayanB . Will you be updating the appropriate file(s)?

@VijayanB
Copy link
Member

@dlvenable Can you check this one too? Thanks.

@dlvenable
Copy link
Member

The documentation page has a section titled "Install Logstash". Perhaps we can add a new section for "Updating Logstash" with the instructions from #235 (comment).

One thing to consider is that the current instructions are somewhat of a getting started guide. But, updating the plugin version is more maintenance of the running application.

@hdhalter
Copy link
Contributor

Thanks, @dlvenable!
@Naarcha-AWS - Can you please add these upgrade instructions to this page? https://opensearch.org/docs/latest/tools/logstash/index/. Thanks!

@hdhalter hdhalter added 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. and removed needs-more-info labels Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. logstash
Projects
None yet
Development

No branches or pull requests

8 participants