kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-05-23 07:17:02 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Merge pull request #1965 from prachirp/config-doc

Browse Source 
Clarify removing annotations in config-io
This commit is contained in:
Kubernetes Prow Robot
2019-12-16 09:27:38 -08:00
committed by GitHub
parent 3b904108bd b5dba5b4da
commit 2fc224c2ff
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cmd/config/docs/api-conventions/config-io.md
View File

@@ -4,16 +4,17 @@ Resource Configuration may be read / written from / to sources such as directori
stdin|out or network. Tools may be composed using pipes such that the tools writing
Resource Configuration may be a different tool from the one that read the configuration.
In order for tools to be composed in this way, while preserving origin information --
such as the original file, index, etc.
such as the original file, index, etc.:
Tools **SHOULD** write the following annotations when reading from sources,
and **SHOULD** respect the annotations when writing to sinks.
Tools **SHOULD** insert the following annotations when reading from sources,
and **SHOULD** delete the annotations when writing to sinks.
### `config.kubernetes.io/path`
Records the slash-delimited, OS-agnostic, relative file path to a Resource.
This annotation **SHOULD** be set when reading Resources from files.
It **SHOULD** be unset when writing Resources to files.
When writing Resources to a directory, the Resource **SHOULD** be written to the corresponding
path relative to that directory.
@@ -27,10 +28,11 @@ metadata:
### `config.kubernetes.io/index`
Records the index of a Resource in file. In a multi-object files YAML file, Resources are separated
Records the index of a Resource in file. In a multi-object YAML file, Resources are separated
by three dashes (`---`), and the index represents the positon of the Resource starting from zero.
This annotation **SHOULD** be set when reading Resources from files.
It **SHOULD** be unset when writing Resources to files.
When writing multiple Resources to the same file, the Resource **SHOULD** be written in the
relative order matching the index.