kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-13 01:50:55 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Remove extraneous whitespace.

Browse Source 
make all (generate docs)

Update examples in cmd docs.

make all (generate docs)

functions/examples: Whitespace cleanup.

functions/examples: Fix some example commands.
This commit is contained in:
bzub
2019-12-09 19:53:49 -06:00
parent 2102ddab7c
commit 3803541bfd
17 changed files with 182 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
functions/examples/injection-tshirt-sizes/README.md
View File

@@ -8,7 +8,7 @@ input and writing the output. Writing in `go` is not a requirement.
## Function implementation
The function is implemented as an [image](image), and built using `make image`.
The template is implemented as a go program, which reads a collection of input
Resource configuration, and looks for invalid configuration.
@@ -17,19 +17,19 @@ Resource configuration, and looks for invalid configuration.
The function is invoked by authoring a [local Resource](local-resource)
with `metadata.configFn` and running:
kustomize config run local-resources/
This exists non-zero if there is an error.
kustomize config run local-resource/
This exits non-zero if there is an error.
## Running the Example
Run the validator with:
kustomize config run local-resource/
This will add resource reservations to the Deployment. Change the `tshirt-size`
annotation from `medium` to `small` and rerun:
kustomize config run local-resource/
Observe that the reservations have changed.
Observe that the reservations have changed.

16
functions/examples/template-go-nginx/README.md
View File

@@ -27,12 +27,12 @@ function input, and writing the function output.
The function is invoked by authoring a [local Resource](local-resource)
with `metadata.configFn` and running:
kustomize config run local-resources/
kustomize config run local-resource/
This generates the `local-resources/config` directory containing the template output.
- the template output may be modified by adding fields -- such as initContainers,
sidecarConatiners, cpu resource limits, etc -- and these fields will be retained
sidecarConatiners, cpu resource limits, etc -- and these fields will be retained
when re-running `run`
- the function input `example-use.yaml` may be changed and rerunning `run` will update
only the parts changed in the template output.
@@ -42,14 +42,14 @@ This generates the `local-resources/config` directory containing the template ou
Run the config with:
kustomize config run local-resource/
This will create the directory
local-resource/config
Add an annotation to the StatefulSet Resource and change the replica count of the
Add an annotation to the Deployment Resource and change the replica count of the
`kind: Nginx` Resource in `example-use.yaml`. Rerun the template:
kustomize config run local-resource/
The replica count should be updated, but your annotation should remain.
The replica count should be updated, but your annotation should remain.

16
functions/examples/template-heredoc-cockroachdb/README.md
View File

@@ -7,7 +7,7 @@ This example uses the simplest approach for building abstractions.
## Function implementation
The function is implemented as an [image](image), and built using `make image`.
The template is implemented as a heredoc, which substitutes environment variables
into a static string.
@@ -22,12 +22,12 @@ heavy lifting of implementing the function interface.
The function is invoked by authoring a [local Resource](local-resource)
with `metadata.configFn` and running:
kustomize config run local-resources/
kustomize config run local-resource/
This generates the `local-resources/config` directory containing the template output.
- the template output may be modified by adding fields -- such as initContainers,
sidecarConatiners, cpu resource limits, etc -- and these fields will be retained
sidecarConatiners, cpu resource limits, etc -- and these fields will be retained
when re-running `run`
- the function input `example-use.yaml` may be changed and rerunning `run` will update
only the parts changed in the template output.
@@ -37,14 +37,14 @@ This generates the `local-resources/config` directory containing the template ou
Run the config with:
kustomize config run local-resource/
This will create the directory
local-resource/config
Add an annotation to the StatefulSet Resource and change the replica count of the
`kind: CockroachDB` Resource in `example-use.yaml`. Rerun the template:
kustomize config run local-resource/
The replica count should be updated, but your annotation should remain.
The replica count should be updated, but your annotation should remain.

12
functions/examples/validator-resource-requests/README.md
View File

@@ -8,7 +8,7 @@ input and writing the output. Writing in `go` is not a requirement.
## Function implementation
The function is implemented as an [image](image), and built using `make image`.
The template is implemented as a go program, which reads a collection of input
Resource configuration, and looks for invalid configuration.
@@ -17,8 +17,8 @@ Resource configuration, and looks for invalid configuration.
The function is invoked by authoring a [local Resource](local-resource)
with `metadata.configFn` and running:
kustomize config run local-resources/
kustomize config run local-resource/
This exists non-zero if there is an error.
## Running the Example
@@ -26,7 +26,7 @@ This exists non-zero if there is an error.
Run the validator with:
kustomize config run local-resource/
This will return an error:
cpu-requests missing for container nginx
@@ -34,5 +34,5 @@ This will return an error:
Now uncomment the resource reservations and run again:
kustomize config run local-resource/
This will return success
This will return success