kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-09-15 12:18:57 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

revert generated doc change

Browse Source
This commit is contained in:
Jijie Wei
2020-06-23 14:22:09 -07:00
parent b92de5cb80
commit e32aa8ddb2
3 changed files with 76 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
cmd/config/internal/generateddocs/api/docs.go
View File

@@ -1,9 +1,10 @@
// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
// Code generated by "mdtogo"; DO NOT EDIT. // Code generated by "mdtogo"; DO NOT EDIT.
package api package api
var ConfigIoLong=`# Configuration IO API Semantics var ConfigIoLong = `# Configuration IO API Semantics
Resource Configuration may be read / written from / to sources such as directories, 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 stdin|out or network. Tools may be composed using pipes such that the tools writing
@@ -63,8 +64,8 @@ Example:
annotations: annotations:
config.kubernetes.io/local-config: "true"` config.kubernetes.io/local-config: "true"`
var FunctionsImplShort=`Following is an example for implementing an nginx abstraction using a configuration` var FunctionsImplShort = `Following is an example for implementing an nginx abstraction using a configuration`
var FunctionsImplLong=`# Running Configuration Functions using kustomize CLI var FunctionsImplLong = `# Running Configuration Functions using kustomize CLI
Configuration functions can be implemented using any toolchain and invoked using any Configuration functions can be implemented using any toolchain and invoked using any
container workflow orchestrator including Tekton, Cloud Build, or run directly using ` + "`" + `docker run` + "`" + `. container workflow orchestrator including Tekton, Cloud Build, or run directly using ` + "`" + `docker run` + "`" + `.
@@ -233,8 +234,8 @@ The function is invoked using byrunning ` + "`" + `kustomize config run dir/` +
app: nginx app: nginx
instance: my-instance` instance: my-instance`
var FunctionsSpecShort=`_Configuration functions_ enable shift-left practices (client-side) through:` var FunctionsSpecShort = `_Configuration functions_ enable shift-left practices (client-side) through:`
var FunctionsSpecLong=`# Configuration Functions Specification var FunctionsSpecLong = `# Configuration Functions Specification
This document specifies a standard for client-side functions that operate on This document specifies a standard for client-side functions that operate on
Kubernetes declarative configurations. This standard enables creating Kubernetes declarative configurations. This standard enables creating
@@ -411,7 +412,7 @@ A non-zero exit code indicates a failure.
[2]: https://tools.ietf.org/html/rfc2119 [2]: https://tools.ietf.org/html/rfc2119
[3]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds` [3]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#types-kinds`
var Merge2Long=`# Merge (2-way) var Merge2Long = `# Merge (2-way)
2-way merges fields from a source to a destination, overriding the destination fields 2-way merges fields from a source to a destination, overriding the destination fields
where they differ. where they differ.
@@ -503,7 +504,7 @@ var Merge2Long=`# Merge (2-way)
- name: sidecar2 - name: sidecar2
image: sidecar2:v1` image: sidecar2:v1`
var Merge3Long=`# Merge (3-way) var Merge3Long = `# Merge (3-way)
3-way merge identifies changes between an original source + updated source and merges the result 3-way merge identifies changes between an original source + updated source and merges the result
into a destination, overriding the destination fields where they have changed between into a destination, overriding the destination fields where they have changed between

113
cmd/config/internal/generateddocs/commands/docs.go
View File

