Skip to content

CLI Usage

Usage:

1
$ kpops [OPTIONS] COMMAND [ARGS]...

Options:

  • -V, --version: Print KPOps version
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • clean: Clean pipeline steps
  • deploy: Deploy pipeline steps
  • destroy: Destroy pipeline steps
  • generate: Generate enriched pipeline representation
  • init: Initialize a new KPOps project.
  • manifest: Render final resource representation
  • reset: Reset pipeline steps
  • schema: Generate JSON schema.

kpops clean

Clean pipeline steps

Usage:

1
$ kpops clean [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --parallel / --no-parallel: Enable or disable parallel execution of pipeline steps. If enabled, multiple steps can be processed concurrently. If disabled, steps will be processed sequentially. [default: no-parallel]
  • --help: Show this message and exit.

kpops deploy

Deploy pipeline steps

Usage:

1
$ kpops deploy [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --parallel / --no-parallel: Enable or disable parallel execution of pipeline steps. If enabled, multiple steps can be processed concurrently. If disabled, steps will be processed sequentially. [default: no-parallel]
  • --help: Show this message and exit.

kpops destroy

Destroy pipeline steps

Usage:

1
$ kpops destroy [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --parallel / --no-parallel: Enable or disable parallel execution of pipeline steps. If enabled, multiple steps can be processed concurrently. If disabled, steps will be processed sequentially. [default: no-parallel]
  • --help: Show this message and exit.

kpops generate

Enrich pipeline steps with defaults. The enriched pipeline is used for all KPOps operations (deploy, destroy, ...).

Usage:

1
$ kpops generate [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --help: Show this message and exit.

kpops init

Initialize a new KPOps project.

Usage:

1
$ kpops init [OPTIONS] PATH

Arguments:

  • PATH: Path for a new KPOps project. It should lead to an empty (or non-existent) directory. The part of the path that doesn't exist will be created. [required]

Options:

  • --config-include-opt / --no-config-include-opt: Whether to include non-required settings in the generated 'config.yaml' [default: no-config-include-opt]
  • --help: Show this message and exit.

kpops manifest

In addition to generate, render final resource representation for each pipeline step, e.g. Kubernetes manifests.

Usage:

1
$ kpops manifest [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --help: Show this message and exit.

kpops reset

Reset pipeline steps

Usage:

1
$ kpops reset [OPTIONS] PIPELINE_PATHS...

Arguments:

  • PIPELINE_PATHS...: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'. [env var: KPOPS_PIPELINE_PATHS;required]

Options:

  • --dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]
  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]
  • --filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: FilterType.INCLUDE]
  • --environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]
  • --dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]
  • --verbose / --no-verbose: Enable verbose printing [default: no-verbose]
  • --parallel / --no-parallel: Enable or disable parallel execution of pipeline steps. If enabled, multiple steps can be processed concurrently. If disabled, steps will be processed sequentially. [default: no-parallel]
  • --help: Show this message and exit.

kpops schema

Generate JSON schema.

The schemas can be used to enable support for KPOps files in a text editor.

Usage:

1
$ kpops schema [OPTIONS] SCOPE:{pipeline|defaults|config}

Arguments:

  • SCOPE:{pipeline|defaults|config}: Scope of the generated schema
    1
2
3
    pipeline: Schema of PipelineComponents. Includes the built-in KPOps components by default. To include custom components, provide components module in config.

config: Schema of KpopsConfig.  [required]

Options:

  • --config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]
  • --include-stock-components / --no-include-stock-components: Include the built-in KPOps components. [default: include-stock-components]
  • --help: Show this message and exit.