Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion documentation/content/en/reference/cli/fn/eval/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ fn-args:
#### Flags

```shell
--allow-alpha-wasm:
Allow alpha wasm functions to be run. If true, you can specify a wasm image
with --image flag or a path to a wasm file (must have the .wasm file
extension) with --exec flag. Defaults to false.

--as-current-user:
Use the `uid` and `gid` of the kpt process for container function execution.
By default, container function is executed as `nobody` user. You may want to use
Expand Down Expand Up @@ -108,7 +113,7 @@ fn-args:
--match-api-version:
Select resources matching the given apiVersion.

--match-kind
--match-kind:
Select resources matching the given kind.

--match-name:
Expand All @@ -117,6 +122,38 @@ fn-args:
--match-namespace:
Select resources matching the given namespace.

--match-annotations:
Select resources matching the given annotations. The value should be in
`key=value` format. Can be specified multiple times to match multiple
annotations.

--match-labels:
Select resources matching the given labels. The value should be in
`key=value` format. Can be specified multiple times to match multiple
labels.

--exclude-api-version:
Exclude resources matching the given apiVersion.

--exclude-kind:
Exclude resources matching the given kind.

--exclude-name:
Exclude resources matching the given name.

--exclude-namespace:
Exclude resources matching the given namespace.

--exclude-annotations:
Exclude resources matching the given annotations. The value should be in
`key=value` format. Can be specified multiple times to match multiple
annotations.

--exclude-labels:
Exclude resources matching the given labels. The value should be in
`key=value` format. Can be specified multiple times to match multiple
labels.

--mount:
List of storage options to enable reading from the local filesytem. By default,
container functions can not access the local filesystem. It accepts the same options
Expand Down
5 changes: 5 additions & 0 deletions documentation/content/en/reference/cli/fn/render/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ PKG_PATH:
#### Flags

```shell
--allow-alpha-wasm:
Allow wasm to be used during pipeline execution. When enabled, function
images that are wasm modules will be executed using the wasm runtime
instead of a container runtime. Defaults to false.

--allow-exec:
Allow executable binaries to run as function. Note that executable binaries
can perform privileged operations on your system, so ensure that binaries
Expand Down
9 changes: 9 additions & 0 deletions documentation/content/en/reference/cli/live/apply/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ PKG_PATH | -:
for all resources. Default is `false`.
Does not apply for the `table` output format.
--status-policy:
Determines which status information should be saved in the inventory
(if compatible). The available options are:
* all: Save status for all resources in the inventory.
* none: Do not save any status information in the inventory.
The default value is `all`.
```
<!--mdtogo-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,15 @@ PKG_PATH | -:
for all resources. Default is `false`.

Does not apply for the `table` output format.

--status-policy:
Determines which status information should be saved in the inventory
(if compatible). The available options are:

* all: Save status for all resources in the inventory.
* none: Do not save any status information in the inventory.

The default value is `all`.
```
<!--mdtogo-->
Expand Down
3 changes: 3 additions & 0 deletions documentation/content/en/reference/cli/live/init/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ PKG_PATH:
in the package belong in the same namespace. If they do, that namespace will
be used. If they do not, the namespace in the user's context will be chosen.
--quiet:
If true, do not print output message for initialization. Defaults to false.
--rg-file:
The name used for the file created for the ResourceGroup CR. Defaults to
'resourcegroup.yaml'.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ PKG_PATH:
The namespace for the ResourceGroup resource that contains the inventory
for the package. If not provided, it defaults to the same namespace as the
existing inventory object.
--rg-file:
The file path to the ResourceGroup object. Defaults to
'resourcegroup.yaml'.
```
<!--mdtogo-->
Expand Down
24 changes: 13 additions & 11 deletions documentation/content/en/reference/cli/pkg/cat/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,29 @@ FILE | DIR:
Binary files are skipped. Defaults to the current directory.
```

<!--mdtogo-->

#### Flags

```shell
--annotate
Annotate resources with their file origins.
--annotate:
Annotate resources with their file origins. Defaults to false.

--format
Format resource before printing. Defaults to true.
--format:
Format resource config YAML before printing (reorders fields to canonical
order). Defaults to true.

--recurse-subpackages, -R
--recurse-subpackages, -R:
Print resources recursively in all the nested subpackages. Defaults to true.

--strip-comments
Remove comments from yaml.
--strip-comments:
Remove comments from yaml. Defaults to false.

--style
yaml styles to apply. May be 'TaggedStyle', 'DoubleQuotedStyle', 'LiteralStyle', 'FoldedStyle', 'FlowStyle'.
--style:
yaml styles to apply. May be 'TaggedStyle', 'DoubleQuotedStyle',
'LiteralStyle', 'FoldedStyle', 'FlowStyle'.
```

<!--mdtogo-->

### Examples

<!--mdtogo:Examples-->
Expand Down
4 changes: 4 additions & 0 deletions documentation/content/en/reference/cli/pkg/diff/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ VERSION:
# Show changes using the diff command with recursive options.
kpt pkg diff @master --diff-tool meld --diff-tool-opts "-r"
--debug:
When true, prints additional debug information and does not delete the
staged package directories used for comparison. Defaults to false.
```
#### Environment Variables
Expand Down
8 changes: 5 additions & 3 deletions documentation/content/en/reference/cli/pkg/tree/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@ description: |
kpt pkg tree [DIR]
```

<!--mdtogo-->

#### Args

```shell
DIR:
Path to a directory containing KRM resource(s). Defaults to the current working directory.
Path to a local package directory. Defaults to the current directory.
Displays KRM resources with their Kind and Name, and non-KRM text files
as plain filenames. Dotfiles and symlinks are excluded.
```

<!--mdtogo-->

### Examples

<!--mdtogo:Examples-->
Expand Down
47 changes: 46 additions & 1 deletion internal/docs/generated/fndocs/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions internal/docs/generated/livedocs/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions internal/docs/generated/pkgdocs/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading