Default to gcr.io/kpt-fn/ (#2126)

phanimarupaka · web-flow · commit 06adff51c84d · 2021-07-08T12:11:27.000-07:00
* Default to gcr.io/kpt-fn/

* reference docs

* Update tests

* Extend to render and fndoc

* Add new tests

* Update book and package examples docs

* Delete helloworld examples

* Rebase updates

* Rename examples

* Fully resolved path for results display

* Update render docs

* Update e2e tests for eval and render

* Move the call up in stack

* Short hand for --include-meta-resources

* Move call to container.go

* Suggested changes

* generate docs

* Update eval tests

* Changes
diff --git a/e2e/testdata/fn-eval/short-image-path/.expected/config.yaml b/e2e/testdata/fn-eval/short-image-path/.expected/config.yaml
@@ -0,0 +1,21 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+testType: eval
+image: set-namespace:v0.1.3
+args:
+  namespace: staging
+stdErr: |
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3"
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3"
diff --git a/e2e/testdata/fn-eval/short-image-path/.expected/diff.patch b/e2e/testdata/fn-eval/short-image-path/.expected/diff.patch
@@ -0,0 +1,19 @@
+diff --git a/resources.yaml b/resources.yaml
+index 7a494c9..254b9cd 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -15,6 +15,7 @@ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
++  namespace: staging
+ spec:
+   replicas: 3
+ ---
+@@ -22,5 +23,6 @@ apiVersion: custom.io/v1
+ kind: Custom
+ metadata:
+   name: custom
++  namespace: staging
+ spec:
+   image: nginx:1.2.3
diff --git a/e2e/testdata/fn-eval/short-image-path/.expected/results.yaml b/e2e/testdata/fn-eval/short-image-path/.expected/results.yaml
@@ -0,0 +1,8 @@
+apiVersion: kpt.dev/v1
+kind: FunctionResultList
+metadata:
+  name: fnresults
+exitCode: 0
+items:
+  - image: gcr.io/kpt-fn/set-namespace:v0.1.3
+    exitCode: 0
diff --git a/e2e/testdata/fn-eval/short-image-path/.krmignore b/e2e/testdata/fn-eval/short-image-path/.krmignore
@@ -0,0 +1 @@
+.expected
diff --git a/e2e/testdata/fn-eval/short-image-path/resources.yaml b/e2e/testdata/fn-eval/short-image-path/resources.yaml
@@ -0,0 +1,26 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 3
+---
+apiVersion: custom.io/v1
+kind: Custom
+metadata:
+  name: custom
+spec:
+  image: nginx:1.2.3
diff --git a/e2e/testdata/fn-render/short-image-path/.expected/config.yaml b/e2e/testdata/fn-render/short-image-path/.expected/config.yaml
@@ -0,0 +1,19 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+stdErr: |
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3"
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3"
+  [RUNNING] "gcr.io/kpt-fn/set-labels:v0.1.4"
+  [PASS] "gcr.io/kpt-fn/set-labels:v0.1.4"
diff --git a/e2e/testdata/fn-render/short-image-path/.expected/diff.patch b/e2e/testdata/fn-render/short-image-path/.expected/diff.patch
@@ -0,0 +1,30 @@
+diff --git a/resources.yaml b/resources.yaml
+index 7a494c9..a9dd224 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -15,12 +15,25 @@ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
++  namespace: staging
++  labels:
++    tier: backend
+ spec:
+   replicas: 3
++  selector:
++    matchLabels:
++      tier: backend
++  template:
++    metadata:
++      labels:
++        tier: backend
+ ---
+ apiVersion: custom.io/v1
+ kind: Custom
+ metadata:
+   name: custom
++  namespace: staging
++  labels:
++    tier: backend
+ spec:
+   image: nginx:1.2.3
diff --git a/e2e/testdata/fn-render/short-image-path/.expected/results.yaml b/e2e/testdata/fn-render/short-image-path/.expected/results.yaml
@@ -0,0 +1,10 @@
+apiVersion: kpt.dev/v1
+kind: FunctionResultList
+metadata:
+  name: fnresults
+exitCode: 0
+items:
+  - image: gcr.io/kpt-fn/set-namespace:v0.1.3
+    exitCode: 0
+  - image: gcr.io/kpt-fn/set-labels:v0.1.4
+    exitCode: 0
diff --git a/e2e/testdata/fn-render/short-image-path/.krmignore b/e2e/testdata/fn-render/short-image-path/.krmignore
@@ -0,0 +1 @@
+.expected
diff --git a/e2e/testdata/fn-render/short-image-path/Kptfile b/e2e/testdata/fn-render/short-image-path/Kptfile
@@ -0,0 +1,12 @@
+apiVersion: kpt.dev/v1
+kind: Kptfile
+metadata:
+  name: app
+pipeline:
+  mutators:
+    - image: set-namespace:v0.1.3
+      configMap:
+        namespace: staging
+    - image: set-labels:v0.1.4
+      configMap:
+        tier: backend
diff --git a/e2e/testdata/fn-render/short-image-path/resources.yaml b/e2e/testdata/fn-render/short-image-path/resources.yaml
@@ -0,0 +1,26 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 3
+---
+apiVersion: custom.io/v1
+kind: Custom
+metadata:
+  name: custom
+spec:
+  image: nginx:1.2.3
diff --git a/internal/cmdfndoc/cmdfndoc.go b/internal/cmdfndoc/cmdfndoc.go
@@ -24,6 +24,7 @@ import (
 
 	"github.com/GoogleContainerTools/kpt/internal/docs/generated/fndocs"
 	"github.com/GoogleContainerTools/kpt/internal/printer"
+	"github.com/GoogleContainerTools/kpt/internal/fnruntime"
 	"github.com/GoogleContainerTools/kpt/internal/util/cmdutil"
 	"github.com/spf13/cobra"
 )
@@ -41,7 +42,7 @@ func NewRunner(ctx context.Context, parent string) *Runner {
 		RunE:    r.runE,
 	}
 	r.Command = c
-	c.Flags().StringVar(&r.Image, "image", "", "kpt function image name")
+	c.Flags().StringVarP(&r.Image, "image", "i", "", "kpt function image name")
 	cmdutil.FixDocs("kpt", parent, c)
 	return r
 }
