Skip to content

docs: update CLI and helm reference for v2.36.2 #349

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

Merged
mbevc1 merged 1 commit into from
Jul 30, 2026
Merged

docs: update CLI and helm reference for v2.36.2 #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions client_reference/kosli_create_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ The following types are supported:
- server - Generic type
- logical - Logical grouping of real environments

By default, kosli will not make new snapshots for scaling events (change in number of instances running).
For large clusters the scaling events will often outnumber the actual change of SW.

It is possible to enable new snapshots for scaling events with the --include-scaling flag, or turn
it off again with the --exclude-scaling.

Logical environments are used for grouping of physical environments. For instance **prod-aws** and **prod-s3** can
be grouped into logical environment **prod**. Logical environments are view-only, you can not report snapshots
to them.
Expand All @@ -40,9 +34,7 @@ to them.
| :--- | :--- |
| `-d`, `--description` string | [optional] The environment description. |
| `-D`, `--dry-run` | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| `--exclude-scaling` | [optional] Exclude scaling events for snapshots. Snapshots with scaling changes will not result in new environment records. |
| `-h`, `--help` | help for environment |
| `--include-scaling` | [optional] Include scaling events for snapshots. Snapshots with scaling changes will result in new environment records. |
| `--included-environments` strings | [optional] Comma separated list of environments to include in logical environment |
| `-t`, `--type` string | The type of environment. Valid types are: [K8S, ECS, S3, lambda, server, docker, azure-apps, cloud-run, logical]. |

Expand Down
3 changes: 3 additions & 0 deletions client_reference/kosli_delete_api-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ This permanently deletes the API key(s) identified by KEY-ID. Deletion is immedi
cannot be undone. You are asked to confirm before the key is deleted; use
`--assume-yes`/`--yes` to skip the confirmation prompt.

When stdin is not interactive (e.g. in CI) the prompt cannot be answered and the
command fails without deleting anything, so pass `--assume-yes` there.

## Flags
| Flag | Description |
| :--- | :--- |
Expand Down
3 changes: 3 additions & 0 deletions client_reference/kosli_delete_service-account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ from the organization, along with their API keys. Deletion is immediate and
cannot be undone. You are asked to confirm before deletion; use
`--assume-yes`/`--yes` to skip the confirmation prompt.

When stdin is not interactive (e.g. in CI) the prompt cannot be answered and the
command fails without deleting anything, so pass `--assume-yes` there.

