Document KHI job mode#709
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for running KHI in job mode. It adds a new guide, docs/en/setup-guide/job-mode.md, which details the required flags, command format, inspection values, and feature selection, and updates README.md to link to this new guide. There are no review comments, and I have no feedback to provide.
|
This is ready for review from my side. The remaining github-deploy-ondemand check appears to require project-side approval/run permissions; could someone take a look or trigger it when convenient? |
| --job-mode \ | ||
| --job-inspection-type gcp-gke \ | ||
| --job-inspection-features ALL \ | ||
| --job-inspection-values '{ |
There was a problem hiding this comment.
I think the most difficult part of this feature is building the --job-inspection-values parameter.
The current easiest way is using dev tool on browser to see what is sent from the frontend. It's a little hacky way but worth to be documented.
| "cloud.google.com/common/input-location": "us-central1", | ||
| "cloud.google.com/common/input-end-time": "2026-01-15T10:00:00Z", | ||
| "cloud.google.com/common/input-duration": "2h", | ||
| "<inspection-specific-field-id>": "<value>" |
There was a problem hiding this comment.
It would be better if we can show the example workable job command with the full parameter.
The current example lacks of many parameters and user need to find what are missing. It'll be nicer if we can list keys required for actually running the job mode. Values for the parameters can be placeholder then.
41a81bf to
0c9b9a5
Compare
|
Thanks, I updated the job mode doc in two places:
I kept the wording scoped because the exact required fields still depend on the selected inspection type and enabled features. |
Summary
Fixes #196
Tests
go test ./pkg/parametersgit diff --check