Camel K CLI (kamel)
The Camel K command line interface, kamel
, is the main entry point for running integrations on a Kubernetes cluster.
Releases of the Camel K CLI are available on:
-
Apache Mirrors (official): https://downloads.apache.org/camel/camel-k/
-
Github Releases: https://github.com/apache/camel-k/releases
-
Homebrew (Mac and Linux): https://formulae.brew.sh/formula/kamel
Running on macOS
Before running the CLI on macOS, it may be necessary to give adequate permissions for it to run.
It can either be done on the "Privacy & Security" panel in the System Settings or via command-line:
xattr -d com.apple.quarantine /path/to/kamel
Available Commands
Some of the most used commands are:
Name | Description | Example |
---|---|---|
| Obtain the full list of available commands |
|
| Run an integration on Kubernetes |
|
| Debug a remote integration using a local debugger |
|
| Get integrations deployed on Kubernetes |
|
| Get detailed information on a resource |
|
| Print the logs of a running integration |
|
| Delete integrations deployed on Kubernetes |
|
| Bind Kubernetes resources, such as Kamelets, in an integration flow. |
|
| Install Camel K on a Kubernetes cluster |
|
| Clear the state of integrations to rebuild them. |
|
| Reset the Camel K installation |
|
| Uninstall Camel K from a Kubernetes cluster |
|
| Display client version |
|
The list above is not the full list of available commands. You can run kamel help
to obtain the full list. Each command also takes the --help
as option to output more information, e.g.:
$ kamel run --help
Global Flags
While each command has a dedicated set of flags, there are global flags that are available to every command:
Flag | Description | Example |
---|---|---|
| Path to the config file to use for CLI requests |
|
| Help for |
|
| Namespace to use for all operations |
|
For command-specific flags, run --help
with the command to obtain the full list, e.g.:
$ kamel <command> --help
Modeline
Some command options in the CLI can be also specified as modeline in the source file, take a look at the Modeline section for more information.
Image Registry
The CLI can be used to upload content to the Image Registry. To do so, the registry options need to be correctly set during installation. If the Image Registry uses a custom certificate authority then it needs to be trusted by the CLI see SSL_CERT_FILE. If the Image registry uses authentication then it should be configured correctly in $HOME/.docker/config.json
; see Docker Credentials store].