// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT

= {{ .Image }} {{ .Kamelet.Spec.Definition.Title }}

*Provided by: "{{ index .Kamelet.ObjectMeta.Annotations "camel.apache.org/provider" }}"*

{{ .Kamelet.Spec.Definition.Description }}

== Configuration Options
{{ if .HasProperties }}
The following table summarizes the configuration options available for the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet:
{{ .Properties }}
NOTE: Fields marked with an asterisk ({empty}*) are mandatory.
{{ else }}
The `{{ .Kamelet.ObjectMeta.Name }}` Kamelet does not specify any configuration option.
{{ end }}

== Dependencies

At runtime, the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet relies upon the presence of the following dependencies:
{{range .Kamelet.Spec.Dependencies}}
- {{ . }}{{end}} 

== Usage

This section describes how you can use the `{{ .Kamelet.ObjectMeta.Name }}`.

=== Knative {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" | ToCamel }}

{{ if eq (index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type") "action" -}}
You can use the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet as an intermediate step in a Knative binding.
{{ else -}}
You can use the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet as a Knative {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by binding it to a Knative object.
{{ end }}
{{- .SetVal "RefApiVersion" "messaging.knative.dev/v1" -}}{{- .SetVal "RefKind" "Channel" -}}{{- .SetVal "RefName" "mychannel" }}
.{{ .Kamelet.ObjectMeta.Name }}-binding.yaml
[source,yaml]
----
{{ if .GenerateExampleBinding }}
{{- template "kamelet-binding-sink-source.tmpl" . -}}
{{ else }}
{{- .ReadKameletBindingExample "camel-k" .Kamelet.ObjectMeta.Name -}}
{{ end }}
----

==== *Prerequisite*

Make sure you have *"Red Hat Integration - Camel K"* installed into the OpenShift cluster you're connected to.

==== *Procedure for using the cluster CLI*

. Save the `{{ .Kamelet.ObjectMeta.Name }}-binding.yaml` file to your local drive, and then edit it as needed for your configuration.

. Run the {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by using the following command:
+
[source,shell]
----
oc apply -f {{ .Kamelet.ObjectMeta.Name }}-binding.yaml
----

==== *Procedure for using the Kamel CLI*

Configure and run the {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by using the following command:

[source,shell]
----
{{ .ExampleKamelBindCommand "channel:mychannel" }}
----

This command creates the KameletBinding in the current namespace on the cluster.

=== Kafka {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" | ToCamel }}

{{ if eq (index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type") "action" -}}
You can use the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet as an intermediate step in a Kafka binding.
{{ else -}}
You can use the `{{ .Kamelet.ObjectMeta.Name }}` Kamelet as a Kafka {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by binding it to a Kafka topic.
{{ end }} {{- .SetVal "RefApiVersion" "kafka.strimzi.io/v1beta1" -}}{{- .SetVal "RefKind" "KafkaTopic" -}}{{- .SetVal "RefName" "my-topic" }}
.{{ .Kamelet.ObjectMeta.Name }}-binding.yaml
[source,yaml]
----
{{ if .GenerateExampleBinding }}
{{- template "kamelet-binding-sink-source.tmpl" . -}}
{{ else }}
{{- .ReadKameletBindingExample "camel-k" .Kamelet.ObjectMeta.Name -}}
{{ end }}
----

==== *Prerequisites*

Ensure that you've installed the *AMQ Streams* operator in your OpenShift cluster and created a topic named `my-topic` in the current namespace.
Make also sure you have *"Red Hat Integration - Camel K"* installed into the OpenShift cluster you're connected to.

==== *Procedure for using the cluster CLI*

. Save the `{{ .Kamelet.ObjectMeta.Name }}-binding.yaml` file to your local drive, and then edit it as needed for your configuration.

. Run the {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by using the following command:
+
[source,shell]
----
oc apply -f {{ .Kamelet.ObjectMeta.Name }}-binding.yaml
----

==== *Procedure for using the Kamel CLI*

Configure and run the {{ index .Kamelet.ObjectMeta.Labels "camel.apache.org/kamelet.type" }} by using the following command:

[source,shell]
----
{{ .ExampleKamelBindCommand "kafka.strimzi.io/v1beta1:KafkaTopic:my-topic" }}
----

This command creates the KameletBinding in the current namespace on the cluster.

== Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/blob/main/{{ .Kamelet.ObjectMeta.Name }}.kamelet.yaml

// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
