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 992d77142f58f64f0f2b42efbdfe6e79e372abd7
Author: Pasquale Congiusti <pasquale.congiu...@gmail.com>
AuthorDate: Thu May 4 10:47:16 2023 +0200
chore: update documentation
---
docs/modules/ROOT/pages/cli/cli.adoc | 4 ----
.../ROOT/pages/configuration/runtime-config.adoc | 28 ----------------------
.../pages/configuration/runtime-resources.adoc | 27 +--------------------
docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc | 8 +++----
4 files changed, 5 insertions(+), 62 deletions(-)
diff --git a/docs/modules/ROOT/pages/cli/cli.adoc
b/docs/modules/ROOT/pages/cli/cli.adoc
index 6628071e2..0aadda5dd 100644
--- a/docs/modules/ROOT/pages/cli/cli.adoc
+++ b/docs/modules/ROOT/pages/cli/cli.adoc
@@ -31,10 +31,6 @@ Some of the most used commands are:
|Obtain the full list of available commands
|kamel help
-|init
-|Initialize empty Camel K files (besides Java you can also do this for other
languages like Groovy, Kotlin, XML, YAML)
-|kamel init Routes.java
-
|run
|Run an integration on Kubernetes
|kamel run Routes.java
diff --git a/docs/modules/ROOT/pages/configuration/runtime-config.adoc
b/docs/modules/ROOT/pages/configuration/runtime-config.adoc
index 50fe95855..15edf435f 100644
--- a/docs/modules/ROOT/pages/configuration/runtime-config.adoc
+++ b/docs/modules/ROOT/pages/configuration/runtime-config.adoc
@@ -7,34 +7,6 @@ The *runtime configuration* files are expected to be encoded
in `UTF-8` as they
NOTE: the scope of `--config` global option had different meaning prior Camel
K version 1.5. The old global `--config` has been replaced with `--kube-config`
since Camel K version 1.5.
-[[runtime-config-file]]
-== Runtime file configuration
-
-The most classic way to provide a configuration is probably to have a file
where you have certain text data stored. In this case you can use the `--config
file:/path/to/file` flag that will copy that file and make it available at
classpath level.
-
-[source,txt]
-.resources-data.txt
-----
-the file body
-----
-
-[source,groovy]
-.config-file-route.groovy
-----
-from('timer:config-file')
- .setBody()
- .simple("resource:classpath:resources-data.txt")
- .log('resource file content is: ${body}')
-----
-
-We are referring to the file expected to be copied somewhere in the classpath,
with the same name as the source file. In order to use it, we'll execute the
following `--config` _file_ flag command:
-
-----
-kamel run --config file:resources-data.txt config-file-route.groovy
-----
-
-You can provide more than one single `config` at once by just adding the flag
repeatedly (ie, `--config file:file1.txt ---config file:file2.txt ...`).
-
[[runtime-config-configmap]]
== Runtime configmap configuration
diff --git a/docs/modules/ROOT/pages/configuration/runtime-resources.adoc
b/docs/modules/ROOT/pages/configuration/runtime-resources.adoc
index f3227e9a3..301920487 100644
--- a/docs/modules/ROOT/pages/configuration/runtime-resources.adoc
+++ b/docs/modules/ROOT/pages/configuration/runtime-resources.adoc
@@ -7,31 +7,6 @@ The *runtime resources* are expected to be any resource type
(text or binary con
NOTE: you'll find `--resource` is very similar to the `--config` run flag. The
main difference is that a `resource` can have a binary content and it won't be
parsed by the Camel Context.
-[[runtime-resource-file]]
-== Runtime file resource
-
-Most of the time you will deal with the need to provide your `Integration`
with resource files you have stored in your local machine. In this case you can
use the `--resource file:/path/to/file` flag that will copy that file under the
_/etc/camel/resources/_ directory. You can look at the _resource destination
path_ section at the bottom of this page to specify the destination file
location.
-
-Let's see an example. We want to create an `Integration` unzipping and reading
the content of a file we'll provide (ie, _resources-data.zip_):
-
-[source,groovy]
-.resource-file-binary-route.groovy
-----
-from('file:/etc/camel/resources/?fileName=resources-data.zip&noop=true&idempotent=false')
- .unmarshal().zipFile()
- .log('resource file unzipped content is: ${body}')
-----
-
-We have this file available locally, so we can use the `--resource` _file_
flag command to copy this file in the `Integration`:
-
-----
-kamel run --resource file:resources-data.zip resource-file-binary-route.groovy
-d camel:zipfile
-----
-
-NOTE: when you're providing a resource file, we try to recognize if it's a
binary file and process it accordingly creating a binary representation that
will be decoded transparently in the `Integration`.
-
-You can provide more than one single `resource` at once by just adding the
flag repeatedly (ie, `--resource file:file1.txt --resource file:file2.txt ...`).
-
[[runtime-resource-configmap]]
== Runtime configmap resource
@@ -109,7 +84,7 @@
from('file:/tmp/?fileName=input.txt&noop=true&idempotent=false')
When running the `Integration`, you can specify where to mount the resource
content (either a `File`, `Configmap` or `Secret`) with the _@path_ syntax:
----
-kamel run --resource file:resources-data.txt@/tmp/input.txt
resource-file-location-route.groovy
+kamel run --resource configmap:my-cm@/tmp/input.txt
resource-file-location-route.groovy
----
You may check in the `Integration` `Pod` and verify that the file was mounted
in the _tmp/input.txt_ destination.
diff --git a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
index ba70e270b..8f807688f 100644
--- a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
+++ b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
@@ -38,11 +38,11 @@ We're going to show an example shortly.
Suppose that you want to provide a Kamelet that allows users to search data on
Twitter, providing a stream of information about a given keyword.
Creating such a Kamelet is a fairly easy task: we can use options of the
"camel-twitter" component without adding much processing logic.
-So the procedure of writing a simple Kamelet starts with scaffolding a new
Kamelet resource, which can be done with the `kamel` CLI:
+So the procedure of writing a simple Kamelet starts with scaffolding a new
Kamelet resource, which can be done with the Camel JBang CLI (`camel`):
[source]
----
-kamel init twitter-search-source.kamelet.yaml
+camel init twitter-search-source.kamelet.yaml
----
This produces a YAML file like the following one:
@@ -352,11 +352,11 @@ We write it using the Java DSL because that is the
language that most Apache Cam
TIP: For a great developer experience, we suggest to use
https://code.visualstudio.com/[Visual Studio Code] with the
https://marketplace.visualstudio.com/items?itemName=redhat.apache-camel-extension-pack[Camel
Extension Pack]
-We start from scratch by creating an integration file
+We start from scratch by creating an integration file with Camel JBang CLI:
[source]
----
-kamel init Earthquake.java
+camel init Earthquake.java
----
This will scaffold a Java source file with a timer-to-log integration, that
we'll edit according to our need.
