Skip to content

Commit 9f29cf9

Browse files
authored
Merge pull request #47205 from sbueringer/pr-fix-crd-doc
Disentangle CRD additional printer columns & field selector sections
2 parents 4fa3e70 + 4521fe7 commit 9f29cf9

File tree

1 file changed

+39
-38
lines changed

1 file changed

+39
-38
lines changed

content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1630,6 +1630,45 @@ my-new-cron-object * * * * * 1 7s
16301630
The `NAME` column is implicit and does not need to be defined in the CustomResourceDefinition.
16311631
{{< /note >}}
16321632

1633+
1634+
#### Priority
1635+
1636+
Each column includes a `priority` field. Currently, the priority
1637+
differentiates between columns shown in standard view or wide view (using the `-o wide` flag).
1638+
1639+
- Columns with priority `0` are shown in standard view.
1640+
- Columns with priority greater than `0` are shown only in wide view.
1641+
1642+
#### Type
1643+
1644+
A column's `type` field can be any of the following (compare
1645+
[OpenAPI v3 data types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#dataTypes)):
1646+
1647+
- `integer` – non-floating-point numbers
1648+
- `number` – floating point numbers
1649+
- `string` – strings
1650+
- `boolean` – `true` or `false`
1651+
- `date` – rendered differentially as time since this timestamp.
1652+
1653+
If the value inside a CustomResource does not match the type specified for the column,
1654+
the value is omitted. Use CustomResource validation to ensure that the value
1655+
types are correct.
1656+
1657+
#### Format
1658+
1659+
A column's `format` field can be any of the following:
1660+
1661+
- `int32`
1662+
- `int64`
1663+
- `float`
1664+
- `double`
1665+
- `byte`
1666+
- `date`
1667+
- `date-time`
1668+
- `password`
1669+
1670+
The column's `format` controls the style used when `kubectl` prints the value.
1671+
16331672
### Field selectors
16341673

16351674
[Field Selectors](/docs/concepts/overview/working-with-objects/field-selectors/)
@@ -1719,44 +1758,6 @@ NAME COLOR SIZE
17191758
example2 blue M
17201759
```
17211760

1722-
#### Priority
1723-
1724-
Each column includes a `priority` field. Currently, the priority
1725-
differentiates between columns shown in standard view or wide view (using the `-o wide` flag).
1726-
1727-
- Columns with priority `0` are shown in standard view.
1728-
- Columns with priority greater than `0` are shown only in wide view.
1729-
1730-
#### Type
1731-
1732-
A column's `type` field can be any of the following (compare
1733-
[OpenAPI v3 data types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#dataTypes)):
1734-
1735-
- `integer` – non-floating-point numbers
1736-
- `number` – floating point numbers
1737-
- `string` – strings
1738-
- `boolean` – `true` or `false`
1739-
- `date` – rendered differentially as time since this timestamp.
1740-
1741-
If the value inside a CustomResource does not match the type specified for the column,
1742-
the value is omitted. Use CustomResource validation to ensure that the value
1743-
types are correct.
1744-
1745-
#### Format
1746-
1747-
A column's `format` field can be any of the following:
1748-
1749-
- `int32`
1750-
- `int64`
1751-
- `float`
1752-
- `double`
1753-
- `byte`
1754-
- `date`
1755-
- `date-time`
1756-
- `password`
1757-
1758-
The column's `format` controls the style used when `kubectl` prints the value.
1759-
17601761
### Subresources
17611762

17621763
Custom resources support `/status` and `/scale` subresources.

0 commit comments

Comments
 (0)