mirror of
https://github.com/kyverno/kyverno.git
synced 2024-12-14 11:57:48 +00:00
feat: add experimental commands docs (#8200)
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com> Co-authored-by: shuting <shuting@nirmata.com> Co-authored-by: kyverno-bot <104836976+kyverno-bot@users.noreply.github.com>
This commit is contained in:
Charles-Edouard Brétéché
GitHub
parent
ca3b65a62d
commit
2050a53c38
5 changed files with 146 additions and 1 deletions
2
Makefile
2
Makefile
|
|
@ -516,7 +516,7 @@ codegen-api-docs: $(PACKAGE_SHIM) $(GEN_CRD_API_REFERENCE_DOCS) ## Generate API
|
|||
codegen-cli-docs: $(CLI_BIN) ## Generate CLI docs
|
||||
@echo Generate cli docs... >&2
|
||||
@rm -rf docs/user/cli && mkdir -p docs/user/cli
|
||||
@$(CLI_BIN) docs -o docs/user/cli --autogenTag=false
|
||||
@KYVERNO_EXPERIMENTAL=true $(CLI_BIN) docs -o docs/user/cli --autogenTag=false
|
||||
|
||||
.PHONY: codegen-docs-all
|
||||
codegen-docs-all: codegen-helm-docs codegen-cli-docs codegen-api-docs ## Generate all docs
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ To enable experimental commands, KYVERNO_EXPERIMENTAL should be configured with
|
|||
* [kyverno create](kyverno_create.md) - Provides a command-line interface to help with the creation of various Kyverno resources.
|
||||
* [kyverno docs](kyverno_docs.md) - Generates documentation.
|
||||
* [kyverno jp](kyverno_jp.md) - Provides a command-line interface to JMESPath, enhanced with Kyverno specific custom functions.
|
||||
* [kyverno oci](kyverno_oci.md) - Pulls/pushes images that include policie(s) from/to OCI registries.
|
||||
* [kyverno test](kyverno_test.md) - Run tests from directory.
|
||||
* [kyverno version](kyverno_version.md) - Shows current version of kyverno.
|
||||
|
||||
|
|
|
|||
43
docs/user/cli/kyverno_oci.md
Normal file
43
docs/user/cli/kyverno_oci.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
## kyverno oci
|
||||
|
||||
Pulls/pushes images that include policie(s) from/to OCI registries.
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command is one of the supported experimental commands, and its behaviour might be changed any time.
|
||||
|
||||
```
|
||||
kyverno oci [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for oci
|
||||
-i, --image string image reference to push to or pull from
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--add_dir_header If true, adds the file directory to the header of the log messages
|
||||
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
|
||||
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
|
||||
--log_dir string If non-empty, write log files in this directory (no effect when -logtostderr=true)
|
||||
--log_file string If non-empty, use this log file (no effect when -logtostderr=true)
|
||||
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
|
||||
--logtostderr log to standard error instead of files (default true)
|
||||
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
|
||||
--skip_headers If true, avoid header prefixes in the log messages
|
||||
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
|
||||
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) (default 2)
|
||||
-v, --v Level number for the log level verbosity
|
||||
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kyverno](kyverno.md) - Kubernetes Native Policy Management
|
||||
* [kyverno oci pull](kyverno_oci_pull.md) - pulls policie(s) that are included in an OCI image from OCI registry and saves them to a local directory
|
||||
* [kyverno oci push](kyverno_oci_push.md) - push policie(s) that are included in an OCI image to OCI registry
|
||||
|
||||
49
docs/user/cli/kyverno_oci_pull.md
Normal file
49
docs/user/cli/kyverno_oci_pull.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
## kyverno oci pull
|
||||
|
||||
pulls policie(s) that are included in an OCI image from OCI registry and saves them to a local directory
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command is one of the supported experimental commands, and its behaviour might be changed any time
|
||||
|
||||
```
|
||||
kyverno oci pull [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# pull policy from an OCI image and save it to the specific directory
|
||||
kyverno oci pull -i <imgref> -d policies
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --directory string path to a directory (default ".")
|
||||
-h, --help help for pull
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--add_dir_header If true, adds the file directory to the header of the log messages
|
||||
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
|
||||
-i, --image string image reference to push to or pull from
|
||||
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
|
||||
--log_dir string If non-empty, write log files in this directory (no effect when -logtostderr=true)
|
||||
--log_file string If non-empty, use this log file (no effect when -logtostderr=true)
|
||||
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
|
||||
--logtostderr log to standard error instead of files (default true)
|
||||
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
|
||||
--skip_headers If true, avoid header prefixes in the log messages
|
||||
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
|
||||
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) (default 2)
|
||||
-v, --v Level number for the log level verbosity
|
||||
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kyverno oci](kyverno_oci.md) - Pulls/pushes images that include policie(s) from/to OCI registries.
|
||||
|
||||
52
docs/user/cli/kyverno_oci_push.md
Normal file
52
docs/user/cli/kyverno_oci_push.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
## kyverno oci push
|
||||
|
||||
push policie(s) that are included in an OCI image to OCI registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
This command is one of the supported experimental commands in Kyverno CLI, and its behaviour might be changed any time.
|
||||
|
||||
```
|
||||
kyverno oci push [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# push policy to an OCI image from a given policy file
|
||||
kyverno oci push -p policy.yaml -i <imgref>
|
||||
|
||||
# push multiple policies to an OCI image from a given directory that includes policies
|
||||
kyverno oci push -p policies. -i <imgref>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for push
|
||||
-p, --policy string path to policie(s)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--add_dir_header If true, adds the file directory to the header of the log messages
|
||||
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
|
||||
-i, --image string image reference to push to or pull from
|
||||
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
|
||||
--log_dir string If non-empty, write log files in this directory (no effect when -logtostderr=true)
|
||||
--log_file string If non-empty, use this log file (no effect when -logtostderr=true)
|
||||
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
|
||||
--logtostderr log to standard error instead of files (default true)
|
||||
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
|
||||
--skip_headers If true, avoid header prefixes in the log messages
|
||||
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
|
||||
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=false) (default 2)
|
||||
-v, --v Level number for the log level verbosity
|
||||
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kyverno oci](kyverno_oci.md) - Pulls/pushes images that include policie(s) from/to OCI registries.
|
||||
|
||||
Loading…
Reference in a new issue