Skip to content

Commit

Permalink
Applying feedback (jordi laser eyes for typos)
Browse files Browse the repository at this point in the history
Signed-off-by: gabriel-farache <[email protected]>
  • Loading branch information
gabriel-farache committed Nov 15, 2024
1 parent 56d0709 commit fe12f31
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/main/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Note that as of November 6, 2023, OpenShift Serverless Operator is based on RHEL
### Using Knative kafka broker
If you want to use a Knative broker for communication between the different componenets (Data Index, Job Service and Workflows), you should use a reliable broker, i.e: not in-memory.
Kafka perfectly fullfil this reliability need.
Kafka perfectly fullfills this reliability need.
Follow these [instructions](https://raw.githubusercontent.com/parodos-dev/orchestrator-helm-operator/refs/heads/main/docs/main/kafka-knative-broker/README.md) to setup the a kafka broker.
Expand Down
15 changes: 8 additions & 7 deletions docs/main/kafka-knative-broker/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Using Knative kafka broker
If you want to use a Knative broker for communication between the different componenets (Data Index, Job Service and Workflows), you should use a reliable broker, i.e: not in-memory.

Kafka perfectly fullfil this reliability need.
Kafka perfectly fullfills this reliability need.

## Pre-requisites

Expand All @@ -15,16 +15,17 @@ Kafka perfectly fullfil this reliability need.
oc apply --filename https://github.com/knative-extensions/eventing-kafka-broker/releases/download/knative-v1.14.5/eventing-kafka-controller.yaml
oc apply --filename https://github.com/knative-extensions/eventing-kafka-broker/releases/download/knative-v1.14.5/eventing-kafka-broker.yaml
```
* Note the we are using the version `knative-v1.14.5` in this example, this may change, please refer to the offical documention link provided
* wait for the `kafka-broker-receiver` resource to be ready:
> [!NOTE]
> Note the we are using the version `knative-v1.14.5` in this example, this may change, please refer to the official documentation link provided
* Wait for the `kafka-broker-receiver` resource to be ready:
```console
oc wait --for condition=ready=true pod -l app=kafka-broker-receiver -n knative-eventing --timeout=60s
```
* Review the `scc` to be granted to the `knative-kafka-broker-data-plane` service account used by the `kafka-broker-receiver` deployment:
```console
oc get deployments.apps -n knative-eventing kafka-broker-receiver -oyaml | oc adm policy scc-subject-review --filename -
```
* i.e:
* i.e:
```console
oc -n knative-eventing adm policy add-scc-to-user nonroot-v2 -z knative-kafka-broker-data-plane
```
Expand Down Expand Up @@ -56,7 +57,7 @@ spec:
name: kafka-broker-config
namespace: knative-eventing" | oc apply -f -
```
3. Configure the `sonataflowplatforms.sonataflow.org`: given that the `Orchestrator` is names `orchestrator-sample` and was created under the `orchestrator` namespace:
3. Configure the `sonataflowplatforms.sonataflow.org`: given that the `Orchestrator` is named `orchestrator-sample` and was created under the `orchestrator` namespace:
```console
oc -n orchestrator patch sorchestrators.rhdh.redhat.com orchestrator-sample --type merge \
-p '
Expand Down Expand Up @@ -94,5 +95,5 @@ jobs-service-delete-job-2ac1baab-d856-40bc-bcec-c6dd50951419 kafka-broker
```

For each workflows deployed:
* a `sinkbinding` resource will be created: it will inject the `K_SINK` environment variable into the `deployment` resource. See https://knative.dev/docs/eventing/custom-event-source/sinkbinding/ for more information about`sinkbinding`.
* a `trigger` resource will be created for each event consumed by the workflow. See https://knative.dev/docs/eventing/triggers/ for more information about `trigger` and their usage.
* A `sinkbinding` resource will be created: it will inject the `K_SINK` environment variable into the `deployment` resource. See https://knative.dev/docs/eventing/custom-event-source/sinkbinding/ for more information about`sinkbinding`.
* A `trigger` resource will be created for each event consumed by the workflow. See https://knative.dev/docs/eventing/triggers/ for more information about `trigger` and their usage.
2 changes: 1 addition & 1 deletion helm-charts/orchestrator/templates/sonataflows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:
limits:
memory: {{ .Values.orchestrator.sonataflowPlatform.resources.limits.memory }}
cpu: {{ .Values.orchestrator.sonataflowPlatform.resources.limits.cpu }}
{{- if (and (.Values.orchestrator.sonataflowPlatform.broker.name) (.Values.orchestrator.sonataflowPlatform.broker.name)) }}
{{- if (and (.Values.orchestrator.sonataflowPlatform.broker.name) (.Values.orchestrator.sonataflowPlatform.broker.namespace)) }}
eventing:
broker:
ref:
Expand Down

0 comments on commit fe12f31

Please sign in to comment.