mirror of https://github.com/knative/docs.git
Update docs after moving ContainerSource, CronJobSource. (#1254)
* First pass at updating docs for container source. * ran lint. * CronJobSource updated.
This commit is contained in:
Scott Nichols
Knative Prow Robot
parent
65115d7105
commit
ae0ad0d486
|
|
@ -204,7 +204,7 @@ during `chan` reconciliation. See [Channel Controller](#channel-controller).
|
|||
`src` is a
|
||||
[`KubernetesEventSource`](https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/kuberneteseventsource_types.go),
|
||||
which creates an underlying
|
||||
[`ContainerSource`](https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go).
|
||||
[`ContainerSource`](https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go).
|
||||
|
||||
First we will verify that `src` is writing to `chan`.
|
||||
|
||||
|
|
@ -354,16 +354,16 @@ kubectl --namespace knative-sources logs -l control-plane=controller-manager
|
|||
###### ContainerSource Controller
|
||||
|
||||
The `ContainerSource` Controller is run in the same binary as some other Source
|
||||
Controllers. It is:
|
||||
Controllers from Eventing. It is:
|
||||
|
||||
```shell
|
||||
kubectl --namespace knative-sources get pod -l control-plane=controller-manager
|
||||
kubectl --namespace knative-eventing get pod -l app=sources-controller
|
||||
```
|
||||
|
||||
View its logs with:
|
||||
|
||||
```shell
|
||||
kubectl --namespace knative-sources logs -l control-plane=controller-manager
|
||||
kubectl --namespace knative-eventing logs -l app=sources-controller
|
||||
```
|
||||
|
||||
Pay particular attention to any lines that have a logging level of `warning` or
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ These are sources that are installed as `CRD`s.
|
|||
| [Apache Camel](https://github.com/knative/eventing-sources/blob/master/contrib/camel/pkg/apis/sources/v1alpha1/camelsource_types.go) | Proof of Concept | None | Allows to use [Apache Camel](https://github.com/apache/camel) components for pushing events into Knative. |
|
||||
| [Apache Kafka](https://github.com/knative/eventing-sources/blob/master/contrib/kafka/pkg/apis/sources/v1alpha1/kafka_types.go) | Proof of Concept | None | Brings [Apache Kafka](https://kafka.apache.org/) messages into Knative. |
|
||||
| [BitBucket](https://github.com/nachocano/bitbucket-source) | Proof of Concept | None | Registers for events of the specified types on the specified BitBucket organization/repository. Brings those events into Knative. |
|
||||
| [Cron Job](https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/cron_job_types.go) | Proof of Concept | None | Uses an in-memory timer to produce events on the specified Cron schedule. |
|
||||
| [Cron Job](https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/cron_job_types.go) | Proof of Concept | None | Uses an in-memory timer to produce events on the specified Cron schedule. |
|
||||
| [GCP PubSub](https://github.com/knative/eventing-sources/blob/master/contrib/gcppubsub/pkg/apis/sources/v1alpha1/gcp_pubsub_types.go) | Proof of Concept | None | Brings [GCP PubSub](https://cloud.google.com/pubsub/) messages into Knative. |
|
||||
| [GitHub](https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/githubsource_types.go) | Proof of Concept | None | Registers for events of the specified types on the specified GitHub organization/repository. Brings those events into Knative. |
|
||||
| [GitLab](https://gitlab.com/triggermesh/gitlabsource) | Proof of Concept | None | Registers for events of the specified types on the specified GitLab repository. Brings those events into Knative. |
|
||||
|
|
@ -42,11 +42,11 @@ These are sources that are installed as `CRD`s.
|
|||
|
||||
These are not directly usable, but make writing a Source much easier.
|
||||
|
||||
| Name | Status | Support | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Auto Container Source](https://github.com/Harwayne/auto-container-source) | Proof of Concept | None | AutoContainerSource is a controller that allows the Source CRDs _without_ needing a controller. It notices CRDs with a specific label and starts controlling resources of that type. It utilizes Container Source as underlying infrastructure. |
|
||||
| [Container Source](https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go) | Active Development | Knative | Container Source is a generic controller. Given an Image URL, it will keep a single `Pod` running with the specified image, environment, and arguments. It is used by multiple other Sources as underlying infrastructure. |
|
||||
| [Sample Source](https://github.com/grantr/sample-source) | Proof of Concept | None | SampleSource is a reference implementation supporting the [Writing an Event Source the Hard Way tutorial](../samples/writing-a-source). |
|
||||
| Name | Status | Support | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Auto Container Source](https://github.com/Harwayne/auto-container-source) | Proof of Concept | None | AutoContainerSource is a controller that allows the Source CRDs _without_ needing a controller. It notices CRDs with a specific label and starts controlling resources of that type. It utilizes Container Source as underlying infrastructure. |
|
||||
| [Container Source](https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go) | Active Development | Knative | Container Source is a generic controller. Given an Image URL, it will keep a single `Pod` running with the specified image, environment, and arguments. It is used by multiple other Sources as underlying infrastructure. |
|
||||
| [Sample Source](https://github.com/grantr/sample-source) | Proof of Concept | None | SampleSource is a reference implementation supporting the [Writing an Event Source the Hard Way tutorial](../samples/writing-a-source). |
|
||||
|
||||
### ContainerSource Containers
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ These are containers intended to be used with `ContainerSource`.
|
|||
| [AWS SNS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssns) | Active Development | TriggerMesh | Registers for events of the specified AWS SNS endpoint. Brings those events into Knative. |
|
||||
| [AWS SQS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssqs) | Active Development | TriggerMesh | Registers for events of the specified AWS SQS queue. Brings those events into Knative. |
|
||||
| [FTP / SFTP](https://github.com/vaikas-google/ftp) | Proof of concept | None | Watches for files being uploaded into a FTP/SFTP and generates events for those. |
|
||||
| [Heartbeat](https://github.com/knative/eventing-sources/tree/master/cmd/heartbeats) | Proof of Concept | None | Uses an in-memory timer to produce events at the specified interval. |
|
||||
| [Heartbeat](https://github.com/Harwayne/auto-container-source/tree/master/heartbeat-source) | Proof of Concept | None | Uses an in-memory timer to produce events as the specified interval. Uses AutoContainerSource for underlying infrastructure. |
|
||||
| [Heartbeats](https://github.com/knative/eventing-sources/tree/master/cmd/heartbeats) | Proof of Concept | None | Uses an in-memory timer to produce events at the specified interval. |
|
||||
| [K8s](https://github.com/Harwayne/auto-container-source/tree/master/k8s-event-source) | Proof of Concept | None | Brings Kubernetes cluster events into Knative. Uses AutoContainerSource for underlying infrastructure. |
|
||||
| [WebSocket](https://github.com/knative/eventing-sources/tree/master/cmd/websocketsource) | Active Development | None | Opens a WebSocket to the specified source and packages each received message as a Knative event. |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
# sources easy to write and maintain.
|
||||
metaSources:
|
||||
- name: Container Source
|
||||
url: https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go
|
||||
url: https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go
|
||||
status: Active Development
|
||||
support: Knative
|
||||
description: >
|
||||
|
|
@ -40,7 +40,7 @@ sources:
|
|||
description: >
|
||||
Brings [AWS Simple Queue Service](https://aws.amazon.com/sqs/) messages into Knative.
|
||||
- name: Cron Job
|
||||
url: https://github.com/knative/eventing-sources/blob/master/pkg/apis/sources/v1alpha1/cron_job_types.go
|
||||
url: https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/cron_job_types.go
|
||||
status: Proof of Concept
|
||||
support: None
|
||||
description: >
|
||||
|
|
@ -102,7 +102,7 @@ sources:
|
|||
|
||||
# These are containers intended to be used with ContainerSource, but are not CRDs.
|
||||
containers:
|
||||
- name: Heartbeat
|
||||
- name: Heartbeats
|
||||
url: https://github.com/knative/eventing-sources/tree/master/cmd/heartbeats
|
||||
status: Proof of Concept
|
||||
support: None
|
||||
|
|
|
|||
|
|
@ -203,32 +203,32 @@ files from the Knative repositories:
|
|||
- [Eventing][4]
|
||||
- [Eventing Sources][5]
|
||||
|
||||
| Knative Install Filename | Notes | Dependencies |
|
||||
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
|
||||
| **knative/serving** | | |
|
||||
| [`serving.yaml`][1.1]† | Installs the Serving component. | Cluster roles enabled, if interacting with Build |
|
||||
| [`monitoring.yaml`][1.2]† | Installs the [ELK stack][2], [Prometheus][2.1], [Grafana][2.2], and [Zipkin][2.3]**\*** | Serving component |
|
||||
| [`monitoring-logs-elasticsearch.yaml`][1.3] | Installs only the [ELK stack][2]**\*** | Serving component |
|
||||
| [`monitoring-metrics-prometheus.yaml`][1.4] | Installs only [Prometheus][2.1]**\*** | Serving component |
|
||||
| [`monitoring-tracing-jaeger.yaml`][1.5] | Installs only [Jaeger][2.4].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-jaeger-in-mem.yaml`][1.6] | Installs only [Jaeger in-memory][2.4]**\*** | Serving component |
|
||||
| [`monitoring-tracing-zipkin.yaml`][1.7] | Installs only [Zipkin][2.3].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-zipkin-in-mem.yaml`][1.8] | Installs only [Zipkin in-memory][2.3]**\*** | Serving component |
|
||||
| **knative/build** | | |
|
||||
| [`build.yaml`][3.1]† | Installs the Build component. | Cluster roles enabled, if interacting with Serving |
|
||||
| **knative/eventing** | | |
|
||||
| [`release.yaml`][4.1]† | Installs the Eventing component. Includes the in-memory channel provisioner. | Serving component |
|
||||
| [`eventing.yaml`][4.2] | Installs the Eventing component. Does not include the in-memory channel provisioner. | Serving component |
|
||||
| [`in-memory-channel.yaml`][4.3] | Installs only the in-memory channel provisioner. | Serving component, Eventing component |
|
||||
| [`kafka.yaml`][4.4] | Installs only the Kafka channel provisioner. | Serving component, Eventing component |
|
||||
| **knative/eventing-sources** | | |
|
||||
| [`eventing-sources.yaml`][5.1]† | Installs the following sources: [Kubernetes][6], [GitHub][6.1], [Container image](../eventing#containersource), [CronJob][6.2] | Serving component, Eventing component |
|
||||
| [`camel.yaml`][5.4] | Installs the Apache Camel source. | Serving component, Eventing component |
|
||||
| [`gcppubsub.yaml`][5.2] | Installs the [GCP PubSub source][6.3] | Serving component, Eventing component |
|
||||
| [`kafka.yaml`][5.5] | Installs the Apache Kafka source. | Serving component, Eventing component |
|
||||
| [`event-display.yaml`][5.3] | Installs a Knative Service that logs events received for use in samples and debugging. | Serving component, Eventing component |
|
||||
| **Cluster roles** | | |
|
||||
| [`clusterrole.yaml`][7]† | Enables the Build and Serving components to interact. | Serving component, Build component |
|
||||
| Knative Install Filename | Notes | Dependencies |
|
||||
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| **knative/serving** | | |
|
||||
| [`serving.yaml`][1.1]† | Installs the Serving component. | Cluster roles enabled, if interacting with Build |
|
||||
| [`monitoring.yaml`][1.2]† | Installs the [ELK stack][2], [Prometheus][2.1], [Grafana][2.2], and [Zipkin][2.3]**\*** | Serving component |
|
||||
| [`monitoring-logs-elasticsearch.yaml`][1.3] | Installs only the [ELK stack][2]**\*** | Serving component |
|
||||
| [`monitoring-metrics-prometheus.yaml`][1.4] | Installs only [Prometheus][2.1]**\*** | Serving component |
|
||||
| [`monitoring-tracing-jaeger.yaml`][1.5] | Installs only [Jaeger][2.4].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-jaeger-in-mem.yaml`][1.6] | Installs only [Jaeger in-memory][2.4]**\*** | Serving component |
|
||||
| [`monitoring-tracing-zipkin.yaml`][1.7] | Installs only [Zipkin][2.3].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-zipkin-in-mem.yaml`][1.8] | Installs only [Zipkin in-memory][2.3]**\*** | Serving component |
|
||||
| **knative/build** | | |
|
||||
| [`build.yaml`][3.1]† | Installs the Build component. | Cluster roles enabled, if interacting with Serving |
|
||||
| **knative/eventing** | | |
|
||||
| [`release.yaml`][4.1]† | Installs the Eventing component. Includes [ContainerSource](../eventing#containersource), [CronJobSource][6.2], the in-memory channel provisioner. | Serving component |
|
||||
| [`eventing.yaml`][4.2] | Installs the Eventing component. Does not include the in-memory channel provisioner. | Serving component |
|
||||
| [`in-memory-channel.yaml`][4.3] | Installs only the in-memory channel provisioner. | Serving component, Eventing component |
|
||||
| [`kafka.yaml`][4.4] | Installs only the Kafka channel provisioner. | Serving component, Eventing component |
|
||||
| **knative/eventing-sources** | | |
|
||||
| [`eventing-sources.yaml`][5.1]† | Installs the following sources: [Kubernetes][6], [GitHub][6.1] | Serving component, Eventing component |
|
||||
| [`camel.yaml`][5.4] | Installs the Apache Camel source. | Serving component, Eventing component |
|
||||
| [`gcppubsub.yaml`][5.2] | Installs the [GCP PubSub source][6.3] | Serving component, Eventing component |
|
||||
| [`kafka.yaml`][5.5] | Installs the Apache Kafka source. | Serving component, Eventing component |
|
||||
| [`event-display.yaml`][5.3] | Installs a Knative Service that logs events received for use in samples and debugging. | Serving component, Eventing component |
|
||||
| **Cluster roles** | | |
|
||||
| [`clusterrole.yaml`][7]† | Enables the Build and Serving components to interact. | Serving component, Build component |
|
||||
|
||||
_\*_ See
|
||||
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
|
||||
|
|
@ -348,7 +348,7 @@ commands below.
|
|||
- `https://github.com/knative/eventing/releases/download/v0.5.0/release.yaml`
|
||||
- `https://github.com/knative/eventing-sources/releases/download/v0.5.0/eventing-sources.yaml`
|
||||
|
||||
**Example install commands:**
|
||||
**Example install commands:**
|
||||
|
||||
- To install the Knative Serving component with the set of observability
|
||||
plugins, enter the following command. The `--selector` flag installs the
|
||||
|
|
|
|||
Loading…
Reference in New Issue