diff --git a/docs/eventing/README.md b/docs/eventing/README.md index 6bd9b00f67b..eb3516dccb6 100644 --- a/docs/eventing/README.md +++ b/docs/eventing/README.md @@ -307,7 +307,7 @@ Knative Serving application so that they can be consumed. certificate. See the -[Kafka Source](https://github.com/knative/eventing-contrib/tree/master/kafka/source) +[Kafka Source](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/source) example. ### CamelSource @@ -337,7 +337,7 @@ to be installed into the current namespace. development purposes. See the -[CamelSource](https://github.com/knative/eventing-contrib/tree/master/camel/source/samples) +[CamelSource](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/camel/source/samples) example. ## Getting Started diff --git a/docs/eventing/broker-trigger.md b/docs/eventing/broker-trigger.md index ccaba49ece6..e2c3cc7c7a3 100644 --- a/docs/eventing/broker-trigger.md +++ b/docs/eventing/broker-trigger.md @@ -90,7 +90,7 @@ to that `Broker`. If `spec.channelTemplateSpec` is not specified, then the Have a `Channel` CRD installed and set as the default channel for the namespace you are interested in. For development, the -[InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel) +[InMemoryChannel](https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel) is normally used. #### Changing diff --git a/docs/eventing/channels/channels-crds.md b/docs/eventing/channels/channels-crds.md index 4f384e8cbe5..04fdbddd1a9 100644 --- a/docs/eventing/channels/channels-crds.md +++ b/docs/eventing/channels/channels-crds.md @@ -27,8 +27,8 @@ Notes: Name | Status | Support | Description --- | --- | --- | --- [GCP PubSub](https://github.com/google/knative-gcp) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). -[InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. -[KafkaChannel](https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. -[NatssChannel](https://github.com/knative/eventing/tree/master/contrib/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). +[InMemoryChannel](https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. +[KafkaChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. +[NatssChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). diff --git a/docs/eventing/channels/channels.yaml b/docs/eventing/channels/channels.yaml index 4a2de1d3017..bf92ac50435 100644 --- a/docs/eventing/channels/channels.yaml +++ b/docs/eventing/channels/channels.yaml @@ -1,19 +1,19 @@ # List of available Channel implementation for persistence of the events associated with a given channel channels: - name: InMemoryChannel - url: https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel + url: https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel status: Proof of Concept support: None description: > In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. - name: KafkaChannel - url: https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/config status: Proof of Concept support: None description: > Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. - name: NatssChannel - url: https://github.com/knative/eventing/tree/master/contrib/natss/config + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config status: Proof of Concept support: None description: > diff --git a/docs/eventing/debugging/README.md b/docs/eventing/debugging/README.md index 50f3e606040..9faa6263ffc 100644 --- a/docs/eventing/debugging/README.md +++ b/docs/eventing/debugging/README.md @@ -144,7 +144,7 @@ This should return a single Pod, which if you inspect is the one generated by ##### `chan` `chan` uses the -[`in-memory-channel`]( https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel). +[`in-memory-channel`]( https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel). This is a very basic channel and has few failure modes that will be exhibited in `chan`'s `status`. diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index a9e589aa9c6..f064a34688d 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -258,7 +258,7 @@ the next topic: How do we actually populate the registry in the first place? If you are interested in more information regarding configuration options of a KafkaSource, please refer to the - [KafKaSource example](https://github.com/knative/eventing-contrib/tree/master/kafka/source/samples). + [KafKaSource example](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/source/samples). For this discussion, the relevant information from the yaml above are the `sink` and the `topics`. We observe that the `sink` is of kind `Broker`. We diff --git a/docs/eventing/getting-started.md b/docs/eventing/getting-started.md index 8529b9c8001..8de735b2e3d 100644 --- a/docs/eventing/getting-started.md +++ b/docs/eventing/getting-started.md @@ -34,7 +34,7 @@ If the `knative-eventing` namespace or the `imc-controller-*` does not exist, us 1. Make sure that you have a functioning Kubernetes cluster. See the [Comprehensive Install guide](../install) for more information. - Old versions of Knative Serving doesn't necessarily work well with latest Knative Eventing, so try to install the latest version of Knative Serving. - - If your Kubernetes cluster comes with pre-installed Istio, make sure it has `cluster-local-gateway` [deployed](https://github.com/knative/serving/blob/master/DEVELOPMENT.md#deploy-istio). Depending on which Istio version you have, you'd need to apply the `istio-knative-extras.yaml` in the corresponding version folder at [here](https://github.com/knative/serving/tree/master/third_party). + - If your Kubernetes cluster comes with pre-installed Istio, make sure it has `cluster-local-gateway` [deployed](https://github.com/knative/serving/blob/master/DEVELOPMENT.md#deploy-istio). Depending on which Istio version you have, you'd need to apply the `istio-knative-extras.yaml` in the corresponding version folder at [here](https://github.com/knative/serving/tree/{{< branch >}}/third_party). 2. Install the Eventing CRDs by running the following command: ```sh diff --git a/docs/eventing/samples/container-source/README.md b/docs/eventing/samples/container-source/README.md index 95115f94d83..75ba10d9f82 100644 --- a/docs/eventing/samples/container-source/README.md +++ b/docs/eventing/samples/container-source/README.md @@ -175,6 +175,5 @@ event source is a sample for your reference. When the container image is ready, a YAML file will be used to create a concrete ContainerSource. Use [heartbeats-source.yaml](./heartbeats-source.yaml) as a -sample for reference. You can get more details about ContainerSource -specification -[here](https://github.com/knative/docs/tree/master/docs/eventing#containersource). +sample for reference. [Learn more about the ContainerSource +specification](../../../eventing#containersource). diff --git a/docs/eventing/samples/kubernetes-event-source/README.md b/docs/eventing/samples/kubernetes-event-source/README.md index f6924601bf7..34184228474 100644 --- a/docs/eventing/samples/kubernetes-event-source/README.md +++ b/docs/eventing/samples/kubernetes-event-source/README.md @@ -5,18 +5,22 @@ weight: 50 type: "docs" --- -Kubernetes Event Source example shows how to wire kubernetes cluster events for -consumption by a function that has been implemented as a Knative Service. The -code for the following files can be found in the -[/kubernetes-event-source/](https://github.com/knative/docs/tree/master/docs/eventing/samples/kubernetes-event-source) -directory. +Kubernetes Event Source example shows how to wire Kubernetes cluster events for +consumption by a function that has been implemented as a Knative Service. -## Deployment Steps +## Before you begin + +1. You must have a Knative cluster running both the Serving and Eventing components. + To learn how to install the required components, see [Installing Knative](../../../install). +1. You can follow the steps below to create new files, or you clone a copy from + the repo by running: -### Prerequisites + ```shell + git clone -b "release-0.9" https://github.com/knative/docs knative-docs + cd knative-docs/docs/eventing/samples/kubernetes-event-source + ``` -1. Setup [Knative Serving](../../../serving). -1. Setup [Knative Eventing](../../../eventing). +## Deployment Steps ### Broker diff --git a/docs/eventing/samples/writing-a-source/03-reconcile-sources.md b/docs/eventing/samples/writing-a-source/03-reconcile-sources.md index 9b2d45d0ba1..cdc8da6a187 100644 --- a/docs/eventing/samples/writing-a-source/03-reconcile-sources.md +++ b/docs/eventing/samples/writing-a-source/03-reconcile-sources.md @@ -114,9 +114,9 @@ string. _After completing this tutorial, consider replacing the code below with existing sink resolution helpers provided by Knative: `AddressableType` from -`[github.com/knative/pkg/apis/duck/v1alpha1](https://github.com/knative/pkg/tree/master/apis/duck/v1alpha1)` +`[github.com/knative/pkg/apis/duck/v1alpha1](https://github.com/knative/pkg/tree/{{< branch >}}/apis/duck/v1alpha1)` and `GetSinkURI` from -`[github.com/knative/eventing-contrib/pkg/controller/sinks](https://github.com/knative/eventing-contrib/tree/master/pkg/controller/sinks)`._ +`[github.com/knative/eventing-contrib/pkg/controller/sinks](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/pkg/controller/sinks)`._ ```go type addressableType struct { diff --git a/docs/eventing/sources/README.md b/docs/eventing/sources/README.md index 45f618188a3..6f073416681 100644 --- a/docs/eventing/sources/README.md +++ b/docs/eventing/sources/README.md @@ -36,7 +36,7 @@ Name | Status | Support | Description --- | --- | --- | --- [AWS SQS](https://github.com/knative/eventing-contrib/blob/master/contrib/awssqs/pkg/apis/sources/v1alpha1/aws_sqs_types.go) | Proof of Concept | None | Brings [AWS Simple Queue Service](https://aws.amazon.com/sqs/) messages into Knative. [Apache Camel](https://github.com/knative/eventing-contrib/blob/master/camel/source/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 CouchDB](https://github.com/knative/eventing-contrib/tree/master/couchdb) | Active Development | None | Brings [Apache CouchDB](https://couchdb.apache.org/) messages into Knative. +[Apache CouchDB](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/couchdb) | Active Development | None | Brings [Apache CouchDB](https://couchdb.apache.org/) messages into Knative. [Apache Kafka](https://github.com/knative/eventing-contrib/blob/master/kafka/source/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/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. @@ -75,7 +75,7 @@ Name | Status | Support | Description [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/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-contrib/tree/master/cmd/heartbeats) | Proof of Concept | None | Uses an in-memory timer to produce events at the specified interval. +[Heartbeats](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/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-contrib/tree/master/cmd/websocketsource) | Active Development | None | Opens a WebSocket to the specified source and packages each received message as a Knative event. +[WebSocket](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/cmd/websocketsource) | Active Development | None | Opens a WebSocket to the specified source and packages each received message as a Knative event. diff --git a/docs/eventing/sources/sources.yaml b/docs/eventing/sources/sources.yaml index 01031625daa..f44cb0c8934 100644 --- a/docs/eventing/sources/sources.yaml +++ b/docs/eventing/sources/sources.yaml @@ -99,7 +99,7 @@ sources: description: > Brings [Apache Kafka](https://kafka.apache.org/) messages into Knative. - name: Apache CouchDB - url: https://github.com/knative/eventing-contrib/tree/master/couchdb + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/couchdb status: Active Development support: None description: > @@ -108,13 +108,13 @@ sources: # These are containers intended to be used with ContainerSource, but are not CRDs. containers: - name: Heartbeats - url: https://github.com/knative/eventing-contrib/tree/master/cmd/heartbeats + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/cmd/heartbeats status: Proof of Concept support: None description: > Uses an in-memory timer to produce events at the specified interval. - name: WebSocket - url: https://github.com/knative/eventing-contrib/tree/master/cmd/websocketsource + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/cmd/websocketsource status: Active Development support: None description: > diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 5ff07f01195..d78bc0e4f14 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,4 +1,4 @@ -
See the Knative Eventing repo for the API.
+See the Knative Eventing repo for the API.
There is currently an API doc build tool issue that we hope to resolve soon.
diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 7af9145d6e1..55cf07ec4dc 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,4 +1,4 @@ -See the Knative Serving repo for the API.
+See the Knative Serving repo for the API.
There is currently an API doc build tool issue that we hope to resolve soon.
diff --git a/docs/serving/fluentd-requirements.md b/docs/serving/fluentd-requirements.md index 6e63a836eb7..fbaeb7d46bc 100644 --- a/docs/serving/fluentd-requirements.md +++ b/docs/serving/fluentd-requirements.md @@ -30,7 +30,7 @@ includes the desired output plugin. Two examples below: ### Send logs to Elasticsearch Operators can use -[k8s.gcr.io/fluentd-elasticsearch:v2.0.4](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/fluentd-elasticsearch/fluentd-es-image) +[k8s.gcr.io/fluentd-elasticsearch:v2.0.4](https://github.com/kubernetes/kubernetes/tree/{{< branch >}}/cluster/addons/fluentd-elasticsearch/fluentd-es-image) which includes [fluent-plugin-elasticsearch](https://github.com/uken/fluent-plugin-elasticsearch) that allows sending logs to a Elasticsearch service. @@ -38,7 +38,7 @@ that allows sending logs to a Elasticsearch service. ### Send logs to Stackdriver This sample [Dockerfile](./stackdriver/Dockerfile) is based on -[k8s.gcr.io/fluentd-elasticsearch:v2.0.4](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/fluentd-elasticsearch). +[k8s.gcr.io/fluentd-elasticsearch:v2.0.4](https://github.com/kubernetes/kubernetes/tree/{{< branch >}}/cluster/addons/fluentd-elasticsearch). It additionally adds one more plugin - [fluent-plugin-google-cloud](https://github.com/GoogleCloudPlatform/fluent-plugin-google-cloud) which allows sending logs to Stackdriver.