diff --git a/cmd/kinflate/README.md b/cmd/kinflate/README.md index 70e097f00..d256400ec 100644 --- a/cmd/kinflate/README.md +++ b/cmd/kinflate/README.md @@ -40,10 +40,8 @@ and your `PATH` contains `$GOPATH/bin`: go get k8s.io/kubectl/cmd/kinflate ``` -Note: golang 1.10 or newer is required. - ## Demos - * [hello world one-pager](demoHelloWorldShort.md) - * [hello world, with instances, slide format](demoHelloWorldLong/README.md) - * [mysql one-pager](demoMySql.md) + * [hello world one-pager](demo/helloWorldOnePager.md) + * [hello world detailed](demo/helloWorldDetailed/README.md) (with instances, in slide format) + * [mysql one-pager](demo/mySql.md) diff --git a/cmd/kinflate/demoHelloWorldLong/README.md b/cmd/kinflate/demo/helloWorldDetailed/README.md similarity index 60% rename from cmd/kinflate/demoHelloWorldLong/README.md rename to cmd/kinflate/demo/helloWorldDetailed/README.md index fee8afc0e..02b3abd70 100644 --- a/cmd/kinflate/demoHelloWorldLong/README.md +++ b/cmd/kinflate/demo/helloWorldDetailed/README.md @@ -1,10 +1,11 @@ # Demo: hello world with instances -Goal: +Steps: - 1. Clone a simple off-the-shelf example as a base configuration. + 1. Clone an off-the-shelf configuration as your base. 1. Customize it. - 1. Create two different instances based on the customization. + 1. Create two different instances (_staging_ and _production_) + from your customized base. First define a place to work: diff --git a/cmd/kinflate/demoHelloWorldLong/README_ORDER.txt b/cmd/kinflate/demo/helloWorldDetailed/README_ORDER.txt similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/README_ORDER.txt rename to cmd/kinflate/demo/helloWorldDetailed/README_ORDER.txt diff --git a/cmd/kinflate/demoHelloWorldLong/clone.md b/cmd/kinflate/demo/helloWorldDetailed/clone.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/clone.md rename to cmd/kinflate/demo/helloWorldDetailed/clone.md diff --git a/cmd/kinflate/demoHelloWorldLong/customize.md b/cmd/kinflate/demo/helloWorldDetailed/customize.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/customize.md rename to cmd/kinflate/demo/helloWorldDetailed/customize.md diff --git a/cmd/kinflate/demoHelloWorldLong/editor.md b/cmd/kinflate/demo/helloWorldDetailed/editor.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/editor.md rename to cmd/kinflate/demo/helloWorldDetailed/editor.md diff --git a/cmd/kinflate/demoHelloWorldLong/manifest.md b/cmd/kinflate/demo/helloWorldDetailed/manifest.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/manifest.md rename to cmd/kinflate/demo/helloWorldDetailed/manifest.md diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/README.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/README.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/README.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/README.md diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/README_ORDER.txt b/cmd/kinflate/demo/helloWorldDetailed/overlays/README_ORDER.txt similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/README_ORDER.txt rename to cmd/kinflate/demo/helloWorldDetailed/overlays/README_ORDER.txt diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/compare.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/compare.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/compare.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/compare.md diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/deploy.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/deploy.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/deploy.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/deploy.md diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/production/manifest.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/production/manifest.md similarity index 91% rename from cmd/kinflate/demoHelloWorldLong/overlays/production/manifest.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/production/manifest.md index 79a01aa3f..e1113a2f8 100644 --- a/cmd/kinflate/demoHelloWorldLong/overlays/production/manifest.md +++ b/cmd/kinflate/demo/helloWorldDetailed/overlays/production/manifest.md @@ -10,7 +10,6 @@ apiVersion: manifest.k8s.io/v1alpha1 kind: Package metadata: name: makes-production-tuthello -# description: hello configured for production namePrefix: production- objectLabels: instance: production diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/production/patch.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/production/patch.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/production/patch.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/production/patch.md diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/staging/manifest.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/staging/manifest.md similarity index 92% rename from cmd/kinflate/demoHelloWorldLong/overlays/staging/manifest.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/staging/manifest.md index 667793031..975f729b3 100644 --- a/cmd/kinflate/demoHelloWorldLong/overlays/staging/manifest.md +++ b/cmd/kinflate/demo/helloWorldDetailed/overlays/staging/manifest.md @@ -10,7 +10,6 @@ apiVersion: manifest.k8s.io/v1alpha1 kind: Package metadata: name: makes-staging-hello -# description: hello configured for staging namePrefix: staging- objectLabels: instance: staging diff --git a/cmd/kinflate/demoHelloWorldLong/overlays/staging/patch.md b/cmd/kinflate/demo/helloWorldDetailed/overlays/staging/patch.md similarity index 100% rename from cmd/kinflate/demoHelloWorldLong/overlays/staging/patch.md rename to cmd/kinflate/demo/helloWorldDetailed/overlays/staging/patch.md diff --git a/cmd/kinflate/demoHelloWorldShort.md b/cmd/kinflate/demo/helloWorldOnePager.md similarity index 92% rename from cmd/kinflate/demoHelloWorldShort.md rename to cmd/kinflate/demo/helloWorldOnePager.md index 595d7a4c4..f087c604b 100644 --- a/cmd/kinflate/demoHelloWorldShort.md +++ b/cmd/kinflate/demo/helloWorldOnePager.md @@ -4,8 +4,8 @@ Steps: - 1. Clone an off-the-shelf example configuration. - 1. Customizes the resources in it with a name prefix. + 1. Clone an off-the-shelf configuration. + 1. Customize its resources with a name prefix. 1. Apply the result to a cluster via [kubectl]. First make a place to work: diff --git a/cmd/kinflate/demoMySql.md b/cmd/kinflate/demo/mySql.md similarity index 99% rename from cmd/kinflate/demoMySql.md rename to cmd/kinflate/demo/mySql.md index ec1fb23ac..c86180ba1 100644 --- a/cmd/kinflate/demoMySql.md +++ b/cmd/kinflate/demo/mySql.md @@ -1,4 +1,4 @@ -# MySql Example +# Demo: MySql This example takes some off-the-shelf k8s resources designed for MySQL, and customizes them to suit a