diff --git a/config/nav.yml b/config/nav.yml index 5e236f55308..2b055a656e2 100644 --- a/config/nav.yml +++ b/config/nav.yml @@ -88,6 +88,7 @@ nav: - Creating functions: functions/creating-functions.md - Building functions: functions/building-functions.md - Running functions: functions/running-functions.md + - Subscribing functions: functions/subscribing-functions.md - Deploying functions: functions/deploying-functions.md - Invoking functions: functions/invoking-functions.md - Language packs: functions/language-packs.md diff --git a/docs/functions/subscribing-functions.md b/docs/functions/subscribing-functions.md new file mode 100644 index 00000000000..53fb4e44db6 --- /dev/null +++ b/docs/functions/subscribing-functions.md @@ -0,0 +1,37 @@ +# Subscribe functions to CloudEvents + +### Prerequisites + +- Knative Eventing installed on the cluster + +### Procedure + +--8<-- "proc-subscribe-function.md" + +### Deployment with Triggers + +When invoking `func deploy` the CLI will create Knative Triggers for the function. + +=== "func" + + Deploy the function with Triggers by running the command inside the project directory: + + ```bash + func deploy + ``` + +=== "kn func" + + Deploy the function with Triggers by running the command inside the project directory: + + ```bash + kn func deploy + ``` + +!!! Success "Expected output" + ```{ .bash .no-copy } + 🙌 Function image built: /hello:latest + 🎯 Creating Triggers on the cluster + ✅ Function deployed in namespace "default" and exposed at URL: + http://hello.default.127.0.0.1.sslip.io + ``` diff --git a/docs/snippets/proc-subscribe-function.md b/docs/snippets/proc-subscribe-function.md new file mode 100644 index 00000000000..d8c2654f793 --- /dev/null +++ b/docs/snippets/proc-subscribe-function.md @@ -0,0 +1,33 @@ + +The `subscribe` command will connect the function to a set of events, matching a series of filters for Cloud Event metadata +and a Knative Broker as the source of events, from where they are consumed. + +=== "func" + + To subscribe the function to events for a given broker, run the following command: + + ```bash + func subscribe --filter type=com.example --filter extension=my-extension-value --source my-broker + ``` + + To subscribe the function to events for the default broker, run the following command: + + ```bash + func subscribe --filter type=com.example --filter extension=my-extension-value + ``` + +=== "kn func" + + To subscribe the function to events for a given broker, run the following command: + + ```bash + kn func subscribe --filter type=com.example --filter extension=my-extension-value --source my-broker + ``` + + To subscribe the function to events for the default broker, run the following command: + + ```bash + kn func subscribe --filter type=com.example --filter extension=my-extension-value + ```