## Flags
| Flag | Description |
| :--- | :--- |
Expand Down
76 changes: 51 additions & 25 deletions client_reference/kosli_diff_snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,36 @@ kosli diff snapshots aws-beta aws-prod --output=json
```json
{
"snappish1": {
"snapshot_id": "aws-beta#7875",
"artifacts": []
"snapshot_id": "aws-beta#7885",
"artifacts": [
{
"fingerprint": "26a4c8a14ccf71978ec75fe01edad50d892d7f9054f95fc41d6922fb42995d59",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/creator:07ed087@sha256:26a4c8a14ccf71978ec75fe01edad50d892d7f9054f95fc41d6922fb42995d59",
"most_recent_timestamp": 1785398324,
"flow": "creator-ci",
"commit_url": "https://github.com/cyber-dojo/creator/commit/07ed087071878b405ac1cf7fe77e5d8c70ce3a4b",
"instance_count": 1
},
{
"fingerprint": "7b162dcd6aff6c3eab5ca66d9b0bc0115120b7304cabf5c33f6c91af7f9eb756",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/dashboard:56e831a@sha256:7b162dcd6aff6c3eab5ca66d9b0bc0115120b7304cabf5c33f6c91af7f9eb756",
"most_recent_timestamp": 1785398972,
"flow": "dashboard-ci",
"commit_url": "https://github.com/cyber-dojo/dashboard/commit/56e831abe6a2ec870c0f9d9f214821eb3ebf9c32",
"instance_count": 1
},
{
"fingerprint": "a5b224c24732c48daaf6ea495e57345bc4b9fde34b37bf4b7c758b6ee778bee3",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/saver:595e902@sha256:a5b224c24732c48daaf6ea495e57345bc4b9fde34b37bf4b7c758b6ee778bee3",
"most_recent_timestamp": 1785392629,
"flow": "saver-ci",
"commit_url": "https://github.com/cyber-dojo/saver/commit/595e902fa2f5844d9ce0612a5c9295cd8dab5b97",
"instance_count": 1
}
]
},
"snappish2": {
"snapshot_id": "aws-prod#5134",
"artifacts": []
},
"changed": {
"artifacts": []
},
"not-changed": {
"snapshot_id": "aws-prod#5138",
"artifacts": [
{
"fingerprint": "680e9bb851165e8a6e3bc52c1be106286fa910b57c17d844ee052fd3e104e9b4",
Expand All @@ -86,6 +105,29 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/saver/commit/c29db2ce6d16a9ace09a8548b0cc39fd608abd2e",
"instance_count": 1
},
{
"fingerprint": "aaf68b01cfe75f9012155d59cc7421dac140457ea7f5eb1e508e12b7f1e58aa6",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/creator:76672a8@sha256:aaf68b01cfe75f9012155d59cc7421dac140457ea7f5eb1e508e12b7f1e58aa6",
"most_recent_timestamp": 1784357070,
"flow": "creator-ci",
"commit_url": "https://github.com/cyber-dojo/creator/commit/76672a8b247049c3ce8c3140852e17be8f47d995",
"instance_count": 1
},
{
"fingerprint": "c7481eac72e01e25aa4f1dda5e8fa1f8c89215d32c32891762e3fc0b99fbfe98",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/dashboard:0fb0be4@sha256:c7481eac72e01e25aa4f1dda5e8fa1f8c89215d32c32891762e3fc0b99fbfe98",
"most_recent_timestamp": 1785241255,
"flow": "dashboard-ci",
"commit_url": "https://github.com/cyber-dojo/dashboard/commit/0fb0be439480821efb926a5079e39ce5941eaa48",
"instance_count": 1
}
]
},
"changed": {
"artifacts": []
},
"not-changed": {
"artifacts": [
{
"fingerprint": "6ca8f8d96e1fe8c360fce64b81c330c4ac05d3f128461be4034d36b37147eeac",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/spooler:c81791f@sha256:6ca8f8d96e1fe8c360fce64b81c330c4ac05d3f128461be4034d36b37147eeac",
Expand All @@ -110,14 +152,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/custom-start-points/commit/790d86b66f4d86ab47f5c521daf5039dc8aeef4d",
"instance_count": 1
},
{
"fingerprint": "aaf68b01cfe75f9012155d59cc7421dac140457ea7f5eb1e508e12b7f1e58aa6",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/creator:76672a8@sha256:aaf68b01cfe75f9012155d59cc7421dac140457ea7f5eb1e508e12b7f1e58aa6",
"most_recent_timestamp": 1784357070,
"flow": "creator-ci",
"commit_url": "https://github.com/cyber-dojo/creator/commit/76672a8b247049c3ce8c3140852e17be8f47d995",
"instance_count": 1
},
{
"fingerprint": "af5870236f643273d1f26a7f842fd2b616b0f766cc2ac177c6d8f9882b90851e",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/web:2779354@sha256:af5870236f643273d1f26a7f842fd2b616b0f766cc2ac177c6d8f9882b90851e",
Expand Down Expand Up @@ -150,14 +184,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/differ/commit/1b7ea87a174a1a290600b469dc1029ec4c974320",
"instance_count": 1
},
{
"fingerprint": "c7481eac72e01e25aa4f1dda5e8fa1f8c89215d32c32891762e3fc0b99fbfe98",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/dashboard:0fb0be4@sha256:c7481eac72e01e25aa4f1dda5e8fa1f8c89215d32c32891762e3fc0b99fbfe98",
"most_recent_timestamp": 1785241255,
"flow": "dashboard-ci",
"commit_url": "https://github.com/cyber-dojo/dashboard/commit/0fb0be439480821efb926a5079e39ce5941eaa48",
"instance_count": 1
},
{
"fingerprint": "c7b7fd69d904329f9264e111bd3dc63cf98724cce567bae719e79a171e6925ea",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/exercises-start-points:258b6d0@sha256:c7b7fd69d904329f9264e111bd3dc63cf98724cce567bae719e79a171e6925ea",
Expand Down
6 changes: 3 additions & 3 deletions client_reference/kosli_get_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ kosli get environment aws-prod --output=json
"name": "aws-prod",
"type": "ECS",
"description": "The ECS cluster for production cyber-dojo",
"last_modified_at": 1785324178.5060613,
"last_reported_at": 1785324178.5060613,
"last_changed_at": 1785310558.4611607,
"last_modified_at": 1785405118.3597527,
"last_reported_at": 1785405118.3597527,
"last_changed_at": 1785386758.6525679,
"state": true,
"include_scaling": false,
"tags": {
Expand Down
Loading