Skip to content

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Sep 5, 2024

This adds some detail to clear up usage of Fleet enrollment tokens.

Thanks for the suggestions @jillguyonnet. Let me know if I've missed anything.

Closes: #1270


Why the token name must be unique.

I think it should be enough for users to know just that the names need to be unique. I added:

Screenshot 2024-09-05 at 1 26 29 PM


Add an explanation around revoking tokens (marked as inactive, will be removed after expiration) with a link to the retention period setting in Elasticsearch.
A mention that inactive tokens are still returned by the GET API and visible in the UI until they are cleaned up.

Screenshot 2024-09-05 at 1 41 12 PM


"enrollment tokens" in the docs vs. "enrollment API keys" in the OpenAPI spec

Screenshot 2024-09-05 at 1 31 33 PM


"revoke token" vs. "invalidate API key"

Screenshot 2024-09-05 at 1 33 34 PM

@kilfoyle kilfoyle requested a review from a team as a code owner September 5, 2024 17:43
Copy link

github-actions bot commented Sep 5, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

jillguyonnet
jillguyonnet previously approved these changes Sep 10, 2024
Copy link
Contributor

@jillguyonnet jillguyonnet left a comment

Choose a reason for hiding this comment

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

Looks great, thank you 🚀

If I was to be super nitpicky, I could suggest adding a link to https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html, for example:

...setting has expired (see Invalidate API key API for details).

I agree with you regarding only mentioning that the token name must be unique. The reason behind it is not 100% clear and there is a possibility it will not always be the case. I've opened elastic/kibana#192469 to capture the open discussion that resulted from the previous doc improvement.

@kilfoyle
Copy link
Contributor Author

Good idea @jillguyonnet! I've added that link:

Screenshot 2024-09-10 at 10 00 39 AM

@kilfoyle
Copy link
Contributor Author

P.S., the new commit automatically removed your approval. Sorry. :-)

@jillguyonnet
Copy link
Contributor

Reapproved 🙂 Thanks for the change!

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM

@kilfoyle kilfoyle merged commit dc3b285 into elastic:main Sep 10, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Sep 10, 2024
* Fix up enrollment token docs

* fixup

* fixup

* Add link to 'Invalidate API key API'

(cherry picked from commit dc3b285)
kilfoyle added a commit that referenced this pull request Sep 10, 2024
* Fix up enrollment token docs

* fixup

* fixup

* Add link to 'Invalidate API key API'

(cherry picked from commit dc3b285)

Co-authored-by: David Kilfoyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve enrollment token docs and terminology consistency

3 participants