Skip to content

Commit

Permalink
Fix apache#1234: generate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaferraro committed Feb 21, 2020
1 parent 067ff80 commit 3a9f1e3
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions docs/modules/ROOT/pages/traits/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
The Master trait allows to configure the integration to automatically leverage Kubernetes resources for doing
leader election and starting *master* routes only on certain instances.

It's activated automatically when using the master endpoint in a route, e.g. `from("master:telegram:bots")...`.
It's activated automatically when using the master endpoint in a route, e.g. `from("master:lockname:telegram:bots")...`.

NOTE: this trait adds special permissions to the integration service account in order to read/write configmaps and read pods.
It's recommended to use a different service account than "default" when running the integration.


This trait is available in the following profiles: **Kubernetes, Knative, OpenShift**.
Expand All @@ -15,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:
```
kamel run --trait master.[key]=[value] integration.groovy
kamel run --trait master.[key]=[value] --trait master.[key2]=[value2] integration.groovy
```
The following configuration options are available:

Expand All @@ -27,6 +30,28 @@ The following configuration options are available:
| bool
| Can be used to enable or disable a trait. All traits share this common property.

| master.auto
| bool
| Enables automatic configuration of the trait.

| master.include-delegate-dependencies
| bool
| When this flag is active, the operator analyzes the source code to add dependencies required by delegate endpoints.
E.g. when using `master:lockname:timer`, then `camel:timer` is automatically added to the set of dependencies.
It's enabled by default.

| master.configmap
| string
| Name of the configmap that will be used to store the lock. Defaults to "<integration-name>-lock".

| master.label-key
| string
| Label that will be used to identify all pods contending the lock. Defaults to "camel.apache.org/integration".

| master.label-value
| string
| Label value that will be used to identify all pods contending the lock. Defaults to the integration name.

|===

// End of autogenerated code - DO NOT EDIT! (configuration)

0 comments on commit 3a9f1e3

Please sign in to comment.