mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-25 08:17:02 +00:00
revert change in generated doc
This commit is contained in:
@@ -1,10 +1,9 @@
|
||||
// Copyright 2019 The Kubernetes Authors.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
|
||||
// Code generated by "mdtogo"; DO NOT EDIT.
|
||||
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,
|
||||
stdin|out or network. Tools may be composed using pipes such that the tools writing
|
||||
@@ -64,8 +63,8 @@ Example:
|
||||
annotations:
|
||||
config.kubernetes.io/local-config: "true"`
|
||||
|
||||
var FunctionsImplShort = `Following is an example for implementing an nginx abstraction using a configuration`
|
||||
var FunctionsImplLong = `# Running Configuration Functions using kustomize CLI
|
||||
var FunctionsImplShort=`Following is an example for implementing an nginx abstraction using a configuration`
|
||||
var FunctionsImplLong=`# Running Configuration Functions using kustomize CLI
|
||||
|
||||
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` + "`" + `.
|
||||
@@ -234,8 +233,8 @@ The function is invoked using byrunning ` + "`" + `kustomize config run dir/` +
|
||||
app: nginx
|
||||
instance: my-instance`
|
||||
|
||||
var FunctionsSpecShort = `_Configuration functions_ enable shift-left practices (client-side) through:`
|
||||
var FunctionsSpecLong = `# Configuration Functions Specification
|
||||
var FunctionsSpecShort=`_Configuration functions_ enable shift-left practices (client-side) through:`
|
||||
var FunctionsSpecLong=`# Configuration Functions Specification
|
||||
|
||||
This document specifies a standard for client-side functions that operate on
|
||||
Kubernetes declarative configurations. This standard enables creating
|
||||
@@ -244,7 +243,7 @@ containers that can be chained together as part of a configuration management pi
|
||||
The end result of such a pipeline are fully rendered configurations that can then be
|
||||
applied to a control plane (e.g. Using ‘kubectl apply’ for Kubernetes control plane).
|
||||
As such, although this document references Kubernetes Resource Model and API conventions,
|
||||
it is completely decoupled from Kuberentes API machinery and does not depend on any
|
||||
it is completely decoupled from Kubernetes API machinery and does not depend on any
|
||||
in-cluster components.
|
||||
|
||||
This document references terms described in [Kubernetes API Conventions][1].
|
||||
@@ -267,7 +266,7 @@ interpreted as described in [RFC 2119][2].
|
||||
Performing these on the client rather than the server enables:
|
||||
|
||||
- Configuration to be reviewed prior to being sent to the API server
|
||||
- Configuration to be validated as part of the CI?CD pipeline
|
||||
- Configuration to be validated as part of the CI/CD pipeline
|
||||
- Configuration for Resources to validated holistically rather than individually
|
||||
per-Resource
|
||||
- e.g. ensure the ` + "`" + `Service.selector` + "`" + ` and ` + "`" + `Deployment.spec.template` + "`" + ` labels
|
||||
@@ -412,7 +411,7 @@ A non-zero exit code indicates a failure.
|
||||
[2]: https://tools.ietf.org/html/rfc2119
|
||||
[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
|
||||
where they differ.
|
||||
@@ -504,7 +503,7 @@ var Merge2Long = `# Merge (2-way)
|
||||
- name: sidecar2
|
||||
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
|
||||
into a destination, overriding the destination fields where they have changed between
|
||||
|
||||
Reference in New Issue
Block a user