This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 8b85b3db569 docs: Add JBang plugin documentation (#13110)
8b85b3db569 is described below
commit 8b85b3db569c7f45d1e5470919b2a3f2a160b625
Author: Christoph Deppisch <[email protected]>
AuthorDate: Wed Feb 14 06:28:29 2024 +0100
docs: Add JBang plugin documentation (#13110)
- Describe how to manage the command plugins
- Add instructions to enable the plugin first before using the Camel K
subcommands
---
.../modules/ROOT/pages/camel-jbang-k.adoc | 17 +++++++++
.../modules/ROOT/pages/camel-jbang.adoc | 44 +++++++++++++++++++++-
2 files changed, 60 insertions(+), 1 deletion(-)
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-k.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-k.adoc
index d202b44c724..4cca0a82c0f 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang-k.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-k.adoc
@@ -7,6 +7,23 @@ Please make sure to meet these prerequisites for running Camel
integrations on K
Running Camel routes on Kubernetes is quite simple with Camel JBang.
In fact, you can develop and test your Camel route locally with Camel JBang
and then promote the same source to running it as an integration on Kubernetes.
+
+The Camel JBang Kubernetes functionality is provided as a command plugin.
+This means you need to enable the `camel-k` plugin first to use the
subcommands in Camel JBang.
+
+[source,bash]
+----
+camel plugin add camel-k
+----
+
+You should see the `camel-k` plugin listed as installed plugin.
+
+[source,bash]
+----
+camel plugin get
+----
+
+Now Camel JBang is able to run the subcommands offered by the plugin.
Simply run the integration using the `k` subcommand in Camel JBang.
[source,bash]
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
index fab35eabe34..d672fefc55c 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
@@ -858,7 +858,6 @@ camel init
https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92 --
IMPORTANT: When using `--directory` then Camel will automatically clean this
directory if already exists.
-
=== Using a specific Camel version
You can specify which Camel version to run as shown:
@@ -1003,6 +1002,49 @@ camel version list --runtime=quarkus
TIP: See more options with `camel version list --help`.
+=== Manage plugins
+
+Camel JBang uses a plugin concept for some of the subcommands so users can add
functionality on demand.
+Each provided plugin adds a list of commands to the Camel JBang command line
tool.
+
+You can list the supported plugins with
+
+[source,bash]
+----
+camel plugin get --all
+----
+
+[source,text]
+----
+Supported plugins:
+
+ NAME COMMAND DEPENDENCY DESCRIPTION
+ camel-k k org.apache.camel:camel-jbang-plugin-k Manage Camel
integrations on Kubernetes
+----
+
+In case you want to enable a plugin and its functionality you can add it as
follows:
+
+[source,bash]
+----
+camel plugin add <plugin-name>
+----
+
+This adds the plugin and all subcommands are now available for execution.
+
+You can list the currently installed plugins with:
+
+[source,bash]
+----
+camel plugin get
+----
+
+To remove a plugin from the current Camel JBang command line tooling you can
use the `plugin delete` command.
+
+[source,bash]
+----
+camel plugin delete <plugin-name>
+----
+
=== Running Camel K integrations or pipes
Camel also supports running Camel K integrations and binding files, which are
in CRD format (Kubernetes Custom Resource Definitions).
