docs: add limactl help yq concept guide to explain yqlib limitations#4886
docs: add limactl help yq concept guide to explain yqlib limitations#4886Mysterio-17 wants to merge 1 commit intolima-vm:masterfrom
Conversation
|
|
||
| func newYQHelpCommand() *cobra.Command { | ||
| return &cobra.Command{ | ||
| Use: "yq", |
There was a problem hiding this comment.
This seems to conflict with the existing limactl yq command
There was a problem hiding this comment.
I missed that limactl yq is intercepted as a multicall binary. I've just pushed an update renaming the concept guide to yq-dialect, and I've updated the --set flag description to point there.
ef0dfac to
41f1478
Compare
| function check_location_without_cache() { | ||
| local -r location="$1" | ||
| curl -sIL -w "%{http_code} %header{Content-Length}" "${location}" -o /dev/null | ||
| curl --retry 5 --retry-connrefused -sIL -w "%{http_code} %header{Content-Length}" "${location}" -o /dev/null |
There was a problem hiding this comment.
This seems unrelated to the issue
b18afdd to
390ad8d
Compare
unsuman
left a comment
There was a problem hiding this comment.
Looks good, please squash the commits!
0b3ba6b to
39f0f5b
Compare
|
I think I would prefer I wonder if we should also mention that the new system operations are disabled as well? Of course they are also disabled by ❯ limactl yq -n 'system("ls")'
Error: system operations are disabled, use --security-enable-system-operator to enableWe probably should have a BATS tests to ensure we don't enable it by accident. Some other observations:
|
Adds a 'yq-restrictions' help topic explaining which yq operators are disabled by Lima (env, load, load_str) and which are disabled by yqlib itself (system), along with the security rationale. Updates the --set flag description to point to it. Adds a BATS test to ensure system() stays disabled. Signed-off-by: Mysterio-17 <mradultiwari1708@gmail.com>
39f0f5b to
cb3d817
Compare
Hi @jandubois , I've made the changes:-
|
Description
Addresses the missing documentation for the Lima
yqdialect by adding a concept guide that clarifies whichyqoperators are disabled for security reasons.Fixes: #4531
Changes
limactl help yqcommand to document unsupportedyqoperators (env,load,load_str).limactl yqinto the root command so it appears natively under "Additional help topics".--setflag description (used inlimactl create, etc.) to explicitly point users tolimactl help yq.Testing
limactl help: Verifiedyqis listed under "Additional help topics".limactl help yq: Verified it correctly prints the new concept guide.limactl create --help: Verified the--setflag correctly referenceslimactl help yq.go test ./cmd/limactl/...: Tests passed successfully with no regressions.