Merge pull request #4294 from Nordix/env-var-typo

Fix typo in environment variable name KRM_FN_RUNTIME

Author: efiacor

.github/workflows/go.yml

@@ -65,7 +65,7 @@ jobs:
           make all
           make test-docker
         env:
-          KRM_FN_RUNTIMETIME: ${{ matrix.runtime }}
+          KRM_FN_RUNTIME: ${{ matrix.runtime }}
 
   build-macos:
     runs-on: macos-latest

Makefile

@@ -95,20 +95,20 @@ test:
 
 # This target is used to run Go tests that require docker runtime.
 # Some tests, like pipeline tests, need to have docker available to run.
-# KRM_FN_RUNTIMETIME can be set to select the desired function runtime.
+# KRM_FN_RUNTIME can be set to select the desired function runtime.
 # If unspecified, the default function runtime will be used.
 test-docker: build
 	PATH=$(GOBIN):$(PATH) go test -cover --tags=docker ./...
 
 # KPT_E2E_UPDATE_EXPECTED=true (if expected output to be updated)
 # target to run e2e tests for "kpt fn render" command
-# KRM_FN_RUNTIMETIME can be set to select the desired function runtime.
+# KRM_FN_RUNTIME can be set to select the desired function runtime.
 # If unspecified, the default function runtime will be used.
 test-fn-render: build
 	PATH=$(GOBIN):$(PATH) go test -v --tags=docker --run=TestFnRender/testdata/fn-render/$(T) ./e2e/
 
 # target to run e2e tests for "kpt fn eval" command
-# KRM_FN_RUNTIMETIME can be set to select the desired function runtime.
+# KRM_FN_RUNTIME can be set to select the desired function runtime.
 # If unspecified, the default function runtime will be used.
 test-fn-eval: build
 	PATH=$(GOBIN):$(PATH) go test -v --tags=docker --run=TestFnEval/testdata/fn-eval/$(T)  ./e2e/

documentation/content/en/reference/cli/fn/doc/_index.md

@@ -34,7 +34,7 @@ kpt fn doc --image=IMAGE
 #### Environment Variables
 
 ```
-KRM_FN_RUNTIMETIME:
+KRM_FN_RUNTIME:
   The runtime to run kpt functions. It must be one of "docker", "podman" and "nerdctl".
 ```
 

documentation/content/en/reference/cli/fn/eval/_index.md

@@ -145,7 +145,7 @@ fn-args:
 #### Environment Variables
 
 ```
-KRM_FN_RUNTIMETIME:
+KRM_FN_RUNTIME:
   The runtime to run kpt functions. It must be one of "docker", "podman" and "nerdctl".
 ```
 
@@ -258,7 +258,7 @@ kpt fn eval -i set-namespace:latest --by-kind Deployment --by-name foo -- namesp
 ```shell
 # execute container my-fn with podman on the resources in DIR directory and
 # write output back to DIR
-$ KRM_FN_RUNTIMETIME=podman kpt fn eval DIR -i gcr.io/example.com/my-fn
+$ KRM_FN_RUNTIME=podman kpt fn eval DIR -i gcr.io/example.com/my-fn
 ```
 
 <!--mdtogo-->

e2e/testdata/fn-eval/image-pull-policy-always/.expected/setup.sh

@@ -15,11 +15,11 @@
 
 set -eo pipefail
 
-KRM_FN_RUNTIMETIME="${KRM_FN_RUNTIMETIME:=docker}"
+KRM_FN_RUNTIME="${KRM_FN_RUNTIME:=docker}"
 
 # Function ghcr.io/kptdev/krm-functions-catalog/foo:v0.1 prints "foo" to stderr and
 # function ghcr.io/kptdev/krm-functions-catalog/bar:v0.1 prints "bar" to stderr.
 # We intentionally tag a wrong image as ghcr.io/kptdev/krm-functions-catalog/foo:v0.1, since we
 # expect the correct image to be pulled and override the wrong image.
-${KRM_FN_RUNTIMETIME} pull ghcr.io/kptdev/krm-functions-catalog/bar:v0.1
-${KRM_FN_RUNTIMETIME} tag ghcr.io/kptdev/krm-functions-catalog/bar:v0.1 ghcr.io/kptdev/krm-functions-catalog/foo:v0.1
+${KRM_FN_RUNTIME} pull ghcr.io/kptdev/krm-functions-catalog/bar:v0.1
+${KRM_FN_RUNTIME} tag ghcr.io/kptdev/krm-functions-catalog/bar:v0.1 ghcr.io/kptdev/krm-functions-catalog/foo:v0.1

e2e/testdata/fn-eval/no-image-pull/.expected/exec.sh

@@ -15,11 +15,11 @@
 
 set -eo pipefail
 
-KRM_FN_RUNTIMETIME="${KRM_FN_RUNTIMETIME:=docker}"
+KRM_FN_RUNTIME="${KRM_FN_RUNTIME:=docker}"
 
 kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
 
-${KRM_FN_RUNTIMETIME} image inspect ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
+${KRM_FN_RUNTIME} image inspect ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
 if [[ $? != 0 ]]; then
     echo "ERR: Image could not be found locally and may not have been pulled"
     exit 1

e2e/testdata/fn-eval/no-image-pull/.expected/setup.sh

@@ -13,10 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-KRM_FN_RUNTIMETIME="${KRM_FN_RUNTIMETIME:=docker}"
+KRM_FN_RUNTIME="${KRM_FN_RUNTIME:=docker}"
 
-${KRM_FN_RUNTIMETIME} image inspect ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
+${KRM_FN_RUNTIME} image inspect ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
 # if inspect exits with a 0 exit code the image was found locally, remove it
 if [[ $? == 0 ]]; then
-    ${KRM_FN_RUNTIMETIME} image rm ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
+    ${KRM_FN_RUNTIME} image rm ghcr.io/kptdev/krm-functions-catalog/search-replace:latest
 fi

internal/docs/generated/fndocs/docs.go

@@ -52,7 +52,7 @@ const (
 	podmanBin  string = "podman"
 	nerdctlBin string = "nerdctl"
 
-	ContainerRuntimeEnv = "KRM_FN_RUNTIMETIME"
+	ContainerRuntimeEnv = "KRM_FN_RUNTIME"
 
 	Docker  ContainerRuntime = "docker"
 	Podman  ContainerRuntime = "podman"