kptdev / kpt Goto Github PK

to reproduce:

kpt pkg get [email protected]:GoogleContainerTools/kpt.git/package-examples/[email protected] helloworld
kpt cfg set helloworld replicas 3
git add . && git commit -m 'fetched helloworld'
kpt pkg diff [email protected]

This should show the replicas diff AND the labels change. It only shows the replicas diff.

If you update the package to v0.2.0, then it will change the labels, but this isn't shown in the diff.

Example Set 1:

• Generate: Create a Deployment + Service from an image (as data on ConfigMap input)
• Validate: Make sure Deployments have Resources reservations set
• Inject: Set Resource reservations to a default if unset

Example Set 2:

• Inject: a side-car into a Deployment
• Inject: an init container into a Deployment
• Validate: Deployment and Service labels match if names match

Either in:

https://github.com/GoogleContainerTools/kpt/blob/master/docs/fn/README.md

or one of the child commands, it'd be good to have a link to KPT Functions Catalog:

https://github.com/GoogleContainerTools/kpt-functions-catalog

Trying to deploy the sample to a test GKE cluster failed with:

Failed to pull image "gcr.io/kpt-dev/helloworld-gke:0.1.0": rpc error: code = Unknown desc = Error response from daemon: pull access denied for gcr.io/kpt-dev/helloworld-gke, repository does not exist or may require 'docker login'

Do the images need to be made public?

in docs/fn/README.md:

[kpt-functions-sdk]
[kustomize/kyaml]

Defer explaining CRD support until the basics are clear.

npm init should install the Kubernetes 1.17 types by default without the need for a cluster. generating from a cluster should be opt-in

orgs will probably want to explicitly choose the types that are used, rather than have them generated ad-hoc per user.

Support Cat, Grep, Tree Commands

There is a bug where the yaml libraries decode

old: resource
---
# Copyright
new: resource

as

old: resource
# Copyright
---
new: resource

To work around this, the ByteWriter replaces --- with \n---\n, which fixes the issue so that the decoded properly recognizes the resource / comment boundaries.

Follow up on this to see if it is an issue in the underlying libraries, or just how we use them.

The guide links to a set of examples, but its unclear which ones are good examples to start with. Also just show me the example next to the interface so I can compare them.

Spending some time in the docs and playing with some of it, what I feel is missing the most is a good walkthrough that takes the user through an entire scenario command by command.

As it stands, there is a lot of great information, but you have to go to the doc for each command one by one and try to figure out how it all fits together.

The walkthrough doesn't have to cover everything, but could include e.g.:

• Starting from nothing
• Pulling down a demo package at some older revision using pkg
• Applying the config to a cluster using svr
• Making local changes to the package, e.g. by using cfg set
• Pulling from the package source and showing how things get can get merged
• Showing off functions

A nice screencast following the same walkthrough would be nice as well.

Add help topics for various tutorials

• fetch and update a package
  • various merge strategies
• use tree, grep, fmt, man
• using subpackages
• writing and publishing packages

Right now, it's just a link to some binary, and you're on your own. Some people like more guidance. e.g. on my Mac, there were a bunch of extra step after clicking the link:

• First I had to `chmod +x'
• Then it was still blocked by the OS and I had to go in the system settings to allow it
• The file needed to be renamed to kpt
• It also needed to be moved to some folder on the path

Those may seem trivial, but I think it will lose some readers.

Doc has this example:

$ kpt pkg get https://github.com/GoogleContainerTools/\
  kpt.git/package-examples/[email protected] helloworld

But pasting it as is fails because it ends up with an extra space in the middle of the url:

Error: accepts 2 arg(s), received 3
Usage:
  kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] LOCAL_DEST_DIRECTORY [flags]

Similar to how we generate .md docs from the built-in command help, we should generate a nicer docs page. Consider using: https://mmistakes.github.io/minimal-mistakes/

Note how after running the command, it didn't restore the font color:

https://github.com/GoogleContainerTools/kpt/blob/master/docs/fn/run.md

• Caveats section is very long since it's explaining multiple concepts. It's probably worth creating subsection for each
• Need to use verbatim code style in many instances. e.g. metadata.annotations.[config.kubernetes.io/function]. Otherwise, it's hard to read.
• Config Functions -> KPT Functions ?
• We should simplify number of ways to invoke functions declarativey. Or at least, emphasize one approach in docs so user doesn't get overwhelmed.
• It's ambiguous whether functions directory is required or just a convention used (functions dir is in fact a special dir recognized by kpt).
• Also note that the implicit pattern is currently broken: #188

Need to be able to go get kpt.dev and go get lib.kpt.dev -- requires configuring the domain to respond with the correct go headers

See: https://golang.org/cmd/go/#hdr-Remote_import_paths

Also see:
https://github.com/GoogleCloudPlatform/govanityurls

kpt:

• get with tag including the path -- e.g. @v01.0 --> @package-examples/[email protected]
• sync
• environment variable controls

kustomize:

• Merge -- Invert order
• Cat Styles
• Cat Strip comments
• Fmt override file annotations
• RC kind=false
• ElementSetter
• IsAssociative
• ElementValues
• MapSlice
• filters.merge
• filters.merg3
• filters.IsReconciler

insert implies update and create, but there is no update, only create and replace

Possibly using GitHub pages.

• invert matches
• multiple level list matches

Sample has:

# Fetch all resources in the cluster and wait up to 5 minutes for all of them to become Current
kubectl get all --all-namespaces -o yaml | resource status fetch

Maybe resource status fetch is an obsolete name for kpt svr status fetch?

Allow the GVK -> image mapping to be pulled from the Kptfile for Reconcile

parse : as separator

• If you kill kpt reconcile it should kill the containers
• kpt reconcile should timeout

• between local and upstream source
• between local and upstream source at some version

I thought it would be mostly similar to kubectl apply, but I got an error that didn't make sense to me:

$ kpt svr apply .
error: unable to find one of 'kustomization.yaml', 'kustomization.yml' or 'Kustomization' in directory '/Users/davidebbo/tmp/tmp/helloworld'

The doc doesn't mention needing a kustomization file, so I'm not sure what I did wrong.

Generate documentation for Kptfile, Filters, etc. Use the go-struct comments to generate both .md docs and built-in kpt help api Kptfile docs.

source: Hydrate ACM repo
vet: Run validations rules
sink: Write configs into ACM repo format