Skip to content

Commit

Permalink
add apiVersion and kind in README.md for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Liujingfang1 committed Dec 18, 2018
1 parent 64372a7 commit 0d14e89
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 0 deletions.
6 changes: 6 additions & 0 deletions examples/breakfast.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ breakfast. This breakfast has coffee and pancakes:
<!-- @baseKustomization @test -->
```
cat <<EOF >$DEMO_HOME/breakfast/base/kustomization.yaml
apiVersion: v1
kind: Kustomization
resources:
- coffee.yaml
- pancakes.yaml
Expand Down Expand Up @@ -69,6 +71,8 @@ likes her coffee hot:
mkdir -p $DEMO_HOME/breakfast/overlays/alice
cat <<EOF >$DEMO_HOME/breakfast/overlays/alice/kustomization.yaml
apiVersion: v1
kind: Kustomization
commonLabels:
who: alice
bases:
Expand All @@ -92,6 +96,8 @@ And likewise a [variant] for Bob, who wants _five_ pancakes, with strawberries:
mkdir -p $DEMO_HOME/breakfast/overlays/bob
cat <<EOF >$DEMO_HOME/breakfast/overlays/bob/kustomization.yaml
apiVersion: v1
kind: Kustomization
commonLabels:
who: bob
bases:
Expand Down
6 changes: 6 additions & 0 deletions examples/combineConfigs.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ height=10m
EOF
cat <<EOF >$DEMO_HOME/base/kustomization.yaml
apiVersion: v1
kind: Kustomization
configMapGenerator:
- name: my-configmap
files:
Expand Down Expand Up @@ -191,6 +193,8 @@ dbpassword=mothersMaidenName
EOF
cat <<EOF >$OVERLAYS/development/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ../../base
namePrefix: dev-
Expand Down Expand Up @@ -273,6 +277,8 @@ dbpassword=thisShouldProbablyBeInASecretInstead
EOF
cat <<EOF >$OVERLAYS/production/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ../../base
namePrefix: prod-
Expand Down
4 changes: 4 additions & 0 deletions examples/configGeneration.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ curl -s -o "$BASE/#1.yaml" "https://raw.githubusercontent.com\
/{deployment,service}.yaml"
cat <<'EOF' >$BASE/kustomization.yaml
apiVersion: v1
kind: Kustomization
commonLabels:
app: hello
resources:
Expand All @@ -59,6 +61,8 @@ OVERLAYS=$DEMO_HOME/overlays
mkdir -p $OVERLAYS/staging
cat <<'EOF' >$OVERLAYS/staging/kustomization.yaml
apiVersion: v1
kind: Kustomization
namePrefix: staging-
nameSuffix: -v1
commonLabels:
Expand Down
2 changes: 2 additions & 0 deletions examples/generatorOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Create a kustomization and add a ConfigMap generator to it.
<!-- @createCMGenerator @test -->
```
cat > $DEMO_HOME/kustomization.yaml << EOF
apiVersion: v1
kind: Kustomization
configMapGenerator:
- name: my-configmap
literals:
Expand Down
4 changes: 4 additions & 0 deletions examples/helloWorld/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ defining a new name prefix, and some different labels.
<!-- @makeStagingKustomization @test -->
```
cat <<'EOF' >$OVERLAYS/staging/kustomization.yaml
apiVersion: v1
kind: Kustomization
namePrefix: staging-
commonLabels:
variant: staging
Expand Down Expand Up @@ -183,6 +185,8 @@ with a different name prefix and labels.
<!-- @makeProductionKustomization @test -->
```
cat <<EOF >$OVERLAYS/production/kustomization.yaml
apiVersion: v1
kind: Kustomization
namePrefix: production-
commonLabels:
variant: production
Expand Down
2 changes: 2 additions & 0 deletions examples/imageTags.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Make a `kustomization` containing a pod resource
<!-- @createKustomization @test -->
```
cat <<EOF >$DEMO_HOME/kustomization.yaml
apiVersion: v1
kind: Kustomization
resources:
- pod.yaml
EOF
Expand Down
2 changes: 2 additions & 0 deletions examples/jsonpatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Make a `kustomization` containing an ingress resource.
DEMO_HOME=$(mktemp -d)
cat <<EOF >$DEMO_HOME/kustomization.yaml
apiVersion: v1
kind: Kustomization
resources:
- ingress.yaml
EOF
Expand Down
10 changes: 10 additions & 0 deletions examples/multibases/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ BASE=$DEMO_HOME/base
mkdir $BASE
cat <<EOF >$BASE/kustomization.yaml
apiVersion: v1
kind: Kustomization
resources:
- pod.yaml
EOF
Expand All @@ -47,6 +49,8 @@ DEV=$DEMO_HOME/dev
mkdir $DEV
cat <<EOF >$DEV/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ./../base
namePrefix: dev-
Expand All @@ -60,6 +64,8 @@ STAG=$DEMO_HOME/staging
mkdir $STAG
cat <<EOF >$STAG/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ./../base
namePrefix: stag-
Expand All @@ -73,6 +79,8 @@ PROD=$DEMO_HOME/production
mkdir $PROD
cat <<EOF >$PROD/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ./../base
namePrefix: prod-
Expand All @@ -83,6 +91,8 @@ Then define a _Kustomization_ composing three variants together:
<!-- @makeTopLayer @test -->
```
cat <<EOF >$DEMO_HOME/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- ./dev
- ./staging
Expand Down
2 changes: 2 additions & 0 deletions examples/remoteBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ A base can also be specified as a URL:
DEMO_HOME=$(mktemp -d)
cat <<EOF >$DEMO_HOME/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- github.com/kubernetes-sigs/kustomize//examples/multibases?ref=v1.0.6
namePrefix: remote-
Expand Down
2 changes: 2 additions & 0 deletions examples/wordpress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Create a new kustomization with two bases:
<!-- @createKustomization @test -->
```
cat <<EOF >$DEMO_HOME/kustomization.yaml
apiVersion: v1
kind: Kustomization
bases:
- wordpress
- mysql
Expand Down

0 comments on commit 0d14e89

Please sign in to comment.