You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "squakez (via GitHub)" <gi...@apache.org> on 2024/09/04 09:42:29 UTC
[PR] doc: polish documentation [camel-k]
squakez opened a new pull request, #5818:
URL: https://github.com/apache/camel-k/pull/5818
<!-- Description -->
With this PR we have a more up to date documentation.
<!--
Enter your extended release note in the below block. If the PR requires
additional action from users switching to the new release, include the string
"action required". If no release note is required, write "NONE".
You can (optionally) mark this PR with labels "kind/bug" or "kind/feature" to make sure
the text is added to the right section of the release notes.
-->
**Release Note**
```release-note
doc: polish documentation
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: polish documentation [camel-k]
Posted by "gansheer (via GitHub)" <gi...@apache.org>.
gansheer commented on code in PR #5818:
URL: https://github.com/apache/camel-k/pull/5818#discussion_r1743422532
##########
docs/modules/ROOT/pages/contributing/local-execution.adoc:
##########
@@ -62,11 +89,24 @@ IMPORTANT: using build strategy as `Pod` won't probably work as it will expect t
=== Local Camel K runtime
Camel K integrations are based on https://github.com/apache/camel-k-runtime[Camel K runtime], generally paired with the operator release. If you need to specify a different runtime, or you have a local Camel K runtime that you want to test, then you will need to specify it in the `Integration Platform`:
-----
-./kamel install --skip-operator-setup -n operator-test --registry localhost:5000 --force --runtime-version $version -x camel-k-dev
-----
-The `$version` variable must be replaced with the version you are building. For example, `1.3.1-SNAPSHOT`. With these instructions, the operator will pick up and use the snapshot version you have released locally. In order to use the local maven repository, you will also need to edit your IntegrationPlatform as follow:
+```yaml
+apiVersion: camel.apache.org/v1
+kind: IntegrationPlatform
+metadata:
+ annotations:
+ camel.apache.org/operator.id: camel-k-dev
+ name: camel-k
+ namespace: operator-test
+spec:
+ build:
+ registry:
+ address: localhost:5000
+ insecure: true
+ runtimeVersion: <my-version>
+```
+
+The <my-version> variable must be replaced with the version you are building. For example, `1.3.1-SNAPSHOT`. With these instructions, the operator will pick up and use the snapshot version you have released locally. In order to use the local maven repository, you will also need to edit your IntegrationPlatform as follow:
----
$ k edit ip -n operator-test
Review Comment:
Small nitpick here not from your modifications : it would be better to replace `k` by `kubectl`
##########
docs/modules/ROOT/pages/configuration/configuration.adoc:
##########
@@ -1,28 +1,31 @@
-[[configuration]]
= Configure Integrations
-Runtime properties associated to an integration can be configured using the `--property` flag when running the integration. If the property is a *build time property* (ie, certain `Quarkus` configuration), then, you can use xref:configuration/build-time-properties.adoc[`--build-property`] instead.
+Camel K is highly configurable and attempts to be as much as automatic as possible in order to provide a nice development experience. However, as soon as you start playing harder you will need to provide more tuning to your applications. In this section we're exploring specifically Integration configuration, make sure not to get confused with the xref:installation/integrationplatform.adoc[IntegrationPlatform configuration] section, which influences the general building and publishing behavior.
-The property value can be used inside Camel K integrations using the *property placeholder* mechanism.
+We can distinguish a series of different configurations for an Integration:
-The syntax for properties has the form `{{my.property}}`, for example:
+* Build time configuration
+* Runtime configuration
+* Deployment configuration
-[source,yaml]
-.property-route.yaml
-----
-- from:
- uri: "timer:props"
- steps:
- - setBody:
- simple: "{{my.message}}"
- - to: "log:info"
-----
+== Build time configuration
-In order to give a value to the `my.message` property you can pass it using the command line:
+Most of the time you won't need to influence the building process. There may be circumstances where you need to provide a given Maven dependency to your application, provide some build time property or fine tune the application and the container image resulting from the build process.
-[source]
-----
-kamel run --property my.message="Hello World" property-route.yaml
-----
+Camel K does the best it can to discover automatically dependencies required by your application. However, when you're using external code or the operator can't discover dependencies, you'll need to add them manually. See more in the xref:configuration/dependencies.adoc[dependencies] section.
-For more details and advanced use cases, see the xref:configuration/runtime-properties.adoc[runtime properties] section.
+Build time properties are the configuration injected during the building of the project. They are mainly used by Camel Quarkus and you may not need at all depending on the kind of applications you're building. See more in the xref:configuration/build-time-properties.adoc[build time properties] section.
+
+If you want to optimize your application to run natively on the cloud, then you may see how to xref:configuration/quarkus-native.adoc[run your application with Quarkus Native].
Review Comment:
What does "Quarkus native" refers to in this instance ? Quarkus with native compilation or the fact that Quarkus is said to be a cloud-native framework ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: polish documentation [camel-k]
Posted by "squakez (via GitHub)" <gi...@apache.org>.
squakez commented on code in PR #5818:
URL: https://github.com/apache/camel-k/pull/5818#discussion_r1743674056
##########
docs/modules/ROOT/pages/configuration/configuration.adoc:
##########
@@ -1,28 +1,31 @@
-[[configuration]]
= Configure Integrations
-Runtime properties associated to an integration can be configured using the `--property` flag when running the integration. If the property is a *build time property* (ie, certain `Quarkus` configuration), then, you can use xref:configuration/build-time-properties.adoc[`--build-property`] instead.
+Camel K is highly configurable and attempts to be as much as automatic as possible in order to provide a nice development experience. However, as soon as you start playing harder you will need to provide more tuning to your applications. In this section we're exploring specifically Integration configuration, make sure not to get confused with the xref:installation/integrationplatform.adoc[IntegrationPlatform configuration] section, which influences the general building and publishing behavior.
-The property value can be used inside Camel K integrations using the *property placeholder* mechanism.
+We can distinguish a series of different configurations for an Integration:
-The syntax for properties has the form `{{my.property}}`, for example:
+* Build time configuration
+* Runtime configuration
+* Deployment configuration
-[source,yaml]
-.property-route.yaml
-----
-- from:
- uri: "timer:props"
- steps:
- - setBody:
- simple: "{{my.message}}"
- - to: "log:info"
-----
+== Build time configuration
-In order to give a value to the `my.message` property you can pass it using the command line:
+Most of the time you won't need to influence the building process. There may be circumstances where you need to provide a given Maven dependency to your application, provide some build time property or fine tune the application and the container image resulting from the build process.
-[source]
-----
-kamel run --property my.message="Hello World" property-route.yaml
-----
+Camel K does the best it can to discover automatically dependencies required by your application. However, when you're using external code or the operator can't discover dependencies, you'll need to add them manually. See more in the xref:configuration/dependencies.adoc[dependencies] section.
-For more details and advanced use cases, see the xref:configuration/runtime-properties.adoc[runtime properties] section.
+Build time properties are the configuration injected during the building of the project. They are mainly used by Camel Quarkus and you may not need at all depending on the kind of applications you're building. See more in the xref:configuration/build-time-properties.adoc[build time properties] section.
+
+If you want to optimize your application to run natively on the cloud, then you may see how to xref:configuration/quarkus-native.adoc[run your application with Quarkus Native].
Review Comment:
Quarkus native compilation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: polish documentation [camel-k]
Posted by "squakez (via GitHub)" <gi...@apache.org>.
squakez commented on code in PR #5818:
URL: https://github.com/apache/camel-k/pull/5818#discussion_r1743673365
##########
docs/modules/ROOT/pages/contributing/local-execution.adoc:
##########
@@ -62,11 +89,24 @@ IMPORTANT: using build strategy as `Pod` won't probably work as it will expect t
=== Local Camel K runtime
Camel K integrations are based on https://github.com/apache/camel-k-runtime[Camel K runtime], generally paired with the operator release. If you need to specify a different runtime, or you have a local Camel K runtime that you want to test, then you will need to specify it in the `Integration Platform`:
-----
-./kamel install --skip-operator-setup -n operator-test --registry localhost:5000 --force --runtime-version $version -x camel-k-dev
-----
-The `$version` variable must be replaced with the version you are building. For example, `1.3.1-SNAPSHOT`. With these instructions, the operator will pick up and use the snapshot version you have released locally. In order to use the local maven repository, you will also need to edit your IntegrationPlatform as follow:
+```yaml
+apiVersion: camel.apache.org/v1
+kind: IntegrationPlatform
+metadata:
+ annotations:
+ camel.apache.org/operator.id: camel-k-dev
+ name: camel-k
+ namespace: operator-test
+spec:
+ build:
+ registry:
+ address: localhost:5000
+ insecure: true
+ runtimeVersion: <my-version>
+```
+
+The <my-version> variable must be replaced with the version you are building. For example, `1.3.1-SNAPSHOT`. With these instructions, the operator will pick up and use the snapshot version you have released locally. In order to use the local maven repository, you will also need to edit your IntegrationPlatform as follow:
----
$ k edit ip -n operator-test
Review Comment:
Sorry, did not noticed your review. I'll make the change required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: polish documentation [camel-k]
Posted by "squakez (via GitHub)" <gi...@apache.org>.
squakez merged PR #5818:
URL: https://github.com/apache/camel-k/pull/5818
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org