Merge pull request #40836 from iyear/feat/jsonpath-escape-dot

kubectl/jsonpath: add example of escaping termination character

Author: k8s-ci-robot

content/en/docs/reference/kubectl/jsonpath.md

@@ -34,7 +34,12 @@ Given the JSON input:
   "items":[
     {
       "kind":"None",
-      "metadata":{"name":"127.0.0.1"},
+      "metadata":{
+        "name":"127.0.0.1",
+        "labels":{
+          "kubernetes.io/hostname":"127.0.0.1"
+        }
+      },
       "status":{
         "capacity":{"cpu":"4"},
         "addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}]
@@ -65,18 +70,19 @@ Given the JSON input:
 }
 ```
 
-Function            | Description               | Example                                                         | Result
---------------------|---------------------------|-----------------------------------------------------------------|------------------
-`text`              | the plain text            | `kind is {.kind}`                                               | `kind is List`
-`@`                 | the current object        | `{@}`                                                           | the same as input
-`.` or `[]`         | child operator            | `{.kind}`, `{['kind']}` or `{['name\.type']}`                   | `List`
-`..`                | recursive descent         | `{..name}`                                                      | `127.0.0.1 127.0.0.2 myself e2e`
-`*`                 | wildcard. Get all objects | `{.items[*].metadata.name}`                                     | `[127.0.0.1 127.0.0.2]`
-`[start:end:step]` | subscript operator        | `{.users[0].name}`                                              | `myself`
-`[,]`               | union operator            | `{.items[*]['metadata.name', 'status.capacity']}`               | `127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8]`
-`?()`               | filter                    | `{.users[?(@.name=="e2e")].user.password}`                      | `secret`
-`range`, `end`      | iterate list              | `{range .items[*]}[{.metadata.name}, {.status.capacity}] {end}` | `[127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]]`
-`''`                | quote interpreted string  | `{range .items[*]}{.metadata.name}{'\t'}{end}`                  | `127.0.0.1      127.0.0.2`
+Function            | Description                  | Example                                                         | Result
+--------------------|------------------------------|-----------------------------------------------------------------|------------------
+`text`              | the plain text               | `kind is {.kind}`                                               | `kind is List`
+`@`                 | the current object           | `{@}`                                                           | the same as input
+`.` or `[]`         | child operator               | `{.kind}`, `{['kind']}` or `{['name\.type']}`                   | `List`
+`..`                | recursive descent            | `{..name}`                                                      | `127.0.0.1 127.0.0.2 myself e2e`
+`*`                 | wildcard. Get all objects    | `{.items[*].metadata.name}`                                     | `[127.0.0.1 127.0.0.2]`
+`[start:end:step]` | subscript operator           | `{.users[0].name}`                                              | `myself`
+`[,]`               | union operator               | `{.items[*]['metadata.name', 'status.capacity']}`               | `127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8]`
+`?()`               | filter                       | `{.users[?(@.name=="e2e")].user.password}`                      | `secret`
+`range`, `end`      | iterate list                 | `{range .items[*]}[{.metadata.name}, {.status.capacity}] {end}` | `[127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]]`
+`''`                | quote interpreted string     | `{range .items[*]}{.metadata.name}{'\t'}{end}`                  | `127.0.0.1      127.0.0.2`
+`\`                 | escape termination character | `{.items[0].metadata.labels.kubernetes\.io/hostname}`           | `127.0.0.1`
 
 Examples using `kubectl` and JSONPath expressions:
 
@@ -87,6 +93,7 @@ kubectl get pods -o=jsonpath='{.items[0]}'
 kubectl get pods -o=jsonpath='{.items[0].metadata.name}'
 kubectl get pods -o=jsonpath="{.items[*]['metadata.name', 'status.capacity']}"
 kubectl get pods -o=jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.startTime}{"\n"}{end}'
+kubectl get pods -o=jsonpath='{.items[0].metadata.labels.kubernetes\.io/hostname}'
 ```
 
 {{< note >}}