From 1a3f622207a1631e2a7db89e03130f1b4a6dea0e Mon Sep 17 00:00:00 2001 From: Phillip Wittrock Date: Thu, 12 Dec 2019 09:34:14 -0800 Subject: [PATCH] regenerate docs and license --- cmd/config/cmddocs/api/docs.go | 70 ++++++++++++++++++-------------- kyaml/commandutil/commandutil.go | 3 ++ 2 files changed, 42 insertions(+), 31 deletions(-) diff --git a/cmd/config/cmddocs/api/docs.go b/cmd/config/cmddocs/api/docs.go index 45205cfa9..d0ea008d5 100644 --- a/cmd/config/cmddocs/api/docs.go +++ b/cmd/config/cmddocs/api/docs.go @@ -288,53 +288,61 @@ Following is an example of running the ` + "`" + `kustomize config run` + "`" + var ConfigIoLong = `# Configuration IO API Semantics - Resource Configuration may be read / written from / to sources such as directories, - 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. +Resource Configuration may be read / written from / to sources such as directories, +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. - Tools **SHOULD** write the following annotations when reading from sources, - and **SHOULD** respect the annotations when writing to syncs. +Tools **SHOULD** write the following annotations when reading from sources, +and **SHOULD** respect the annotations when writing to sinks. ### ` + "`" + `config.kubernetes.io/path` + "`" + ` - ` + "`" + `config.kubernetes.io/path` + "`" + ` records a relative path on a Resource. This annotation - **SHOULD** be set when reading Resources from files. - When writing Resources to a directory, the Resource **SHOULD** be written to the corresponding - path relative to that directory. +Records the slash-delimited, OS-agnostic, relative file path to a Resource. - Example: +This annotation **SHOULD** be set when reading Resources from files. +When writing Resources to a directory, the Resource **SHOULD** be written to the corresponding +path relative to that directory. - metadata: - annotations: - config.kubernetes.io/path: "relative/file/path.yaml" +Example: + + metadata: + annotations: + config.kubernetes.io/path: "relative/file/path.yaml" ### ` + "`" + `config.kubernetes.io/index` + "`" + ` - ` + "`" + `config.kubernetes.io/index` + "`" + ` records the index of a Resource into a file which may contain - multiple Resource. This annotation **SHOULD** be set when reading Resources from files. - When writing multiple Resources to the same file, the Resource **SHOULD** be written in the - relative order matching the index. +Records the index of a Resource in file. In a multi-object files YAML file, Resources are separated +by three dashes (` + "`" + `---` + "`" + `), and the index represents the positon of the Resource starting from zero. - Example: +This annotation **SHOULD** be set when reading Resources from files. +When writing multiple Resources to the same file, the Resource **SHOULD** be written in the +relative order matching the index. - metadata: - annotations: - config.kubernetes.io/index: "0" +When this annotation is not specified, it implies a value of ` + "`" + `0` + "`" + `. + +Example: + + metadata: + annotations: + config.kubernetes.io/path: "relative/file/path.yaml" + config.kubernetes.io/index: 2 + +This represents the third Resource in the file. ### ` + "`" + `config.kubernetes.io/local-config` + "`" + ` - ` + "`" + `config.kubernetes.io/local-config` + "`" + ` declares that the configuration is to local tools - rather than a remote Resource. e.g. The ` + "`" + `Kustomization` + "`" + ` config in a ` + "`" + `kustomization.yaml` + "`" + ` - **SHOULD** contain this annotation so that tools know it is not intended to be sent to - the Kubernetes api server. +` + "`" + `config.kubernetes.io/local-config` + "`" + ` declares that the configuration is to local tools +rather than a remote Resource. e.g. The ` + "`" + `Kustomization` + "`" + ` config in a ` + "`" + `kustomization.yaml` + "`" + ` +**SHOULD** contain this annotation so that tools know it is not intended to be sent to +the Kubernetes api server. - Example: +Example: - metadata: - annotations: - config.kubernetes.io/local-config: "true"` + metadata: + annotations: + config.kubernetes.io/local-config: "true"` var Merge2Long = `# Merge (2-way) diff --git a/kyaml/commandutil/commandutil.go b/kyaml/commandutil/commandutil.go index 8463c1e8f..ac0291aa7 100644 --- a/kyaml/commandutil/commandutil.go +++ b/kyaml/commandutil/commandutil.go @@ -1,3 +1,6 @@ +// Copyright 2019 The Kubernetes Authors. +// SPDX-License-Identifier: Apache-2.0 + package commandutil import (