Add classification for about 2/3rds of docs (func + eventing)

This commit is contained in:
Evan Anderson 2025-07-10 16:50:45 -07:00
parent 69206142bf
commit 51bc498ce1
123 changed files with 888 additions and 0 deletions

View File

@ -1,3 +1,12 @@
---
audience: contributor
components:
- eventing
- functions
- serving
function: community
---
# How to Get Involved
<!-- TODO: what is community, what are the touchpoints -->

View File

@ -1,3 +1,12 @@
---
audience: contributor
components:
- eventing
- functions
- serving
function: community
---
# Contribute to Knative
This is the starting point for becoming a contributor - improving code, improving docs, giving talks, etc.

View File

@ -1,3 +1,9 @@
---
audience: contributor
components: []
function: community
---
# Community Rules and Practices
This page provides links to documents for common Knative community practices and

View File

@ -1,3 +1,12 @@
---
audience: developer
components:
- eventing
- functions
- serving
function: explanation
---
# Concepts
The documentation in this section explains commonly referenced Knative concepts and abstractions, and helps to provide you with a better understanding of how Knative works.

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
- serving
function: explanation
---
# Duck typing
Knative enables [loose coupling](https://en.wikipedia.org/wiki/Loose_coupling) of its components by using [duck typing](https://en.wikipedia.org/wiki/Duck_typing).

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Brokers
--8<-- "about-brokers.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- serving
function: explanation
---
# Revisions
--8<-- "about-revisions.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Knative Eventing - The Event-driven application platform for Kubernetes
--8<-- "about-eventing.md"

View File

@ -1,3 +1,11 @@
---
audience: administrator
# And audience: developer for accessing traces
components:
- eventing
function: how-to
---
# Accessing CloudEvent traces
Depending on the request tracing tool that you have installed on your Knative

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# About Brokers
--8<-- "about-brokers.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Developer configuration options
## Broker configuration

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Available Broker types
The following broker types are available for use with Knative Eventing.

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Channel based Broker
The Channel based Broker (`MTChannelBasedBroker`) uses [Channels](../../../channels) for event routing. It is shipped by default with Knative Eventing.

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Knative Broker for Apache Kafka
The Knative Broker for Apache Kafka is an implementation of the Knative Broker API natively targeting Apache Kafka to reduce network hops and offering a better integration with Apache Kafka for the Broker and Trigger API model.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configuring Kafka Features
There are many different configuration options for how Knative Eventing and the Knaitve Broker for Apache Kafka interact with the Apache Kafka clusters.

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: explanation
---
# Creating a RabbitMQ Broker
This topic describes how to create a RabbitMQ Broker.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Creating a Broker
Once you have installed Knative Eventing and a Broker implementation, you can create an instance of a Broker.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Channels
Channels are Kubernetes [custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that define a single event forwarding and persistence layer.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Channel types and defaults
Knative uses two types of Channels:

View File

@ -1,3 +1,9 @@
---
audience: developer
components:
- eventing
function: reference
---
<!--
This is a generated file and should not be changed manually. All changes should follow the
procedure:

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Creating a Channel using cluster or namespace defaults
Developers can create Channels of any supported implementation type by creating an instance of a

View File

@ -1,3 +1,9 @@
---
audience: developer
components:
- eventing
function: reference
---
{{ "" }}
{{- /* This will be interpreted given a yamlChannels object. */ -}}

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Subscriptions
After you have created a Channel and a Sink, you can create a Subscription to enable event delivery.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure Broker defaults
If you have cluster administrator permissions for your Knative installation, you can modify ConfigMaps to change the global default configuration options for Brokers on the cluster.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure Channel defaults
Knative Eventing provides a `default-ch-webhook` ConfigMap that contains the configuration settings that govern default Channel creation.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure Channels for Apache Kafka
!!! note

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure KEDA Autoscaling of Knative Kafka Resources
All of the Knative Kafka components which dispatch events (source, channel broker) support scaling the dispatcher data plane with KEDA.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure event source defaults
This topic describes how to configure defaults for Knative event sources. You can configure event sources depending on how they generate events.

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Configure Sugar Controller
This topic describes how to configure the Sugar Controller. You can configure the Sugar controller to create a Broker when a Namespace or Trigger is created with configured labels. See [Knative Eventing Sugar Controller](../sugar/README.md) for an example.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Custom event sources
If you need to ingress events from an event producer that is not included in Knative, or from a producer that emits events which are not in the CloudEvent format that is used by Knative, you can do this by using one of the following methods:

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Create a ContainerSource
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# ContainerSource reference
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Create a custom event source
If you want to create a custom event source for a specific event producer type, you must create the components that enable forwarding events from that producer type to a Knative sink.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: tutorial
---
# Create a controller
You can use the sample repository [`update-codegen.sh`](https://github.com/knative-extensions/sample-source/blob/main/hack/update-codegen.sh) script to generate and inject the required components (the `clientset`, `cache`, `informers`, and `listers`) into your custom controller.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: tutorial
---
# Publish an event source to your cluster
1. Start a minikube cluster:

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: tutorial
---
# Create a receive adapter
As part of the source reconciliation process, you must create and deploy the underlying receive adapter.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: tutorial
---
# Using the Knative sample repository
The Knative project provides a [sample repository](https://github.com/knative-extensions/sample-source) that contains a template for a basic event source controller and a receive adapter.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# SinkBinding
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Create a SinkBinding
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# SinkBinding reference
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Handling Delivery Failure
You can configure event delivery parameters for Knative Eventing components that are applied in cases where an event fails to be delivered

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Event Mesh
An Event Mesh is dynamic, interconnected infrastructure which is designed to simplify distributing events from senders to recipients. Similar to traditional message-channel architectures like Apache Kafka or RabbitMQ, an Event Mesh provides asynchronous (store-and-forward) delivery of messages which allows decoupling senders and recipients in time. Unlike traditional message-channel based integration patterns, Event Meshes also simplify the routing concerns of senders and recipients by decoupling them from the underlying event transport infrastructure (which may be a federated set of solutions like Kafka, RabbitMQ, or cloud provider infrastructure). The mesh transports events from producers to consumers via a network of interconnected _event brokers_ across any environment, and even between clouds in a seamless and loosely coupled way.

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
function: explanation
# And function: how-to
---
# Event registry
Knative Eventing defines an `EventType` object to make it easier for consumers to discover the types of events they can consume from Brokers or Channels.

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Knative Event Mesh Backstage Plugin
!!! info

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Eventing FAQs
## What is a Sugar Controller?

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Eventing Features
To keep Knative innovative, the maintainers of this project have developed an

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Knative Eventing Authorization
**Tracking issue**: [#7256](https://github.com/knative/eventing/issues/7256)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Cross Namespace Event Links
**Flag name**: `cross-namespace-event-links`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# DeliverySpec.RetryAfterMax field
**Flag name**: `delivery-retryafter`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# DeliverySpec.Timeout field
**Flag name**: `delivery-timeout`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# EventType auto creation for improved discoverability
**Flag name**: `eventtype-auto-create`

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Eventing integration with Istio service mesh
**Flag name**: `istio`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# KReference.Group field
**Flag name**: `kreference-group`

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Knative reference mapping
**Flag name**: `kreference-mapping`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# New trigger filters
**Flag name**: `new-apiserversource-filters`

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Sender Identity for Knative Eventing
**Flag name**: `authentication-oidc`

View File

@ -1,3 +1,10 @@
---
audience: administrator
components:
- eventing
function: how-to
---
# Transport Encryption for Knative Eventing
**Flag name**: `transport-encryption`

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Eventing Flows
Knative Eventing provides a collection of [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that you can use to define event flows:

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Parallel
Parallel CRD provides a way to easily define a list of branches, each receiving

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Sequence
Sequence CRD provides a way to define an in-order list of functions that will be

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
- serving
function: how-to
---
# Sequence wired to event-display
We are going to create the following logical configuration. We create a

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
- serving
function: how-to
---
# Sequence wired to another Sequence
We are going to create the following logical configuration. We create a

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
- serving
function: how-to
---
# Sequence terminal
We are going to create the following logical configuration. We create a

View File

@ -1,3 +1,11 @@
---
audience: developer
components:
- eventing
- serving
function: how-to
---
# Using Sequence with Broker and Trigger
We are going to create the following logical configuration. We create a

View File

@ -1 +1,8 @@
---
audience: administrator
components:
- eventing
function: how-to
---
--8<-- "collecting-logs.md"

View File

@ -1 +1,8 @@
---
audience: administrator
components:
- eventing
function: how-to
---
--8<-- "configuring-logs.md"

View File

@ -1 +1,8 @@
---
audience: administrator
components:
- eventing
function: how-to
---
--8<-- "collecting-metrics.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Knative Eventing metrics
Administrators can view metrics for Knative Eventing components.

View File

@ -1 +1,8 @@
---
audience: developer
components:
- eventing
function: reference
---
This file is updated to the correct version from the eventing repo (docs/eventing-api.md) during the build.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# About sinks
When you create an event source, you can specify a _sink_ where events are sent to from the source. A sink is an _Addressable_ or a _Callable_ resource that can receive incoming events from other resources. Knative Services, Channels, and Brokers are all examples of sinks.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Knative Sink for Apache Camel Kamelet integrations
![stage](https://img.shields.io/badge/Stage-alpah-red?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS S3 Sink
The `IntegrationSink` supports the Amazon Web Services (AWS) S3 service, through its `aws.s3` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS Simple Notification Service Sink
The `IntegrationSink` supports the Amazon Web Services (AWS) Simple Notification Service (SNS) service, through its `aws.sns` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS Simple Queue Service Sink
The `IntegrationSink` supports the Amazon Web Services (AWS) Simple Queue Service (SQS) service, through its `aws.sqs` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Log Sink
The `IntegrationSink` supports the _Log Sink Kamelet_ that logs all data that it receives, through its `log` property. This sink useful for debugging purposes.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# JobSink, triggering long-running background jobs when events occurs
Usually event processing combined with a Knative Service is expected to complete in a relative short

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Knative Sink for Apache Kafka
The `KafkaSink` is an Apache Kafka-native [Sink implementation](https://knative.dev/docs/eventing/sinks/) persisting the incoming CloudEvent to a configurable Apache Kafka Topic. This page shows how to install and configure the Knative `KafkaSink`.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# Event sources
An event source is a Kubernetes custom resource (CR), created by a developer or cluster administrator, that acts as a link between an event producer and an event _sink_.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# About ApiServerSource
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how to
---
# Creating an ApiServerSource object
![version](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# ApiServerSource reference
![version](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# Knative Source for Apache Camel Kamelet integrations
![stage](https://img.shields.io/badge/Stage-alpah-red?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS DynamoDB Streams
The `IntegrationSource` supports the Amazon Web Services (AWS) DynamoDB Streams service, through its `aws.ddbStreams` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS S3 Source
The `IntegrationSource` supports the Amazon Web Services (AWS) S3 service, through its `aws.s3` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# AWS Simple Queue Service Source
The `IntegrationSource` supports the Amazon Web Services (AWS) Simple Queue Service (SQS) service, through its `aws.sqs` property.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Timer Source
The `IntegrationSource` supports the _Timer Kamelet_ for producing periodic messages with a custom payload, through its `timer` property.

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Knative Source for Apache Kafka
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Creating a PingSource object
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: reference
---
# PingSource reference
![API version v1](https://img.shields.io/badge/API_Version-v1-green?style=flat-square)

View File

@ -1,3 +1,11 @@
---
audience: developer
# And audience: administrator for install
components:
- eventing
function: how-to
---
# Creating a RabbitMQSource
![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: explanation
---
# About RedisStreamSource
![stage](https://img.shields.io/badge/Stage-alpha-green?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Creating a RedisStreamSource
![version](https://img.shields.io/badge/API_Version-v1alpha1-red?style=flat-square)

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Knative Eventing Sugar Controller
Knative Eventing Sugar Controller will react to configured labels

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Event Transformation
## Overview

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Event Transformations for JSON with JSONata
## Introduction to JSONata

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Using Triggers
A trigger represents a desire to subscribe to events from a specific broker.

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- eventing
function: how-to
---
# Debugging Knative Eventing
This is an evolving document on how to debug a non-working Knative Eventing

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- functions
function: explanation
---
# Knative Functions overview
--8<-- "about-functions.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- functions
function: how-to
---
# Building functions
--8<-- "build-func-intro.md"

View File

@ -1,3 +1,10 @@
---
audience: developer
components:
- functions
function: how-to
---
# Creating functions
--8<-- "create-a-function.md"

Some files were not shown because too many files have changed in this diff Show More