Skip to content

Clarify ECH node bootlooping documentation #1093

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 5 commits into from
Apr 14, 2025
Merged

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Apr 11, 2025

Description

Per an internal discussion (sdh-cp #9409), we would like to update the ECH doc to clarify the node bootlooping related doc.

Background

A setting is configured in Elasticsearch but it reports error

org.elasticsearch.common.settings.SettingsException: 
The configuration setting [xpack.security.authc.realms.foobar.foobar1.foobar2.client_secret] is required

And during the troubleshooting, we found the setting is configured via client tooling and it's not properly configured (zero byte).

Based on that, we logically thought to solve the issue, users should

  • understand this may happen if the keystore setting ([xpack.security.authc.realms.foobar.foobar1.foobar2.client_secret] to be configured on ECH side) is invalid, missing or improperly configured
  • understand the way to solve is to check if the keystore is valid or not and make sure it's configured properly
  • additionally if users configured this via client tooling, they should try configuring this in cloud UI directly as a way to isolate the cause

After PR being merged

The following orange section will be added

image

image

@kunisen kunisen added the documentation Improvements or additions to documentation label Apr 11, 2025
@kunisen kunisen self-assigned this Apr 11, 2025
Copy link

@AlexP-Elastic AlexP-Elastic left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@maggieghamry maggieghamry left a comment

Choose a reason for hiding this comment

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

LGTM! small note: perhaps having an example next to "via a client tool or API" (for example terraform-ec) or perhaps utilize a knowledge article separately.

@kunisen kunisen enabled auto-merge (squash) April 14, 2025 02:14
@kunisen
Copy link
Contributor Author

kunisen commented Apr 14, 2025

Thanks all for the quick review! 🙏

Also thanks @maggieghamry sure, I added terraform ec provider as an example as suggested.

image

kunisen added 2 commits April 14, 2025 11:19
workaround the "unknown language: log" issue
@kunisen kunisen merged commit 5c941ad into main Apr 14, 2025
3 of 4 checks passed
@kunisen kunisen deleted the kunisen-docpr-sdhcp-9409 branch April 14, 2025 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants