You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: update CLI and helm reference for v2.51.0 - #477
Claude finished @github-actions[bot]'s task in 1m 9s —— View job
Doc review — v2.51.0 reference update
The only new content in this release is the --personal flag on the five api-key commands. Most of the diff is new sample data in kosli_get_snapshot.md, kosli_log_environment.md, kosli_list_*, kosli_get_environment.md and kosli_diff_snapshots.md: new timestamps, snapshot numbers, flow lists and commit SHAs. Nothing else changes in those pages. The version line in overview.md is correct.
The PR doesn't touch the hand-written pages below, but --personal makes them out of date. They need a follow-up PR.
user/personal_api_keys.md
Improvement.Location:user/personal_api_keys.md:13-36. Issue: The page says personal keys can only be created and revoked in the web app (Profile → API keys). The CLI can now do this too: kosli create, list, get, rotate and delete api-key --personal. There are also two rules the reader won't find anywhere else:
A personal key created with another API key is revoked together with that key, and expires no later than it.
Deleting a key also deletes every key created with it.
Recommendation: Add a short CLI section that links to /client_reference/kosli_create_api-key and the other four commands, and states both rules. Fix this →
administration/authentication/api_key_rotation.md
Improvement.Location:administration/authentication/api_key_rotation.md:7, :11, :26. Issue: The page describes rotation only for service account keys. Line 26 tells readers to "create a new personal key and revoke the old one", but kosli rotate api-key --personal now rotates personal keys directly. The page also doesn't mention a new limit: when you rotate a personal key using an API key as --api-token, you can only rotate that key and keys created with it, and the new key expires no later than that key. Recommendation: Say that personal keys can be rotated, update line 26, and add that limit to the Warning. If you want, also add a --personal example to the CLI tab in tutorials/rotating_api_keys.mdx:48. Fix this →
Upstream — does not block this merge
kosli-dev/cli → cmd/kosli/createApiKey.go (example "create a personal API key for yourself"). The example gives the personal key the description "key for CI". Two pages in this repo tell readers not to use personal keys in CI: user/personal_api_keys.md:10 and administration/managing_users/roles_in_kosli.md:239. Use a description like "local scripting" instead.
Summary: 0 Critical, 2 Improvement (both in follow-up pages), 1 upstream. This PR is a faithful regeneration and is fine to merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated update of CLI and Helm reference documentation for release
v2.51.0.