@@ -1,30 +1,31 @@
// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
// Code generated by "mdtogo"; DO NOT EDIT. // Code generated by "mdtogo"; DO NOT EDIT.
package commands package commands
var AnnotateShort=`[Alpha] Set an annotation on Resources.` var AnnotateShort = `[Alpha] Set an annotation on Resources.`
var AnnotateLong=` var AnnotateLong = `
[Alpha] Set an annotation on Resources. [Alpha] Set an annotation on Resources.
DIR: DIR:
Path to local directory. Path to local directory.
` `
var AnnotateExamples=` var AnnotateExamples = `
kustomize cfg annotate my-dir/ --kv foo=bar kustomize cfg annotate my-dir/ --kv foo=bar
kustomize cfg annotate my-dir/ --kv foo=bar --kv a=b kustomize cfg annotate my-dir/ --kv foo=bar --kv a=b
kustomize cfg annotate my-dir/ --kv foo=bar --kind Deployment --name foo` kustomize cfg annotate my-dir/ --kv foo=bar --kind Deployment --name foo`
var CatShort=`[Alpha] Print Resource Config from a local directory.` var CatShort = `[Alpha] Print Resource Config from a local directory.`
var CatLong=` var CatLong = `
[Alpha] Print Resource Config from a local directory. [Alpha] Print Resource Config from a local directory.
DIR: DIR:
Path to local directory. Path to local directory.
` `
var CatExamples=` var CatExamples = `
# print Resource config from a directory # print Resource config from a directory
kustomize cfg cat my-dir/ kustomize cfg cat my-dir/
@@ -34,8 +35,8 @@ var CatExamples=`
# unwrap Resource config from a directory in an ResourceList # unwrap Resource config from a directory in an ResourceList
... | kustomize cfg cat` ... | kustomize cfg cat`
var CompletionShort=`Install shell completion.` var CompletionShort = `Install shell completion.`
var CompletionLong=` var CompletionLong = `
Install shell completion for kustomize commands and flags -- supports bash, fish and zsh. Install shell completion for kustomize commands and flags -- supports bash, fish and zsh.
kustomize install-completion kustomize install-completion
@@ -51,19 +52,19 @@ To uninstall shell completion run:
COMP_UNINSTALL=1 kustomize install-completion` COMP_UNINSTALL=1 kustomize install-completion`
var CountShort=`[Alpha] Count Resources Config from a local directory.` var CountShort = `[Alpha] Count Resources Config from a local directory.`
var CountLong=` var CountLong = `
[Alpha] Count Resources Config from a local directory. [Alpha] Count Resources Config from a local directory.
DIR: DIR:
Path to local directory. Path to local directory.
` `
var CountExamples=` var CountExamples = `
# print Resource counts from a directory # print Resource counts from a directory
kustomize cfg count my-dir/` kustomize cfg count my-dir/`
var CreateSetterShort=`[Alpha] Create a custom setter for a Resource field` var CreateSetterShort = `[Alpha] Create a custom setter for a Resource field`
var CreateSetterLong=` var CreateSetterLong = `
Create a custom setter for a Resource field by inlining OpenAPI as comments. Create a custom setter for a Resource field by inlining OpenAPI as comments.
DIR DIR
@@ -78,7 +79,7 @@ Create a custom setter for a Resource field by inlining OpenAPI as comments.
The current value of the field, or a substring within the field. The current value of the field, or a substring within the field.
` `
var CreateSetterExamples=` var CreateSetterExamples = `
# create a setter for port fields matching "8080" # create a setter for port fields matching "8080"
kustomize cfg create-setter DIR/ port 8080 --type "integer" --field port \ kustomize cfg create-setter DIR/ port 8080 --type "integer" --field port \
--description "default port used by the app" --description "default port used by the app"
@@ -88,8 +89,24 @@ var CreateSetterExamples=`
kustomize cfg create-setter DIR/ image-tag v1.0.1 --type "string" \ kustomize cfg create-setter DIR/ image-tag v1.0.1 --type "string" \
--field image --description "current stable release"` --field image --description "current stable release"`
var FmtShort=`[Alpha] Format yaml configuration files.` var DeleteSetterShort = `[Alpha] Delete a custom setter for a Resource field`
var FmtLong=` var DeleteSetterLong = `
Delete a custom setter for a Resource field.
DIR
A directory containing Resource configuration.
NAME
The name of the setter to create.
`
var DeleteSetterExamples = `
# delete a setter for port
kustomize cfg create-setter DIR/ port`
var FmtShort = `[Alpha] Format yaml configuration files.`
var FmtLong = `
[Alpha] Format yaml configuration files. [Alpha] Format yaml configuration files.
Fmt will format input by ordering fields and unordered list items in Kubernetes Fmt will format input by ordering fields and unordered list items in Kubernetes
@@ -115,7 +132,7 @@ field paths.
- .spec.template.spec.containers (by element name) - .spec.template.spec.containers (by element name)
- .webhooks.rules.operations (by element value) - .webhooks.rules.operations (by element value)
` `
var FmtExamples=` var FmtExamples = `
# format file1.yaml and file2.yml # format file1.yaml and file2.yml
kustomize cfg fmt file1.yaml file2.yml kustomize cfg fmt file1.yaml file2.yml
@@ -128,8 +145,8 @@ var FmtExamples=`
# format kustomize output # format kustomize output
kustomize build | kustomize cfg fmt` kustomize build | kustomize cfg fmt`
var GrepShort=`[Alpha] Search for matching Resources in a directory or from stdin` var GrepShort = `[Alpha] Search for matching Resources in a directory or from stdin`
var GrepLong=` var GrepLong = `
[Alpha] Search for matching Resources in a directory or from stdin. [Alpha] Search for matching Resources in a directory or from stdin.
QUERY: QUERY:
@@ -142,7 +159,7 @@ var GrepLong=`
DIR: DIR:
Path to local directory. Path to local directory.
` `
var GrepExamples=` var GrepExamples = `
# find Deployment Resources # find Deployment Resources
kustomize cfg grep "kind=Deployment" my-dir/ kustomize cfg grep "kind=Deployment" my-dir/
@@ -155,22 +172,22 @@ var GrepExamples=`
# look for Resources matching a specific container image # look for Resources matching a specific container image
kustomize cfg grep "spec.template.spec.containers[name=nginx].image=nginx:1\.7\.9" my-dir/ | kustomize cfg tree` kustomize cfg grep "spec.template.spec.containers[name=nginx].image=nginx:1\.7\.9" my-dir/ | kustomize cfg tree`
var InitShort=`[Alpha] Initialize a directory with a Krmfile.` var InitShort = `[Alpha] Initialize a directory with a Krmfile.`
var InitLong=` var InitLong = `
[Alpha] Initialize a directory with a Krmfile. [Alpha] Initialize a directory with a Krmfile.
DIR: DIR:
Path to local directory. Path to local directory.
` `
var InitExamples=` var InitExamples = `
# create a Krmfile in the local directory # create a Krmfile in the local directory
kustomize cfg init kustomize cfg init
# create a Krmfile in my-dir/ # create a Krmfile in my-dir/
kustomize cfg init my-dir/` kustomize cfg init my-dir/`
var ListSettersShort=`[Alpha] List setters for Resources.` var ListSettersShort = `[Alpha] List setters for Resources.`
var ListSettersLong=` var ListSettersLong = `
List setters for Resources. List setters for Resources.
DIR DIR
@@ -181,15 +198,15 @@ List setters for Resources.
Optional. The name of the setter to display. Optional. The name of the setter to display.
` `
var ListSettersExamples=` var ListSettersExamples = `
Show setters: Show setters:
$ kustomize cfg list-setters DIR/ $ kustomize cfg list-setters DIR/
NAME DESCRIPTION VALUE TYPE COUNT SETBY NAME DESCRIPTION VALUE TYPE COUNT SETBY
name-prefix '' PREFIX string 2` name-prefix '' PREFIX string 2`
var MergeShort=`[Alpha] Merge Resource configuration files` var MergeShort = `[Alpha] Merge Resource configuration files`
var MergeLong=` var MergeLong = `
[Alpha] Merge Resource configuration files [Alpha] Merge Resource configuration files
Merge reads Kubernetes Resource yaml configuration files from stdin or sources packages and write Merge reads Kubernetes Resource yaml configuration files from stdin or sources packages and write
@@ -205,11 +222,11 @@ For information on merge rules, run:
kustomize cfg docs merge kustomize cfg docs merge
` `
var MergeExamples=` var MergeExamples = `
cat resources_and_patches.yaml | kustomize cfg merge > merged_resources.yaml` cat resources_and_patches.yaml | kustomize cfg merge > merged_resources.yaml`
var Merge3Short=`[Alpha] Merge diff of Resource configuration files into a destination (3-way)` var Merge3Short = `[Alpha] Merge diff of Resource configuration files into a destination (3-way)`
var Merge3Long=` var Merge3Long = `
[Alpha] Merge diff of Resource configuration files into a destination (3-way) [Alpha] Merge diff of Resource configuration files into a destination (3-way)
Merge3 performs a 3-way merge by applying the diff between 2 sets of Resources to a 3rd set. Merge3 performs a 3-way merge by applying the diff between 2 sets of Resources to a 3rd set.
@@ -224,11 +241,11 @@ For information on merge rules, run:
kustomize cfg docs-merge3 kustomize cfg docs-merge3
` `
var Merge3Examples=` var Merge3Examples = `
kustomize cfg merge3 --ancestor a/ --from b/ --to c/` kustomize cfg merge3 --ancestor a/ --from b/ --to c/`
var RunFnsShort=`[Alpha] Reoncile config functions to Resources.` var RunFnsShort = `[Alpha] Reoncile config functions to Resources.`
var RunFnsLong=` var RunFnsLong = `
[Alpha] Reconcile config functions to Resources. [Alpha] Reconcile config functions to Resources.
run sequentially invokes all config functions in the directory, providing Resources run sequentially invokes all config functions in the directory, providing Resources
@@ -273,11 +290,11 @@ order they appear in the file).
See ` + "`" + `kustomize help cfg docs-fn` + "`" + ` for more details on writing functions. See ` + "`" + `kustomize help cfg docs-fn` + "`" + ` for more details on writing functions.
` `
var RunFnsExamples=` var RunFnsExamples = `
kustomize fn run example/` kustomize fn run example/`
var SetShort=`[Alpha] Set values on Resources fields values.` var SetShort = `[Alpha] Set values on Resources fields values.`
var SetLong=` var SetLong = `
Set values on Resources fields. May set either the complete or partial field value. Set values on Resources fields. May set either the complete or partial field value.
` + "`" + `set` + "`" + ` identifies setters using field metadata published as OpenAPI extensions. ` + "`" + `set` + "`" + ` identifies setters using field metadata published as OpenAPI extensions.
@@ -315,7 +332,7 @@ The description and setBy fields are left unmodified unless specified with flags
To create a custom setter for a field see: ` + "`" + `kustomize help cfg create-setter` + "`" + ` To create a custom setter for a field see: ` + "`" + `kustomize help cfg create-setter` + "`" + `
` `
var SetExamples=` var SetExamples = `
Resource YAML: Name Prefix Setter Resource YAML: Name Prefix Setter
# DIR/resources.yaml # DIR/resources.yaml
@@ -359,8 +376,8 @@ var SetExamples=`
name: test-app2 # {"description":"test environment","type":"string","x-kustomize":{"setBy":"dev","setter":[{"name":"name-prefix","value":"test"}]}} name: test-app2 # {"description":"test environment","type":"string","x-kustomize":{"setBy":"dev","setter":[{"name":"name-prefix","value":"test"}]}}
...` ...`
var SinkShort=`[Alpha] Implement a Sink by writing input to a local directory.` var SinkShort = `[Alpha] Implement a Sink by writing input to a local directory.`
var SinkLong=` var SinkLong = `
[Alpha] Implement a Sink by writing input to a local directory. [Alpha] Implement a Sink by writing input to a local directory.
kustomize fn sink [DIR] kustomize fn sink [DIR]
@@ -370,11 +387,11 @@ var SinkLong=`
` + "`" + `sink` + "`" + ` writes its input to a directory ` + "`" + `sink` + "`" + ` writes its input to a directory
` `
var SinkExamples=` var SinkExamples = `
kustomize fn source DIR/ | your-function | kustomize fn sink DIR/` kustomize fn source DIR/ | your-function | kustomize fn sink DIR/`
var SourceShort=`[Alpha] Implement a Source by reading a local directory.` var SourceShort = `[Alpha] Implement a Source by reading a local directory.`
var SourceLong=` var SourceLong = `
[Alpha] Implement a Source by reading a local directory. [Alpha] Implement a Source by reading a local directory.
kustomize fn source DIR... kustomize fn source DIR...
@@ -385,14 +402,14 @@ var SourceLong=`
` + "`" + `source` + "`" + ` emits configuration to act as input to a function ` + "`" + `source` + "`" + ` emits configuration to act as input to a function
` `
var SourceExamples=` var SourceExamples = `
# emity configuration directory as input source to a function # emity configuration directory as input source to a function
kustomize fn source DIR/ kustomize fn source DIR/
kustomize fn source DIR/ | your-function | kustomize fn sink DIR/` kustomize fn source DIR/ | your-function | kustomize fn sink DIR/`
var TreeShort=`[Alpha] Display Resource structure from a directory or stdin.` var TreeShort = `[Alpha] Display Resource structure from a directory or stdin.`
var TreeLong=` var TreeLong = `
[Alpha] Display Resource structure from a directory or stdin. [Alpha] Display Resource structure from a directory or stdin.
kustomize cfg tree may be used to print Resources in a directory or cluster, preserving structure kustomize cfg tree may be used to print Resources in a directory or cluster, preserving structure
@@ -413,7 +430,7 @@ By default, kustomize cfg tree uses Resource graph structure if any relationship
are detected, as is typically the case when printing from a cluster. Otherwise, directory graph structure is used. The are detected, as is typically the case when printing from a cluster. Otherwise, directory graph structure is used. The
graph structure can also be selected explicitly using the '--graph-structure' flag. graph structure can also be selected explicitly using the '--graph-structure' flag.
` `
var TreeExamples=` var TreeExamples = `
# print Resources using directory structure # print Resources using directory structure
kustomize cfg tree my-dir/ kustomize cfg tree my-dir/

4
kyaml/setters2/delete.go
View File

@@ -132,12 +132,12 @@ func (dd DeleterDefinition) Filter(object *yaml.RNode) (*yaml.RNode, error) {
return nil, errors.Errorf("setter is used in substitution %s, please delete the substitution first", subst) return nil, errors.Errorf("setter is used in substitution %s, please delete the substitution first", subst)
} }
_, err = definitions.Pipe(yaml.FieldClearer{Name:key}) _, err = definitions.Pipe(yaml.FieldClearer{Name: key})
if err != nil { if err != nil {
return nil, err return nil, err
} }
// remove definitions if it's empty // remove definitions if it's empty
_, err = object.Pipe(yaml.Lookup(openapi.SupplementaryOpenAPIFieldName), yaml.FieldClearer{Name:"definitions", IfEmpty: true}) _, err = object.Pipe(yaml.Lookup(openapi.SupplementaryOpenAPIFieldName), yaml.FieldClearer{Name: "definitions", IfEmpty: true})
if err != nil { if err != nil {
return nil, err return nil, err
} }