Skip to content

Commit

Permalink
doc(trait): configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
squakez committed Sep 24, 2021
1 parent 0797c59 commit b1f13c7
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
** xref:traits:affinity.adoc[Affinity]
** xref:traits:builder.adoc[Builder]
** xref:traits:camel.adoc[Camel]
** xref:traits:configuration.adoc[Configuration]
** xref:traits:container.adoc[Container]
** xref:traits:cron.adoc[Cron]
** xref:traits:dependencies.adoc[Dependencies]
Expand Down
36 changes: 36 additions & 0 deletions docs/modules/traits/pages/configuration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
= Configuration Trait

// Start of autogenerated code - DO NOT EDIT! (description)
The configuration trait is used to customize the Integration configuration such as properties and resources.


This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**.

WARNING: The configuration trait is a *platform trait*: disabling it may compromise the platform functionality.

// End of autogenerated code - DO NOT EDIT! (description)
// Start of autogenerated code - DO NOT EDIT! (configuration)
== Configuration

Trait properties can be specified when running any integration with the CLI:
[source,console]
----
$ kamel run --trait configuration.[key]=[value] --trait configuration.[key2]=[value2] integration.groovy
----
The following configuration options are available:

[cols="2m,1m,5a"]
|===
|Property | Type | Description

| configuration.enabled
| bool
| Can be used to enable or disable a trait. All traits share this common property.

| configuration.properties
| []string
| A list of properties to be provided to the Integration runtime

|===

// End of autogenerated code - DO NOT EDIT! (configuration)
16 changes: 16 additions & 0 deletions resources/traits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,22 @@ traits:
type: string
description: The camel-k-runtime version to use for the integration. It overrides
the default version set in the Integration Platform.
- name: configuration
platform: true
profiles:
- Kubernetes
- Knative
- OpenShift
description: The configuration trait is used to customize the Integration configuration
such as properties and resources.
properties:
- name: enabled
type: bool
description: Can be used to enable or disable a trait. All traits share this common
property.
- name: properties
type: '[]string'
description: A list of properties to be provided to the Integration runtime
- name: container
platform: true
profiles:
Expand Down

0 comments on commit b1f13c7

Please sign in to comment.