Skip to content

Commit

Permalink
(#5489) Use yaml in docs traits
Browse files Browse the repository at this point in the history
  • Loading branch information
tdiesler committed May 15, 2024
1 parent aaa0e31 commit 2961aa0
Show file tree
Hide file tree
Showing 45 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/3scale.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait 3scale.[key]=[value] --trait 3scale.[key2]=[value2] integration.groovy
$ kamel run --trait 3scale.[key]=[value] --trait 3scale.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/affinity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait affinity.[key]=[value] --trait affinity.[key2]=[value2] integration.groovy
$ kamel run --trait affinity.[key]=[value] --trait affinity.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/aws-secrets-manager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait aws-secrets-manager.[key]=[value] --trait aws-secrets-manager.[key2]=[value2] integration.groovy
$ kamel run --trait aws-secrets-manager.[key]=[value] --trait aws-secrets-manager.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/azure-key-vault.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait azure-key-vault.[key]=[value] --trait azure-key-vault.[key2]=[value2] integration.groovy
$ kamel run --trait azure-key-vault.[key]=[value] --trait azure-key-vault.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/traits/pages/builder.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The builder trait is a *platform trait* and cannot be disabled by the user
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait builder.[key]=[value] --trait builder.[key2]=[value2] integration.groovy
$ kamel run --trait builder.[key]=[value] --trait builder.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down Expand Up @@ -144,5 +144,5 @@ Node selectors can be specified when running an integration with the CLI:

[source,console]
----
$ kamel run --trait builder.node-selector.'size'=large integration.groovy
$ kamel run --trait builder.node-selector.'size'=large integration.yaml
----
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/camel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ NOTE: The camel trait is a *platform trait* and cannot be disabled by the user.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait camel.[key]=[value] --trait camel.[key2]=[value2] integration.groovy
$ kamel run --trait camel.[key]=[value] --trait camel.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/container.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ NOTE: The container trait is a *platform trait* and cannot be disabled by the us
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait container.[key]=[value] --trait container.[key2]=[value2] integration.groovy
$ kamel run --trait container.[key]=[value] --trait container.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/cron.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait cron.[key]=[value] --trait cron.[key2]=[value2] integration.groovy
$ kamel run --trait cron.[key]=[value] --trait cron.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/deployer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The deployer trait is a *platform trait* and cannot be disabled by the use
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait deployer.[key]=[value] --trait deployer.[key2]=[value2] integration.groovy
$ kamel run --trait deployer.[key]=[value] --trait deployer.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The deployment trait is a *platform trait* and cannot be disabled by the u
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait deployment.[key]=[value] --trait deployment.[key2]=[value2] integration.groovy
$ kamel run --trait deployment.[key]=[value] --trait deployment.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/environment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The environment trait is a *platform trait* and cannot be disabled by the
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait environment.[key]=[value] --trait environment.[key2]=[value2] integration.groovy
$ kamel run --trait environment.[key]=[value] --trait environment.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/error-handler.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ NOTE: The error-handler trait is a *platform trait* and cannot be disabled by th
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait error-handler.[key]=[value] --trait error-handler.[key2]=[value2] integration.groovy
$ kamel run --trait error-handler.[key]=[value] --trait error-handler.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/gc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait gc.[key]=[value] --trait gc.[key2]=[value2] integration.groovy
$ kamel run --trait gc.[key]=[value] --trait gc.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/gcp-secret-manager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait gcp-secret-manager.[key]=[value] --trait gcp-secret-manager.[key2]=[value2] integration.groovy
$ kamel run --trait gcp-secret-manager.[key]=[value] --trait gcp-secret-manager.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/hashicorp-vault.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait hashicorp-vault.[key]=[value] --trait hashicorp-vault.[key2]=[value2] integration.groovy
$ kamel run --trait hashicorp-vault.[key]=[value] --trait hashicorp-vault.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/health.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait health.[key]=[value] --trait health.[key2]=[value2] integration.groovy
$ kamel run --trait health.[key]=[value] --trait health.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/ingress.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This trait is available in the following profiles: **Kubernetes**.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait ingress.[key]=[value] --trait ingress.[key2]=[value2] integration.groovy
$ kamel run --trait ingress.[key]=[value] --trait ingress.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/istio.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait istio.[key]=[value] --trait istio.[key2]=[value2] integration.groovy
$ kamel run --trait istio.[key]=[value] --trait istio.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/jolokia.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait jolokia.[key]=[value] --trait jolokia.[key2]=[value2] integration.groovy
$ kamel run --trait jolokia.[key]=[value] --trait jolokia.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/jvm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait jvm.[key]=[value] --trait jvm.[key2]=[value2] integration.groovy
$ kamel run --trait jvm.[key]=[value] --trait jvm.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/kamelets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait kamelets.[key]=[value] --trait kamelets.[key2]=[value2] integration.groovy
$ kamel run --trait kamelets.[key]=[value] --trait kamelets.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/keda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait keda.[key]=[value] --trait keda.[key2]=[value2] integration.groovy
$ kamel run --trait keda.[key]=[value] --trait keda.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/knative-service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This trait is available in the following profiles: **Knative**.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait knative-service.[key]=[value] --trait knative-service.[key2]=[value2] integration.groovy
$ kamel run --trait knative-service.[key]=[value] --trait knative-service.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/knative.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This trait is available in the following profiles: **Knative**.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait knative.[key]=[value] --trait knative.[key2]=[value2] integration.groovy
$ kamel run --trait knative.[key]=[value] --trait knative.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait logging.[key]=[value] --trait logging.[key2]=[value2] integration.groovy
$ kamel run --trait logging.[key]=[value] --trait logging.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait master.[key]=[value] --trait master.[key2]=[value2] integration.groovy
$ kamel run --trait master.[key]=[value] --trait master.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/mount.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ NOTE: The mount trait is a *platform trait* and cannot be disabled by the user.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait mount.[key]=[value] --trait mount.[key2]=[value2] integration.groovy
$ kamel run --trait mount.[key]=[value] --trait mount.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/openapi.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ NOTE: The openapi trait is a *platform trait* and cannot be disabled by the user
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait openapi.[key]=[value] --trait openapi.[key2]=[value2] integration.groovy
$ kamel run --trait openapi.[key]=[value] --trait openapi.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/owner.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ NOTE: The owner trait is a *platform trait* and cannot be disabled by the user.
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait owner.[key]=[value] --trait owner.[key2]=[value2] integration.groovy
$ kamel run --trait owner.[key]=[value] --trait owner.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/pdb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait pdb.[key]=[value] --trait pdb.[key2]=[value2] integration.groovy
$ kamel run --trait pdb.[key]=[value] --trait pdb.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/platform.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ NOTE: The platform trait is a *platform trait* and cannot be disabled by the use
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait platform.[key]=[value] --trait platform.[key2]=[value2] integration.groovy
$ kamel run --trait platform.[key]=[value] --trait platform.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
35 changes: 17 additions & 18 deletions docs/modules/traits/pages/pod.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh

[source,console]
----
$ kamel run integration.groovy --pod-template template.yaml --env TEST_VARIABLE=will_be_overriden --env ANOTHER_VARIABLE=Im_There
$ kamel run integration.yaml --pod-template template.yaml --env TEST_VARIABLE=will_be_overriden --env ANOTHER_VARIABLE=Im_There
----

The value from the template overwrites the `TEST_VARIABLE` environment variable, while `ANOTHER_VARIABLE` stays unchanged.
Expand All @@ -32,7 +32,7 @@ The value from the template overwrites the `TEST_VARIABLE` environment variable,
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait pod.[key]=[value] integration.groovy
$ kamel run --trait pod.[key]=[value] integration.yaml
----
The following configuration options are available:

Expand All @@ -52,20 +52,21 @@ The following configuration options are available:

With the following Integration, that reads files from a directory:

.integration.groovy
[source,groovy]
[source,yaml]
.pod-trait-route.yaml
----
from('file:///var/log')
.convertBodyTo(String.class)
.setBody().simple('${body}: {{TEST_VARIABLE}} ')
.log('${body}')
- from:
uri: "file:///var/log"
steps:
- setBody:
simple: "${body}: {{TEST_VARIABLE}}"
- to: "log:info"
----

Plus the following Pod template, that adds a sidecar container to the Integration Pod, generating some data into the directory, and mounts it into the `integration` container:

.template.yaml
[source,yaml]
.pod-trait-template.yaml
----
containers:
- name: integration
Expand All @@ -90,15 +91,13 @@ The Integration route logs the content of the file generated by the sidecar cont

[source,console]
----
$ kamel run integration.groovy --pod-template template.yaml
kamel run pod-trait-route.yaml --pod-template pod-trait-template.yaml
...
Condition "Ready" is "True" for Integration integration
[1] 2021-04-30 07:40:03,136 INFO [route1] (Camel (camel-1) thread #0 - file:///var/log) Fri Apr 30 07:40:02 UTC 2021 Content from the sidecar container
[1] : hello from the template
[1] 2021-04-30 07:40:04,140 INFO [route1] (Camel (camel-1) thread #0 - file:///var/log) Fri Apr 30 07:40:03 UTC 2021 Content from the sidecar container
[1] : hello from the template
[1] 2021-04-30 07:40:05,142 INFO [route1] (Camel (camel-1) thread #0 - file:///var/log) Fri Apr 30 07:40:04 UTC 2021 Content from the sidecar container
[1] : hello from the template
Condition "Ready" is "True" for Integration pod-trait-route: 1/1 ready replicas
Integration "pod-trait-route" in phase "Running"
[1] 2024-05-15 11:32:30,562 INFO [info] (Camel (camel-1) thread #1 - file:///var/log) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Wed May 15 11:32:30 UTC 2024 Content from the sidecar container: hello from the template]
[1] 2024-05-15 11:32:31,574 INFO [info] (Camel (camel-1) thread #1 - file:///var/log) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Wed May 15 11:32:31 UTC 2024 Content from the sidecar container: hello from the template]
[1] 2024-05-15 11:32:32,583 INFO [info] (Camel (camel-1) thread #1 - file:///var/log) Exchange[ExchangePattern: InOnly, BodyType: String, Body: Wed May 15 11:32:32 UTC 2024 Content from the sidecar container: hello from the template]
----

== Init containers
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/prometheus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait prometheus.[key]=[value] --trait prometheus.[key2]=[value2] integration.groovy
$ kamel run --trait prometheus.[key]=[value] --trait prometheus.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/pull-secret.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait pull-secret.[key]=[value] --trait pull-secret.[key2]=[value2] integration.groovy
$ kamel run --trait pull-secret.[key]=[value] --trait pull-secret.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/quarkus.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ NOTE: The quarkus trait is a *platform trait* and cannot be disabled by the user
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait quarkus.[key]=[value] --trait quarkus.[key2]=[value2] integration.groovy
$ kamel run --trait quarkus.[key]=[value] --trait quarkus.[key2]=[value2] integration.yaml
----
The following configuration options are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/traits/pages/registry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This trait is available in the following profiles: **Kubernetes, Knative, OpenSh
Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait registry.[key]=[value] integration.groovy
$ kamel run --trait registry.[key]=[value] integration.yaml
----
The following configuration options are available:

Expand Down
Loading

0 comments on commit 2961aa0

Please sign in to comment.