Skip to content

Fix formating & add needed config for xpack.security.remote_cluster_s…#6732

Open
SimonKoetting wants to merge 7 commits into
elastic:mainfrom
SimonKoetting:k8s_ccs_cert
Open

Fix formating & add needed config for xpack.security.remote_cluster_s…#6732
SimonKoetting wants to merge 7 commits into
elastic:mainfrom
SimonKoetting:k8s_ccs_cert

Conversation

@SimonKoetting
Copy link
Copy Markdown

Summary

Fix formating & add needed configs for xpack.security.remote_cluster_server.ssl setting when using own certificates

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

…erver.ssl setting when using own certificates
@SimonKoetting SimonKoetting requested a review from a team as a code owner May 27, 2026 12:38
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

Elastic Docs Style Checker (Vale)

Summary: 1 suggestion found

💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
deploy-manage/security/k8s-transport-settings.md 126 Elastic.WordChoice Consider using 'deactivates, deselects, hides, turns off, makes unavailable' instead of 'Disables', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@eedugon
Copy link
Copy Markdown
Contributor

eedugon commented May 27, 2026

Great catch @SimonKoetting , thanks for sharing this.

Now that the footnote 3 is getting bigger I'd like to convert it to a note and probably provide some extra background and links for the remote_cluster_client to be better addressed.

Would you mind if I apply a commit to your PR and we can review it together before merging? Or do you prefer if we merge this change and then I create a follow-up PR to update the format of the content a bit?

I'd like to make sure that the reader understands that the remote_cluster_server is used in the destination cluster when configuring Remote Clusters through API key-based authentication.

@SimonKoetting
Copy link
Copy Markdown
Author

@eedugon sound good to me, feel free to add the commit to this PR so we can address this right away :)

…ty transport certs.

This updates the transport certificate guidance to show the required DNS and SSL settings for API key-based remote cluster server usage, with a complete example and cross-links between related ECK docs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@eedugon
Copy link
Copy Markdown
Contributor

eedugon commented May 28, 2026

@SimonKoetting , I have commited directly to your branch with a format change, and also included the opposite link: If a user is configuring remote cluster server interface and they are already using certificates created by a third-party tool they should also follow this guidance.

For the example I'm not sure if the current dropdown is a good choice or if we could move the example of RCS+third-party certs to its own sub-section at the end of the document.

@shainaraskas , would you please share your thoughts here? it's a very small PR that covers a small gap that we had in our docs between RCS 2.0 (api key based auth) and ECK not handling transport certs automatically.

The options for the content in deploy-manage/security/k8s-transport-settings.md are:

  • Add the needed settings in a note without providing the entire example.
  • Add the entire example in a dropdown (current version)
  • Add the entire example in its own sub-section at the end.

Copy link
Copy Markdown
Author

@SimonKoetting SimonKoetting left a comment

Choose a reason for hiding this comment

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

Besides this little nit, the changes look good to me. 👍 @eedugon

Comment thread deploy-manage/remote-clusters/_snippets/eck_rcs_enable.md Outdated
@eedugon
Copy link
Copy Markdown
Contributor

eedugon commented May 29, 2026

@SimonKoetting : I've applied your suggestion and also converted the dropdown example to its own sub-section, per @yetanothertw 's feedback.

Let us know your thoughts, and thanks a lot for your patience :)

@SimonKoetting
Copy link
Copy Markdown
Author

LGTM :) @eedugon

Copy link
Copy Markdown
Member

@yetanothertw yetanothertw left a comment

Choose a reason for hiding this comment

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

Nice work! Really like that you've moved the dropdown into its own section for maximum clarity. 🪴

I've left a minor (not a blocker) comment re the elasticsearch version in your example config manifest, see what you think.

metadata:
name: quickstart
spec:
version: 8.16.1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This might not even be relevant, but should we try to use 9.something as this is the 9.X docset?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah, I'm planning to address all ECK examples in a different PR, to use {{version.stack}} where applicable.
For the moment I've left the example as a copy&paste of the previous example but with the extra needed settings.

@shainaraskas
Copy link
Copy Markdown
Member

@eedugon sorry I missed this. I like the new section. it's a good alternative to the big footnote

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.

5 participants