Skip to content

Commit

Permalink
fix(doc): kamelet distribution instructions
Browse files Browse the repository at this point in the history
Closes #5958
  • Loading branch information
squakez authored Nov 28, 2024
1 parent 8542680 commit 6a41a35
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/kamelets/kamelets-distribution.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ As development of Kamelet is very fast, make sure to use some version which is c

An alternative to the catalog we bundle is to include a repository containing your own catalog. You need to specify it in the IntegrationPlatform `.spec.kamelet.repository`.

However, we have a simple command in our CLI which takes care of it:
```
kamel kamelet add-repo <git-platform>:<owner>/<repo>[/path_to_kamelets_folder][@version]
```yaml
spec:
kamelet:
repositories:
- uri: <git-platform>:<owner>/<repo>[/path_to_kamelets_folder][@version]
```
Mind that `<git-platform>` is the repository of your choice, for instance `github` and `[@version]` is the tag to use (by default it will use `main` branch).

Expand All @@ -27,4 +29,4 @@ The Camel K has an opinionated way to use Kamelets which is the one exposed abov

However, you may find situations where you want to bundle a Kamelet in a dependency (ie, some external catalog containing all Kamelets spec). As Kamelets are a Camel thing, then, you can use such dependency and let the runtime use the Kamelets available in the classpath.

If you're using such an approach, then, you will need to make sure to skip the Kamelet trait (which is in charge to discover them and get required dependencies), and provide all the dependencies which may be required by your Kamelet. Additionally, you may need to specify a Camel property to tell the runtime where to expect to find the Kamelets, `camel.component.kamelet.location` (default `classpath:/kamelets`).
If you're using such an approach, then, you will need to make sure to skip the Kamelet trait (which is in charge to discover them and get required dependencies), and provide all the dependencies which may be required by your Kamelet. Additionally, you may need to specify a Camel property to tell the runtime where to expect to find the Kamelets, `camel.component.kamelet.location` (default `classpath:/kamelets`).

0 comments on commit 6a41a35

Please sign in to comment.