| // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |
| = image:kamelets/slack-sink.svg[] Slack Sink |
| |
| *Provided by: "Apache Software Foundation"* |
| |
| *Support Level for this Kamelet is: "Preview"* |
| |
| Send messages to a Slack channel. |
| |
| == Configuration Options |
| |
| The following table summarizes the configuration options available for the `slack-sink` Kamelet: |
| [width="100%",cols="2,^2,3,^2,^2,^3",options="header"] |
| |=== |
| | Property| Name| Description| Type| Default| Example |
| | *channel {empty}* *| Channel| The Slack channel to send messages to.| string| | `"#myroom"` |
| | *webhookUrl {empty}* *| Webhook URL| The webhook URL used by the Slack channel to handle incoming messages.| string| | |
| | iconEmoji| Icon Emoji| Use a Slack emoji as an avatar.| string| | |
| | iconUrl| Icon URL| The avatar that the component will use when sending message to a channel or user.| string| | |
| | username| Username| This is the username that the bot will have when sending messages to a channel or user.| string| | |
| |=== |
| |
| NOTE: Fields marked with ({empty}*) are mandatory. |
| |
| == Usage |
| |
| This section summarizes how the `slack-sink` can be used in various contexts. |
| |
| === Knative Sink |
| |
| The `slack-sink` Kamelet can be used as Knative sink by binding it to a Knative object. |
| |
| .slack-sink-binding.yaml |
| [source,yaml] |
| ---- |
| apiVersion: camel.apache.org/v1alpha1 |
| kind: KameletBinding |
| metadata: |
| name: slack-sink-binding |
| spec: |
| source: |
| ref: |
| kind: InMemoryChannel |
| apiVersion: messaging.knative.dev/v1 |
| name: mychannel |
| sink: |
| ref: |
| kind: Kamelet |
| apiVersion: camel.apache.org/v1alpha1 |
| name: slack-sink |
| properties: |
| channel: "#myroom" |
| webhookUrl: "The Webhook URL" |
| |
| ---- |
| Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. |
| |
| Save the `slack-sink-binding.yaml` file into your hard drive, then configure it according to your needs. |
| |
| You can run the sink using the following command: |
| |
| [source,shell] |
| ---- |
| kubectl apply -f slack-sink-binding.yaml |
| ---- |
| |
| ==== *Binding to Knative using the Kamel CLI:* |
| |
| The procedure described above can be simplified into a single execution of the `kamel bind` command: |
| |
| [source,shell] |
| ---- |
| kamel bind channel/mychannel slack-sink -p "sink.channel=#myroom" -p "sink.webhookUrl=The Webhook URL" |
| ---- |
| |
| This will create the KameletBinding under the hood and apply it to the current namespace in the cluster. |
| |
| === Kafka Sink |
| |
| The `slack-sink` Kamelet can be used as Kafka sink by binding it to a Kafka topic. |
| |
| .slack-sink-binding.yaml |
| [source,yaml] |
| ---- |
| apiVersion: camel.apache.org/v1alpha1 |
| kind: KameletBinding |
| metadata: |
| name: slack-sink-binding |
| spec: |
| source: |
| ref: |
| kind: KafkaTopic |
| apiVersion: kafka.strimzi.io/v1beta1 |
| name: my-topic |
| sink: |
| ref: |
| kind: Kamelet |
| apiVersion: camel.apache.org/v1alpha1 |
| name: slack-sink |
| properties: |
| channel: "#myroom" |
| webhookUrl: "The Webhook URL" |
| |
| ---- |
| |
| Ensure that you've installed https://strimzi.io/[Strimzi] and created a topic named `my-topic` in the current namespace. |
| Make also sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. |
| |
| Save the `slack-sink-binding.yaml` file into your hard drive, then configure it according to your needs. |
| |
| You can run the sink using the following command: |
| |
| [source,shell] |
| ---- |
| kubectl apply -f slack-sink-binding.yaml |
| ---- |
| |
| ==== *Binding to Kafka using the Kamel CLI:* |
| |
| The procedure described above can be simplified into a single execution of the `kamel bind` command: |
| |
| [source,shell] |
| ---- |
| kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic slack-sink -p "sink.channel=#myroom" -p "sink.webhookUrl=The Webhook URL" |
| ---- |
| |
| This will create the KameletBinding under the hood and apply it to the current namespace in the cluster. |
| |
| // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |