From 4521fe7e49f57a50fadf32178e462c7b8ad5ffac Mon Sep 17 00:00:00 2001 From: Stefan Bueringer Date: Fri, 19 Jul 2024 13:12:28 +0200 Subject: [PATCH] Disentangle CRD additional printer columns & field selector sectiosn MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stefan Büringer buringerst@vmware.com --- .../custom-resource-definitions.md | 77 ++++++++++--------- 1 file changed, 39 insertions(+), 38 deletions(-) diff --git a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md index 867b4180eed48..9451ba3997e95 100644 --- a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md +++ b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md @@ -1630,6 +1630,45 @@ my-new-cron-object * * * * * 1 7s The `NAME` column is implicit and does not need to be defined in the CustomResourceDefinition. {{< /note >}} + +#### Priority + +Each column includes a `priority` field. Currently, the priority +differentiates between columns shown in standard view or wide view (using the `-o wide` flag). + +- Columns with priority `0` are shown in standard view. +- Columns with priority greater than `0` are shown only in wide view. + +#### Type + +A column's `type` field can be any of the following (compare +[OpenAPI v3 data types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#dataTypes)): + +- `integer` – non-floating-point numbers +- `number` – floating point numbers +- `string` – strings +- `boolean` – `true` or `false` +- `date` – rendered differentially as time since this timestamp. + +If the value inside a CustomResource does not match the type specified for the column, +the value is omitted. Use CustomResource validation to ensure that the value +types are correct. + +#### Format + +A column's `format` field can be any of the following: + +- `int32` +- `int64` +- `float` +- `double` +- `byte` +- `date` +- `date-time` +- `password` + +The column's `format` controls the style used when `kubectl` prints the value. + ### Field selectors [Field Selectors](/docs/concepts/overview/working-with-objects/field-selectors/) @@ -1720,44 +1759,6 @@ NAME COLOR SIZE example2 blue M ``` -#### Priority - -Each column includes a `priority` field. Currently, the priority -differentiates between columns shown in standard view or wide view (using the `-o wide` flag). - -- Columns with priority `0` are shown in standard view. -- Columns with priority greater than `0` are shown only in wide view. - -#### Type - -A column's `type` field can be any of the following (compare -[OpenAPI v3 data types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#dataTypes)): - -- `integer` – non-floating-point numbers -- `number` – floating point numbers -- `string` – strings -- `boolean` – `true` or `false` -- `date` – rendered differentially as time since this timestamp. - -If the value inside a CustomResource does not match the type specified for the column, -the value is omitted. Use CustomResource validation to ensure that the value -types are correct. - -#### Format - -A column's `format` field can be any of the following: - -- `int32` -- `int64` -- `float` -- `double` -- `byte` -- `date` -- `date-time` -- `password` - -The column's `format` controls the style used when `kubectl` prints the value. - ### Subresources Custom resources support `/status` and `/scale` subresources.