[camel] 03/04: CAMEL-11158 - Added docs

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 73e4b723b35762035958fd0789f5b2153bcfce55
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Wed Jul 18 12:51:26 2018 +0200

    CAMEL-11158 - Added docs
---
 .../src/main/docs/kubernetes-job-component.adoc    | 92 ++++++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc
new file mode 100644
index 0000000..156bba6
--- /dev/null
+++ b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc
@@ -0,0 +1,92 @@
+[[kubernetes-job-component]]
+== Kubernetes Job Component
+
+*Available as of Camel version 2.23*
+
+The *Kubernetes Job* component is one of <<kubernetes-component,Kubernetes Components>> which
+provides a producer to execute kubernetes job operations.
+ 
+
+
+### Component Options
+
+// component options: START
+The Kubernetes Job component has no options.
+// component options: END
+
+
+### Endpoint Options
+
+// endpoint options: START
+The Kubernetes Job endpoint is configured using URI syntax:
+
+----
+kubernetes-job: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 (28 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
+| *portProtocol* (common) | The port protocol, used for ServiceCall EIP | tcp | 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
+| *connectionTimeout* (advanced) | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. |  | Integer
+| *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
+// spring-boot-auto-configure options: START
+=== Spring Boot Auto-Configuration
+
+
+The component supports 2 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *camel.component.kubernetes-hpa.enabled* |  |  | Boolean
+| *camel.component.kubernetes-hpa.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when
+ starting. Only properties which are of String type can use property
+ placeholders. | true | Boolean
+|===
+// spring-boot-auto-configure options: END
+