You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by pc...@apache.org on 2023/07/14 07:32:00 UTC
[camel-k] branch main updated (06415c895 -> 4c32d44ab)
This is an automated email from the ASF dual-hosted git repository.
pcongiusti pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
from 06415c895 fix(docs): remove local from nav
new 7d5f85500 fix(doc): update references to v1alpha1
new 4c32d44ab chore(doc): runtime and quarkus
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/modules/ROOT/nav.adoc | 2 +
.../ROOT/pages/architecture/cr/camel-catalog.adoc | 6 ++-
.../ROOT/pages/installation/registry/registry.adoc | 2 +-
.../kamelets/kameletbindings-error-handler.adoc | 10 ++---
docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc | 48 +++++++++++-----------
.../modules/ROOT/pages/kamelets/kamelets-user.adoc | 18 ++++----
docs/modules/ROOT/pages/running/knative-sink.adoc | 4 +-
.../modules/ROOT/pages/running/quarkus-native.adoc | 7 ++++
.../ROOT/pages/running/runtime-version.adoc | 15 +++++++
docs/modules/ROOT/pages/scaling/binding.adoc | 12 +++---
docs/modules/traits/pages/quarkus.adoc | 4 +-
11 files changed, 77 insertions(+), 51 deletions(-)
create mode 100644 docs/modules/ROOT/pages/running/quarkus-native.adoc
create mode 100644 docs/modules/ROOT/pages/running/runtime-version.adoc
[camel-k] 02/02: chore(doc): runtime and quarkus
Posted by pc...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pcongiusti pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 4c32d44abf982c27e54928f310ab5af0fef3e84d
Author: Pasquale Congiusti <pa...@gmail.com>
AuthorDate: Fri Jul 14 09:27:20 2023 +0200
chore(doc): runtime and quarkus
---
docs/modules/ROOT/nav.adoc | 2 ++
.../modules/ROOT/pages/architecture/cr/camel-catalog.adoc | 6 +++++-
docs/modules/ROOT/pages/running/quarkus-native.adoc | 7 +++++++
docs/modules/ROOT/pages/running/runtime-version.adoc | 15 +++++++++++++++
docs/modules/traits/pages/quarkus.adoc | 4 +---
5 files changed, 30 insertions(+), 4 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 45612ecb1..990e11d91 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -31,6 +31,8 @@
** xref:cli/modeline.adoc[Modeline]
* xref:running/running.adoc[Run an Integration]
** xref:running/dev-mode.adoc[Developer mode]
+** xref:running/runtime-version.adoc[Camel version]
+** xref:running/quarkus-native.adoc[Quarkus Native]
** xref:running/run-from-github.adoc[Run from GitHub]
** xref:running/promoting.adoc[Promote an Integration]
** xref:running/knative-sink.adoc[Knative Sinks]
diff --git a/docs/modules/ROOT/pages/architecture/cr/camel-catalog.adoc b/docs/modules/ROOT/pages/architecture/cr/camel-catalog.adoc
index ca59c77a1..f301dc6e0 100644
--- a/docs/modules/ROOT/pages/architecture/cr/camel-catalog.adoc
+++ b/docs/modules/ROOT/pages/architecture/cr/camel-catalog.adoc
@@ -1,7 +1,11 @@
[[camel-catalog]]
= CamelCatalog
-The *CamelCatalog* is a static side resource that provides metadata related to what is included in the xref:architecture/runtime.adoc[Runtime] in term of Camel components, languages, dataformats and capabilities provided.
+The *CamelCatalog* is a resource that provides metadata related to what is included in the xref:architecture/runtime.adoc[Runtime] in term of Camel components, languages, dataformats and capabilities provided.
+
+Starting from Camel K version 2, it is a dynamic resource which is reconciled and produces as an output a container image required to build the Camel application when using the builder `Pod` strategy. This container image contains all the toolings which will build the artifacts, above all the Quarkus tools required to compile natively.
+
+NOTE: each catalog generates a different builder image starting from Camel K runtime version 1.17. You cannot run a Camel K runtime < 1.17 with Camel K version 2.
[NOTE]
====
diff --git a/docs/modules/ROOT/pages/running/quarkus-native.adoc b/docs/modules/ROOT/pages/running/quarkus-native.adoc
new file mode 100644
index 000000000..59a61546e
--- /dev/null
+++ b/docs/modules/ROOT/pages/running/quarkus-native.adoc
@@ -0,0 +1,7 @@
+= Run Quarkus native applications
+
+The default Camel runtime used by Camel K is Camel Quarkus (via Camel K Runtime dependency). This is a great choice for cloud development and by default we use the JVM mode which provides already enough optimization which makes Camel applications, first class Cloud Native applications.
+
+Quarkus (and Camel Quarkus) offers also the possibility to perform a build ahead of time (AOT) and have even further optimization, making your Camel application a native executable with very low footprint and immediate startup. This is known as Native mode and we can configure such behavior using the xref:traits:quarkus.adoc[Quarkus trait].
+
+See the examples provided in xref:traits:quarkus.adoc#_automatic_rollout_deployment_to_native_integration[Quarkus trait] documentation page to learn how to use the feature.
\ No newline at end of file
diff --git a/docs/modules/ROOT/pages/running/runtime-version.adoc b/docs/modules/ROOT/pages/running/runtime-version.adoc
new file mode 100644
index 000000000..71f7f5542
--- /dev/null
+++ b/docs/modules/ROOT/pages/running/runtime-version.adoc
@@ -0,0 +1,15 @@
+= Choose the runtime version
+
+Starting from Camel K version 2 you will be able to use any Camel K Runtime version available which version is above 1.17. In order to use the feature you need to use the xref:traits:camel.adoc[Camel trait].
+
+The `runtime-version` property is quite straightforward to use:
+
+```
+kamel run my-route.yaml -t camel.runtime-version=1.17.0
+```
+
+Having the ability to choose the runtime, gives you the ability to specify which Camel version you want to run. Each Camel K Runtime is bound to a well defined version of Camel (see the compatibility matrix).
+
+== Pin a runtime version
+
+By default each Camel K version uses a specific runtime version, ie, Camel K 2.0 uses Camel K Runtime 2.16.0. Using the trait will let you pin to a well defined version, avoiding to unintentionally upgrade the runtime of the integrations running when you perform an operator upgrade. See more info in the xref:contributing/upgrade.adoc##maintain-runtime-integrations[Camel K upgrade documentation].
\ No newline at end of file
diff --git a/docs/modules/traits/pages/quarkus.adoc b/docs/modules/traits/pages/quarkus.adoc
index b03444c8b..a79b746ec 100755
--- a/docs/modules/traits/pages/quarkus.adoc
+++ b/docs/modules/traits/pages/quarkus.adoc
@@ -5,9 +5,7 @@ The Quarkus trait configures the Quarkus runtime.
It's enabled by default.
-NOTE: Compiling to a native executable, i.e. when using `package-type=native`, requires at least
-4GiB of memory, so the Pod running the native build, that is either the operator Pod, or the build
-Pod (depending on the build strategy configured for the platform), must have enough memory available.
+NOTE: Compiling to a native build, i.e. when using `package-type=native` will always trigger a builder `Pod` strategy, performing the build in a Pod. There is a set of sensible resource configuration which can be adjusted using xref:traits:builder.adoc[Builder trait].
This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**.
[camel-k] 01/02: fix(doc): update references to v1alpha1
Posted by pc...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pcongiusti pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 7d5f855004d25039e406ca57d64cf5d009c678d7
Author: Pasquale Congiusti <pa...@gmail.com>
AuthorDate: Fri Jul 14 08:55:51 2023 +0200
fix(doc): update references to v1alpha1
---
.../ROOT/pages/installation/registry/registry.adoc | 2 +-
.../kamelets/kameletbindings-error-handler.adoc | 10 ++---
docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc | 48 +++++++++++-----------
.../modules/ROOT/pages/kamelets/kamelets-user.adoc | 18 ++++----
docs/modules/ROOT/pages/running/knative-sink.adoc | 4 +-
docs/modules/ROOT/pages/scaling/binding.adoc | 12 +++---
6 files changed, 47 insertions(+), 47 deletions(-)
diff --git a/docs/modules/ROOT/pages/installation/registry/registry.adoc b/docs/modules/ROOT/pages/installation/registry/registry.adoc
index 0f966bd96..903b721ba 100644
--- a/docs/modules/ROOT/pages/installation/registry/registry.adoc
+++ b/docs/modules/ROOT/pages/installation/registry/registry.adoc
@@ -24,7 +24,7 @@ Alternatively, the same settings can be set in the `.spec.pipeline.registry` sec
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: IntegrationPlatform
metadata:
labels:
diff --git a/docs/modules/ROOT/pages/kamelets/kameletbindings-error-handler.adoc b/docs/modules/ROOT/pages/kamelets/kameletbindings-error-handler.adoc
index 7bdef351d..747533fa0 100644
--- a/docs/modules/ROOT/pages/kamelets/kameletbindings-error-handler.adoc
+++ b/docs/modules/ROOT/pages/kamelets/kameletbindings-error-handler.adoc
@@ -8,7 +8,7 @@ Pipes offer a mechanism to specify an error policy to adopt in case an event pro
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: my-kamelet-binding
@@ -35,7 +35,7 @@ There may be certain cases where you want to just ignore any failure happening o
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: my-kamelet-binding
@@ -56,7 +56,7 @@ Apache Camel offers a default behavior for handling any failure: log to standard
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: my-kamelet-binding
@@ -80,7 +80,7 @@ The `Sink` is probably the most interesting error handler type as it allows you
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: my-kamelet-binding
@@ -94,7 +94,7 @@ spec:
endpoint:
ref: # <1>
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: error-handler
properties:
message: "ERROR!" # <2>
diff --git a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
index 27c84a423..d3b89a407 100644
--- a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
+++ b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
@@ -50,7 +50,7 @@ This produces a YAML file like the following one:
.twitter-search-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: twitter-search-source
@@ -96,7 +96,7 @@ The route provided in the initial scaffold (timer-to-log) is not what we need, s
.twitter-search-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
# ...
spec:
@@ -129,7 +129,7 @@ We specify it in the `spec` -> `definition` part:
.twitter-search-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: twitter-search-source
@@ -195,7 +195,7 @@ the generated objects and other metadata (like the icon and the provider and you
.twitter-search-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: twitter-search-source
@@ -293,7 +293,7 @@ Then you can create a binding like the following one to try it out:
.twitter-search-source-binding.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: twitter-search-source-binding
@@ -301,7 +301,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: twitter-search-source
properties:
keywords: "Apache Camel"
@@ -664,7 +664,7 @@ As starting point, we may just wrap the previous YAML route into the Kamelet env
.earthquake-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: earthquake-source
@@ -736,7 +736,7 @@ to the Kamelet itself. The way to express all this information is via a https://
.earthquake-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: earthquake-source
@@ -778,7 +778,7 @@ The final result should look like:
.earthquake-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: earthquake-source
@@ -891,7 +891,7 @@ To check if it works, you can create a simple binding:
.earthquake-source-binding.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: earthquake-source-binding
@@ -899,7 +899,7 @@ spec:
source:
ref: # <1>
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: earthquake-source
properties:
period: 10000 # <2>
@@ -1098,7 +1098,7 @@ Having defined the main route template, we need to document the Kamelet and the
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: telegram-sink
@@ -1215,7 +1215,7 @@ So, for example, to send a text message to a chat, we may create a binding like
.telegram-text-binding.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: telegram-text-binding
@@ -1223,7 +1223,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: timer-source
properties:
period: 10000
@@ -1231,7 +1231,7 @@ spec:
sink:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-sink
properties:
authorizationToken: "put-your-own"
@@ -1259,7 +1259,7 @@ To check if we can also receive pictures using the above Kamelet, we can create
.telegram-text-binding.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: telegram-image-binding
@@ -1267,7 +1267,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: http-source
properties:
url: "https://github.com/apache/camel/raw/7204aa132662ab6cb8e3c5afea8b9b0859eff0e8/docs/img/logo.png"
@@ -1276,7 +1276,7 @@ spec:
sink:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-sink
properties:
authorizationToken: "put-your-own"
@@ -1354,7 +1354,7 @@ send data to it via HTTP. Let's create a parameterized binding like the followin
.webhook-to-telegram.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: webhook-to-telegram
@@ -1362,14 +1362,14 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: webhook-source
properties:
subpath: message
sink:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-sink
properties:
authorizationToken: "${telegram.authorization.token}"
@@ -1461,7 +1461,7 @@ For example:
.aws-sqs-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: aws-sqs-source
@@ -1493,7 +1493,7 @@ The `queueURL` is a *metadata* parameter for the autoscaler. In order to configu
.aws-sqs-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: aws-sqs-source
@@ -1533,7 +1533,7 @@ For example:
.my-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: my-source
diff --git a/docs/modules/ROOT/pages/kamelets/kamelets-user.adoc b/docs/modules/ROOT/pages/kamelets/kamelets-user.adoc
index c5509a060..a9befa474 100644
--- a/docs/modules/ROOT/pages/kamelets/kamelets-user.adoc
+++ b/docs/modules/ROOT/pages/kamelets/kamelets-user.adoc
@@ -43,7 +43,7 @@ The following is an example of Kamelet that we'll use to discuss the various par
.telegram-text-source.kamelet.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Kamelet
metadata:
name: telegram-text-source # <1>
@@ -289,7 +289,7 @@ For example, here's an example of binding:
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: telegram-text-source-to-channel
@@ -297,7 +297,7 @@ spec:
source: # <1>
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-text-source
properties:
botToken: the-token-here
@@ -337,7 +337,7 @@ The following binding can be created to push data into the `my-topic` topic:
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: telegram-text-source-to-kafka
@@ -345,7 +345,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-text-source
properties:
botToken: the-token-here
@@ -366,7 +366,7 @@ For example, the following binding is allowed:
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: telegram-text-source-to-channel
@@ -374,7 +374,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: telegram-text-source
properties:
botToken: the-token-here
@@ -398,7 +398,7 @@ You can easily tune your `Pipe` with xref:traits:traits.adoc[traits] configurati
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: timer-2-log-annotation
@@ -658,7 +658,7 @@ In a Pipe, the KEDA trait can be enabled using annotations:
.my-keda-binding.yaml
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: my-keda-binding
diff --git a/docs/modules/ROOT/pages/running/knative-sink.adoc b/docs/modules/ROOT/pages/running/knative-sink.adoc
index 55da49588..8c7d2aef1 100644
--- a/docs/modules/ROOT/pages/running/knative-sink.adoc
+++ b/docs/modules/ROOT/pages/running/knative-sink.adoc
@@ -14,7 +14,7 @@ Or as the value of the `sink` field in a `Pipe` resource, e.g.:
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: timer-source-binding
@@ -22,7 +22,7 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: timer-source
properties:
message: Event
diff --git a/docs/modules/ROOT/pages/scaling/binding.adoc b/docs/modules/ROOT/pages/scaling/binding.adoc
index 294de741a..4124afeb7 100644
--- a/docs/modules/ROOT/pages/scaling/binding.adoc
+++ b/docs/modules/ROOT/pages/scaling/binding.adoc
@@ -37,7 +37,7 @@ The `webhook-source` Kamelet is one of the sources that enables auto-scaling whe
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: webhook-binding
@@ -45,12 +45,12 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: webhook-source
sink:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: log-sink
----
@@ -58,7 +58,7 @@ The Knative https://knative.dev/docs/serving/autoscaling/autoscaling-concepts/#s
[source,yaml]
----
-apiVersion: camel.apache.org/v1alpha1
+apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: webhook-binding
@@ -71,12 +71,12 @@ spec:
source:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: webhook-source
sink:
ref:
kind: Kamelet
- apiVersion: camel.apache.org/v1alpha1
+ apiVersion: camel.apache.org/v1
name: log-sink
----