Skip to content

Add documentation for managing ECK file-based password length. #3339

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 16 commits into
base: eck-3.2.0
Choose a base branch
from
Open

Add documentation for managing ECK file-based password length. #3339

wants to merge 16 commits into from
+21 −3

Conversation

naemono
Copy link
Contributor

@naemono naemono commented Oct 6, 2025 •
edited
Loading

The following elastic/cloud-on-k8s#8817 is planned to be released with the ECK 3.2/Stack 9.2 release.

(replaces #3322 as it was based of the wrong branch)

naemono added 4 commits October 6, 2025 08:39
@naemono
Add documentation for managing ECK file-based password length.
ee15ecc 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
wording changes.
29c21eb 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Add back removed line
4c876a0 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Review changes.
766a792 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono naemono requested a review from a team as a code owner October 6, 2025 13:50
@naemono naemono changed the title Eck enterprise password additions v2 Add documentation for managing ECK file-based password length. Oct 6, 2025
@naemono naemono mentioned this pull request Oct 6, 2025
Closed
@naemono
adjust pathing.
952f602 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono naemono changed the base branch from main to eck-3.2.0 October 6, 2025 13:53
@naemono
Try different pathing style.
1e76096 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Adjust paths again.
ebf786e 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Add .md extension
ed2dc70 
Signed-off-by: Michael Montgomery <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 6, 2025 •
edited
Loading

🔍 Preview links for changed docs

@naemono
remove unneeded line
3a39b08 
Signed-off-by: Michael Montgomery <[email protected]>
pebrc
pebrc reviewed Oct 6, 2025
View reviewed changes
@naemono
review updates.
04f2f25 
Signed-off-by: Michael Montgomery <[email protected]>
eedugon
eedugon approved these changes Oct 6, 2025
View reviewed changes
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

LGTM!
I have suggested to place the applies_to right after the heading, and not after the initial note.

@naemono
Move applies_to
b6a2315 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono naemono requested a review from pebrc October 6, 2025 18:22
shainaraskas
shainaraskas reviewed Oct 6, 2025
View reviewed changes
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.

looks really good. I think we want to consider relocating this chunk of info though because it's specific to the file realm. would you consider making it an H4 under the File realm heading?

https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3339/deploy-manage/users-roles/cluster-or-deployment-auth/managed-credentials-eck#file-realm

deploy-manage/users-roles/cluster-or-deployment-auth/managed-credentials-eck.md Outdated
Comment on lines 114 to 116
:::{note}
Changing these values does not update existing passwords. To rotate current credentials, refer to the [rotating credentials documentation](#k8s-rotate-credentials)
:::
Copy link
Collaborator

Choose a reason for hiding this comment

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

probably ok outside of a note

Suggested change
:::{note}
Changing these values does not update existing passwords. To rotate current credentials, refer to the [rotating credentials documentation](#k8s-rotate-credentials)
:::
Changing these values does not update existing passwords. To rotate current credentials, refer to the [rotating credentials documentation](#k8s-rotate-credentials)

deploy-manage/users-roles/cluster-or-deployment-auth/managed-credentials-eck.md Outdated
```

:::{note}
The ability to control the length of passwords for [file-based credentials](/deploy-manage/users-roles/cluster-or-deployment-auth/file-based.md) generated by {{eck}} requires an Enterprise license.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we want this to not be two notes in a trenchcoat

image
Suggested change
The ability to control the length of passwords for [file-based credentials](/deploy-manage/users-roles/cluster-or-deployment-auth/file-based.md) generated by {{eck}} requires an Enterprise license.
The ability to control the length of passwords for [file-based credentials](/deploy-manage/users-roles/cluster-or-deployment-auth/file-based.md) generated by {{eck}} requires an Enterprise license.
:::

shainaraskas
shainaraskas approved these changes Oct 6, 2025
View reviewed changes
Copy link
Collaborator

@shainaraskas shainaraskas left a comment •
edited
Loading

Choose a reason for hiding this comment

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

(+ approving to unblock)

(oops, guess this tab was old and edu already got you)

@naemono
Add missing end-note
bc2d0f0 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Fix typo
08f288b 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono
Copy link
Contributor Author

naemono commented Oct 7, 2025

looks really good. I think we want to consider relocating this chunk of info though because it's specific to the file realm. would you consider making it an H4 under the File realm heading?

https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3339/deploy-manage/users-roles/cluster-or-deployment-auth/managed-credentials-eck#file-realm

@shainaraskas , @pebrc and I spoke, and though moving all of this under file realm maybe wasn't the best approach being that the file realm section also explains to customers how to create their own users, which password-length doesn't really apply to. We instead thought creating a new ECK auto-generate credentials section with to sub-sections for 1) rotating and 2) controlling length made more sense. Let us know your thoughts. Thanks.

@naemono
fix another typo
f18d288 
Signed-off-by: Michael Montgomery <[email protected]>
shainaraskas
shainaraskas reviewed Oct 7, 2025
View reviewed changes
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.

thanks - this grouping now makes more sense to me. added some additional comments that could clarify things a little further (and I think you have the wrong version # in there)

shainaraskas
shainaraskas reviewed Oct 7, 2025
View reviewed changes
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.

thanks - this grouping now makes more sense to me. added some additional comments that could clarify things a little further (and I think you have the wrong version # in there)

@naemono
Review changes
48435b0 
Signed-off-by: Michael Montgomery <[email protected]>
@naemono naemono requested a review from shainaraskas October 7, 2025 20:50
shainaraskas
shainaraskas approved these changes Oct 7, 2025
View reviewed changes
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.

nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pebrc pebrc pebrc approved these changes

@eedugon eedugon eedugon approved these changes

@shainaraskas shainaraskas shainaraskas approved these changes

@barkbay barkbay Awaiting requested review from barkbay

@rhr323 rhr323 Awaiting requested review from rhr323

@kvalliyurnatt kvalliyurnatt Awaiting requested review from kvalliyurnatt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@naemono @pebrc @eedugon @shainaraskas