@@ -60,6 +61,7 @@ func (r *Runner) runE(c *cobra.Command, _ []string) error {
 	if r.Image == "" {
 		return errors.New("image must be specified")
 	}
+	r.Image = fnruntime.AddDefaultImagePathPrefix(r.Image)
 	var out, errout bytes.Buffer
 	dockerRunArgs := []string{
 		"run",
diff --git a/internal/cmdrender/executor.go b/internal/cmdrender/executor.go
@@ -494,6 +494,7 @@ func fnChain(ctx context.Context, hctx *hydrationContext, pkgPath types.UniquePa
 	var runners []kio.Filter
 	for i := range fns {
 		fn := fns[i]
+		fn.Image = fnruntime.AddDefaultImagePathPrefix(fn.Image)
 		r, err := fnruntime.NewContainerRunner(ctx, &fn, pkgPath, hctx.fnResults, hctx.imagePullPolicy)
 		if err != nil {
 			return nil, err
diff --git a/internal/docs/generated/fndocs/docs.go b/internal/docs/generated/fndocs/docs.go
diff --git a/internal/fnruntime/container.go b/internal/fnruntime/container.go
@@ -230,6 +230,14 @@ func (f *ContainerFn) checkImageExistence() bool {
 	return false
 }
 
+// AddDefaultImagePathPrefix adds default gcr.io/kpt-fn/ path prefix to image if only image name is specified
+func AddDefaultImagePathPrefix(image string) string {
+	if !strings.Contains(image, "/") {
+		return fmt.Sprintf("gcr.io/kpt-fn/%s", image)
+	}
+	return image
+}
+
 // ContainerImageError is an error type which will be returned when
 // the container run time cannot verify docker image.
 type ContainerImageError struct {
diff --git a/internal/fnruntime/runner.go b/internal/fnruntime/runner.go
@@ -108,7 +108,6 @@ type FunctionRunner struct {
 
 func (fr *FunctionRunner) Filter(input []*yaml.RNode) (output []*yaml.RNode, err error) {
 	pr := printer.FromContextOrDie(fr.ctx)
-
 	if !fr.disableCLIOutput {
 		pr.Printf("[RUNNING] %q\n", fr.name)
 	}
diff --git a/site/book/03-packages/02-exploring-a-package.md b/site/book/03-packages/02-exploring-a-package.md
@@ -29,7 +29,7 @@ on the package. For example, to search for resources that have a field with path
 `spec.selector.tier`:
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/search-replace:v0.1 -- 'by-path=spec.selector.tier'
+$ kpt fn eval wordpress -i search-replace:v0.1 -- 'by-path=spec.selector.tier'
 ```
 
 [tree-doc]: /reference/cli/pkg/tree/
diff --git a/site/book/03-packages/03-editing-a-package.md b/site/book/03-packages/03-editing-a-package.md
@@ -47,7 +47,7 @@ For example, setting a label on all the resources in the `wordpress` package can
 using the following function:
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/set-labels:v0.1 -- env=dev
+$ kpt fn eval wordpress -i set-labels:v0.1 -- env=dev
 ```
 
 [Chapter 4] discusses different ways of running functions in detail.
diff --git a/site/book/04-using-functions/01-declarative-function-execution.md b/site/book/04-using-functions/01-declarative-function-execution.md
@@ -110,6 +110,13 @@ The end result is that:
 If any of the functions in the pipeline fails for whatever reason, then the
 entire pipeline is aborted and the local filesystem is left intact.
 
+## Specifying `image`
+
+The `image` field specifies the container image for the function. You can specify
+an image from any container registry. If the registry is omitted, the default
+container registry for functions catalog (`gcr.io/kpt-fn`) is prepended automatically.
+For example, `set-labels:v0.1` is automatically expanded to `gcr.io/kpt-fn/set-labels:v0.1`.
+
 ## Specifying `functionConfig`
 
 In [Chapter 2], we saw this conceptual representation of a function invocation:
@@ -136,7 +143,7 @@ metadata:
   name: mysql
 pipeline:
   mutators:
-    - image: gcr.io/kpt-fn/set-labels:v0.1
+    - image: set-labels:v0.1
       configPath: labels.yaml
 ```
 
@@ -166,7 +173,7 @@ metadata:
   name: mysql
 pipeline:
   mutators:
-    - image: gcr.io/kpt-fn/set-labels:v0.1
+    - image: set-labels:v0.1
       configMap:
         tier: mysql
 ```
diff --git a/site/book/04-using-functions/02-imperative-function-execution.md b/site/book/04-using-functions/02-imperative-function-execution.md
@@ -8,6 +8,12 @@ hierarchy:
 $ kpt fn eval wordpress --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=mywordpress
 ```
 
+Alternatively, for convenience, you can use the short-hand form of the above command
+
+```shell
+$ kpt fn eval wordpress -i set-namespace:v0.1 -- namespace=mywordpress
+```
+
 ?> Refer to the [eval command reference][eval-doc] for usage.
 
 This changes the resources in the `wordpress` package and the `mysql`
@@ -62,7 +68,7 @@ EOF
 ```
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/set-namespace:v0.1 --fn-config /tmp/fn-config.yaml
+$ kpt fn eval wordpress -i set-namespace:v0.1 --fn-config /tmp/fn-config.yaml
 ```
 
 ### CLI arguments
@@ -73,7 +79,7 @@ the key/value pairs as command line arguments. The following is equivalent to
 what we showed previously:
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=mywordpress
+$ kpt fn eval wordpress -i set-namespace:v0.1 -- namespace=mywordpress
 ```
 
 Note that the arguments must come after the separator `--`.
@@ -102,7 +108,7 @@ using the `--network` flag.
 For example, `kubeval` function can download a JSON schema file:
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/kubeval:v0.1 --network -- schema_location="https://kubernetesjsonschema.dev"
+$ kpt fn eval wordpress -i kubeval:v0.1 --network -- schema_location="https://kubernetesjsonschema.dev"
 ```
 
 ### Mounting Directories
@@ -114,7 +120,7 @@ specified on the [Docker Volumes] page.
 For example, `kubeval` function can consume a JSON schema file:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/kubeval:v0.1 --mount type=bind,src="/path/to/schema-dir",dst=/schema-dir --as-current-user wordpress -- schema_location=file:///schema-dir
+$ kpt fn eval -i kubeval:v0.1 --mount type=bind,src="/path/to/schema-dir",dst=/schema-dir --as-current-user wordpress -- schema_location=file:///schema-dir
 ```
 
 Note that the `--as-current-user` flag may be required to run the function as
@@ -144,7 +150,7 @@ For instance, the following will set the labels on all resources in the
 `wordpress` package, including the `Kptfile`:
 
 ```shell
-$ kpt fn eval wordpress --image gcr.io/kpt-fn/set-labels:v0.1 --include-meta-resources -- app=wordpress env=prod
+$ kpt fn eval wordpress -i set-labels:v0.1 --include-meta-resources -- app=wordpress env=prod
 ```
 
 ## Chaining functions using the Unix pipe
diff --git a/site/book/05-developing-functions/02-developing-in-Go.md b/site/book/05-developing-functions/02-developing-in-Go.md
diff --git a/site/reference/cli/fn/doc/README.md b/site/reference/cli/fn/doc/README.md
diff --git a/site/reference/cli/fn/eval/README.md b/site/reference/cli/fn/eval/README.md
diff --git a/thirdparty/cmdconfig/commands/cmdeval/cmdeval.go b/thirdparty/cmdconfig/commands/cmdeval/cmdeval.go
diff --git a/thirdparty/cmdconfig/commands/cmdeval/cmdeval_test.go b/thirdparty/cmdconfig/commands/cmdeval/cmdeval_test.go
