[camel] branch master updated: CAMEL-14003: documentation for k8s CR component

[zr...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new b8af516  CAMEL-14003: documentation for k8s CR component
b8af516 is described below

commit b8af5161d8b4ddbadbd361ef2ba192f45c229900
Author: Zoran Regvart <zr...@apache.org>
AuthorDate: Thu Nov 5 12:31:21 2020 +0100

    CAMEL-14003: documentation for k8s CR component
---
 .../kubernetes-custom-resources-component.adoc     | 112 ++++++++++++++++++++
 .../kubernetes-custom-resources-component.adoc     | 112 ++++++++++++++++++++
 .../kubernetes-custom-resources-component.adoc     | 114 +++++++++++++++++++++
 3 files changed, 338 insertions(+)

diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kubernetes-custom-resources-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kubernetes-custom-resources-component.adoc
new file mode 100644
index 0000000..7106063
--- /dev/null
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/kubernetes-custom-resources-component.adoc
@@ -0,0 +1,112 @@
+[[kubernetes-custom-resources-component]]
+= Kubernetes Custom Resources Component
+:docTitle: Kubernetes Custom Resources
+:artifactId: camel-kubernetes
+:description: Perform operations on Kubernetes Custom Resources and get notified on Deployment changes.
+:since: 3.7
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kubernetes-custom-resources.adoc[opts=optional]
+//Manually maintained attributes
+:group: Kubernetes
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kubernetes Custom Resources component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which
+provides a producer to execute Kubernetes Custom Resources operations and a consumer to consume events related to Node objects.
+ 
+
+
+== Component Options
+
+// component options: START
+The Kubernetes Custom Resources component supports 3 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *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
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+|===
+// component options: END
+
+
+== Endpoint Options
+
+// endpoint options: START
+The Kubernetes Custom Resources endpoint is configured using URI syntax:
+
+----
+kubernetes-custom-resources: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 (35 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
+| *crdGroup* (consumer) | The Consumer CRD Resource Group we would like to watch |  | String
+| *crdName* (consumer) | The Consumer CRD Resource name we would like to watch |  | String
+| *crdPlural* (consumer) | The Consumer CRD Resource Plural we would like to watch |  | String
+| *crdScope* (consumer) | The Consumer CRD Resource Scope we would like to watch |  | String
+| *crdVersion* (consumer) | The Consumer CRD Resource Version we would like to watch |  | String
+| *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 option 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. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *operation* (producer) | Producer operation to do on Kubernetes |  | String
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+| *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
+
+== Supported producer operation
+
+- listCustomResources
+- listCustomResourcesByLabels
+- getCustomResource
+- deleteCustomResource
+- createCustomResource
+
+include::camel-spring-boot::page$kubernetes-starter.adoc[]
diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-custom-resources-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-custom-resources-component.adoc
new file mode 100644
index 0000000..7106063
--- /dev/null
+++ b/components/camel-kubernetes/src/main/docs/kubernetes-custom-resources-component.adoc
@@ -0,0 +1,112 @@
+[[kubernetes-custom-resources-component]]
+= Kubernetes Custom Resources Component
+:docTitle: Kubernetes Custom Resources
+:artifactId: camel-kubernetes
+:description: Perform operations on Kubernetes Custom Resources and get notified on Deployment changes.
+:since: 3.7
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kubernetes-custom-resources.adoc[opts=optional]
+//Manually maintained attributes
+:group: Kubernetes
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kubernetes Custom Resources component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which
+provides a producer to execute Kubernetes Custom Resources operations and a consumer to consume events related to Node objects.
+ 
+
+
+== Component Options
+
+// component options: START
+The Kubernetes Custom Resources component supports 3 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *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
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+|===
+// component options: END
+
+
+== Endpoint Options
+
+// endpoint options: START
+The Kubernetes Custom Resources endpoint is configured using URI syntax:
+
+----
+kubernetes-custom-resources: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 (35 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
+| *crdGroup* (consumer) | The Consumer CRD Resource Group we would like to watch |  | String
+| *crdName* (consumer) | The Consumer CRD Resource name we would like to watch |  | String
+| *crdPlural* (consumer) | The Consumer CRD Resource Plural we would like to watch |  | String
+| *crdScope* (consumer) | The Consumer CRD Resource Scope we would like to watch |  | String
+| *crdVersion* (consumer) | The Consumer CRD Resource Version we would like to watch |  | String
+| *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 option 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. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *operation* (producer) | Producer operation to do on Kubernetes |  | String
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+| *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
+
+== Supported producer operation
+
+- listCustomResources
+- listCustomResourcesByLabels
+- getCustomResource
+- deleteCustomResource
+- createCustomResource
+
+include::camel-spring-boot::page$kubernetes-starter.adoc[]
diff --git a/docs/components/modules/ROOT/pages/kubernetes-custom-resources-component.adoc b/docs/components/modules/ROOT/pages/kubernetes-custom-resources-component.adoc
new file mode 100644
index 0000000..d9b9a67
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/kubernetes-custom-resources-component.adoc
@@ -0,0 +1,114 @@
+[[kubernetes-custom-resources-component]]
+= Kubernetes Custom Resources Component
+//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
+:page-source: components/camel-kubernetes/src/main/docs/kubernetes-custom-resources-component.adoc
+:docTitle: Kubernetes Custom Resources
+:artifactId: camel-kubernetes
+:description: Perform operations on Kubernetes Custom Resources and get notified on Deployment changes.
+:since: 3.7
+:supportLevel: Preview
+:component-header: Both producer and consumer are supported
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/kubernetes-custom-resources.adoc[opts=optional]
+//Manually maintained attributes
+:group: Kubernetes
+
+*Since Camel {since}*
+
+*{component-header}*
+
+The Kubernetes Custom Resources component is one of xref:kubernetes-summary.adoc[Kubernetes Components] which
+provides a producer to execute Kubernetes Custom Resources operations and a consumer to consume events related to Node objects.
+ 
+
+
+== Component Options
+
+// component options: START
+The Kubernetes Custom Resources component supports 3 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *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
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+|===
+// component options: END
+
+
+== Endpoint Options
+
+// endpoint options: START
+The Kubernetes Custom Resources endpoint is configured using URI syntax:
+
+----
+kubernetes-custom-resources: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 (35 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
+| *crdGroup* (consumer) | The Consumer CRD Resource Group we would like to watch |  | String
+| *crdName* (consumer) | The Consumer CRD Resource name we would like to watch |  | String
+| *crdPlural* (consumer) | The Consumer CRD Resource Plural we would like to watch |  | String
+| *crdScope* (consumer) | The Consumer CRD Resource Scope we would like to watch |  | String
+| *crdVersion* (consumer) | The Consumer CRD Resource Version we would like to watch |  | String
+| *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 option 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. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
+| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...]
+| *operation* (producer) | Producer operation to do on Kubernetes |  | String
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
+| *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
+
+== Supported producer operation
+
+- listCustomResources
+- listCustomResourcesByLabels
+- getCustomResource
+- deleteCustomResource
+- createCustomResource
+
+include::camel-spring-boot::page$kubernetes-starter.adoc[]