Skip to content

Commit 029e4f1

Browse files
authored
Merge pull request #53351 from rxinui/kyaml-nit
Add fixes for KYAML reference
2 parents 5be0375 + 5bdbbaa commit 029e4f1

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

content/en/docs/reference/_index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,19 @@ An archive of the design docs for Kubernetes functionality. Good starting points
115115
[Kubernetes Architecture](https://git.k8s.io/design-proposals-archive/architecture/architecture.md) and
116116
[Kubernetes Design Overview](https://git.k8s.io/design-proposals-archive).
117117

118+
## Encodings
119+
120+
Tools such as {{< glossary_tooltip text="kubectl" term_id="kubectl" >}}
121+
can work with different formats / encodings. These include:
122+
123+
* [CBOR](https://cbor.io/), used on the network but **not** available as a kubectl output format
124+
* See [CBOR resource encoding](https://kubernetes.io/docs/reference/using-api/api-concepts/#cbor-encoding)
125+
* [JSON](https://www.json.org/), available as a `kubectl` output format and also used at the HTTP layer
126+
* [KYAML](/docs/reference/encodings/kyaml), a Kubernetes dialect of YAML
127+
* KYAML is essentially an _output format_; any place where you can provide KYAML to Kubernetes, you can also provide any other valid YAML input
128+
* [YAML](https://yaml.org/), available as a `kubectl` output format and also used at the HTTP layer
129+
130+
Kubernetes also has a custom [protobuf encoding](/docs/reference/using-api/api-concepts/#protobuf-encoding) that is only used within HTTP messages.
131+
132+
The `kubectl` tool supports some other output formats, such as _custom columns_;
133+
see [output formats](/docs/reference/kubectl/#output-options) in the kubectl reference.

content/en/docs/reference/encodings/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ no_list: true
66
card:
77
name: encodings
88
title: Kubernetes encodings
9-
weight: 20
9+
weight: 125
1010
---
1111

0 commit comments

Comments
 (0)