From e17d303392d46edc997ba581c2020ef5a80bdf83 Mon Sep 17 00:00:00 2001 From: Jingfang Liu Date: Thu, 23 May 2019 13:46:31 -0700 Subject: [PATCH] reorganize the examples layout --- examples/README.md | 81 ++++++++++++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 35 deletions(-) diff --git a/examples/README.md b/examples/README.md index da4ec4b0b..1954fd60b 100644 --- a/examples/README.md +++ b/examples/README.md @@ -12,46 +12,57 @@ tests, and should work with HEAD go get sigs.k8s.io/kustomize ``` - * [hello world](helloWorld/README.md) - Deploy multiple - (differently configured) variants of a simple Hello - World server. +Basic Usage - * [last mile helm](chart.md) - Make last mile modifications to - a helm chart. - - * [LDAP](ldap/README.md) - Deploy multiple - (differently configured) variants of a LDAP server. - - * [mySql](mySql/README.md) - Create a MySQL production - configuration from scratch. - - * [springboot](springboot/README.md) - Create a Spring Boot - application production configuration from scratch. - - * [combineConfigs](combineConfigs.md) - + * [configGenerations](configGeneration.md) - + Rolling update when ConfigMapGenerator changes. + + * [combineConfigs](combineConfigs.md) - Mixing configuration data from different owners (e.g. devops/SRE and developers). + + * [generatorOptions](generatorOptions.md) - + Modifying behavior of all ConfigMap and Secret generators. - * [configGenerations](configGeneration.md) - - Rolling update when ConfigMapGenerator changes. + * [vars](wordpress/README.md) - Injecting k8s runtime data into + container arguments (e.g. to point wordpress to a SQL service) by vars. + + * [image names and tags](image.md) - Updating image names and tags without applying a patch. + + * [remote target](remoteBuild.md) - Building a kustomization from a github URL + + * [json patch](jsonpatch.md) - Apply a json patch in a kustomization - * [secret generation](secretGeneratorPlugin.md) - Generating secrets from a plugin. +Advanced Usage + +- generator plugins: + + * [last mile helm](chart.md) - Make last mile modifications to + a helm chart. + + * [secret generation](secretGeneratorPlugin.md) - Generating secrets from a plugin. + +- customize builtin transformer configurations + + * [transformer configs](transformerconfigs/README.md) - Customize transformer configurations + - * [generatorOptions](generatorOptions.md) - - Modifying behavior of all ConfigMap and Secret generators. +Multi Variant Examples - * [breakfast](breakfast.md) - Customize breakfast for - Alice and Bob. + * [hello world](helloWorld/README.md) - Deploy multiple + (differently configured) variants of a simple Hello + World server. + + * [LDAP](ldap/README.md) - Deploy multiple + (differently configured) variants of a LDAP server. + + * [springboot](springboot/README.md) - Create a Spring Boot + application production configuration from scratch. - * [vars](wordpress/README.md) - Injecting k8s runtime data into - container arguments (e.g. to point wordpress to a SQL service) by vars. - - * [image names and tags](image.md) - Updating image names and tags without applying a patch. - - * [multibases](multibases/README.md) - Composing three variants (dev, staging, production) with a common base. - - * [remote target](remoteBuild.md) - Building a kustomization from a github URL - - * [json patch](jsonpatch.md) - Apply a json patch in a kustomization - - * [transformer configs](transformerconfigs/README.md) - Customize transformer configurations + * [mySql](mySql/README.md) - Create a MySQL production + configuration from scratch. + + * [breakfast](breakfast.md) - Customize breakfast for + Alice and Bob. + + * [multibases](multibases/README.md) - Composing three variants (dev, staging, production) with a common base. \ No newline at end of file