Skip to content

Commit f0840a3

Browse files
committed
added documentation
1 parent c609aa6 commit f0840a3

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,31 @@ python krr.py simple --selector 'app.kubernetes.io/instance in (robusta, ingress
352352
```
353353
</details>
354354

355+
<details>
356+
<summary>Group jobs by specific labels</summary>
357+
358+
Group jobs that have specific labels into GroupedJob objects for consolidated resource recommendations. This is useful for batch jobs, data processing pipelines, or any workload where you want to analyze resource usage across multiple related jobs.
359+
360+
```sh
361+
krr simple --job-grouping-labels app,team
362+
```
363+
364+
This will:
365+
- Group jobs that have either `app` or `team` labels (or both)
366+
- Create GroupedJob objects with names like `app=frontend`, `team=backend`, etc.
367+
- Provide resource recommendations for the entire group instead of individual jobs
368+
- Jobs with the specified labels will be excluded from regular Job listing
369+
370+
You can specify multiple labels separated by commas:
371+
372+
```sh
373+
krr simple --job-grouping-labels app,team,environment
374+
```
375+
376+
Each job will be grouped by each label it has, so a job with `app=api,team=backend` will appear in both `app=api` and `team=backend` groups.
377+
378+
</details>
379+
355380
<details>
356381
<summary>Override the kubectl context</summary>
357382

0 commit comments

Comments
 (0)