From 5cadc09ef4c7965525ece7fdc72efb609f8b2a11 Mon Sep 17 00:00:00 2001 From: chenrui Date: Sun, 25 Nov 2018 09:42:21 +0800 Subject: [PATCH] zh-trans: add docs/reference/kubectl/jsonpath.md (#11252) --- content/zh/docs/reference/kubectl/jsonpath.md | 114 ++++++++++++++++++ content/zh/docs/user-guide/jsonpath.md | 63 ---------- 2 files changed, 114 insertions(+), 63 deletions(-) create mode 100644 content/zh/docs/reference/kubectl/jsonpath.md delete mode 100644 content/zh/docs/user-guide/jsonpath.md diff --git a/content/zh/docs/reference/kubectl/jsonpath.md b/content/zh/docs/reference/kubectl/jsonpath.md new file mode 100644 index 0000000000..25590b1202 --- /dev/null +++ b/content/zh/docs/reference/kubectl/jsonpath.md @@ -0,0 +1,114 @@ +--- +title: JSONPath 支持 +--- + + + + + +JSONPath 模板由 {} 包起来的 JSONPath 表达式组成。 +除了原始的 JSONPath 语法之外，我们还添加了三个函数： + + + +1. `$` 运算符是可选的，因为表达式默认情况下始终从根对象开始。 +2. 可以使用 `""` 来引用 JSONPath 表达式中的文本。 +3. 可以使用 `range` 运算符来遍历列表。 +4. 可以使用负切片索引来反向遍历列表。负索引并不会遍历完列表。它们只需要满足 `-index + listLength >= 0` 便可执行。 + + + +结果对象使用 String() 函数打印。 + + +给定输入： + +```json +{ + "kind": "List", + "items":[ + { + "kind":"None", + "metadata":{"name":"127.0.0.1"}, + "status":{ + "capacity":{"cpu":"4"}, + "addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}] + } + }, + { + "kind":"None", + "metadata":{"name":"127.0.0.2"}, + "status":{ + "capacity":{"cpu":"8"}, + "addresses":[ + {"type": "LegacyHostIP", "address":"127.0.0.2"}, + {"type": "another", "address":"127.0.0.3"} + ] + } + } + ], + "users":[ + { + "name": "myself", + "user": {} + }, + { + "name": "e2e", + "user": {"username": "admin", "password": "secret"} + } + ] +} +``` + + + +函数 | 描述 | 示例 | 结果 +---------|--------------------|--------------------|------------------ +text | 纯文本 | kind is {.kind} | kind 是 List +@ | 当前对象 | {@} | 与输入相同 +. or [] | 子运算符 | {.kind} or {['kind']}| List +.. | 递归下降 | {..name} | 127.0.0.1 127.0.0.2 myself e2e +\* | 通配符，获取所有对象| {.items[*].metadata.name} | [127.0.0.1 127.0.0.2] +[start:end :step] | 下标运算符 | {.users[0].name}| myself +[,] | 并集运算符 | {.items[*]['metadata.name', 'status.capacity']} | 127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8] +?() | 过滤器 | {.users[?(@.name=="e2e")].user.password} | secret +range, end | 遍历列表 | {range .items[*]}[{.metadata.name}, {.status.capacity}] {end} | [127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]] +'' | 引用解释字符串 | {range .items[*]}{.metadata.name}{'\t'}{end} | 127.0.0.1 127.0.0.2 + + +下面是使用 jsonpath 的一些例子： + +```shell +$ kubectl get pods -o json +$ kubectl get pods -o=jsonpath='{@}' +$ kubectl get pods -o=jsonpath='{.items[0]}' +$ kubectl get pods -o=jsonpath='{.items[0].metadata.name}' +$ kubectl get pods -o=jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.startTime}{"\n"}{end}' +``` + + + +在 Windows 上，你必须要 _双_ 引号（而不是上面 bash 例子中的单引号）来引用包含空格符的任何 JSONPath 模板。 +这也意味着，如果你要用字面值，必须要使用单引号或者转义双引号。例如： + +```cmd +C:\> kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{'\t'}{.status.startTime}{'\n'}{end}" +C:\> kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{\"\t\"}{.status.startTime}{\"\n\"}{end}" +``` diff --git a/content/zh/docs/user-guide/jsonpath.md b/content/zh/docs/user-guide/jsonpath.md deleted file mode 100644 index e85041951c..0000000000 --- a/content/zh/docs/user-guide/jsonpath.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: JSONPath 支持 ---- - -JSONPath 模板由 {} 包起来的 JSONPath 表达式组成。 -除了原始的 JSONPath 语法之外，我们还添加了三个函数： - -1. `$` 运算符是可选的，因为表达式默认情况下始终从根对象开始。 -2. 我们可以使用 `""` 来引用 JSONPath 表达式中的文本。 -3. 我们可以使用 `range` 运算符来迭代列表。 - -结果对象使用 String() 函数打印。 - -给定输入： - -```json -{ - "kind": "List", - "items":[ - { - "kind":"None", - "metadata":{"name":"127.0.0.1"}, - "status":{ - "capacity":{"cpu":"4"}, - "addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}] - } - }, - { - "kind":"None", - "metadata":{"name":"127.0.0.2"}, - "status":{ - "capacity":{"cpu":"8"}, - "addresses":[ - {"type": "LegacyHostIP", "address":"127.0.0.2"}, - {"type": "another", "address":"127.0.0.3"} - ] - } - } - ], - "users":[ - { - "name": "myself", - "user": {} - }, - { - "name": "e2e", - "user": {"username": "admin", "password": "secret"} - } - ] -} -``` -| 函数 | 描述 | 示例 | 结果 | -| ----------------- | ---------- | ---------------------------------------- | ---------------------------------------- | -| text | 纯文本 | kind is {.kind} | kind is List | -| @ | 当前对象 | {@} | 与输入相同 | -| . or [] | 子运算符 | {.kind} 或者 {['kind']} | List | -| .. | 递归下降 | {..name} | 127.0.0.1 127.0.0.2 myself e2e | -| * | 通配符，获取所有对象 | {.items[*].metadata.name} | [127.0.0.1 127.0.0.2] | -| [start:end :step] | 下标运算符 | {.users[0].name} | myself | -| [,] | 并集运算符 | {.items[*]['metadata.name', 'status.capacity']} | 127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8] | -| ?() | 过滤 | {.users[?(@.name=="e2e")].user.password} | secret | -| range, end | 迭代列表 | {range .items[*]}[{.metadata.name}, {.status.capacity}] {end} | [127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]] | -| "" | 引用解释执行字符串 | {range .items[*]}{.metadata.name}{"\t"}{end} | 127.0.0.1 127.0.0.2 | \ No newline at end of file