ECK Elastic Stack configuration policies refinement and restructured#5363
ECK Elastic Stack configuration policies refinement and restructured#5363
Conversation
✅ Vale Linting ResultsNo 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. |
There was a problem hiding this comment.
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
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Show resolved
Hide resolved
deploy-manage/deploy/cloud-on-k8s/elastic-stack-configuration-policies.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Syntax Examples | ||
|
|
||
| **Settings map**: |
There was a problem hiding this comment.
would like to see some sort of api example that's more complex here
|
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>
pkoutsovasilis
left a comment
There was a problem hiding this comment.
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`: |
There was a problem hiding this comment.
| 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: |
There was a problem hiding this comment.
| `composableIndexTemplates` and `componentTemplats` must be defined under the `indexTemplates` field: | |
| `composableIndexTemplates` and `componentTemplates` must be defined under the `indexTemplates` field: |
| - name: my-secret | ||
| mountPath: /etc/secrets | ||
| - name: my-certificate | ||
| mountPath: /usr/share/elasticsearch/config/my-certificate |
There was a problem hiding this comment.
| - 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?
Summary
Refinement of Elastic Stack configuration policies document, addressing the following improvement areas:
Changes:
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
Tool(s) and model(s) used: Cursor - auto mode