User manual

camel kubernetes run

Run Camel application on Kubernetes

This command is provided by the kubernetes plugin. Install it with camel plugin add kubernetes.

Usage

camel kubernetes run [options]

Options

Option Description Default Type

--annotation

Add an annotation to the integration. Use name values pairs like --annotation my.company=hello.

String

--base-image

The base image that is used to build the container image from (default is mirror.gcr.io/library/eclipse-temurin:<java-version>).

String

--build-property

Maven properties, ex. --build-property=prop1=foo

List

--camel-spring-boot-version

Camel version to use with Spring Boot

String

--camel-version

To export using a different Camel version than the default version.

String

--cleanup

Automatically removes deployment when process is stopped. Only in combination with --dev, --reload option.

true

boolean

--cluster-type

The target cluster type . Special configurations may be applied to different cluster types such as Kind or Minikube.

String

--config

Add a runtime configuration from a ConfigMap or a Secret (syntax: [configmap|secret]:name[/key], where name represents the configmap/secret name and key optionally represents the configmap/secret key to be filtered).

String

--connect

A Service that the integration should bind to, specified as [[apigroup/]version:]kind:[namespace/]name.

String

--dep,--dependency

Add additional dependencies

List

--disable-auto

Disable automatic cluster type detection and automatic settings for cluster.

boolean

--download

Whether to allow automatic downloading JAR dependencies (over the internet)

true

boolean

--env

Set an environment variable in the integration container, for instance -e MY_VAR=my-value.

String

--exclude

Exclude files by name or pattern

List

--fresh

Make sure we use fresh (i.e. non-cached) resources

false

boolean

--gav

The Maven group:artifact:version

String

--image

The image name to be built.

String

--image-build

Whether to build container image as part of the run.

true

boolean

--image-builder

The image builder used to build the container image (e.g. docker, jib, s2i).

jib

String

--image-group

The image registry group used to push images to.

String

--image-platform

List of target platforms. Each platform is defined using os and architecture (e.g. linux/amd64).

String

--image-push

Whether to push image to given image registry as part of the run.

true

boolean

--image-registry

The image registry to hold the app container image.

String

--java-version,--java

Java version

21

String

--kamelets-version

Apache Camel Kamelets version

String

--kube-config

Path to the kube config file to initialize Kubernetes client

String

--label

Add a label to the integration. Use name values pairs like --label my.company=hello.

String

--local-kamelet-dir

Local directory for loading Kamelets (takes precedence)

String

--logs

Print logs after Camel application has been started.

boolean

--maven-apache-snapshot-enabled

Whether downloading JARs from ASF Maven Snapshot repository is enabled

boolean

--maven-central-enabled

Whether downloading JARs from Maven Central repository is enabled

boolean

--maven-settings

Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used.

String

--maven-settings-security

Optional location of Maven settings-security.xml file to decrypt settings.xml

String

--name

The integration name. Use this when the name should not get derived otherwise.

String

--namespace,-n

Namespace to use for all operations

String

--open-api

Add an OpenAPI spec (syntax: [configmap|file]:name).

String

--output

Just output the generated integration custom resource (supports: yaml or json).

String

--package-name

For Java source files should they have the given package name. By default the package name is computed from the Maven GAV. Use false to turn off and not include package name in the Java source files.

String

--package-scan-jars

Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel CLI

false

boolean

--profile

Profile to export (dev, test, or prod).

String

--prop,--property

Add a runtime property or properties from a file (syntax: [my-key=my-value|file:/path/to/my-conf.properties|/path/to/my-conf.properties].

String

--quarkus-artifact-id (deprecated)

Deprecated. This value is not used anymore. It is kept only for backwards compatibility and will be removed in Camel 5.x. Camel commands may use either 'quarkus-bom' or 'quarkus-camel-bom' artifactIds depending on the context.

quarkus-bom

String

--quarkus-ext-registry

The base URI of Quarkus Extension Registry. The default is {@value RuntimeType#QUARKUS_EXTENSION_REGISTRY_BASE_URL} unless camel.jbang.quarkus.platform.url system property is set (the /client/platforms suffix is removed if present).

String

--quarkus-group-id

groupId of Quarkus Platform BOM; honored only if --quarkus-version is set

io.quarkus.platform

String

--quarkus-version

version of Quarkus Platform BOM; the default value is looked up in Quarkus Extension Registry

String

--quiet

Quiet output - only show errors for build/deploy.

boolean

--registry-mirror

Optional Docker registry mirror where to pull images from when building the container image.

String

--reload,--dev

Enables dev mode (live reload when source files are updated and saved)

boolean

--repo,--repos

Additional maven repositories for download on-demand (Use commas to separate multiple repositories)

String

--resource

Add a runtime resource from a Configmap or a Secret (syntax: [configmap|secret]:name[/key][@path], where name represents the configmap/secret name, key optionally represents the configmap/secret key to be filtered and path represents the destination path).

String

--resource-dir,--resource-dirs

Additional resource directories to include in src/main/resources (recursive, preserving structure)

List

--runtime

Runtime

quarkus

RuntimeType

--service-account

The service account used to run the application.

String

--skip-plugins

Skip plugins during export

false

boolean

--spring-boot-version

Spring Boot version

RuntimeType.SPRING_BOOT_VERSION

String

--trait

Add a trait configuration to the integration. Use name values pairs like --trait trait.name.config=hello.

String

--verbose

Verbose output of build/deploy progress

boolean

--volume

Mount a volume into the integration container, for instance -v pvcname:/container/path.

String

--wait

Wait for the deployment to become ready.

boolean

-h,--help

Display the help and sub-commands

boolean