From 2b190d196f947426d5058d33c5f5ae5f61ce5dea Mon Sep 17 00:00:00 2001 From: Nicola Ferraro Date: Wed, 4 Dec 2019 17:02:58 +0100 Subject: [PATCH] Fix #1047: adding platform trait doc --- docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/traits/platform.adoc | 43 ++++++++++++++++++++ docs/modules/ROOT/pages/traits/traits.adoc | 1 + 3 files changed, 45 insertions(+) create mode 100755 docs/modules/ROOT/pages/traits/platform.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 468165c010..6169a8c0b9 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -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] diff --git a/docs/modules/ROOT/pages/traits/platform.adoc b/docs/modules/ROOT/pages/traits/platform.adoc new file mode 100755 index 0000000000..29d29ca49e --- /dev/null +++ b/docs/modules/ROOT/pages/traits/platform.adoc @@ -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) diff --git a/docs/modules/ROOT/pages/traits/traits.adoc b/docs/modules/ROOT/pages/traits/traits.adoc index 3a3d04389b..1312b4d343 100644 --- a/docs/modules/ROOT/pages/traits/traits.adoc +++ b/docs/modules/ROOT/pages/traits/traits.adoc @@ -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]