docs: make kubectl patch commands use yaml instead of json payloads, for legibility

[eitansuez]

Description:

i wonder whether the kubectl patch commands used in different guides can be recast using yaml instead of json, to eliminate some of that noise.

example:

https://gateway.envoyproxy.io/v1.0.1/tasks/security/basic-auth/#enable-https

kubectl patch gateway eg --type=json --patch '[{
   "op": "add",
   "path": "/spec/listeners/-",
   "value": {
      "name": "https",
      "protocol": "HTTPS",
      "port": 443,
      "tls": {
        "mode": "Terminate",
        "certificateRefs": [{
          "kind": "Secret",
          "group": "",
          "name": "example-cert",
        }],
      },
    },
}]'

becomes..

cat <<EOF | kubectl patch gateway eg --type=json --patch-file=/dev/stdin
- op: add
  path: "/spec/listeners/-"
  value:
    name: https
    protocol: HTTPS
    port: 443
    tls:
      mode: Terminate
      certificateRefs:
      - group: ""
        kind: Secret
        name: example-cert
EOF

i'm not sure the yaml example above is the canonical way of using kubectl patch with yaml. i'll look more closely at that if this issue is accepted post-triage.

[arkodg]

big +1

[eitansuez]

i looks like the above example can be simplified slightly to:

kubectl patch gateway eg --type=json --patch '
  - op: add
    path: "/spec/listeners/-"
    value:
      name: https
      protocol: HTTPS
      port: 443
      tls:
        mode: Terminate
        certificateRefs:
        - group: ""
          kind: Secret
          name: example-cert
  '

i'll use that format as the recipe to edit each instance.

[ShyunnY]

i looks like the above example can be simplified slightly to:

kubectl patch gateway eg --type=json --patch '
  - op: add
    path: "/spec/listeners/-"
    value:
      name: https
      protocol: HTTPS
      port: 443
      tls:
        mode: Terminate
        certificateRefs:
        - group: ""
          kind: Secret
          name: example-cert
  '

i'll use that format as the recipe to edit each instance.

Maybe it would be better to execute after we redirect the results to a file, like the solution you started with: cat <<EOF ... EOF

[eitansuez]

so for this issue the plan is to just translate the json to yaml. in a separate issue the idea is to provide two tabs, where one will just display the resource (or patch file) to apply, decoupled from the command that actually applies it.