[WIP] Adding ODC SinkBinding docs

[abrennan89]

Fixes https://issues.redhat.com/browse/RHDEVDOCS-1950

[openshift-docs-preview-bot]

The preview will be available shortly at:

• https://sinkbindODC--ocpdocs.netlify.com/

[cardil]

Some minor questions to be answered

[cardil]

Those verification steps will not work.

[cardil]

Unfortunately, this will not work. Previously we had here a weak verification, just by looking at how ODC renders those resources. Now, you've copied verification steps from other ways of configuring sinkbinding. This approach has couple of pitfalls:

1. We don't setup here any event producer. That means that user will not see any event on event-display logs. We could fix that, by deploying some event producer like cronjob or pingsource. Best will be to deploy them using ODC only.
2. We use CLI tools to verify ODC operation. User may not have CLI configured. That's why "ODC way" may have been chosen to follow. We could fix that by rewriting this CLI based verification to one that uses ODC UI to check the same outcome.
3. I'd left previous paragraph of how ODC should render sinkbinding being connected to ksvc, just as first step of simple verification.

[invincibleJai]

User can click om Knative Service in topology and on sidebar , it'll show Pods with view logs option, user can click on view logs and check the events in logs similar to what's being done via CLI. @cardil Thoughts?

[Preeticp]

@invincibleJai can you please review this PR and provide an SME ack?

[invincibleJai]

@abrennan89 if this Doc is from 4.6 POV , then images needs to be updated and SinkBinding got it's icon

[Preeticp]

Hey @abrennan89 I just had a brief look and have asked Jai the ODC-Serverless SME to take a look at it in addition to the ODC QE, before I do a peer review. For Pipelines, we have QE for both ODC and Pipelines review docs for ODC-Pipelines, it probably makes sense for us to follow a similar model for ODC-Serverless issues too. WDYT?

Apart from that, is there a reason why we have this section in the Knative Eventing Sub-bucket instead of the Event sources Sub-bucket, before or after: https://sinkbindodc--ocpdocs.netlify.app/openshift-enterprise/latest/serverless/event_sources/serverless-apiserversource.html

[invincibleJai]

here apiVersion and kind will be kind of subject as in below deployment can even have Job
See label selector to have it working even Deployment needs to be created to proper labels

https://github.com/knative/docs/blob/master/docs/eventing/samples/sinkbinding/sinkbinding.yaml#L19-L25

spec:
  subject:
    apiVersion: apps/v1
    kind: Deployment
    selector:
      matchLabels:
        app: wss

[abrennan89]

Gonna revisit this and use the CronJob / heartbeats example for now.

We can't really doc every option for kind under this PR at least. There are general docs here about CRDs / kind: https://docs.openshift.com/container-platform/4.5/operators/crds/crd-extending-api-with-crds.html#crd-custom-resource-definitions_crd-extending-api-with-crds
but they don't mention much about specific types. Maybe there should be a link to https://kubernetes.io/docs/concepts/workloads/controllers/ or similar that explains these concepts without us having to list all the supported types?

[abrennan89]

@abrennan89 if this Doc is from 4.6 POV , then images needs to be updated and SinkBinding got it's icon

@invincibleJai these docs are for OCP 4.5; they might need an update for 4.6 but there's an issue open for updating the images for that so I would say 4.6 updates should be done under https://issues.redhat.com/browse/RHDEVDOCS-2085

[abrennan89]

Hey @abrennan89 I just had a brief look and have asked Jai the ODC-Serverless SME to take a look at it in addition to the ODC QE, before I do a peer review. For Pipelines, we have QE for both ODC and Pipelines review docs for ODC-Pipelines, it probably makes sense for us to follow a similar model for ODC-Serverless issues too. WDYT?

Followed up in Slack.

Apart from that, is there a reason why we have this section in the Knative Eventing Sub-bucket instead of the Event sources Sub-bucket, before or after: https://sinkbindodc--ocpdocs.netlify.app/openshift-enterprise/latest/serverless/event_sources/serverless-apiserversource.html

It's because sinkbinding technically isn't an event source, so our docs were separate, but I can move it to the event sources section since that's where it is in the UI now 🤷

[cardil]

It's because sinkbinding technically isn't an event source, so our docs were separate, but I can move it to the event sources section since that's where it is in the UI now shrug

For me SinkBinding is in the same class of "thing" as channels. It's an event's transport, a bridge, a road, on which events are delivered from place A to place B. Channels are similar, but events routes are decided by using triggers. Analogy would be a road junction with road sings that forces different type of cars to take different lanes.

Those are a "transport" class things. Event producers are "things" that creates and send events. Taking the analogy one step further, it may be a car dealer, a garage, etc.

[Preeticp]

Thanks for explaining that @abrennan89 I get it now. I came at it from the UI pov(screenshot) :)
Please organize it as you see fit.

[abrennan89]

Closing as per discussions with team and https://issues.redhat.com/browse/RHDEVDOCS-1950