User manual

camel kubernetes export

Export as Maven project that contains a Kubernetes deployment manifest

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

Usage

camel kubernetes export [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:21-jdk:<java-version>).

String

--build-property

Maven build 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

--camel-wrapper

Include Camel Wrapper scripts in exported project for version pinning

false

boolean

--clean-dir

If exporting to current directory (default) then all existing files are preserved. Enabling this option will force cleaning current directory including all sub dirs (use this with care)

false

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

--console

Developer console on the local HTTP server (port 8080 by default): /q/dev with Camel Main, /actuator/camel with Spring Boot, and /q/camel/dev-console with Quarkus. The exported project only has the console with the dev profile.

false

boolean

--dep,--dependency

Add additional dependencies

List

--dir,--directory

Directory where the project will be exported

.

String

--docker

Include Docker files in exported project

true

boolean

--download

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

true

boolean

--dry-run

Preview export without writing files

false

boolean

--env

Set an environment variable in the integration container, for instance --env 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

--groovy-pre-compiled

Whether to include pre-compiled Groovy classes in the export (only supported with runtime=camel-main)

false

boolean

--hawtio

Whether to include Hawtio web console (only available for exporting to Spring Boot or Quarkus)

false

boolean

--hawtio-version

Version of the Hawtio web console

HawtioVersion.HAWTIO_VERSION

String

--ignore-loading-error

Whether to ignore route loading and compilation errors (use this with care!)

false

boolean

--image

The image name to be built.

String

--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 the container image to a given image registry.

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 (auto-detected from classpath if not set)

String

--label

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

String

--lazy-bean

Whether to use lazy bean initialization (can help with complex classloading issues

true

boolean

--local-kamelet-dir

Local directory for loading Kamelets (takes precedence)

String

--logging

Can be used to turn on logging to console (logs by default to file in <user home>/.camel directory)

false

boolean

--logging-level

Logging level

info

String

--main-classname

The class name of the Camel Main application class

CamelApplication

String

--management-port

To use a dedicated port for HTTP management

int

--maven-apache-snapshot-enabled

Whether downloading JARs from ASF Maven Snapshot repository is enabled

true

boolean

--maven-central-enabled

Whether downloading JARs from Maven Central repository is enabled

true

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

--maven-wrapper

Include Maven Wrapper files in exported project

true

boolean

--name

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

String

--observe

Enable observability services

false

boolean

--open-api

Adds an OpenAPI spec from the given file (json or yaml file)

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

--parent-pom

The Maven parent POM group:artifact:version

String

--port

Embeds a local HTTP server on this port

int

--profile

Profile to export .

String

--prop,--property

Camel application properties, ex. --property=prop1=foo

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

Will be quiet, only print when error occurs

false

boolean

--registry-mirror

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

String

--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

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 startup activity (dependency resolution and downloading

false

boolean

--volume

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

String

--yes,-y

Automatically answer yes to confirmation prompts (e.g. when using --clean-dir)

false

boolean

-h,--help

Display the help and sub-commands

boolean