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

[Automatic import] readme input types templates #194308

Conversation

haetamoudi
Copy link
Contributor

Summary

Enhance Readme with documentation specific to Input types.

For now the templates under x-pack/plugins/integration_assistant/server/templates/readme/setup/* are not used anywhere. The goal of the PR is to complete those templates, we will integrate them into the readme in a follow up PR

@haetamoudi haetamoudi added enhancement New value added to drive a business result release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Security-Scalability Team label for Security Integrations Scalability Team Feature:AutomaticImport labels Sep 27, 2024
@haetamoudi haetamoudi self-assigned this Sep 27, 2024
Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

A handful of nits as I read through initially.

@ebeahan
Copy link
Member

ebeahan commented Oct 2, 2024

Hey all - we're trying to standardize some documentation templates for certain inputs supported by Automatic Import. We would appreciate a quick review from a CODEOWNER for each input listed, if possible. 🙏

@elastic/security-service-integrations:

@elastic/obs-cloud-monitoring:

Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

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

What are the sources for these docs?

The event hub docs seem to come from https://github.com/elastic/integrations/blob/main/packages/azure/_dev/build/docs/README.md. I'm not familiar with these CloudWatch and S3 docs.

Do these docs focus on the (Filebeat) input or the (Elastic Agent) integration?

Is this a one-time import, or is it a sync that will happen regularly?

@haetamoudi
Copy link
Contributor Author

haetamoudi commented Oct 10, 2024

What are the sources for these docs?

The event hub docs seem to come from https://github.com/elastic/integrations/blob/main/packages/azure/_dev/build/docs/README.md. I'm not familiar with these CloudWatch and S3 docs.

The documentation comes from the multiple Readme files from the different integrations in the integrations repo.
The integration repo contains many readme with similar content but written in a slightly different way. The idea is to have templates that can be reuse to generate a unified documentation.

Do these docs focus on the (Filebeat) input or the (Elastic Agent) integration?

Is this a one-time import, or is it a sync that will happen regularly?

The templates will be used by automatic import when generating new integrations by users

@zmoog

@zmoog
Copy link
Contributor

zmoog commented Oct 17, 2024

Is this a one-time import, or is it a sync that will happen regularly?

The templates will be used by automatic import when generating new integrations by users

Do these docs focus on the (Filebeat) input or the (Elastic Agent) integration?

@haetamoudi
Copy link
Contributor Author

Do these docs focus on the (Filebeat) input or the (Elastic Agent) integration?

the Elastic Agent integration

@haetamoudi
Copy link
Contributor Author

We are still missing some content (some might also be too specific to each integration for us to be able to add generic guidelines):

  • cloud foundry
  • filestream
  • journald
  • kafka
  • tcp
  • udp
  • ssl probably can be enhanced too

@zmoog @efd6 do you know anyone that could help writing those?

@ebeahan
Copy link
Member

ebeahan commented Oct 28, 2024

We are still missing some content (some might also be too specific to each integration for us to be able to add generic guidelines).

Discussed a bit with @haetamoudi offline. Looking at the list, my guidance is as follows:

  • cloud foundry - input exists in Beats and Elastic Agent supports the input. However, no integration currently uses, so I think it's fair to skip adding a template into Automatic Import for now.

  • filestream - documented in Beats. There is a Custom Logs docs page, but it's still using the deprecated log input. If we re-use any guidance from the Custom Logs page, we should verify the guidance applies to filestream.

  • tcp, udp, kafka, journald - Each of these types has a custom input page in the integration docs(kakfa, tcp, udp, journald).

ssl probably can be enhanced too

The Fleet UX points to the SSL docs, so I think it's an ok approach here to do the same:

Screenshot 2024-10-28 at 1 58 37 PM

@alaudazzi alaudazzi self-assigned this Dec 5, 2024
@ilyannn
Copy link
Contributor

ilyannn commented Dec 27, 2024

@alaudazzi @ebeahan Let's target this for inclusion in 9.0.0?

@haetamoudi haetamoudi marked this pull request as ready for review January 7, 2025 16:57
@haetamoudi haetamoudi requested a review from a team as a code owner January 7, 2025 16:57
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-scalability (Team:Security-Scalability)

@haetamoudi
Copy link
Contributor Author

  • tcp, udp..

tcp, udp, kafka, journald - Each of these types has a custom input page in the integration docs(kakfa, tcp, udp, journald).

The current documentation was already taken from there.

  • As we talked about I have deleted the cloud foundry one.
    @ebeahan

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

cc @alaudazzi @haetamoudi

Copy link

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

I left a few editing suggestions.

haetamoudi and others added 3 commits January 8, 2025 14:04
…mplates/description_readme.njk

Co-authored-by: Arianna Laudazzi <[email protected]>
…mplates/description_readme.njk

Co-authored-by: Arianna Laudazzi <[email protected]>
…mplates/description_readme.njk

Co-authored-by: Arianna Laudazzi <[email protected]>
@haetamoudi haetamoudi merged commit aff9217 into elastic:main Jan 9, 2025
8 checks passed
Zacqary pushed a commit to Zacqary/kibana that referenced this pull request Jan 9, 2025
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Jan 13, 2025
viduni94 pushed a commit to viduni94/kibana that referenced this pull request Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting enhancement New value added to drive a business result Feature:AutomaticImport release_note:skip Skip the PR/issue when compiling release notes Team:Security-Scalability Team label for Security Integrations Scalability Team v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants