Skip to content

Commit

Permalink
Fix #1047: adding platform trait doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaferraro authored and lburgazzoli committed Dec 5, 2019
1 parent b785984 commit 2b190d1
Show file tree
Hide file tree
Showing 3 changed files with 45 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 @@ -33,6 +33,7 @@
** xref:traits/knative-service.adoc[Knative Service]
** xref:traits/knative.adoc[Knative]
** xref:traits/owner.adoc[Owner]
** xref:traits/platform.adoc[Platform]
** xref:traits/probes.adoc[Probes]
** xref:traits/prometheus.adoc[Prometheus]
** xref:traits/pull-secret.adoc[Pull Secret]
Expand Down
43 changes: 43 additions & 0 deletions docs/modules/ROOT/pages/traits/platform.adoc
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)
1 change: 1 addition & 0 deletions docs/modules/ROOT/pages/traits/traits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ See the trait description pages for more information on a specific trait:
* xref:traits/knative-service.adoc[Knative Service Trait]
* xref:traits/knative.adoc[Knative Trait]
* xref:traits/owner.adoc[Owner Trait]
* xref:traits/platform.adoc[Platform Trait]
* xref:traits/probes.adoc[Probes Trait]
* xref:traits/prometheus.adoc[Prometheus Trait]
* xref:traits/pull-secret.adoc[Pull Secret Trait]
Expand Down

0 comments on commit 2b190d1

Please sign in to comment.