-
Notifications
You must be signed in to change notification settings - Fork 352
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix #1047: adding platform trait doc
- Loading branch information
1 parent
b785984
commit 2b190d1
Showing
3 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
= Platform Trait | ||
|
||
// Start of autogenerated code - DO NOT EDIT! (description) | ||
The platform trait is a base trait that is used to assign an integration platform to an integration. | ||
|
||
In case the platform is missing, the trait is allowed to create a default platform. | ||
This feature is especially useful in contexts where there's no need to provide a custom configuration for the platform | ||
(e.g. on OpenShift the default settings work, since there's an embedded container image registry). | ||
|
||
|
||
This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**. | ||
|
||
WARNING: The platform 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: | ||
``` | ||
kamel run --trait platform.[key]=[value] integration.groovy | ||
``` | ||
The following configuration options are available: | ||
|
||
[cols="2,1,5a"] | ||
|=== | ||
|Property | Type | Description | ||
|
||
| platform.enabled | ||
| bool | ||
| Can be used to enable or disable a trait. All traits share this common property. | ||
|
||
| platform.create-default | ||
| bool | ||
| To create a default (empty) platform when the platform is missing. | ||
|
||
| platform.auto | ||
| bool | ||
| To automatically detect from the environment if a default platform can be created (it will be created on OpenShift only). | ||
|
||
|=== | ||
|
||
// End of autogenerated code - DO NOT EDIT! (configuration) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters