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

docs: use valid settings in examples #92651

Merged

Conversation

yaauie
Copy link
Member

@yaauie yaauie commented Jan 3, 2023

Logstash Central Management allows key/value map for pipeline_settings, but the Elasticsearch API does not perform validation of the provided settings.

Here, we remove from our examples introduced in #67788 settings that have no semantic meaning to Logstash, and replace them with a key/value pair "queue.max_bytes": "1gb" that has been valid since at least Logstash 6.0,

Logstash Central Management allows key/value map for pipeline
settings, but the Elasticsearch API does not perform validation
of the provided settings. Here, we remove from our examples
settings that have no semantic meaning to Logstash, and replace
them with a meaningful key/value pair
@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2023

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v8.7.0 needs:triage Requires assignment of a team area label external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 3, 2023
@yaauie yaauie added >docs General docs changes and removed needs:triage Requires assignment of a team area label external-contributor Pull request authored by a developer outside the Elasticsearch team v8.7.0 labels Jan 3, 2023
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Jan 3, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@grcevski grcevski left a comment

Choose a reason for hiding this comment

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

LGTM!

@yaauie yaauie merged commit 2c3792f into elastic:main Jan 4, 2023
@yaauie yaauie deleted the logstash-central-management-docs-example-fixes branch January 4, 2023 02:03
elasticsearchmachine pushed a commit that referenced this pull request Jan 4, 2023
Logstash Central Management allows key/value map for pipeline
settings, but the Elasticsearch API does not perform validation
of the provided settings. Here, we remove from our examples
settings that have no semantic meaning to Logstash, and replace
them with a meaningful key/value pair
@yaauie
Copy link
Member Author

yaauie commented Jan 4, 2023

@grcevski can this be auto-backported to 7.17 too since the source of the doc bug goes back to 7.12? I'm not a regular contributor to Elasticsearch, so I'm not sure what the protocol is.

@grcevski
Copy link
Contributor

grcevski commented Jan 4, 2023

Hi @yaauie, since we already merged this PR we can't really use the auto backport and merge option anymore. We'll need a separate PR on the 7.17 branch. You don't need another approval for backports, just force merge the PR when it comes out green from tests. I'm happy to look over the backport PR as well, just tag me.

When making the backport PR, just follow what the automation did here for the 8.6 branch #92654, prefix in the title, referencing the original PR inside ().

Thanks for fixing this.

yaauie added a commit that referenced this pull request Jan 6, 2023
Logstash Central Management allows key/value map for pipeline
settings, but the Elasticsearch API does not perform validation
of the provided settings. Here, we remove from our examples
settings that have no semantic meaning to Logstash, and replace
them with a meaningful key/value pair
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.6.1 v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants