Chapter 7. Camel K command reference
Chapter 7. Camel K command reference This chapter provides reference details on the Camel K command line interface (CLI), and provides examples of using the kamel command. This chapter also provides reference details on Camel K modeline options that you can specify in a Camel K integration source file, which are executed at runtime. This chapter includes the following sections: Section 7.1, "Camel K command line" Section 7.2, "Camel K modeline options" 7.1. Camel K command line The Camel K CLI provides the kamel command as the main entry point for running Camel K integrations on OpenShift. 7.1.1. Supported commands Note the following key: Symbol Description ✔ Supported ❌ Unsupported or not yet supported Table 7.1. kamel commands Name Supported Description Example bind ✔ Bind Kubernetes resources such as Kamelets, in an integration flow, to Knative channels, Kafka topics, or any other endpoint. kamel bind telegram-source -p "source.authorizationToken=The Token" channel:mychannel completion ❌ Generate completion scripts. kamel completion bash debug ❌ Debug a remote integration using a local debugger. kamel debug my-integration delete ✔ Delete an integration deployed on OpenShift. kamel delete my-integration describe ✔ Get detailed information on a Camel K resource. This includes an integration , kit , or platform . kamel describe integration my-integration get ✔ Get the status of integrations deployed on OpenShift. kamel get help ✔ Get the full list of available commands. You can enter --help as a parameter to each command for more details. kamel help kamel run --help install ❌ Install Camel K on an OpenShift cluster. Note: It is recommended that you use the OpenShift Camel K Operator to install and uninstall Camel K. kamel install kit ❌ Configure an Integration Kit. kamel kit create my-integration --secret log ✔ Print the logs of a running integration. kamel log my-integration promote ✔ You can move an integration from one namespace to another. kamel promote rebuild ✔ Clear the state of one or more integrations causing a rebuild. kamel rebuild my-integration reset ✔ Reset the current Camel K installation. kamel reset run ✔ Run an integration on OpenShift. kamel run MyIntegration.java uninstall ❌ Uninstall Camel K from an OpenShift cluster. Note: It is recommended that you use the OpenShift Camel K Operator to install and uninstall Camel K. kamel uninstall version ✔ Display Camel-K client version. kamel version Additional resources See Installing Camel K 7.2. Camel K modeline options You can use the Camel K modeline to enter configuration options in a Camel K integration source file, which are executed at runtime, for example, using kamel run MyIntegration.java . For more details, see Running Camel K integrations using modeline . All options that are available for the kamel run command, you can specify as modeline options. The following table describes some of the most commonly-used modeline options. Table 7.2. Camel K modeline options Option Description build-property Add a build-time property or build-time properties file. Syntax: [my-key=my-value|file:/path/to/my-conf.properties] config Add a runtime configuration from a Configmap, Secret, or file Syntax: [configmap|secret|file]:name[/key] - name represents the local file path or the ConfigMap/Secret name. - key optionally represents the ConfigMap/Secret key to be filtered. dependency Include an external library (for example, a Maven dependency) Example: dependency=mvn:org.my:app:1.0 env Set an environment variable in the integration container. For example, env=MY_ENV_VAR=my-value . label Add a label for the integration. For example, label=my.company=hello . name Add an integration name. For example, name=my-integration . open-api Add an OpenAPI v2 specification. For example, open-api=path/to/my-hello-api.json . profile Set the Camel K trait profile used for deployment. For example, openshift . property Add a runtime property or a runtime properties file. Syntax: [my-key=my-value|file:/path/to/my-conf.properties]) resource Add a run-time resource from a ConfigMap, Secret or file Syntax: [configmap|secret|file]:name[/key][@path] - name represents the local file path or the ConfigMap/Secret name - key (optional) represents the ConfigMap or Secret key to be filtered s - path (optional) represents the destination path trait Configure a Camel K feature or core capability in a trait. For example, trait=service.enabled=false .