Skip to content

ECK Elastic Stack configuration policies refinement and restructured#5363

Open
eedugon wants to merge 7 commits intomainfrom
eck_policies_links
Open

ECK Elastic Stack configuration policies refinement and restructured#5363
eedugon wants to merge 7 commits intomainfrom
eck_policies_links

Conversation

@eedugon
Copy link
Contributor

@eedugon eedugon commented Mar 4, 2026

Summary

Refinement of Elastic Stack configuration policies document, addressing the following improvement areas:

  • The feature wasn't explained or introduced in the original doc.
  • The links to the API docs in the initial list of features felt odd, without clear motivation or reasoning.
  • There are two long bulleted lists with the same elements.
  • Syntax of the different settings wasn't completely clear.

Changes:

  • New introduction and document structure
  • Define policies start with a basic example
  • All examples organized under a Examples H2 section
  • Features organized in a single table instead of creating two bulleted lists with the same items.
  • Different syntax explained with examples.

With the new structure I think future maintenance of this section will be easier, even if we decide to separate all this in a few docs under its own hierarchy.

Closes #3177

Generative AI disclosure

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

Tool(s) and model(s) used: Cursor - auto mode

@eedugon eedugon changed the title initial draft created ECK Elastic Stack configuration policies refinement and restructured Mar 4, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

✅ Vale Linting Results

No issues found on modified lines!


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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

I like it. I do think we should go with more columns even if it's ugly. table is definitely the right thing.

we can maybe resurrect an issue requesting wider tables or this one that collapses the nav and gives us more room (the viewport is kind of small)

edit: looks like dev will have a fix soon #5363


### Syntax Examples

**Settings map**:
Copy link
Collaborator

Choose a reason for hiding this comment

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

would like to see some sort of api example that's more complex here

@shainaraskas
Copy link
Collaborator

one small thing: do you think it would be nice to have a small stack config policy above the fold, so people who just want to copy one quickly don't have to scroll too far?

@eedugon
Copy link
Contributor Author

eedugon commented Mar 5, 2026

one small thing: do you think it would be nice to have a small stack config policy above the fold, so people who just want to copy one quickly don't have to scroll too far?

Great idea, yes! I also think devs will like it.

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
@eedugon eedugon marked this pull request as ready for review March 5, 2026 12:54
@eedugon eedugon requested a review from a team as a code owner March 5, 2026 12:54
Copy link
Contributor

@pkoutsovasilis pkoutsovasilis left a comment

Choose a reason for hiding this comment

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

ty @eedugon for this improvement, overall LGMT left some comments


## {{kib}} settings [kib-settings]

The following settings can be configured for {{kib}} under `StackConfigPolicy.spec.elasticsearch`:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following settings can be configured for {{kib}} under `StackConfigPolicy.spec.elasticsearch`:
The following settings can be configured for {{kib}} under `StackConfigPolicy.spec.kibana`:

This says spec.elasticsearch but should say spec.kibana, right?


### Specifics for index and component templates [templates-specifics]

`composableIndexTemplates` and `componentTemplats` must be defined under the `indexTemplates` field:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`composableIndexTemplates` and `componentTemplats` must be defined under the `indexTemplates` field:
`composableIndexTemplates` and `componentTemplates` must be defined under the `indexTemplates` field:

Comment on lines +547 to +550
- name: my-secret
mountPath: /etc/secrets
- name: my-certificate
mountPath: /usr/share/elasticsearch/config/my-certificate
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- name: my-secret
mountPath: /etc/secrets
- name: my-certificate
mountPath: /usr/share/elasticsearch/config/my-certificate
- secretName: my-secret
mountPath: /etc/secrets
- secretName: my-certificate
mountPath: /usr/share/elasticsearch/config/my-certificate

these should have secretName right?

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.

[Website]: less than ideal links used in the list of configurable settings for ECK

3 participants