Skip to content

Commit 5860a70

Browse files
Address ACM fishfood feedback (#2347)
1 parent e090fd3 commit 5860a70

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

site/installation/migration.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,33 @@ Since you are the package publisher, you are expected to have the latest version
207207
of published package on your local disk. If you do not already have it, you can [git clone]
208208
the latest version of remote package on to your local disk.
209209

210+
```shell
211+
$ DEMO_HOME=$(mktemp -d); cd $DEMO_HOME
212+
```
213+
214+
```shell
215+
$ export ORG_NAME=example-org; export PKG_DIR=example
216+
```
217+
218+
```shell
219+
$ export PKG_REPO=https://github.com/${ORG_NAME}/${PKG_DIR}.git
220+
```
221+
222+
```shell
223+
$ git clone $PKG_REPO
224+
```
225+
226+
```shell
227+
# verify the version of kpt
228+
$ kpt version
229+
1.0.0+
230+
```
231+
210232
Invoke `gcr.io/kpt-fn/fix` function on the kpt package.
211233

212234
```shell
213235
# you must be using 1.0+ version of kpt
214-
$ kpt fn eval PKG_PATH --image gcr.io/kpt-fn/fix:v0.2 --include-meta-resources --truncate-output=false
236+
$ kpt fn eval ${PKG_DIR} --image gcr.io/kpt-fn/fix:v0.2 --include-meta-resources --truncate-output=false
215237
```
216238

217239
##### Changes made by the function
@@ -275,8 +297,25 @@ and migrate the local customizations(if any) already performed to their existing
275297
from your existing package directory.
276298

277299
```shell
278-
# you must be using v1.0 version of kpt to run this command
279-
$ kpt pkg get https://example.com/some-pkg@latest
300+
$ DEMO_HOME=$(mktemp -d); cd $DEMO_HOME
301+
```
302+
303+
```shell
304+
$ export ORG_NAME=example-org; export PKG_DIR=example
305+
```
306+
307+
```shell
308+
$ export PKG_REPO=https://github.com/${ORG_NAME}/${PKG_DIR}.git
309+
```
310+
311+
```shell
312+
# verify the version of kpt
313+
$ kpt version
314+
1.0.0+
315+
```
316+
317+
```shell
318+
$ kpt pkg get $PKG_REPO
280319
```
281320

282321
- You might have performed some customizations to your existing package such as,
@@ -287,7 +326,7 @@ $ kpt pkg get https://example.com/some-pkg@latest
287326
- Render the package resources with customizations
288327

289328
```shell
290-
$ kpt fn render PKG_PATH
329+
$ kpt fn render $PKG_DIR
291330
```
292331

293332
- The step is only applicable if you're using `kpt live` functionality.

0 commit comments

Comments
 (0)