diff --git a/cmd/kinflate/README.md b/cmd/kinflate/README.md index f2dae3e9d..b54ac4f33 100644 --- a/cmd/kinflate/README.md +++ b/cmd/kinflate/README.md @@ -2,15 +2,13 @@ `kinflate` is a kubernetes cluster configuration utility, a prototype of ideas discussed in this [proposal for -Declarative Application Management](https://goo.gl/T66ZcD). - -## Declarative Application Management (DAM) +Declarative Application Management](https://goo.gl/T66ZcD) (DAM). [declarations]: https://kubernetes.io/docs/tutorials/object-management-kubectl/declarative-object-management-configuration/ DAM allows one to customize native kubernetes resources using new modification declarations rather than using -templates or new configuration languages. +template or configuration languages. It facilitates coupling cluster state changes to version control commits. It encourages forking a configuration, @@ -19,7 +17,7 @@ upgrades from the original configuration. ## Installation -This assumes you have [Go](https://golang.org/) installed. +Prerequisites: [Go](https://golang.org/), [git](https://git-scm.com) ``` @@ -32,21 +30,27 @@ GOBIN=$tmp go get k8s.io/kubectl/cmd/kinflate [kubectl]: https://kubernetes.io/docs/user-guide/kubectl-overview/ [YAML]: http://www.yaml.org/start.html -The following commands checkout a _kinflate app_, -customize all the resources in the app with a name prefix, -then pipe the resulting [YAML] directly to a cluster via [kubectl]. +Clone an app, customize the resources in the app with a +name prefix, then pipe the resulting [YAML] directly to +a cluster via [kubectl]. ``` # Download a demo app -git clone https://github.com/monopole/kapps/demo $tmp +cd $tmp +git clone https://github.com/monopole/damapps +cd damapps/demo # Use kinflate to customize it -cd $tmp -$GOBIN/kinflate setprefixname acme- +$tmp/kinflate setprefixname acme- -# See the change: -grep prefixName Kube-manifest.yaml +# See the added line: +grep namePrefix Kube-manifest.yaml +git diff Kube-manifest.yaml # Send the app to your cluster: -$GOBIN/kinflate inflate -f . | kubectl apply -f - +$tmp/kinflate inflate -f . | kubectl apply -f - + ``` + +At this point, you could commit your fork +to your own repository, and rebase as desired.