Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Remove references to kamel local #4572

Merged
merged 1 commit into from
Jul 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -392,11 +392,10 @@ simpler solution that just requires your own machine:

[source]
----
kamel local run Earthquake.java
camel run Earthquake.java
----

The `local` keyword will tell Camel K to use your own machine (you need maven 3.6+ and Java 11+ in order for this to work).
The integration will start and begin printing out earthquake data every 10 seconds.
The `camel run` command relies on https://camel.apache.org/manual/camel-jbang.html[Camel JBang] to locally run the integration. The integration will start and begin printing out earthquake data every 10 seconds.

I show an excerpt of what is printed by the integration:

Expand Down Expand Up @@ -576,7 +575,7 @@ public class Earthquake extends RouteBuilder {
This looks the same as before, but notice that the `period` and `lookAhead` parameters are set in the modeline, while the route uses the `{\{period}}`
and `{\{lookAhead}}` placeholders instead of the actual values.

As before, this integration can be tested with `kamel local run Earthquake.java` (the modeline parameters will be automatically added by the kamel CLI).
As before, this integration can be tested with `camel run Earthquake.java` (the modeline parameters will be automatically added by the kamel CLI).

=== Step 4 (optional): translate into YAML DSL

Expand All @@ -600,7 +599,7 @@ If we managed to reduce our integration to contain only a Camel route, convertin
- set-header:
name: CamelCaffeineAction
constant: GET
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- choice:
when:
- simple: "${header.CamelCaffeineActionHasResult}"
Expand All @@ -616,7 +615,7 @@ If we managed to reduce our integration to contain only a Camel route, convertin
- set-header:
name: CamelHttpMethod
constant: GET
- tod: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- toD: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- unmarshal:
json: {}
- set-property:
Expand All @@ -632,7 +631,7 @@ If we managed to reduce our integration to contain only a Camel route, convertin
- set-header:
name: CamelCaffeineAction
constant: PUT
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- claim-check:
operation: Pop
- split:
Expand All @@ -654,7 +653,7 @@ This route can be run like the previous one using the `kamel` CLI:

[source]
----
kamel local run earthquake.yaml
camel run earthquake.yaml
----

=== Step 5: wrap it into a Kamelet
Expand All @@ -681,7 +680,7 @@ spec:
- set-header:
name: CamelCaffeineAction
constant: GET
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- choice:
when:
- simple: "${header.CamelCaffeineActionHasResult}"
Expand All @@ -697,7 +696,7 @@ spec:
- set-header:
name: CamelHttpMethod
constant: GET
- tod: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- toD: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- unmarshal:
json: {}
- set-property:
Expand All @@ -713,7 +712,7 @@ spec:
- set-header:
name: CamelCaffeineAction
constant: PUT
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- claim-check:
operation: Pop
- split:
Expand Down Expand Up @@ -823,7 +822,7 @@ spec:
- set-header:
name: CamelCaffeineAction
constant: GET
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- choice:
when:
- simple: "${header.CamelCaffeineActionHasResult}"
Expand All @@ -839,7 +838,7 @@ spec:
- set-header:
name: CamelHttpMethod
constant: GET
- tod: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- toD: "https://earthquake.usgs.gov/fdsnws/event/1/query?format=geojson&updatedafter=${exchangeProperty.lastUpdate}&orderby=time-asc"
- unmarshal:
json: {}
- set-property:
Expand All @@ -855,7 +854,7 @@ spec:
- set-header:
name: CamelCaffeineAction
constant: PUT
- tod: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- toD: "caffeine-cache:cache-${routeId}?key=lastUpdate"
- claim-check:
operation: Pop
- split:
Expand Down
172 changes: 0 additions & 172 deletions docs/modules/ROOT/pages/running/local.adoc

This file was deleted.

4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/running/running.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ Camel K provide a very nice **dev mode** feature that will allow you to apply an
[[running-integration-locally]]
== Running an Integration locally

During development, you can also run your integration locally with `kamel local` sub commands. Check out xref:running/local.adoc[Running Locally] for how to use the commands.
During development, for most of the cases, if you are not using Camel K traits or specific camel quarkus configuration, you can use https://camel.apache.org/manual/camel-jbang.html[Camel JBang] to run the integration.

[[no-cli-integration]]
== Running an Integration without CLI

You can run your integration also if you have no CLI available. `kamel` CLI manages a lot of fancy features but you can create an xref:apis/camel-k.adoc#_camel_apache_org_v1_Integration[Integration Custom Resource] with all the configuration expected to run your application.

As an example, let's get the result of a **dry run** for a sample route:
As an example, let's get the result of a **dry run** for a sample route:

```
kamel run Sample.java -o yaml
Expand Down