Repository: camel Updated Branches: refs/heads/master ae8fc5505 -> c88d02107
CAMEL-11156 - added Deployments component doc Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/c88d0210 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c88d0210 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c88d0210 Branch: refs/heads/master Commit: c88d02107c82b0bf377286d237e939c96fb1a079 Parents: e6c57eb Author: Andrea Cosentino <anco...@gmail.com> Authored: Tue Jul 25 15:36:03 2017 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Tue Jul 25 15:36:27 2017 +0200 ---------------------------------------------------------------------- .../docs/kubernetes-deployments-component.adoc | 66 ++++++++++++++++++++ 1 file changed, 66 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/c88d0210/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc new file mode 100644 index 0000000..938635a --- /dev/null +++ b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc @@ -0,0 +1,66 @@ +## Kubernetes Deployments Component + +*Available as of Camel version 2.20* + +The *Kubernetes Deployments*Â component is one of link:kubernetes.html[Kubernetes Components] which +provides a producer to execute kubernetes secret operations. + + + +### Component Options + +// component options: START +The Kubernetes Deployments component has no options. +// component options: END + + +### Endpoint Options + +// endpoint options: START +The Kubernetes Deployments endpoint is configured using URI syntax: + + kubernetes-deployments:masterUrl + +with the following path and query parameters: + +#### Path Parameters (1 parameters): + +[width="100%",cols="2,5,^1,2",options="header"] +|======================================================================= +| Name | Description | Default | Type +| **masterUrl** | *Required* Kubernetes Master url | | String +|======================================================================= + +#### Query Parameters (26 parameters): + +[width="100%",cols="2,5,^1,2",options="header"] +|======================================================================= +| Name | Description | Default | Type +| **apiVersion** (common) | The Kubernetes API Version to use | | String +| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String +| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | KubernetesClient +| **portName** (common) | The port name used for ServiceCall EIP | | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String +| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String +| **namespace** (consumer) | The namespace | | String +| **poolSize** (consumer) | The Consumer pool size | 1 | int +| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | String +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **operation** (producer) | Producer operation to do on Kubernetes | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **caCertData** (security) | The CA Cert Data | | String +| **caCertFile** (security) | The CA Cert File | | String +| **clientCertData** (security) | The Client Cert Data | | String +| **clientCertFile** (security) | The Client Cert File | | String +| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String +| **clientKeyData** (security) | The Client Key data | | String +| **clientKeyFile** (security) | The Client Key file | | String +| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String +| **oauthToken** (security) | The Auth Token | | String +| **password** (security) | Password to connect to Kubernetes | | String +| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean +| **username** (security) | Username to connect to Kubernetes | | String +|======================================================================= +// endpoint options: END
