mirror of https://github.com/knative/docs.git
Fix rendering issues due to nested shortcodes (#1596)
* Community - move frontmatter into README * Serving - move frontmatter into README * swap readfile calls from README.md to index.md * Eventing - move frontmatter into README
This commit is contained in:
parent
353f6fe300
commit
9a92f43ca2
|
@ -5,4 +5,5 @@ weight: 40
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
||||
|
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Clojure"
|
||||
linkTitle: "Clojure"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Clojure that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Clojure"
|
||||
linkTitle: "Clojure"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Dart"
|
||||
linkTitle: "Dart"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in the [Dart](www.dartlang.org) programming language
|
||||
that you can use for testing. It reads in the env variable `TARGET` and prints
|
||||
`"Hello $TARGET"`. If `TARGET` is not specified, it will use `"World"` as
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Dart"
|
||||
linkTitle: "Dart"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Elixir"
|
||||
linkTitle: "Elixir"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web application written in [Elixir](https://elixir-lang.org/) using the
|
||||
[Phoenix Framework](https://phoenixframework.org/). The application prints all
|
||||
environment variables to the main page.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Elixir"
|
||||
linkTitle: "Elixir"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Haskell"
|
||||
linkTitle: "Haskell"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Haskell that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Haskell"
|
||||
linkTitle: "Haskell"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Java (Micronaut)"
|
||||
linkTitle: "Java (Micronaut)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
Learn how to deploy a simple web app that is written in Java and uses Micronaut.
|
||||
|
||||
This samples uses Docker to build locally. The app reads in a `TARGET` env
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Java (Micronaut)"
|
||||
linkTitle: "Java (Micronaut)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Java (Quarkus)"
|
||||
linkTitle: "Java (Quarkus)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple [JAX-RS REST API](https://github.com/jax-rs) application that is
|
||||
written in Java and uses [Quarkus](https://quarkus.io/).
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Java (Quarkus)"
|
||||
linkTitle: "Java (Quarkus)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Rust"
|
||||
linkTitle: "Rust"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Rust that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Rust"
|
||||
linkTitle: "Rust"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Swift"
|
||||
linkTitle: "Swift"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Swift that you can use for testing. The app reads in
|
||||
an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, the app uses "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Swift"
|
||||
linkTitle: "Swift"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Eclipse Vert.x"
|
||||
linkTitle: "Eclipse Vert.x"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
Learn how to deploy a simple web app that is written in Java and uses Eclipse
|
||||
Vert.x. This samples uses Docker to build locally. The app reads in a `TARGET`
|
||||
env variable and then prints "Hello World: \${TARGET}!". If a value for `TARGET`
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Eclipse Vert.x"
|
||||
linkTitle: "Eclipse Vert.x"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -5,4 +5,4 @@ weight: 10
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 20
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 60
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Knative Eventing channels"
|
||||
linkTitle: "Eventing channels"
|
||||
weight: 40
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
<!--
|
||||
This is a generated file and should not be changed manually. All changes should follow the
|
||||
procedure:
|
||||
|
@ -10,24 +17,26 @@ procedure:
|
|||
```
|
||||
-->
|
||||
|
||||
Channels are Kubernetes Custom Resources which define a single event forwarding
|
||||
and persistence layer. Messaging implementations may provide implementations of
|
||||
Channels via the
|
||||
Channels are Kubernetes Custom Resources which define a single event forwarding and persistence layer.
|
||||
Messaging implementations may provide implementations of Channels via the
|
||||
[ClusterChannelProvisioner](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/cluster_channel_provisioner_types.go#L35)
|
||||
object, supporting different technologies, such as Apache Kafka or NATS
|
||||
Streaming.
|
||||
object, supporting different technologies, such as Apache Kafka or NATS Streaming.
|
||||
|
||||
This is a non-exhaustive list of Channels for Knative.
|
||||
|
||||
|
||||
### Inclusion in this list is not an endorsement, nor does it imply any level of support.
|
||||
|
||||
|
||||
## Channels
|
||||
|
||||
These are the channels `CRD`s.
|
||||
|
||||
| Name | Status | Support | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Apache Kafka](https://github.com/knative/eventing/tree/master/contrib/kafka/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. |
|
||||
| [GCP PubSub](https://github.com/knative/eventing/tree/master/contrib/gcppubsub/config) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). |
|
||||
| [In-Memory](https://github.com/knative/eventing/tree/master/config/provisioners/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. |
|
||||
| [Natss](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). |
|
||||
Name | Status | Support | Description
|
||||
--- | --- | --- | ---
|
||||
[Apache Kafka](https://github.com/knative/eventing/tree/master/contrib/kafka/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics.
|
||||
[GCP PubSub](https://github.com/knative/eventing/tree/master/contrib/gcppubsub/config) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/).
|
||||
[In-Memory](https://github.com/knative/eventing/tree/master/config/provisioners/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.
|
||||
[Natss](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).
|
||||
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Knative Eventing channels"
|
||||
linkTitle: "Eventing channels"
|
||||
weight: 40
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,12 @@
|
|||
---
|
||||
title: "Knative Eventing channels"
|
||||
linkTitle: "Eventing channels"
|
||||
weight: 40
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{ "" }}
|
||||
|
||||
{{- /* This will be interpreted given a yamlChannels object. */ -}}
|
||||
|
||||
{{- /* Ignore this next paragraph, it is only intended in the generated markdown, not here. */ -}}
|
||||
|
|
|
@ -30,7 +30,7 @@ import (
|
|||
var (
|
||||
yamlFile = flag.String("yaml", "eventing/channels/channels.yaml", "The YAML file to parse to generate the mark down.")
|
||||
templateFile = flag.String("template", "eventing/channels/generator/ReadmeTemplate.gomd", "The template file to fill in.")
|
||||
mdFile = flag.String("md", "eventing/channels/", "The mark down file to write to. Any existing file will be overwritten.")
|
||||
mdFile = flag.String("md", "eventing/channels/README.md", "The mark down file to write to. Any existing file will be overwritten.")
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Debugging Knative Eventing"
|
||||
linkTitle: "Debugging"
|
||||
weight: 100
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This is an evolving document on how to debug a non-working Knative Eventing
|
||||
setup.
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Debugging Knative Eventing"
|
||||
linkTitle: "Debugging"
|
||||
weight: 100
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Apache Camel source"
|
||||
linkTitle: "Camel source"
|
||||
weight: 5
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
These samples show how to configure a Camel Source. It is an Event Source that
|
||||
can leverage one of the
|
||||
[250+ Apache Camel components](https://github.com/apache/camel/tree/master/components)
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Apache Camel source"
|
||||
linkTitle: "Camel source"
|
||||
weight: 5
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Container Source Example"
|
||||
linkTitle: "Container source"
|
||||
weight: 10
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
ContainerSource will start a container image which will generate events under
|
||||
certain situations and send messages to a sink URI. It also can be an easy way
|
||||
to support your own event sources in Knative. This guide shows how to configure
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Container Source Example"
|
||||
linkTitle: "Container source"
|
||||
weight: 10
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Cron job source example"
|
||||
linkTitle: "Cron job source"
|
||||
weight: 10
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
Cron Job Source example shows how to configure Cron Job as event source for
|
||||
functions.
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Cron job source example"
|
||||
linkTitle: "Cron job source"
|
||||
weight: 10
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "GCP Cloud Pub/Sub source"
|
||||
linkTitle: "Pub/Sub source"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This sample shows how to configure the GCP PubSub event source. This event
|
||||
source is most useful as a bridge from other GCP services, such as
|
||||
[Cloud Storage](https://cloud.google.com/storage/docs/pubsub-notifications),
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "GCP Cloud Pub/Sub source"
|
||||
linkTitle: "Pub/Sub source"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: "GitHub source"
|
||||
linkTitle: "GitHub source"
|
||||
weight: 30
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
GitHub Source example shows how to wire GitHub events for consumption
|
||||
by a Knative Service.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "GitHub source"
|
||||
linkTitle: "GitHub source"
|
||||
weight: 30
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Binding running services to an IoT core"
|
||||
linkTitle: "IoT core"
|
||||
weight: 40
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This sample shows how to bind a running service to an
|
||||
[IoT core](https://cloud.google.com/iot-core/) using
|
||||
[GCP PubSub](https://cloud.google.com/pubsub/) as the event source. With minor
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Binding running services to an IoT core"
|
||||
linkTitle: "IoT core"
|
||||
weight: 40
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Kubernetes Api Server Source"
|
||||
linkTitle: "Kubernetes event"
|
||||
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
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Kubernetes Api Server Source"
|
||||
linkTitle: "Kubernetes event"
|
||||
weight: 50
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,4 +1,9 @@
|
|||
## Overview
|
||||
---
|
||||
title: "Sequence wired to event-display"
|
||||
linkTitle: "Displaying sequence output"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
||||
CronJobSource, feeding events to a [`Sequence`](../../../sequence.md), then
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Sequence wired to event-display"
|
||||
linkTitle: "Displaying sequence output"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,4 +1,9 @@
|
|||
## Overview
|
||||
---
|
||||
title: "Sequence wired to another Sequence"
|
||||
linkTitle: "Using Sequences in series"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
||||
CronJobSource, feeding events to a [`Sequence`](../../../sequence.md), then
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Sequence wired to another Sequence"
|
||||
linkTitle: "Using Sequences in series"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,4 +1,9 @@
|
|||
## Overview
|
||||
---
|
||||
title: "Sequence terminal"
|
||||
linkTitle: "Create additional events"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
||||
CronJobSource, feeding events to a [`Sequence`](../../../sequence.md). Sequence
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Sequence terminal"
|
||||
linkTitle: "Create additional events"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,4 +1,9 @@
|
|||
## Overview
|
||||
---
|
||||
title: "Using Sequence with Broker and Trigger"
|
||||
linkTitle: "Using with Broker and Trigger"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
We are going to create the following logical configuration. We create a
|
||||
CronJobSource, feeding events into the Broker, then we create a `Filter` that
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Using Sequence with Broker and Trigger"
|
||||
linkTitle: "Using with Broker and Trigger"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -5,4 +5,4 @@ weight: 60
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Knative Eventing sources"
|
||||
linkTitle: "Eventing sources"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
<!--
|
||||
This is a generated file and should not be changed manually. All changes should follow the
|
||||
procedure:
|
||||
|
@ -10,11 +17,10 @@ procedure:
|
|||
```
|
||||
-->
|
||||
|
||||
Event Sources are Kubernetes Custom Resources which provide a mechanism for
|
||||
registering interest in a class of events from a particular software system.
|
||||
Since different event sources may be described by different Custom Resources,
|
||||
this page provides an index of the available source resource types as well as
|
||||
links to installation instructions.
|
||||
Event Sources are Kubernetes Custom Resources which provide a mechanism for registering interest in
|
||||
a class of events from a particular software system. Since different event sources may be described
|
||||
by different Custom Resources, this page provides an index of the available source resource types as
|
||||
well as links to installation instructions.
|
||||
|
||||
This is a non-exhaustive list of Event sources for Knative.
|
||||
|
||||
|
@ -42,11 +48,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/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
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Knative Eventing sources"
|
||||
linkTitle: "Eventing sources"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,12 @@
|
|||
---
|
||||
title: "Knative Eventing sources"
|
||||
linkTitle: "Eventing sources"
|
||||
weight: 20
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{ "" }}
|
||||
|
||||
{{- /* This will be interpreted given a yamlSources object. */ -}}
|
||||
|
||||
{{- /* Ignore this next paragraph, it is only intended in the generated markdown, not here. */ -}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 05
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 20
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="build.md" relative="true" %}}
|
||||
{{< readfile file="build.md" relative="true" >}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 30
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="eventing.md" relative="true" %}}
|
||||
{{< readfile file="eventing.md" relative="true" >}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 50
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="eventing-contrib-resources.md" relative="true" %}}
|
||||
{{< readfile file="eventing-contrib-resources.md" relative="true" >}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 50
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="serving.md" relative="true" %}}
|
||||
{{< readfile file="serving.md" relative="true" >}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 20
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -5,4 +5,4 @@ weight: 100
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||
{{% readfile file="index.md" relative="true" markdown="true" %}}
|
||||
|
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Autoscale Sample App - Go"
|
||||
linkTitle: "Autoscaling - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A demonstration of the autoscaling capabilities of a Knative Serving Revision.
|
||||
|
||||
## Prerequisites
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Autoscale Sample App - Go"
|
||||
linkTitle: "Autoscaling - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "GitHub webhook sample - Go"
|
||||
linkTitle: "GitHub Webhook - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A handler written in Go that demonstrates interacting with GitHub through a
|
||||
webhook.
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "GitHub webhook sample - Go"
|
||||
linkTitle: "GitHub Webhook - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "gRPC server - Go"
|
||||
#linkTitle: ""
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple gRPC server written in Go that you can use for testing.
|
||||
|
||||
## Prerequisites
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "gRPC server - Go"
|
||||
#linkTitle: ""
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello world - .NET Core"
|
||||
linkTitle: ".NET"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in C# using .NET Core 2.2 that you can use for testing.
|
||||
It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET
|
||||
is not specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello world - .NET Core"
|
||||
linkTitle: ".NET"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Go"
|
||||
linkTitle: "Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Go that you can use for testing. It reads in an env
|
||||
variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified,
|
||||
it will use `World` as the `TARGET`.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Go"
|
||||
linkTitle: "Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Spark Java Framework"
|
||||
linkTitle: "Java (Spark)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Java using Spark Java Framework that you can use for
|
||||
testing.
|
||||
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Spark Java Framework"
|
||||
linkTitle: "Java (Spark)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Spring Boot Java"
|
||||
linkTitle: "Java (Spring)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Java using Spring Boot 2.0 that you can use for
|
||||
testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If
|
||||
TARGET is not specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Spring Boot Java"
|
||||
linkTitle: "Java (Spring)"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Kotlin"
|
||||
linkTitle: "Kotlin"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Kotlin using [Ktor](https://ktor.io/) that you can
|
||||
use for testing. It reads in an env variable `TARGET` and prints "Hello
|
||||
\${TARGET}". If TARGET is not specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Kotlin"
|
||||
linkTitle: "Kotlin"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Node.js"
|
||||
linkTitle: "Node.js"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Node.js that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Node.js"
|
||||
linkTitle: "Node.js"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - PHP"
|
||||
linkTitle: "PHP"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Go that you can use for testing. It reads in an env
|
||||
variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified,
|
||||
it will use `World` as the `TARGET`.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - PHP"
|
||||
linkTitle: "PHP"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Python"
|
||||
linkTitle: "Python"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Python that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Python"
|
||||
linkTitle: "Python"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Ruby"
|
||||
linkTitle: "Ruby"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Ruby that you can use for testing. It reads in an
|
||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||
specified, it will use "World" as the TARGET.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Ruby"
|
||||
linkTitle: "Ruby"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Scala using Akka HTTP"
|
||||
linkTitle: "Scala"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A microservice which demonstrates how to get set up and running with Knative
|
||||
Serving when using [Scala](https://scala-lang.org/) and [Akka](https://akka.io/)
|
||||
[HTTP](https://doc.akka.io/docs/akka-http/current/). It will respond to a HTTP
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Scala using Akka HTTP"
|
||||
linkTitle: "Scala"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Hello World - Shell"
|
||||
linkTitle: "Shell"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app that executes a shell script. The shell script reads an env
|
||||
variable `TARGET` and prints `Hello ${TARGET}!`. If the `TARGET` environment
|
||||
variable is not specified, the script uses `World`.
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Hello World - Shell"
|
||||
linkTitle: "Shell"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,32 +0,0 @@
|
|||
# Copyright 2018 The Knative Authors
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
apiVersion: serving.knative.dev/v1alpha1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: stock-service-example
|
||||
namespace: default
|
||||
spec:
|
||||
template:
|
||||
spec:
|
||||
containers:
|
||||
- image: ${REPO}/rest-api-go
|
||||
env:
|
||||
- name: RESOURCE
|
||||
value: stock
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
initialDelaySeconds: 0
|
||||
periodSeconds: 3
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
# Copyright 2019 The Knative Authors
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
apiVersion: serving.knative.dev/v1alpha1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: stock-service-example
|
||||
namespace: default
|
||||
spec:
|
||||
release:
|
||||
revisions: ["${CURRENT}"]
|
||||
configuration:
|
||||
revisionTemplate:
|
||||
spec:
|
||||
container:
|
||||
image: ${REPO}/rest-api-go
|
||||
env:
|
||||
- name: RESOURCE
|
||||
value: stock
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
initialDelaySeconds: 0
|
||||
periodSeconds: 3
|
|
@ -1,36 +0,0 @@
|
|||
# Copyright 2019 The Knative Authors
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
apiVersion: serving.knative.dev/v1alpha1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: stock-service-example
|
||||
namespace: default
|
||||
spec:
|
||||
release:
|
||||
revisions: [ "${CURRENT}", "${CANDIDATE}"]
|
||||
rolloutPercent: 50
|
||||
configuration:
|
||||
revisionTemplate:
|
||||
spec:
|
||||
container:
|
||||
image: ${REPO}/rest-api-go
|
||||
env:
|
||||
- name: RESOURCE
|
||||
value: share
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
initialDelaySeconds: 0
|
||||
periodSeconds: 3
|
|
@ -1,35 +0,0 @@
|
|||
# Copyright 2019 The Knative Authors
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
apiVersion: serving.knative.dev/v1alpha1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: stock-service-example
|
||||
namespace: default
|
||||
spec:
|
||||
release:
|
||||
revisions: ["${CURRENT}"]
|
||||
configuration:
|
||||
revisionTemplate:
|
||||
spec:
|
||||
container:
|
||||
image: ${REPO}/rest-api-go
|
||||
env:
|
||||
- name: RESOURCE
|
||||
value: share
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /
|
||||
initialDelaySeconds: 0
|
||||
periodSeconds: 3
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Routing across multiple Knative services - Go"
|
||||
linkTitle: "Routing services - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This example shows how to map multiple Knative services to different paths under
|
||||
a single domain name using the Istio VirtualService concept. Istio is a
|
||||
general-purpose reverse proxy, therefore these directions can also be used to
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Routing across multiple Knative services - Go"
|
||||
linkTitle: "Routing services - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Creating a RESTful Service - Go"
|
||||
linkTitle: "RESTful service - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This "stock ticker" sample demonstrates how to create and run a simple RESTful
|
||||
service on Knative Serving. The exposed endpoint outputs the stock price for a
|
||||
given "[stock symbol](https://www.marketwatch.com/tools/quotes/lookup.asp)",
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Creating a RESTful Service - Go"
|
||||
linkTitle: "RESTful service - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Knative Secrets - Go"
|
||||
linkTitle: "Secrets - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
A simple web app written in Go that you can use for testing. It demonstrates how
|
||||
to use a Kubernetes secret as a Volume with Knative. We will create a new Google
|
||||
Service Account and place it into a Kubernetes secret, then we will mount it
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
title: "Knative Secrets - Go"
|
||||
linkTitle: "Secrets - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
title: "Observability: Monitoring, logging, and tracing sample - Go"
|
||||
linkTitle: "Observability - Go"
|
||||
weight: 1
|
||||
type: "docs"
|
||||
---
|
||||
|
||||
This sample runs a simple web server that makes calls to other in-cluster
|
||||
services and responds to requests with "Hello World!". The purpose of this
|
||||
sample is to show generating [metrics](../../accessing-metrics.md),
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue