new kustomize sample #2136

mikebz · 2021-05-29T16:26:32Z

This is a new kustomize example which is more in line with how we want people to think about kustomize rendering with kpt live apply and packages.

It replaces the helloworld-kustomize but was started from scratch. The modifications to the files are just git trying to be smart.

related to #1502

mortent · 2021-06-01T18:09:16Z

package-examples/kustomize-pkg/README.md

+```shell
+$ kpt pkg tree kustomize-pkg/
+
+PKG: kustomize-pkg


While the output of kpt pkg tree here is accurate, it is kinda misleading. It hides the bases and overlays directories. It seems like we remove any directories that doesn't have any KRM resources inside them.

it's a good observation and I think we should absolutely see if we can fix the tree output.

you can use tree command for now

mortent · 2021-06-01T18:13:13Z

package-examples/kustomize-pkg/README.md

+
+### kustomize the config
+
+We recommend that you keep the kustomize instructions to rendering only such as adding a namespace, transforming or applying a patch.  The second you mix kpt packages and remote bases you will be missing out on a big advantage of having a guaranteed stable base.


Can we make this clearer? It is not clear to me how using kustomize remote bases would necessarily be bad here, other than challenges around mixing packages fetched with kpt and remote bases with kustomize.

That gets convoluted though as you're effectively using two package managers concurrently. It's hard even for me to reason about it. Instead, you want to have a clean conceptual separation of concerns. The price is that you cannot just drop any arbitrary existing kustomization resource since it may use remote bases.

+1 to making this intentional limiting of kustomize features more precise. Explicitly state what features of kustomize is not recommended?

I added stronger language, but I think enumerating every feature of kustomize is going to create a wackamole game. There are new features added and deprecated as we speak and it's best to have a larger umbrella like hydration and packaging in order to avoid updating the sample language every time something changes in kustomize.

mortent · 2021-06-01T18:19:32Z

package-examples/kustomize-pkg/README.md

+
+### Apply the package
+
+It's possible to use kustomize build and kpt live apply, but it does require passing the inventory to `kpt live apply` from `kustomize build` output.  One of the base Kptfiles needs to be initialized with the inventory object.  We will use the nginx base, but in real life exployment it might be better to initialize inventory on your root package.


Initializing the inventory information in the base is not the recommended way. It means that every variant created (so dev and prod in this example) would have the same inventory, and thus would collide if installed in the same cluster.
Also, I think we should refer to the information added to the Kptfile about the inventory as inventory information. It is a bit vague and not a great name, but we usually refer to the actual resource in the cluster as the inventory object.

great feedback, would you recommend having a Kptfile in every overlay?

I moved the kpt inventory to ovrelays. PTAL

mortent · 2021-06-01T18:22:42Z

package-examples/kustomize-pkg/README.md

+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- ../../bases/nginx


This structure is probably ok for an example, but I think the recommended way to do this would be to have each env have separate git references. The structure in this example makes it a bit hard to make changes in the base and then do progressive rollouts into different environments.

What would be the layout of a solution like that? Every overlay then gets a separate base? Why create an overlay then? We can just have the final config in every folder. I haven't seen a pattern like that, even though I am not opposed to showing it.

frankfarzan · 2021-06-01T18:47:11Z

package-examples/kustomize-pkg/README.md

+
+### kustomize the config
+
+We recommend that you keep the kustomize instructions to rendering only such as adding a namespace, transforming or applying a patch.  The second you mix kpt packages and remote bases you will be missing out on a big advantage of having a guaranteed stable base.


That gets convoluted though as you're effectively using two package managers concurrently. It's hard even for me to reason about it. Instead, you want to have a clean conceptual separation of concerns. The price is that you cannot just drop any arbitrary existing kustomization resource since it may use remote bases.

+1 to making this intentional limiting of kustomize features more precise. Explicitly state what features of kustomize is not recommended?

frankfarzan · 2021-06-01T18:51:21Z

package-examples/kustomize-pkg/README.md

+It's possible to use kustomize build and kpt live apply, but it does require passing the inventory to `kpt live apply` from `kustomize build` output.  One of the base Kptfiles needs to be initialized with the inventory object.  We will use the nginx base, but in real life exployment it might be better to initialize inventory on your root package.
+
+```shell
+$ kpt live init bases/nginx


I don't see a kpt live apply command below.

Also, is the assumption that the they want to use kpt live apply? Or does the user want to use packaging but not hydration and live? Providing both options makes sense.

Live apply from STDIN currently doesn't work so that's why we don't have the output. What I have seen is that people who are using kustomize and see the value in kpt usually like both areas: packaging and apply. They generally already know what to do with kubectl -k or kustomize build and piping to kubectl -f -. Providing them an example of doing that probably doesn't add any value in addition to what they can already gather from kustomize docs.

mikebz · 2021-06-03T05:52:26Z

also worth noting that this sample will help with addressing #1545

frankfarzan · 2021-06-03T18:43:02Z

package-examples/kustomize-pkg/README.md

+Get the example package on to local using `kpt pkg get`. Note that this package is for this example, wihin that package we are also using the nginx sub-package which is an alternative to having a remote base. 
+
+```shell
+$ kpt pkg get https://github.com/GoogleContainerTools/kpt.git/package-examples/kustomize-pkg


don't you want to specify the next branch?
Does these commands work currently?

this is a copy from the template and the rest of them are using the default branch which will be main soon. I don't think we should single this sample out.

are you saying no one should try this example before we make next default?

We have all the rest of the samples that do not point to a branch. I am fine making this point to next just to move forward but until now no one has complained about the other samples.

Two theories:

people looking at samples already understand how to point at the right branches and are in tune with the product lifecycle

people are looking at the samples to just understand the flow and read the pattern.

I will change it to next, please update it to point to default branch when you change the branches over.

Two wrongs don't make a right. People are consuming wordpress and nginx through the book which have correct versioning using tags (there are our main examples exposed to users). Just specify the next branch to make this work in the meantime.

all the existing samples are updated.

frankfarzan · 2021-06-03T18:43:17Z

package-examples/kustomize-pkg/README.md

+
+PKG: kustomize-pkg
+├── [Kptfile]  Kptfile kustomize-pkg
+├── PKG: nginx


Part of the tree has changed @phanimarupaka

frankfarzan · 2021-06-03T18:44:09Z

package-examples/kustomize-pkg/README.md

+```shell
+$ kpt pkg tree kustomize-pkg/
+
+PKG: kustomize-pkg


you can use tree command for now

mikebz added this to In Review in kpt kanban board via automation May 29, 2021

mikebz requested review from frankfarzan, droot, phanimarupaka and mortent May 29, 2021 16:27

mortent reviewed Jun 1, 2021

View reviewed changes

frankfarzan reviewed Jun 1, 2021

View reviewed changes

mikebz added 4 commits June 2, 2021 12:53

wip first stab

892438e

rebase of next

92bd845

updates to the kustomize files

00f83bd

updates to README

1e7aea9

mikebz force-pushed the mb_new_kustomize branch from dd6b6ec to 1e7aea9 Compare June 2, 2021 19:57

update per PR feedback

0f52958

mikebz requested review from mortent and frankfarzan June 3, 2021 05:39

mikebz added 2 commits June 2, 2021 22:41

removed the README's in overlays

063a655

update to the readme

0761427

frankfarzan reviewed Jun 3, 2021

View reviewed changes

mikebz added 2 commits June 3, 2021 13:23

using tree command because of nested folders

0315753

updated the pkg get to point to next

eddfd6c

mikebz requested a review from frankfarzan June 3, 2021 22:40

frankfarzan approved these changes Jun 3, 2021

View reviewed changes

mikebz merged commit 3c5c652 into kptdev:next Jun 3, 2021

kpt kanban board automation moved this from In Review to Done Jun 3, 2021

mikebz deleted the mb_new_kustomize branch June 3, 2021 22:44

mikebz mentioned this pull request Jul 13, 2021

[Question] clarifications on live commands relationship with kustomize #1545

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new kustomize sample #2136

new kustomize sample #2136

mikebz commented May 29, 2021

mortent Jun 1, 2021

mikebz Jun 1, 2021

frankfarzan Jun 3, 2021

mortent Jun 1, 2021

frankfarzan Jun 1, 2021

mikebz Jun 3, 2021

mortent Jun 1, 2021

mikebz Jun 1, 2021

mikebz Jun 3, 2021

mortent Jun 1, 2021

mikebz Jun 1, 2021

frankfarzan Jun 1, 2021

frankfarzan Jun 1, 2021

mikebz Jun 2, 2021

mikebz commented Jun 3, 2021

frankfarzan Jun 3, 2021

mikebz Jun 3, 2021

frankfarzan Jun 3, 2021

mikebz Jun 3, 2021

mikebz Jun 3, 2021

frankfarzan Jun 3, 2021 •

edited

mikebz Jun 3, 2021

frankfarzan Jun 3, 2021

frankfarzan Jun 3, 2021


		### kustomize the config

		We recommend that you keep the kustomize instructions to rendering only such as adding a namespace, transforming or applying a patch. The second you mix kpt packages and remote bases you will be missing out on a big advantage of having a guaranteed stable base.


		### Apply the package

		It's possible to use kustomize build and kpt live apply, but it does require passing the inventory to `kpt live apply` from `kustomize build` output. One of the base Kptfiles needs to be initialized with the inventory object. We will use the nginx base, but in real life exployment it might be better to initialize inventory on your root package.

new kustomize sample #2136

new kustomize sample #2136

Conversation

mikebz commented May 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikebz commented Jun 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankfarzan Jun 3, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankfarzan Jun 3, 2021 •

edited