Skip to content

Commit

Permalink
Adding initial doc for func subscribe (#5754)
Browse files Browse the repository at this point in the history
* Adding initial doc for func subscribe

Signed-off-by: Matthias Wessendorf <[email protected]>

* correction

Signed-off-by: Matthias Wessendorf <[email protected]>

* Adding hint for deploy

Signed-off-by: Matthias Wessendorf <[email protected]>

* Adding index

Signed-off-by: Matthias Wessendorf <[email protected]>

* Updates

Signed-off-by: Matthias Wessendorf <[email protected]>

---------

Signed-off-by: Matthias Wessendorf <[email protected]>
  • Loading branch information
matzew authored Nov 10, 2023
1 parent d3120a9 commit f68510c
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
1 change: 1 addition & 0 deletions config/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
37 changes: 37 additions & 0 deletions docs/functions/subscribing-functions.md
Original file line number Diff line number Diff line change
@@ -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: <registry>/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
```
33 changes: 33 additions & 0 deletions docs/snippets/proc-subscribe-function.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- Snippet used in the following topics:
- /docs/functions/subscribing-functions.md
-->
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
```

0 comments on commit f68510c

Please sign in to comment.