mirror of https://github.com/knative/docs.git
Reorg Serving and Eventing files (#4396)
* Move eventing and serving topics * Remove developer folder * Remove admin folder * Cleaning up
This commit is contained in:
parent
8088b06462
commit
96b59e500d
|
@ -67,21 +67,21 @@ nav:
|
||||||
# Serving - developer docs
|
# Serving - developer docs
|
||||||
- Developer Topics:
|
- Developer Topics:
|
||||||
- Services:
|
- Services:
|
||||||
- About Knative Services: developer/serving/services/README.md
|
- About Knative Services: serving/services/README.md
|
||||||
- Creating a Service: developer/serving/services/creating-services.md
|
- Creating a Service: serving/services/creating-services.md
|
||||||
- Service metrics: developer/serving/services/service-metrics.md
|
- Service metrics: serving/services/service-metrics.md
|
||||||
- Configuring private Services: developer/serving/services/private-services.md
|
- Configuring private Services: serving/services/private-services.md
|
||||||
- Configuring ingress class: developer/serving/services/ingress-class.md
|
- Configuring ingress class: serving/services/ingress-class.md
|
||||||
- Configuring certificate class: developer/serving/services/certificate-class.md
|
- Configuring certificate class: serving/services/certificate-class.md
|
||||||
- Configuring custom domains: developer/serving/services/custom-domains.md
|
- Configuring custom domains: serving/services/custom-domains.md
|
||||||
- Using a custom TLS certificate for DomainMapping: developer/serving/services/byo-certificate.md
|
- Using a custom TLS certificate for DomainMapping: serving/services/byo-certificate.md
|
||||||
# TODO: Add security section to docs?
|
# TODO: Add security section to docs?
|
||||||
- Configure resource requests and limits: developer/serving/services/configure-requests-limits-services.md
|
- Configure resource requests and limits: serving/services/configure-requests-limits-services.md
|
||||||
- HTTPS redirection: developer/serving/services/http-option.md
|
- HTTPS redirection: serving/services/http-option.md
|
||||||
- Traffic management: developer/serving/traffic-management.md
|
- Traffic management: serving/traffic-management.md
|
||||||
- Configuring gradual rollout of traffic to Revisions: developer/serving/rolling-out-latest-revision.md
|
- Configuring gradual rollout of traffic to Revisions: serving/rolling-out-latest-revision.md
|
||||||
- Tag resolution: developer/serving/tag-resolution.md
|
- Tag resolution: serving/tag-resolution.md
|
||||||
- Deploying from private registries: developer/serving/deploying-from-private-registry.md
|
- Deploying from private registries: serving/deploying-from-private-registry.md
|
||||||
- Load balancing:
|
- Load balancing:
|
||||||
- Overview: serving/load-balancing/README.md
|
- Overview: serving/load-balancing/README.md
|
||||||
- Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md
|
- Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md
|
||||||
|
@ -111,11 +111,11 @@ nav:
|
||||||
- Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md
|
- Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md
|
||||||
# Serving config
|
# Serving config
|
||||||
- Serving configuration:
|
- Serving configuration:
|
||||||
- Revision garbage collection: admin/serving/revision-gc.md
|
- Revision garbage collection: serving/configuration/revision-gc.md
|
||||||
- Configure Deployment resources: admin/serving/deployment.md
|
- Configure Deployment resources: serving/configuration/deployment.md
|
||||||
- Configuring gradual rollout of traffic to Revisions: admin/serving/rolling-out-latest-revision-configmap.md
|
- Configuring gradual rollout of traffic to Revisions: serving/configuration/rolling-out-latest-revision-configmap.md
|
||||||
- Feature and extension flags: admin/serving/feature-flags.md
|
- Feature and extension flags: serving/configuration/feature-flags.md
|
||||||
- Configure the Defaults ConfigMap: admin/serving/config-defaults.md
|
- Configure the Defaults ConfigMap: serving/configuration/config-defaults.md
|
||||||
# Serving - observability
|
# Serving - observability
|
||||||
- Observability:
|
- Observability:
|
||||||
- Collecting logs: serving/observability/logging/collecting-logs.md
|
- Collecting logs: serving/observability/logging/collecting-logs.md
|
||||||
|
@ -124,7 +124,7 @@ nav:
|
||||||
- Knative Serving metrics: serving/observability/metrics/serving-metrics.md
|
- Knative Serving metrics: serving/observability/metrics/serving-metrics.md
|
||||||
# Serving - troubleshooting
|
# Serving - troubleshooting
|
||||||
- Troubleshooting:
|
- Troubleshooting:
|
||||||
- Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md
|
- Debugging application issues: serving/troubleshooting/debugging-application-issues.md
|
||||||
###############################################################################
|
###############################################################################
|
||||||
# Eventing
|
# Eventing
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
@ -134,37 +134,37 @@ nav:
|
||||||
# Eventing - developer docs
|
# Eventing - developer docs
|
||||||
- Developer topics:
|
- Developer topics:
|
||||||
- Event sources:
|
- Event sources:
|
||||||
- Overview: developer/eventing/sources/README.md
|
- Overview: eventing/sources/README.md
|
||||||
- ApiServerSource:
|
- ApiServerSource:
|
||||||
- Overview: developer/eventing/sources/apiserversource/README.md
|
- Overview: eventing/sources/apiserversource/README.md
|
||||||
- Creating an ApiServerSource object: developer/eventing/sources/apiserversource/getting-started.md
|
- Creating an ApiServerSource object: eventing/sources/apiserversource/getting-started.md
|
||||||
- ApiServerSource reference: developer/eventing/sources/apiserversource/reference.md
|
- ApiServerSource reference: eventing/sources/apiserversource/reference.md
|
||||||
- CamelSource: developer/eventing/sources/apache-camel-source/README.md
|
- CamelSource: eventing/sources/apache-camel-source/README.md
|
||||||
- KafkaSource: developer/eventing/sources/kafka-source/README.md
|
- KafkaSource: eventing/sources/kafka-source/README.md
|
||||||
- PingSource:
|
- PingSource:
|
||||||
- Creating a PingSource object: developer/eventing/sources/ping-source/README.md
|
- Creating a PingSource object: eventing/sources/ping-source/README.md
|
||||||
- PingSource reference: developer/eventing/sources/ping-source/reference.md
|
- PingSource reference: eventing/sources/ping-source/reference.md
|
||||||
# BYO event source
|
# BYO event source
|
||||||
- Custom event sources:
|
- Custom event sources:
|
||||||
- Overview: developer/eventing/custom-event-source/README.md
|
- Overview: eventing/custom-event-source/README.md
|
||||||
- Create a custom event source:
|
- Create a custom event source:
|
||||||
- Overview: developer/eventing/custom-event-source/custom-event-source/README.md
|
- Overview: eventing/custom-event-source/custom-event-source/README.md
|
||||||
- Using the Knative sample repository:
|
- Using the Knative sample repository:
|
||||||
- Overview: developer/eventing/custom-event-source/custom-event-source/sample-repo.md
|
- Overview: eventing/custom-event-source/custom-event-source/sample-repo.md
|
||||||
- Create a controller: developer/eventing/custom-event-source/custom-event-source/controller.md
|
- Create a controller: eventing/custom-event-source/custom-event-source/controller.md
|
||||||
- Create a receive adapter: developer/eventing/custom-event-source/custom-event-source/receive-adapter.md
|
- Create a receive adapter: eventing/custom-event-source/custom-event-source/receive-adapter.md
|
||||||
- Publish an event source to your cluster: developer/eventing/custom-event-source/custom-event-source/publish-event-source.md
|
- Publish an event source to your cluster: eventing/custom-event-source/custom-event-source/publish-event-source.md
|
||||||
- SinkBinding:
|
- SinkBinding:
|
||||||
- Overview: developer/eventing/custom-event-source/sinkbinding/README.md
|
- Overview: eventing/custom-event-source/sinkbinding/README.md
|
||||||
- Create a SinkBinding: developer/eventing/custom-event-source/sinkbinding/create-a-sinkbinding.md
|
- Create a SinkBinding: eventing/custom-event-source/sinkbinding/create-a-sinkbinding.md
|
||||||
- SinkBinding reference: developer/eventing/custom-event-source/sinkbinding/reference.md
|
- SinkBinding reference: eventing/custom-event-source/sinkbinding/reference.md
|
||||||
- ContainerSource:
|
- ContainerSource:
|
||||||
- Create a ContainerSource: developer/eventing/custom-event-source/containersource/README.md
|
- Create a ContainerSource: eventing/custom-event-source/containersource/README.md
|
||||||
- ContainerSource Reference: developer/eventing/custom-event-source/containersource/reference.md
|
- ContainerSource Reference: eventing/custom-event-source/containersource/reference.md
|
||||||
- Event sinks:
|
- Event sinks:
|
||||||
- About sinks: developer/eventing/sinks/README.md
|
- About sinks: eventing/sinks/README.md
|
||||||
- KafkaSink: developer/eventing/sinks/kafka-sink.md
|
- KafkaSink: eventing/sinks/kafka-sink.md
|
||||||
- Handling delivery failure: developer/eventing/event-delivery.md
|
- Handling delivery failure: eventing/event-delivery.md
|
||||||
- Flows:
|
- Flows:
|
||||||
- Overview: eventing/flows/README.md
|
- Overview: eventing/flows/README.md
|
||||||
- Parallel: eventing/flows/parallel.md
|
- Parallel: eventing/flows/parallel.md
|
||||||
|
@ -194,10 +194,10 @@ nav:
|
||||||
- Administrator topics:
|
- Administrator topics:
|
||||||
# Eventing config
|
# Eventing config
|
||||||
- Eventing configuration:
|
- Eventing configuration:
|
||||||
- Configure Channel defaults: admin/eventing/channel-configuration.md
|
- Configure Channel defaults: eventing/configuration/channel-configuration.md
|
||||||
- Configure Broker defaults: admin/eventing/broker-configuration.md
|
- Configure Broker defaults: eventing/configuration/broker-configuration.md
|
||||||
- Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md
|
- Configure Kafka Channel defaults: eventing/configuration/kafka-channel-configuration.md
|
||||||
- Configure event source defaults: admin/eventing/sources-configuration.md
|
- Configure event source defaults: eventing/configuration/sources-configuration.md
|
||||||
# Eventing - observability
|
# Eventing - observability
|
||||||
- Observability:
|
- Observability:
|
||||||
- Collecting logs: eventing/observability/logging/collecting-logs.md
|
- Collecting logs: eventing/observability/logging/collecting-logs.md
|
||||||
|
@ -206,7 +206,7 @@ nav:
|
||||||
- Knative Eventing metrics: eventing/observability/metrics/eventing-metrics.md
|
- Knative Eventing metrics: eventing/observability/metrics/eventing-metrics.md
|
||||||
# Eventing - troubleshooting
|
# Eventing - troubleshooting
|
||||||
- Troubleshooting:
|
- Troubleshooting:
|
||||||
- Debugging: eventing/debugging/README.md
|
- Debugging: eventing/troubleshooting/README.md
|
||||||
- Experimental Features: eventing/experimental-features.md
|
- Experimental Features: eventing/experimental-features.md
|
||||||
###############################################################################
|
###############################################################################
|
||||||
# Code samples
|
# Code samples
|
||||||
|
@ -272,5 +272,5 @@ nav:
|
||||||
- Serving: reference/api/serving-api.md
|
- Serving: reference/api/serving-api.md
|
||||||
- Eventing: reference/api/eventing-api.md
|
- Eventing: reference/api/eventing-api.md
|
||||||
- Concepts:
|
- Concepts:
|
||||||
- Duck types: developer/concepts/duck-typing.md
|
- Duck types: reference/concepts/duck-typing.md
|
||||||
- "Join the Community ➠": /community/
|
- "Join the Community ➠": /community/
|
||||||
|
|
|
@ -1,83 +1,115 @@
|
||||||
plugins:
|
plugins:
|
||||||
redirects:
|
redirects:
|
||||||
redirect_maps:
|
redirect_maps:
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md: eventing/samples/writing-event-source-easy-way/README.md
|
|
||||||
developer/eventing/sources/containersource/reference.md: developer/eventing/custom-event-source/containersource/reference.md
|
|
||||||
developer/eventing/sources/sinkbinding/reference.md: developer/eventing/custom-event-source/sinkbinding/reference.md
|
|
||||||
developer/eventing/sources/sinkbinding/getting-started.md: developer/eventing/custom-event-source/sinkbinding/create-a-sinkbinding.md
|
|
||||||
developer/eventing/sources/sinkbinding/README.md: developer/eventing/custom-event-source/sinkbinding/README.md
|
|
||||||
developer/eventing/sources/containersource/README.md: developer/eventing/custom-event-source/containersource/README.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md: developer/eventing/custom-event-source/custom-event-source/README.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/06-yaml.md: developer/eventing/custom-event-source/custom-event-source/publish-event-source.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md: developer/eventing/custom-event-source/custom-event-source/receive-adapter.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md: developer/eventing/custom-event-source/custom-event-source/receive-adapter.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/01-theory.md: developer/eventing/custom-event-source/custom-event-source/README.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/README.md: developer/eventing/custom-event-source/custom-event-source/README.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md: developer/eventing/custom-event-source/custom-event-source/controller.md
|
|
||||||
developer/eventing/sources/creating-event-sources/writing-event-source/03-controller.md: developer/eventing/custom-event-source/custom-event-source/README.md
|
|
||||||
developer/eventing/sources/creating-event-sources/README.md: developer/eventing/custom-event-source/README.md
|
|
||||||
serving/spec/knative-api-specification-1.0.md: https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md
|
|
||||||
serving/feature-flags.md: admin/serving/feature-flags.md
|
|
||||||
serving/using-subroutes.md: developer/serving/traffic-management.md
|
|
||||||
serving/rolling-out-latest-revision.md: developer/serving/rolling-out-latest-revision.md
|
|
||||||
serving/tag-resolution.md: developer/serving/tag-resolution.md
|
|
||||||
serving/deploying-from-private-registry.md: developer/serving/deploying-from-private-registry.md
|
|
||||||
serving/samples/blue-green-deployment.md: developer/serving/traffic-management.md
|
|
||||||
serving/samples/traffic-splitting/README.md: developer/serving/traffic-management.md
|
|
||||||
serving/installing-cert-manager.md: install/serving/installing-cert-manager.md
|
|
||||||
admin/collecting-logs/README.md: serving/observability/logging/collecting-logs.md
|
admin/collecting-logs/README.md: serving/observability/logging/collecting-logs.md
|
||||||
admin/collecting-metrics/README.md: serving/observability/metrics/collecting-metrics.md
|
|
||||||
admin/collecting-metrics/eventing-metrics/metrics.md: eventing/observability/metrics/eventing-metrics.md
|
admin/collecting-metrics/eventing-metrics/metrics.md: eventing/observability/metrics/eventing-metrics.md
|
||||||
|
admin/collecting-metrics/README.md: serving/observability/metrics/collecting-metrics.md
|
||||||
admin/collecting-metrics/serving-metrics/metrics.md: serving/observability/metrics/serving-metrics.md
|
admin/collecting-metrics/serving-metrics/metrics.md: serving/observability/metrics/serving-metrics.md
|
||||||
|
admin/eventing/broker-configuration.md: eventing/configuration/broker-configuration.md
|
||||||
|
admin/eventing/channel-configuration.md: eventing/configuration/channel-configuration.md
|
||||||
|
admin/eventing/kafka-channel-configuration.md: eventing/configuration/kafka-channel-configuration.md
|
||||||
|
admin/eventing/sources-configuration.md: eventing/configuration/sources-configuration.md
|
||||||
|
admin/install/eventing/eventing-installation-files.md: install/eventing/eventing-installation-files.md
|
||||||
|
admin/install/eventing/install-eventing-with-yaml.md: install/eventing/install-eventing-with-yaml.md
|
||||||
admin/install/install-eventing-with-yaml.md: install/eventing/install-eventing-with-yaml.md
|
admin/install/install-eventing-with-yaml.md: install/eventing/install-eventing-with-yaml.md
|
||||||
admin/install/install-serving-with-yaml.md: install/serving/install-serving-with-yaml.md
|
admin/install/install-serving-with-yaml.md: install/serving/install-serving-with-yaml.md
|
||||||
admin/install/installing-istio.md: install/serving/installing-istio.md
|
admin/install/installing-istio.md: install/serving/installing-istio.md
|
||||||
client/connecting-kn-to-your-cluster/index.md: install/client/README.md
|
|
||||||
concepts/overview.md: index.md
|
|
||||||
eventing/broker/alternate/index.md: eventing/broker/README.md
|
|
||||||
eventing/broker/broker-event-delivery.md: developer/eventing/event-delivery.md
|
|
||||||
eventing/broker/configmaps/README.md: admin/eventing/broker-configuration.md
|
|
||||||
eventing/broker/kafka-broker/kafka-configmap.md: admin/eventing/kafka-channel-configuration.md
|
|
||||||
eventing/channels/default-channels/index.md: eventing/channels/README.md
|
|
||||||
eventing/event-delivery.md: developer/eventing/event-delivery.md
|
|
||||||
eventing/metrics.md: eventing/observability/metrics/eventing-metrics.md
|
|
||||||
eventing/parallel.md: eventing/flows/parallel.md
|
|
||||||
eventing/samples/apache-camel-source/index.md: developer/eventing/sources/apache-camel-source/README.md
|
|
||||||
eventing/samples/gcp-pubsub-source/README.md: eventing/samples/cloud-pubsub-source/README.md
|
|
||||||
eventing/samples/kubernetes-event-source/index.md: developer/eventing/sources/apiserversource/README.md
|
|
||||||
eventing/samples/ping-source/index.md: developer/eventing/sources/ping-source/README.md
|
|
||||||
eventing/samples/sequence/index.md: eventing/flows/sequence/README.md
|
|
||||||
eventing/samples/sequence/sequence-replay-to-event-display/index.md: eventing/flows/sequence/sequence-reply-to-event-display/README.md
|
|
||||||
eventing/samples/sequence/sequence-reply-to-sequence/index.md: eventing/flows/sequence/sequence-reply-to-sequence/README.md
|
|
||||||
eventing/samples/sequence/sequence-terminal/index.md: eventing/flows/sequence/sequence-terminal/README.md
|
|
||||||
eventing/samples/sequence/sequence-with-broker-trigger/index.md: eventing/flows/sequence/sequence-with-broker-trigger/README.md
|
|
||||||
eventing/samples/sinkbinding/README.md: developer/eventing/custom-event-source/sinkbinding/README.md
|
|
||||||
eventing/sequence.md: eventing/flows/sequence/README.md
|
|
||||||
eventing/sink/README.md: developer/eventing/sinks/README.md
|
|
||||||
eventing/sink/kafka-sink.md: developer/eventing/sinks/kafka-sink.md
|
|
||||||
eventing/sources/apiserversource/index.md: developer/eventing/sources/apiserversource/README.md
|
|
||||||
eventing/sources/pingsource/index.md: developer/eventing/sources/ping-source/README.md
|
|
||||||
eventing/sources/containersource.md: developer/eventing/custom-event-source/containersource/README.md
|
|
||||||
eventing/triggers/index.md: eventing/broker/triggers/README.md
|
|
||||||
help/README.md: help/contributor/README.md
|
|
||||||
admin/install/README.md: install/README.md
|
|
||||||
check-install-version.md: install/upgrade/check-install-version.md
|
|
||||||
install/collecting-logs/index.md: serving/observability/logging/collecting-logs.md
|
|
||||||
install/collecting-metrics/index.md: serving/observability/metrics/collecting-metrics.md
|
|
||||||
install/getting-started-knative-app/index.md: getting-started/README.md
|
|
||||||
serving/getting-started-knative-app.md: getting-started/README.md
|
|
||||||
# This doesn't exist anymore, we should probably replace it
|
|
||||||
install/install-extensions.md: install/README.md
|
|
||||||
client/install-kn.md: install/client/install-kn.md
|
|
||||||
client/configure-kn.md: install/client/configure-kn.md
|
|
||||||
client/kn-plugins.md: install/client/kn-plugins.md
|
|
||||||
client/README.md: install/client/README.md
|
|
||||||
install/installation-files.md: install/README.md
|
|
||||||
admin/install/installing-istio.md: install/serving/installing-istio.md
|
admin/install/installing-istio.md: install/serving/installing-istio.md
|
||||||
admin/install/knative-offerings.md: install/knative-offerings.md
|
admin/install/knative-offerings.md: install/knative-offerings.md
|
||||||
admin/install/knative-with-operators.md: install/operator/knative-with-operators.md
|
admin/install/knative-with-operators.md: install/operator/knative-with-operators.md
|
||||||
admin/install/operator/configuring-eventing-cr.md: install/operator/configuring-eventing-cr.md
|
admin/install/operator/configuring-eventing-cr.md: install/operator/configuring-eventing-cr.md
|
||||||
admin/install/operator/configuring-serving-cr.md: install/operator/configuring-serving-cr.md
|
admin/install/operator/configuring-serving-cr.md: install/operator/configuring-serving-cr.md
|
||||||
|
admin/install/README.md: install/README.md
|
||||||
|
admin/install/serving/install-serving-with-yaml.md: install/serving/install-serving-with-yaml.md
|
||||||
|
admin/install/serving/serving-installation-files.md: install/serving/serving-installation-files.md
|
||||||
|
admin/install/uninstall.md: install/uninstall.md
|
||||||
|
admin/serving/config-defaults.md: serving/configuration/config-defaults.md
|
||||||
|
admin/serving/deployment.md: serving/configuration/deployment.md
|
||||||
|
admin/serving/feature-flags.md: serving/configuration/feature-flags.md
|
||||||
|
admin/serving/revision-gc.md: serving/configuration/revision-gc.md
|
||||||
|
admin/serving/rolling-out-latest-revision-configmap.md: serving/configuration/rolling-out-latest-revision-configmap.md
|
||||||
|
admin/upgrade/index.md: install/upgrade/README.md
|
||||||
|
admin/upgrade/upgrade-installation-with-operator.md: install/upgrade/upgrade-installation-with-operator.md
|
||||||
|
admin/upgrade/upgrade-installation.md: install/upgrade/upgrade-installation.md
|
||||||
|
check-install-version.md: install/upgrade/check-install-version.md
|
||||||
|
client/configure-kn.md: install/client/configure-kn.md
|
||||||
|
client/connecting-kn-to-your-cluster/index.md: install/client/README.md
|
||||||
|
client/install-kn.md: install/client/install-kn.md
|
||||||
|
client/kn-plugins.md: install/client/kn-plugins.md
|
||||||
|
client/README.md: install/client/README.md
|
||||||
|
concepts/overview.md: index.md
|
||||||
|
developer/concepts/duck-typing.md: reference/concepts/duck-typing.md
|
||||||
|
developer/eventing/event-delivery.md: eventing/event-delivery.md
|
||||||
|
developer/eventing/sinks/kafka-sink.md: eventing/sinks/kafka-sink.md
|
||||||
|
developer/eventing/sinks/README.md: eventing/sinks/README.md
|
||||||
|
developer/eventing/sources/apache-camel-source/README.md: eventing/sources/apache-camel-source/README.md
|
||||||
|
developer/eventing/sources/apiserversource/getting-started.md: eventing/sources/apiserversource/getting-started.md
|
||||||
|
developer/eventing/sources/apiserversource/reference.md: eventing/sources/apiserversource/reference.md
|
||||||
|
developer/eventing/sources/containersource/README.md: eventing/custom-event-source/containersource/README.md
|
||||||
|
developer/eventing/sources/containersource/reference.md: eventing/custom-event-source/containersource/reference.md
|
||||||
|
developer/eventing/sources/creating-event-sources/README.md: eventing/custom-event-source/README.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md: eventing/samples/writing-event-source-easy-way/README.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/01-theory.md: eventing/custom-event-source/custom-event-source/README.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md: eventing/custom-event-source/custom-event-source/controller.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/03-controller.md: eventing/custom-event-source/custom-event-source/README.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md: eventing/custom-event-source/custom-event-source/receive-adapter.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md: eventing/custom-event-source/custom-event-source/receive-adapter.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/06-yaml.md: eventing/custom-event-source/custom-event-source/publish-event-source.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md: eventing/custom-event-source/custom-event-source/README.md
|
||||||
|
developer/eventing/sources/creating-event-sources/writing-event-source/README.md: eventing/custom-event-source/custom-event-source/README.md
|
||||||
|
developer/eventing/sources/kafka-source/README.md: eventing/sources/kafka-source/README.md
|
||||||
|
developer/eventing/sources/ping-source/README.md: eventing/sources/ping-source/README.md
|
||||||
|
developer/eventing/sources/ping-source/reference.md: eventing/sources/ping-source/reference.md
|
||||||
|
developer/eventing/sources/README.md: eventing/sources/README.md
|
||||||
|
developer/eventing/sources/sinkbinding/getting-started.md: eventing/custom-event-source/sinkbinding/create-a-sinkbinding.md
|
||||||
|
developer/eventing/sources/sinkbinding/README.md: eventing/custom-event-source/sinkbinding/README.md
|
||||||
|
developer/eventing/sources/sinkbinding/reference.md: eventing/custom-event-source/sinkbinding/reference.md
|
||||||
|
developer/serving/deploying-from-private-registry.md: serving/deploying-from-private-registry.md
|
||||||
|
developer/serving/rolling-out-latest-revision.md: serving/rolling-out-latest-revision.md
|
||||||
|
developer/serving/services/byo-certificate.md: serving/services/byo-certificate.md
|
||||||
|
developer/serving/services/certificate-class.md: serving/services/certificate-class.md
|
||||||
|
developer/serving/services/configure-requests-limits-services.md: serving/services/configure-requests-limits-services.md
|
||||||
|
developer/serving/services/creating-services.md: serving/services/creating-services.md
|
||||||
|
developer/serving/services/custom-domains.md: serving/services/custom-domains.md
|
||||||
|
developer/serving/services/http-option.md: serving/services/http-option.md
|
||||||
|
developer/serving/services/ingress-class.md: serving/services/ingress-class.md
|
||||||
|
developer/serving/services/private-services.md: serving/services/private-services.md
|
||||||
|
developer/serving/services/README.md: serving/services/README.md
|
||||||
|
developer/serving/services/service-metrics.md: serving/services/service-metrics.md
|
||||||
|
developer/serving/tag-resolution.md: serving/tag-resolution.md
|
||||||
|
developer/serving/traffic-management.md: serving/traffic-management.md
|
||||||
|
developer/serving/troubleshooting/debugging-application-issues.md: serving/troubleshooting/debugging-application-issues.md
|
||||||
|
eventing/broker/alternate/index.md: eventing/broker/README.md
|
||||||
|
eventing/broker/broker-event-delivery.md: eventing/event-delivery.md
|
||||||
|
eventing/broker/configmaps/README.md: eventing/configuration/broker-configuration.md
|
||||||
|
eventing/broker/kafka-broker/kafka-configmap.md: eventing/configuration/kafka-channel-configuration.md
|
||||||
|
eventing/channels/default-channels/index.md: eventing/channels/README.md
|
||||||
|
evetnting/debugging/README.md: eventing/troubleshooting/README.md
|
||||||
|
eventing/metrics.md: eventing/observability/metrics/eventing-metrics.md
|
||||||
|
eventing/parallel.md: eventing/flows/parallel.md
|
||||||
|
eventing/samples/apache-camel-source/index.md: eventing/sources/apache-camel-source/README.md
|
||||||
|
eventing/samples/gcp-pubsub-source/README.md: eventing/samples/cloud-pubsub-source/README.md
|
||||||
|
eventing/samples/kubernetes-event-source/index.md: eventing/sources/apiserversource/README.md
|
||||||
|
eventing/samples/ping-source/index.md: eventing/sources/ping-source/README.md
|
||||||
|
eventing/samples/sequence/index.md: eventing/flows/sequence/README.md
|
||||||
|
eventing/samples/sequence/sequence-replay-to-event-display/index.md: eventing/flows/sequence/sequence-reply-to-event-display/README.md
|
||||||
|
eventing/samples/sequence/sequence-reply-to-sequence/index.md: eventing/flows/sequence/sequence-reply-to-sequence/README.md
|
||||||
|
eventing/samples/sequence/sequence-terminal/index.md: eventing/flows/sequence/sequence-terminal/README.md
|
||||||
|
eventing/samples/sequence/sequence-with-broker-trigger/index.md: eventing/flows/sequence/sequence-with-broker-trigger/README.md
|
||||||
|
eventing/samples/sinkbinding/README.md: eventing/custom-event-source/sinkbinding/README.md
|
||||||
|
eventing/sequence.md: eventing/flows/sequence/README.md
|
||||||
|
eventing/sink/kafka-sink.md: eventing/sinks/kafka-sink.md
|
||||||
|
eventing/sink/README.md: eventing/sinks/README.md
|
||||||
|
eventing/sources/apiserversource/index.md: eventing/sources/apiserversource/README.md
|
||||||
|
eventing/sources/containersource.md: eventing/custom-event-source/containersource/README.md
|
||||||
|
eventing/sources/pingsource/index.md: eventing/sources/ping-source/README.md
|
||||||
|
eventing/triggers/index.md: eventing/broker/triggers/README.md
|
||||||
|
help/README.md: help/contributor/README.md
|
||||||
|
install/collecting-logs/index.md: serving/observability/logging/collecting-logs.md
|
||||||
|
install/collecting-metrics/index.md: serving/observability/metrics/collecting-metrics.md
|
||||||
|
install/getting-started-knative-app/index.md: getting-started/README.md
|
||||||
|
install/install-extensions.md: install/README.md
|
||||||
|
install/installation-files.md: install/README.md
|
||||||
install/prerequisites.md: install/README.md
|
install/prerequisites.md: install/README.md
|
||||||
operator/configuring-eventing-cr/index.md: install/operator/configuring-eventing-cr.md
|
operator/configuring-eventing-cr/index.md: install/operator/configuring-eventing-cr.md
|
||||||
operator/configuring-serving-cr/index.md: install/operator/configuring-serving-cr.md
|
operator/configuring-serving-cr/index.md: install/operator/configuring-serving-cr.md
|
||||||
|
@ -85,18 +117,19 @@ plugins:
|
||||||
serving/autoscaling/autoscaling-concepts.md: serving/autoscaling/autoscaler-types.md
|
serving/autoscaling/autoscaling-concepts.md: serving/autoscaling/autoscaler-types.md
|
||||||
serving/autoscaling/target-burst-capacity/index.md: serving/load-balancing/target-burst-capacity.md
|
serving/autoscaling/target-burst-capacity/index.md: serving/load-balancing/target-burst-capacity.md
|
||||||
serving/configuring-autoscaling/index.md: serving/autoscaling/README.md
|
serving/configuring-autoscaling/index.md: serving/autoscaling/README.md
|
||||||
serving/creating-domain-mappings.md: developer/serving/services/custom-domains.md
|
serving/creating-domain-mappings.md: serving/services/custom-domains.md
|
||||||
serving/debugging-application-issues.md: developer/serving/troubleshooting/debugging-application-issues.md
|
serving/debugging-application-issues.md: serving/troubleshooting/debugging-application-issues.md
|
||||||
|
serving/feature-flags.md: serving/configuration/feature-flags.md
|
||||||
|
serving/getting-started-knative-app.md: getting-started/README.md
|
||||||
|
serving/installing-cert-manager.md: install/serving/installing-cert-manager.md
|
||||||
serving/metrics.md: serving/observability/metrics/serving-metrics.md
|
serving/metrics.md: serving/observability/metrics/serving-metrics.md
|
||||||
serving/samples/autoscale-go/index.md: serving/autoscaling/autoscale-go/README.md
|
serving/samples/autoscale-go/index.md: serving/autoscaling/autoscale-go/README.md
|
||||||
serving/services/README.md: developer/serving/services/README.md
|
serving/samples/blue-green-deployment.md: serving/traffic-management.md
|
||||||
serving/services/creating-services.md: developer/serving/services/creating-services.md
|
serving/samples/traffic-splitting/README.md: serving/traffic-management.md
|
||||||
serving/services/deployment.md: admin/serving/deployment.md
|
serving/services/creating-services.md: serving/services/creating-services.md
|
||||||
serving/services/private-services.md: developer/serving/services/private-services.md
|
serving/services/deployment.md: serving/configuration/deployment.md
|
||||||
|
serving/services/private-services.md: serving/services/private-services.md
|
||||||
|
serving/services/README.md: serving/services/README.md
|
||||||
|
serving/spec/knative-api-specification-1.0.md: https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md
|
||||||
serving/using-an-ssl-cert/index.md: serving/using-a-tls-cert.md
|
serving/using-an-ssl-cert/index.md: serving/using-a-tls-cert.md
|
||||||
admin/install/uninstall.md: install/uninstall.md
|
serving/using-subroutes.md: serving/traffic-management.md
|
||||||
admin/upgrade/index.md: install/upgrade/README.md
|
|
||||||
admin/upgrade/upgrade-installation-with-operator.md: install/upgrade/upgrade-installation-with-operator.md
|
|
||||||
admin/upgrade/upgrade-installation.md: install/upgrade/upgrade-installation.md
|
|
||||||
admin/install/eventing/eventing-installation-files.md: install/eventing/eventing-installation-files.md
|
|
||||||
admin/install/serving/serving-installation-files.md: install/serving/serving-installation-files.md
|
|
||||||
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Administration guide
|
|
||||||
|
|
||||||
The following topics provide information for cluster administrators about how to complete administration tasks and use administration tools for a Knative cluster.
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Developer guide
|
|
||||||
|
|
||||||
The following topics provide information for developers about how to complete administration tasks and use development tools for a Knative cluster.
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Knative Eventing
|
# Knative Eventing
|
||||||
|
|
||||||
Knative Eventing enables developers to use an [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture) with serverless applications. An event-driven architecture is based on the concept of decoupled relationships between event producers that create events, and event consumers, or [_sinks_](../developer/eventing/sinks/README.md), that receive events.
|
Knative Eventing enables developers to use an [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture) with serverless applications. An event-driven architecture is based on the concept of decoupled relationships between event producers that create events, and event consumers, or [_sinks_](../eventing/sinks/README.md), that receive events.
|
||||||
|
|
||||||
In a Knative Eventing deployment, event [Sources](../developer/eventing/sources/README.md) are the primary event producers, however you can also configure a sink or _subscriber_ to respond to HTTP requests by sending a response event. Examples of sinks in a Knative Eventing deployment include Knative Services, Channels and Brokers.
|
In a Knative Eventing deployment, event [Sources](../eventing/sources/README.md) are the primary event producers, however you can also configure a sink or _subscriber_ to respond to HTTP requests by sending a response event. Examples of sinks in a Knative Eventing deployment include Knative Services, Channels and Brokers.
|
||||||
<!--TODO: Add response / reply event information, maybe diagrams-->
|
<!--TODO: Add response / reply event information, maybe diagrams-->
|
||||||
|
|
||||||
Knative Eventing uses standard HTTP POST requests to send and receive events between event producers and sinks. These events conform to the [CloudEvents specifications](https://cloudevents.io/), which enables creating, parsing, sending, and receiving events in any programming language.
|
Knative Eventing uses standard HTTP POST requests to send and receive events between event producers and sinks. These events conform to the [CloudEvents specifications](https://cloudevents.io/), which enables creating, parsing, sending, and receiving events in any programming language.
|
||||||
|
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
@ -3,7 +3,7 @@
|
||||||
Brokers are Kubernetes [custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that define an event mesh for collecting a pool of [CloudEvents](https://cloudevents.io/). Brokers provide a discoverable endpoint, `status.address`, for event ingress, and triggers for event delivery. Event producers can send events to a broker by POSTing the event to the `status.address.url` of the broker.
|
Brokers are Kubernetes [custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that define an event mesh for collecting a pool of [CloudEvents](https://cloudevents.io/). Brokers provide a discoverable endpoint, `status.address`, for event ingress, and triggers for event delivery. Event producers can send events to a broker by POSTing the event to the `status.address.url` of the broker.
|
||||||
|
|
||||||
Event delivery mechanics are an implementation detail that depend on the configured
|
Event delivery mechanics are an implementation detail that depend on the configured
|
||||||
[broker class](../../admin/eventing/broker-configuration.md#broker-class-options).
|
[broker class](../configuration/broker-configuration.md#broker-class-options).
|
||||||
Using brokers and triggers abstracts the details of event routing from the event producer and event consumer.
|
Using brokers and triggers abstracts the details of event routing from the event producer and event consumer.
|
||||||
|
|
||||||

|

|
||||||
|
@ -51,5 +51,5 @@ For more information, see [RabbitMQ Broker](rabbitmq-broker/README.md) or [the d
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
- Create an [MT channel-based broker](create-mtbroker.md).
|
- Create an [MT channel-based broker](create-mtbroker.md).
|
||||||
- Configure [default broker ConfigMap settings](../../admin/eventing/broker-configuration.md).
|
- Configure [default broker ConfigMap settings](../configuration/broker-configuration.md).
|
||||||
- View the [broker specifications](https://github.com/knative/specs/blob/main/specs/eventing/broker.md).
|
- View the [broker specifications](https://github.com/knative/specs/blob/main/specs/eventing/broker.md).
|
||||||
|
|
|
@ -32,5 +32,5 @@ metadata:
|
||||||
- You can specify any valid `name` for your broker. Using `default` will create a broker named `default`.
|
- You can specify any valid `name` for your broker. Using `default` will create a broker named `default`.
|
||||||
- The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the current namespace.
|
- The `namespace` must be an existing namespace in your cluster. Using `default` will create the broker in the current namespace.
|
||||||
- You can set the `eventing.knative.dev/broker.class` annotation to change the class of the broker. The default broker class is `MTChannelBasedBroker`, but Knative also supports use of the `Kafka` broker class. For more information about Kafka brokers, see the [Apache Kafka Broker](kafka-broker/README.md) documentation.
|
- You can set the `eventing.knative.dev/broker.class` annotation to change the class of the broker. The default broker class is `MTChannelBasedBroker`, but Knative also supports use of the `Kafka` broker class. For more information about Kafka brokers, see the [Apache Kafka Broker](kafka-broker/README.md) documentation.
|
||||||
- `spec.config` is used to specify the default backing channel configuration for MT channel-based broker implementations. For more information on configuring the default channel type, see the documentation on [Configure Broker defaults](../../admin/eventing/broker-configuration.md).
|
- `spec.config` is used to specify the default backing channel configuration for MT channel-based broker implementations. For more information on configuring the default channel type, see the documentation on [Configure Broker defaults](../configuration/broker-configuration.md).
|
||||||
- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../../developer/eventing/event-delivery.md).
|
- `spec.delivery` is used to configure event delivery options. Event delivery options specify what happens to an event that fails to be delivered to an event sink. For more information, see the documentation on [Event delivery](../event-delivery.md).
|
||||||
|
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
@ -4,8 +4,8 @@ This topic describes how to configure defaults for Knative event sources. You ca
|
||||||
|
|
||||||
## Configure defaults for PingSource
|
## Configure defaults for PingSource
|
||||||
|
|
||||||
PingSource is an event source that produces events with a fixed payload on a specified cron schedule. For how to create a new PingSource, see [Creating a PingSource object](../../developer/eventing/sources/ping-source/README.md).
|
PingSource is an event source that produces events with a fixed payload on a specified cron schedule. For how to create a new PingSource, see [Creating a PingSource object](../../eventing/sources/ping-source/README.md).
|
||||||
For the available parameters, see [PingSource reference](../../developer/eventing/sources/ping-source/reference.md).
|
For the available parameters, see [PingSource reference](../../eventing/sources/ping-source/reference.md).
|
||||||
|
|
||||||
In addition to the parameters that you can configure in the PingSource resource, there is a global ConfigMap called `config-ping-defaults`.
|
In addition to the parameters that you can configure in the PingSource resource, there is a global ConfigMap called `config-ping-defaults`.
|
||||||
This ConfigMap allows you to change the maximum amount of data that the PingSource adds to the CloudEvents it produces.
|
This ConfigMap allows you to change the maximum amount of data that the PingSource adds to the CloudEvents it produces.
|
|
@ -13,7 +13,7 @@ container image, and a ContainerSource that uses your image URI.
|
||||||
|
|
||||||
Before you can create a ContainerSource object:
|
Before you can create a ContainerSource object:
|
||||||
|
|
||||||
- You must have [Knative Eventing](../../../../install/eventing/install-eventing-with-yaml.md)
|
- You must have [Knative Eventing](../../../install/eventing/install-eventing-with-yaml.md)
|
||||||
installed on your cluster.
|
installed on your cluster.
|
||||||
- If you want to use the following example heartbeats event source, you must also:
|
- If you want to use the following example heartbeats event source, you must also:
|
||||||
- Install [ko](https://github.com/google/ko)
|
- Install [ko](https://github.com/google/ko)
|
|
@ -14,7 +14,7 @@ type information in the cluster data store.
|
||||||
particularly the
|
particularly the
|
||||||
[Context Attributes](https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes)
|
[Context Attributes](https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes)
|
||||||
section.
|
section.
|
||||||
1. Be familiar with [event sources](../developer/eventing/sources/README.md).
|
1. Be familiar with [event sources](../eventing/sources/README.md).
|
||||||
|
|
||||||
## Discovering events with the registry
|
## Discovering events with the registry
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ Sequence has four parts for the Status:
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
For each of the following examples, you use a [`PingSource`](../../../developer/eventing/sources/ping-source/README.md) as the source of events.
|
For each of the following examples, you use a [`PingSource`](../../../eventing/sources/ping-source/README.md) as the source of events.
|
||||||
|
|
||||||
We also use a very simple [transformer](https://github.com/knative/eventing/blob/main/cmd/appender/main.go) which performs very trivial transformation of the incoming events to demonstrate they have passed through each stage.
|
We also use a very simple [transformer](https://github.com/knative/eventing/blob/main/cmd/appender/main.go) which performs very trivial transformation of the incoming events to demonstrate they have passed through each stage.
|
||||||
|
|
||||||
|
|
|
@ -52,7 +52,7 @@ The [broker](broker/README.md) allows you to route events to different event sin
|
||||||
```
|
```
|
||||||
|
|
||||||
If `READY` is `False`, wait a few moments and then run the command again.
|
If `READY` is `False`, wait a few moments and then run the command again.
|
||||||
If you continue to receive the `False` status, see the [Debugging Guide](debugging/README.md) to troubleshoot the issue.
|
If you continue to receive the `False` status, see the [Debugging Guide](troubleshooting/README.md) to troubleshoot the issue.
|
||||||
|
|
||||||
## Creating event consumers
|
## Creating event consumers
|
||||||
|
|
||||||
|
@ -160,7 +160,7 @@ into a file:
|
||||||
goodbye-display 1/1 1 1 16s
|
goodbye-display 1/1 1 1 16s
|
||||||
```
|
```
|
||||||
The number of replicas in the **READY** column should match the number of replicas in the **AVAILABLE** column.
|
The number of replicas in the **READY** column should match the number of replicas in the **AVAILABLE** column.
|
||||||
If the numbers do not match, see the [Debugging Guide](debugging/README.md) to troubleshoot the issue.
|
If the numbers do not match, see the [Debugging Guide](troubleshooting/README.md) to troubleshoot the issue.
|
||||||
|
|
||||||
## Creating triggers
|
## Creating triggers
|
||||||
|
|
||||||
|
@ -240,7 +240,7 @@ Each trigger can specify a filter that enables selection of relevant events base
|
||||||
|
|
||||||
The `SUBSCRIBER_URI` has a value similar to `triggerName.namespaceName.svc.cluster.local`.
|
The `SUBSCRIBER_URI` has a value similar to `triggerName.namespaceName.svc.cluster.local`.
|
||||||
The exact value depends on the broker implementation.
|
The exact value depends on the broker implementation.
|
||||||
If this value looks incorrect, see the [Debugging Guide](debugging/README.md) to troubleshoot the issue.
|
If this value looks incorrect, see the [Debugging Guide](troubleshooting/README.md) to troubleshoot the issue.
|
||||||
|
|
||||||
## Creating a pod as an event producer
|
## Creating a pod as an event producer
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ All examples are using the
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Each of the following examples use
|
Each of the following examples use
|
||||||
[`PingSource`](../../../developer/eventing/sources/ping-source/README.md) as the source of events.
|
[`PingSource`](../../../eventing/sources/ping-source/README.md) as the source of events.
|
||||||
|
|
||||||
We also use simple
|
We also use simple
|
||||||
[functions](https://github.com/lionelvillard/knative-functions) to perform
|
[functions](https://github.com/lionelvillard/knative-functions) to perform
|
||||||
|
|
|
@ -128,7 +128,7 @@ kn source binding create bind-heartbeat \
|
||||||
The `svc` in `http://event-display.svc.cluster.local` determines that the sink is a Knative Service. Other default sink prefixes include Channel and Broker.
|
The `svc` in `http://event-display.svc.cluster.local` determines that the sink is a Knative Service. Other default sink prefixes include Channel and Broker.
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
You can configure which resources can be used with the `--sink` flag for `kn` CLI commands by [Customizing kn](../../../install/client/configure-kn.md#example-configuration-file).
|
You can configure which resources can be used with the `--sink` flag for `kn` CLI commands by [Customizing kn](../../install/client/configure-kn.md#example-configuration-file).
|
||||||
|
|
||||||
## Supported third-party sink types
|
## Supported third-party sink types
|
||||||
|
|
|
@ -4,7 +4,7 @@ This page shows how to install and configure an Apache KafkaSink.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
You must have access to a Kubernetes cluster with [Knative Eventing installed](../../../install/README.md).
|
You must have access to a Kubernetes cluster with [Knative Eventing installed](../../install/eventing/install-eventing-with-yaml.md).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
|
@ -32,8 +32,8 @@ All Sources are part of the `sources` category.
|
||||||
| [Apache CouchDB](https://github.com/knative-sandbox/eventing-couchdb/blob/main/source) | v1alpha1 | Knative | Brings [Apache CouchDB](https://couchdb.apache.org/) messages into Knative. |
|
| [Apache CouchDB](https://github.com/knative-sandbox/eventing-couchdb/blob/main/source) | v1alpha1 | Knative | Brings [Apache CouchDB](https://couchdb.apache.org/) messages into Knative. |
|
||||||
| [Apache Kafka](kafka-source/README.md) | v1beta1 | Knative | Brings [Apache Kafka](https://kafka.apache.org/) messages into Knative. The KafkaSource reads events from an Apache Kafka Cluster, and passes these events to a sink so that they can be consumed. See the [Kafka Source](https://github.com/knative-sandbox/eventing-kafka/blob/main/pkg/source) example for more details. |
|
| [Apache Kafka](kafka-source/README.md) | v1beta1 | Knative | Brings [Apache Kafka](https://kafka.apache.org/) messages into Knative. The KafkaSource reads events from an Apache Kafka Cluster, and passes these events to a sink so that they can be consumed. See the [Kafka Source](https://github.com/knative-sandbox/eventing-kafka/blob/main/pkg/source) example for more details. |
|
||||||
| [ContainerSource](../custom-event-source/containersource/README.md) | v1 | Knative | The ContainerSource instantiates container image(s) that can generate events until the ContainerSource is deleted. This may be used, for example, to poll an FTP server for new files or generate events at a set time interval. Given a `spec.template` with at least a container image specified, the ContainerSource keeps a Pod running with the specified image(s). `K_SINK` (destination address) and `KE_CE_OVERRIDES` (JSON CloudEvents attributes) environment variables are injected into the running image(s). It is used by multiple other Sources as underlying infrastructure. Refer to the [Container Source](../custom-event-source/containersource/README.md) example for more details. |
|
| [ContainerSource](../custom-event-source/containersource/README.md) | v1 | Knative | The ContainerSource instantiates container image(s) that can generate events until the ContainerSource is deleted. This may be used, for example, to poll an FTP server for new files or generate events at a set time interval. Given a `spec.template` with at least a container image specified, the ContainerSource keeps a Pod running with the specified image(s). `K_SINK` (destination address) and `KE_CE_OVERRIDES` (JSON CloudEvents attributes) environment variables are injected into the running image(s). It is used by multiple other Sources as underlying infrastructure. Refer to the [Container Source](../custom-event-source/containersource/README.md) example for more details. |
|
||||||
| [GitHub](../../../eventing/samples/github-source/README.md) | v1alpha1 | Knative | Registers for events of the specified types on the specified GitHub organization or repository, and brings those events into Knative. The GitHubSource fires a new event for selected [GitHub event types](https://developer.github.com/v3/activity/events/types/). See the [GitHub Source](../../../eventing/samples/github-source/README.md) example for more details. |
|
| [GitHub](../samples/github-source/README.md) | v1alpha1 | Knative | Registers for events of the specified types on the specified GitHub organization or repository, and brings those events into Knative. The GitHubSource fires a new event for selected [GitHub event types](https://developer.github.com/v3/activity/events/types/). See the [GitHub Source](../samples/github-source/README.md) example for more details. |
|
||||||
| [GitLab](../../../eventing/samples/gitlab-source/README.md) | v1alpha1 | Knative | Registers for events of the specified types on the specified GitLab repository, and brings those events into Knative. The GitLabSource creates a webhooks for specified [event types](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#events), listens for incoming events, and passes them to a consumer. See the [GitLab Source](../../../eventing/samples/gitlab-source/README.md) example for more details. |
|
| [GitLab](../samples/gitlab-source/README.md) | v1alpha1 | Knative | Registers for events of the specified types on the specified GitLab repository, and brings those events into Knative. The GitLabSource creates a webhooks for specified [event types](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#events), listens for incoming events, and passes them to a consumer. See the [GitLab Source](../samples/gitlab-source/README.md) example for more details. |
|
||||||
| [Heartbeats](https://github.com/knative/eventing/tree/main/cmd/heartbeats) | N/A | Knative | Uses an in-memory timer to produce events at the specified interval. |
|
| [Heartbeats](https://github.com/knative/eventing/tree/main/cmd/heartbeats) | N/A | Knative | Uses an in-memory timer to produce events at the specified interval. |
|
||||||
| [KogitoSource](https://github.com/knative-sandbox/eventing-kogito) | v1alpha1 | Knative | An implementation of the [Kogito Runtime](https://docs.jboss.org/kogito/release/latest/html_single/#proc-kogito-deploying-on-kubernetes_kogito-deploying-on-openshift) custom resource managed by the [Kogito Operator](https://github.com/kiegroup/kogito-operator). |
|
| [KogitoSource](https://github.com/knative-sandbox/eventing-kogito) | v1alpha1 | Knative | An implementation of the [Kogito Runtime](https://docs.jboss.org/kogito/release/latest/html_single/#proc-kogito-deploying-on-kubernetes_kogito-deploying-on-openshift) custom resource managed by the [Kogito Operator](https://github.com/kiegroup/kogito-operator). |
|
||||||
| [PingSource](ping-source/README.md) | v1beta2 | Knative | Produces events with a fixed payload on a specified [Cron](https://en.wikipedia.org/wiki/Cron) schedule. See the [Ping Source](ping-source/README.md) example for more details. |
|
| [PingSource](ping-source/README.md) | v1beta2 | Knative | Produces events with a fixed payload on a specified [Cron](https://en.wikipedia.org/wiki/Cron) schedule. See the [Ping Source](ping-source/README.md) example for more details. |
|
||||||
|
@ -64,10 +64,10 @@ All Sources are part of the `sources` category.
|
||||||
[Azure Queue Storage](https://github.com/triggermesh/triggermesh/) | Supported | TriggerMesh | Retrieve messages from [Azure Queue Storage](https://azure.microsoft.com/en-us/services/storage/queues/).
|
[Azure Queue Storage](https://github.com/triggermesh/triggermesh/) | Supported | TriggerMesh | Retrieve messages from [Azure Queue Storage](https://azure.microsoft.com/en-us/services/storage/queues/).
|
||||||
[Azure Service Bus](https://github.com/triggermesh/triggermesh/) | Supported | TriggerMesh | Consumes messages from an [Azure Service Bus](https://azure.microsoft.com/en-us/services/service-bus/) queue.
|
[Azure Service Bus](https://github.com/triggermesh/triggermesh/) | Supported | TriggerMesh | Consumes messages from an [Azure Service Bus](https://azure.microsoft.com/en-us/services/service-bus/) queue.
|
||||||
[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.
|
[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.
|
||||||
[CloudAuditLogsSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudauditlogssource/README.md) | v1 | Google | Registers for events of the specified types on the specified [Google Cloud Audit Logs](https://cloud.google.com/logging/docs/audit/). Brings those events into Knative. Refer to the [CloudAuditLogsSource](../../../eventing/samples/cloud-audit-logs-source/README.md) example for more details.
|
[CloudAuditLogsSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudauditlogssource/README.md) | v1 | Google | Registers for events of the specified types on the specified [Google Cloud Audit Logs](https://cloud.google.com/logging/docs/audit/). Brings those events into Knative. Refer to the [CloudAuditLogsSource](../samples/cloud-audit-logs-source/README.md) example for more details.
|
||||||
[CloudPubSubSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudpubsubsource/README.md) | v1 | Google | Brings [Cloud Pub/Sub](https://cloud.google.com/pubsub/) messages into Knative. The CloudPubSubSource fires a new event each time a message is published on a [Google Cloud Platform PubSub topic](https://cloud.google.com/pubsub/). See the [CloudPubSubSource](../../../eventing/samples/cloud-pubsub-source/README.md) example for more details.
|
[CloudPubSubSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudpubsubsource/README.md) | v1 | Google | Brings [Cloud Pub/Sub](https://cloud.google.com/pubsub/) messages into Knative. The CloudPubSubSource fires a new event each time a message is published on a [Google Cloud Platform PubSub topic](https://cloud.google.com/pubsub/). See the [CloudPubSubSource](../samples/cloud-pubsub-source/README.md) example for more details.
|
||||||
[CloudSchedulerSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudschedulersource/README.md) | v1 | Google | Create, update, and delete [Google Cloud Scheduler](https://cloud.google.com/scheduler/) Jobs. When those jobs are triggered, receive the event inside Knative. See the [CloudSchedulerSource](../../../eventing/samples/cloud-scheduler-source/README.md) example for further details.
|
[CloudSchedulerSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudschedulersource/README.md) | v1 | Google | Create, update, and delete [Google Cloud Scheduler](https://cloud.google.com/scheduler/) Jobs. When those jobs are triggered, receive the event inside Knative. See the [CloudSchedulerSource](../samples/cloud-scheduler-source/README.md) example for further details.
|
||||||
[CloudStorageSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudstoragesource/README.md) | v1 | Google | Registers for events of the specified types on the specified [Google Cloud Storage](https://cloud.google.com/storage/) bucket and optional object prefix. Brings those events into Knative. See the [CloudStorageSource](../../../eventing/samples/cloud-storage-source/README.md) example.
|
[CloudStorageSource](https://github.com/google/knative-gcp/blob/main/docs/examples/cloudstoragesource/README.md) | v1 | Google | Registers for events of the specified types on the specified [Google Cloud Storage](https://cloud.google.com/storage/) bucket and optional object prefix. Brings those events into Knative. See the [CloudStorageSource](../samples/cloud-storage-source/README.md) example.
|
||||||
[DockerHubSource](https://github.com/tom24d/eventing-dockerhub) | v1alpha1 | None | Retrieves events from [Docker Hub Webhooks](https://docs.docker.com/docker-hub/webhooks/) and transforms them into CloudEvents for consumption in Knative.
|
[DockerHubSource](https://github.com/tom24d/eventing-dockerhub) | v1alpha1 | None | Retrieves events from [Docker Hub Webhooks](https://docs.docker.com/docker-hub/webhooks/) and transforms them into CloudEvents for consumption in 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.
|
[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.
|
||||||
[GitHub Issue Comments](https://github.com/BrianMMcClain/github-issue-comment-source)| Proof of Concept | None | Polls a specific GitHub issue for new comments.
|
[GitHub Issue Comments](https://github.com/BrianMMcClain/github-issue-comment-source)| Proof of Concept | None | Polls a specific GitHub issue for new comments.
|
|
@ -8,11 +8,11 @@ This topic describes how to create an ApiServerSource object.
|
||||||
|
|
||||||
Before you can create an ApiServerSource object:
|
Before you can create an ApiServerSource object:
|
||||||
|
|
||||||
- You must have [Knative Eventing](../../../../install/eventing/install-eventing-with-yaml.md)
|
- You must have [Knative Eventing](../../../install/eventing/install-eventing-with-yaml.md)
|
||||||
installed on your cluster.
|
installed on your cluster.
|
||||||
- You must install the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
- You must install the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||||
tool.
|
tool.
|
||||||
- Optional: If you want to use the `kn` commands, install the [`kn`](../../../../install/client/configure-kn.md) tool.
|
- Optional: If you want to use the `kn` commands, install the [`kn`](../../../install/client/configure-kn.md) tool.
|
||||||
|
|
||||||
## Create an ApiServerSource object
|
## Create an ApiServerSource object
|
||||||
|
|
||||||
|
@ -221,7 +221,7 @@ command:
|
||||||
- `<namespace>` is the name of the namespace that you created in step 1 earlier.
|
- `<namespace>` is the name of the namespace that you created in step 1 earlier.
|
||||||
- `<service-account>` is the name of the ServiceAccount that you created in step 2 earlier.
|
- `<service-account>` is the name of the ServiceAccount that you created in step 2 earlier.
|
||||||
- `<event-mode>` is either `Resource` or `Reference`. If set to `Resource`, the event payload contains the entire resource that the event is for. If set to `Reference`, the event payload only contains a reference to the resource that the event is for. The default is `Reference`.
|
- `<event-mode>` is either `Resource` or `Reference`. If set to `Resource`, the event payload contains the entire resource that the event is for. If set to `Reference`, the event payload only contains a reference to the resource that the event is for. The default is `Reference`.
|
||||||
- `<sink-kind>` is any supported [Addressable](../../../concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
- `<sink-kind>` is any supported [Addressable](../../../reference/concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
||||||
- `<sink-name>` is the name of your sink.
|
- `<sink-name>` is the name of your sink.
|
||||||
|
|
||||||
For more information about the fields you can configure for the ApiServerSource object, see [ApiServerSource reference](reference.md).
|
For more information about the fields you can configure for the ApiServerSource object, see [ApiServerSource reference](reference.md).
|
|
@ -15,8 +15,8 @@ The `KafkaSource` reads all the messages, from all partitions, and sends those m
|
||||||
|
|
||||||
- Set up a Kubernetes cluster with the Kafka event source installed.
|
- Set up a Kubernetes cluster with the Kafka event source installed.
|
||||||
You can install the Kafka event source by using
|
You can install the Kafka event source by using
|
||||||
[YAML](../../../../install/eventing/install-eventing-with-yaml.md#install-optional-eventing-extensions)
|
[YAML](../../../install/eventing/install-eventing-with-yaml.md#install-optional-eventing-extensions)
|
||||||
or the [Knative Operator](../../../../install/operator/knative-with-operators.md#installing-with-different-eventing-sources).
|
or the [Knative Operator](../../../install/operator/knative-with-operators.md#installing-with-different-eventing-sources).
|
||||||
|
|
||||||
## Optional: Create a Kafka topic
|
## Optional: Create a Kafka topic
|
||||||
|
|
|
@ -14,9 +14,9 @@ If you have an existing sink, you can replace the examples with your own values.
|
||||||
|
|
||||||
To create a PingSource:
|
To create a PingSource:
|
||||||
|
|
||||||
- You must install [Knative Eventing](../../../../install/eventing/install-eventing-with-yaml.md).
|
- You must install [Knative Eventing](../../../install/eventing/install-eventing-with-yaml.md).
|
||||||
The PingSource event source type is enabled by default when you install Knative Eventing.
|
The PingSource event source type is enabled by default when you install Knative Eventing.
|
||||||
- You can use either `kubectl` or [`kn`](../../../../install/client/configure-kn.md) commands
|
- You can use either `kubectl` or [`kn`](../../../install/client/install-kn.md) commands
|
||||||
to create components such as a sink and PingSource.
|
to create components such as a sink and PingSource.
|
||||||
- You can use either `kubectl` or [`kail`](https://github.com/boz/kail) for logging
|
- You can use either `kubectl` or [`kail`](https://github.com/boz/kail) for logging
|
||||||
during the verification step in this procedure.
|
during the verification step in this procedure.
|
||||||
|
@ -150,7 +150,7 @@ during the verification step in this procedure.
|
||||||
- `<cron-schedule>` is a cron expression for the schedule for the PingSource to send events, for example, `*/1 * * * *` sends an event every minute.
|
- `<cron-schedule>` is a cron expression for the schedule for the PingSource to send events, for example, `*/1 * * * *` sends an event every minute.
|
||||||
- `<content-type>` is the media type of the data you want to send, for example, `application/json`.
|
- `<content-type>` is the media type of the data you want to send, for example, `application/json`.
|
||||||
- `<data>` is the data you want to send. This data must be represented as text, not binary. For example, a JSON object such as `{"message": "Hello world!"}`.
|
- `<data>` is the data you want to send. This data must be represented as text, not binary. For example, a JSON object such as `{"message": "Hello world!"}`.
|
||||||
- `<sink-kind>` is any supported [Addressable](../../../concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
- `<sink-kind>` is any supported [Addressable](../../../reference/concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
||||||
- `<sink-name>` is the name of your sink, for example, `event-display`.
|
- `<sink-name>` is the name of your sink, for example, `event-display`.
|
||||||
|
|
||||||
For more information about the fields you can configure for the PingSource object, see [PingSource reference](reference.md).
|
For more information about the fields you can configure for the PingSource object, see [PingSource reference](reference.md).
|
||||||
|
@ -191,7 +191,7 @@ during the verification step in this procedure.
|
||||||
- `<cron-schedule>` is a cron expression for the schedule for the PingSource to send events, for example, `*/1 * * * *` sends an event every minute.
|
- `<cron-schedule>` is a cron expression for the schedule for the PingSource to send events, for example, `*/1 * * * *` sends an event every minute.
|
||||||
- `<content-type>` is the media type of the data you want to send, for example, `application/json`.
|
- `<content-type>` is the media type of the data you want to send, for example, `application/json`.
|
||||||
- `<base64-data>` is the base64 encoded binary data that you want to send, for example, `ZGF0YQ==`.
|
- `<base64-data>` is the base64 encoded binary data that you want to send, for example, `ZGF0YQ==`.
|
||||||
- `<sink-kind>` is any supported [Addressable](../../../concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
- `<sink-kind>` is any supported [Addressable](../../../reference/concepts/duck-typing.md#addressable) object that you want to use as a sink, for example, `Service` or `Deployment`.
|
||||||
- `<sink-name>` is the name of your sink, for example, `event-display`.
|
- `<sink-name>` is the name of your sink, for example, `event-display`.
|
||||||
|
|
||||||
For more information about the fields you can configure for the PingSource object, see [PingSource reference](reference.md).
|
For more information about the fields you can configure for the PingSource object, see [PingSource reference](reference.md).
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
@ -180,7 +180,7 @@ something went wrong during `chan` reconciliation. See
|
||||||
|
|
||||||
##### `src`
|
##### `src`
|
||||||
|
|
||||||
`src` is a [`ApiServerSource`](../../developer/eventing/sources/apiserversource/README.md).
|
`src` is a [`ApiServerSource`](../../eventing/sources/apiserversource/README.md).
|
||||||
|
|
||||||
First we will verify that `src` is writing to `chan`.
|
First we will verify that `src` is writing to `chan`.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# Getting Started with Knative
|
# Getting Started with Knative
|
||||||
## Before you begin
|
## Before you begin
|
||||||
!!! warning
|
!!! warning
|
||||||
Knative Quickstart Environments are for experimentation use only. For production installation, see our [Administrator's Guide](../admin/README.md)
|
Knative Quickstart Environments are for experimentation use only. For production installation, see our [Installing Guide](../install/README.md)
|
||||||
|
|
||||||
Before you can get started with a Knative Quickstart deployment you must install kind, the Kubernetes CLI, and the Knative CLI.
|
Before you can get started with a Knative Quickstart deployment you must install kind, the Kubernetes CLI, and the Knative CLI.
|
||||||
|
|
||||||
|
@ -26,4 +26,3 @@ The Knative CLI (`kn`) provides a quick and easy interface for creating Knative
|
||||||
You can get started with a local deployment of Knative by using the Knative `quickstart` plugin.
|
You can get started with a local deployment of Knative by using the Knative `quickstart` plugin.
|
||||||
|
|
||||||
--8<-- "quickstart-install.md"
|
--8<-- "quickstart-install.md"
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ With Knative Serving, we have a powerful tool which can take our containerized c
|
||||||
|
|
||||||
==**Knative Eventing acts as the "glue" between the disparate parts of your architecture**== and allows you to easily communicate between those parts in a fault-tolerant way. Some examples include:
|
==**Knative Eventing acts as the "glue" between the disparate parts of your architecture**== and allows you to easily communicate between those parts in a fault-tolerant way. Some examples include:
|
||||||
|
|
||||||
:material-file-document: [Creating and responding to Kubernetes API events](../developer/eventing/sources/apiserversource/README.md){target=blank}
|
:material-file-document: [Creating and responding to Kubernetes API events](../eventing/sources/apiserversource/README.md){target=blank}
|
||||||
|
|
||||||
--8<-- "YouTube_icon.svg"
|
--8<-- "YouTube_icon.svg"
|
||||||
[Creating an image processing pipeline](https://www.youtube.com/watch?v=DrmOpjAunlQ){target=blank}
|
[Creating an image processing pipeline](https://www.youtube.com/watch?v=DrmOpjAunlQ){target=blank}
|
||||||
|
|
|
@ -17,10 +17,10 @@ Try out some of the following Knative samples:
|
||||||
|
|
||||||
## :page_with_curl: Explore the Knative docs
|
## :page_with_curl: Explore the Knative docs
|
||||||
|
|
||||||
See the following guides for documentation specific to your role:
|
See the following guides for documentation specific to your use case:
|
||||||
|
|
||||||
- [Developer Guide](../developer/README.md)
|
- [Serving Guide](../serving/README.md)
|
||||||
- [Admin Guide](../admin/README.md)
|
- [Eventing Guide](../eventing/README.md)
|
||||||
|
|
||||||
## :book: Knative books
|
## :book: Knative books
|
||||||
|
|
||||||
|
|
|
@ -90,7 +90,7 @@ Follow the procedure for the Channel of your choice:
|
||||||
|
|
||||||
<!-- TODO(https://github.com/knative/docs/issues/2153): Add more Channels here -->
|
<!-- TODO(https://github.com/knative/docs/issues/2153): Add more Channels here -->
|
||||||
|
|
||||||
You can change the default channel implementation by following the instructions described in the [Configure Channel defaults](../../admin/eventing/channel-configuration.md) section.
|
You can change the default channel implementation by following the instructions described in the [Configure Channel defaults](../../eventing/configuration/channel-configuration.md) section.
|
||||||
|
|
||||||
## Optional: Install a Broker layer:
|
## Optional: Install a Broker layer:
|
||||||
|
|
||||||
|
@ -215,7 +215,7 @@ The following tabs expand to show instructions for installing each Eventing exte
|
||||||
kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-sink.yaml")}}
|
kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka-broker",file="eventing-kafka-sink.yaml")}}
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, see the [Kafka Sink](../../developer/eventing/sinks/kafka-sink.md) documentation.
|
For more information, see the [Kafka Sink](../../eventing/sinks/kafka-sink.md) documentation.
|
||||||
|
|
||||||
=== "Sugar Controller"
|
=== "Sugar Controller"
|
||||||
|
|
||||||
|
@ -271,7 +271,7 @@ The following tabs expand to show instructions for installing each Eventing exte
|
||||||
kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka",file="source.yaml")}}
|
kubectl apply -f {{ artifact(org="knative-sandbox",repo="eventing-kafka",file="source.yaml")}}
|
||||||
```
|
```
|
||||||
|
|
||||||
To learn more, try the [Apache Kafka source sample](../../developer/eventing/sources/kafka-source/README.md).
|
To learn more, try the [Apache Kafka source sample](../../eventing/sources/kafka-source/README.md).
|
||||||
|
|
||||||
|
|
||||||
=== "GCP Sources"
|
=== "GCP Sources"
|
||||||
|
|
|
@ -113,7 +113,7 @@ location. This section is only needed when the registry images do not match the
|
||||||
|
|
||||||
- `imagePullSecrets`: a list of Secret names used when pulling Knative container images. The Secrets
|
- `imagePullSecrets`: a list of Secret names used when pulling Knative container images. The Secrets
|
||||||
must be created in the same namespace as the Knative Serving Deployments. See
|
must be created in the same namespace as the Knative Serving Deployments. See
|
||||||
[deploying images from a private container registry](../../developer/serving/deploying-from-private-registry.md) for configuration details.
|
[deploying images from a private container registry](../../serving/deploying-from-private-registry.md) for configuration details.
|
||||||
|
|
||||||
|
|
||||||
### Download images in a predefined format without secrets:
|
### Download images in a predefined format without secrets:
|
||||||
|
@ -239,7 +239,7 @@ spec:
|
||||||
|
|
||||||
## SSL certificate for controller
|
## SSL certificate for controller
|
||||||
|
|
||||||
To [enable tag to digest resolution](../../developer/serving/tag-resolution.md), the Knative Serving controller needs to access the container registry.
|
To [enable tag to digest resolution](../../serving/tag-resolution.md), the Knative Serving controller needs to access the container registry.
|
||||||
To allow the controller to trust a self-signed registry cert, you can use the Operator to specify the certificate using a ConfigMap or Secret.
|
To allow the controller to trust a self-signed registry cert, you can use the Operator to specify the certificate using a ConfigMap or Secret.
|
||||||
|
|
||||||
Specify the following fields in `spec.controller-custom-certs` to select a custom registry certificate:
|
Specify the following fields in `spec.controller-custom-certs` to select a custom registry certificate:
|
||||||
|
|
|
@ -61,13 +61,13 @@ For more information on the resources and their interactions, see the [Resource
|
||||||
|
|
||||||
## Debugging Knative Serving issues
|
## Debugging Knative Serving issues
|
||||||
|
|
||||||
- [Debugging application issues](../developer/serving/troubleshooting/debugging-application-issues.md)
|
- [Debugging application issues](../serving/troubleshooting/debugging-application-issues.md)
|
||||||
|
|
||||||
## Configuration and Networking
|
## Configuration and Networking
|
||||||
|
|
||||||
- [Configuring cluster local routes](../developer/serving/services/private-services.md)
|
- [Configuring cluster local routes](../serving/services/private-services.md)
|
||||||
- [Using a custom domain](using-a-custom-domain.md)
|
- [Using a custom domain](using-a-custom-domain.md)
|
||||||
- [Traffic management](../developer/serving/traffic-management.md)
|
- [Traffic management](../serving/traffic-management.md)
|
||||||
|
|
||||||
## Observability
|
## Observability
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Revision garbage collection
|
# Revision garbage collection
|
||||||
|
|
||||||
Knative automatically cleans up inactive revisions as configured by the Operator. For more information, see the [Operator settings](../admin/serving/revision-gc.md).
|
Knative automatically cleans up inactive revisions as configured by the Operator. For more information, see the [Operator settings](../serving/configuration/revision-gc.md).
|
||||||
|
|
||||||
You can configure a revision so that it is never garbage collected by adding the `serving.knative.dev/no-gc: "true"` annotation:
|
You can configure a revision so that it is never garbage collected by adding the `serving.knative.dev/no-gc: "true"` annotation:
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
You can configure the `rollout-duration` parameter per Knative Service or Route by using an annotation.
|
You can configure the `rollout-duration` parameter per Knative Service or Route by using an annotation.
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
For information about global, ConfigMap configurations for rollout durations, see the [Administration guide](../../admin/serving/rolling-out-latest-revision-configmap.md).
|
For information about global, ConfigMap configurations for rollout durations, see the [Administration guide](configuration/rolling-out-latest-revision-configmap.md).
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
apiVersion: serving.knative.dev/v1
|
apiVersion: serving.knative.dev/v1
|
|
@ -9,7 +9,7 @@ Serving resources and how they can be applied across common use cases.
|
||||||
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||||
| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](hello-world/helloworld-csharp/), [Go](hello-world/helloworld-go/README.md), [Java (Spark)](hello-world/helloworld-java-spark/README.md), [Java (Spring)](hello-world/helloworld-java-spring/README.md), [Kotlin](hello-world/helloworld-kotlin/README.md), [Node.js](hello-world/helloworld-nodejs/README.md), [PHP](hello-world/helloworld-php/README.md), [Python](hello-world/helloworld-python/README.md), [Ruby](hello-world/helloworld-ruby/README.md), [Scala](hello-world/helloworld-scala/README.md), [Shell](hello-world/helloworld-shell/README.md) |
|
| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](hello-world/helloworld-csharp/), [Go](hello-world/helloworld-go/README.md), [Java (Spark)](hello-world/helloworld-java-spark/README.md), [Java (Spring)](hello-world/helloworld-java-spring/README.md), [Kotlin](hello-world/helloworld-kotlin/README.md), [Node.js](hello-world/helloworld-nodejs/README.md), [PHP](hello-world/helloworld-php/README.md), [Python](hello-world/helloworld-python/README.md), [Ruby](hello-world/helloworld-ruby/README.md), [Scala](hello-world/helloworld-scala/README.md), [Shell](hello-world/helloworld-shell/README.md) |
|
||||||
| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](cloudevents/cloudevents-dotnet/README.md), [Go](cloudevents/cloudevents-go/README.md), [Node.js](cloudevents/cloudevents-nodejs/README.md), [Rust](cloudevents/cloudevents-rust/README.md), [Java (Vert.x)](cloudevents/cloudevents-vertx/README.md) |
|
| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](cloudevents/cloudevents-dotnet/README.md), [Go](cloudevents/cloudevents-go/README.md), [Node.js](cloudevents/cloudevents-nodejs/README.md), [Rust](cloudevents/cloudevents-rust/README.md), [Java (Vert.x)](cloudevents/cloudevents-vertx/README.md) |
|
||||||
| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](../../developer/serving/traffic-management.md#routing-and-managing-traffic-with-bluegreen-deployment) |
|
| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](../../serving/traffic-management.md#routing-and-managing-traffic-with-bluegreen-deployment) |
|
||||||
| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/README.md) |
|
| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/README.md) |
|
||||||
| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](gitwebhook-go/README.md) |
|
| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](gitwebhook-go/README.md) |
|
||||||
| gRPC | A simple gRPC server. | [Go](grpc-ping-go/README.md) |
|
| gRPC | A simple gRPC server. | [Go](grpc-ping-go/README.md) |
|
||||||
|
@ -17,5 +17,5 @@ Serving resources and how they can be applied across common use cases.
|
||||||
| Kong Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Kong API gateway. | [Go](kong-routing-go/README.md) |
|
| Kong Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Kong API gateway. | [Go](kong-routing-go/README.md) |
|
||||||
| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](secrets-go/README.md) |
|
| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](secrets-go/README.md) |
|
||||||
| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](rest-api-go/README.md) |
|
| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](rest-api-go/README.md) |
|
||||||
| Traffic Splitting | This samples builds off the [Creating a RESTful Service](rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](../../developer/serving/traffic-management.md) |
|
| Traffic Splitting | This samples builds off the [Creating a RESTful Service](rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](../../serving/traffic-management.md) |
|
||||||
| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](multi-container/README.md) |
|
| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](multi-container/README.md) |
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
{{ feature(beta="0.24") }}
|
{{ feature(beta="0.24") }}
|
||||||
|
|
||||||
By providing the reference to an existing _TLS Certificate_ you can instruct a `DomainMapping` to use that
|
By providing the reference to an existing _TLS Certificate_ you can instruct a `DomainMapping` to use that
|
||||||
certificate to secure the mapped service. Using this feature skips [autoTLS](../../../serving/using-auto-tls.md) certificate creation.
|
certificate to secure the mapped service. Using this feature skips [autoTLS](../using-auto-tls.md) certificate creation.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
|
@ -6,8 +6,8 @@ You can create a Knative service by applying a YAML file or using the `kn servic
|
||||||
|
|
||||||
To create a Knative service, you will need:
|
To create a Knative service, you will need:
|
||||||
|
|
||||||
* A Kubernetes cluster with Knative Serving installed. For more information, see [Installing Knative](../../../install/README.md).
|
* A Kubernetes cluster with Knative Serving installed. For more information, see [Installing Knative Serving](../../install/serving/install-serving-with-yaml.md).
|
||||||
* Optional: To use the `kn service create` command, you must [install the `kn` CLI](../../../install/client/configure-kn.md).
|
* Optional: To use the `kn service create` command, you must [install the `kn` CLI](../../install/client/configure-kn.md).
|
||||||
|
|
||||||
## Procedure
|
## Procedure
|
||||||
|
|
|
@ -16,11 +16,11 @@ serve a Knative Service at this domain.
|
||||||
!!! tip
|
!!! tip
|
||||||
This topic instructs how to customize the domain of each service, regardless of the default domain.
|
This topic instructs how to customize the domain of each service, regardless of the default domain.
|
||||||
If you want to customize the domain template to assign the default domain name,
|
If you want to customize the domain template to assign the default domain name,
|
||||||
see [Changing the default domain](../../../serving/using-a-custom-domain.md).
|
see [Changing the default domain](../using-a-custom-domain.md).
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- You must have access to a Kubernetes cluster, with Knative Serving and an Ingress implementation installed. For more information, see the [Installation documentation](../../../install/README.md).
|
- You must have access to a Kubernetes cluster, with Knative Serving and an Ingress implementation installed. For more information, see the [Serving Installation documentation](../../install/serving/install-serving-with-yaml.md).
|
||||||
- You must have the domain mapping feature enabled on your cluster.
|
- You must have the domain mapping feature enabled on your cluster.
|
||||||
- You must have access to [a Knative service](creating-services.md) that you can map a domain to.
|
- You must have access to [a Knative service](creating-services.md) that you can map a domain to.
|
||||||
- You must own or have access to a domain name to map, and be able to change the domain DNS to point to your Knative cluster by using the tools provided by your domain registrar.
|
- You must own or have access to a domain name to map, and be able to change the domain DNS to point to your Knative cluster by using the tools provided by your domain registrar.
|
|
@ -1,6 +1,6 @@
|
||||||
# HTTPS redirection
|
# HTTPS redirection
|
||||||
|
|
||||||
Operators can force HTTPS redirection for all Services. See the `httpProtocol` mentioned in the [Turn on AutoTLS](../../../serving/using-auto-tls.md) page for more details.
|
Operators can force HTTPS redirection for all Services. See the `httpProtocol` mentioned in the [Turn on AutoTLS](../using-auto-tls.md) page for more details.
|
||||||
|
|
||||||
## Overriding the default HTTP behavior
|
## Overriding the default HTTP behavior
|
||||||
|
|
|
@ -7,7 +7,7 @@ Knative provides two ways to enable private services which are only available
|
||||||
inside the cluster:
|
inside the cluster:
|
||||||
|
|
||||||
1. To make all Knative Services private, change the default domain to
|
1. To make all Knative Services private, change the default domain to
|
||||||
`svc.cluster.local` by [editing the `config-domain` ConfigMap](../../../serving/using-a-custom-domain.md). This changes all Services deployed through Knative to only be published to the cluster.
|
`svc.cluster.local` by [editing the `config-domain` ConfigMap](../using-a-custom-domain.md). This changes all Services deployed through Knative to only be published to the cluster.
|
||||||
1. To make an individual Service private, the Service or Route can be
|
1. To make an individual Service private, the Service or Route can be
|
||||||
labelled with `networking.knative.dev/visibility=cluster-local` so that it is not published to the external gateway.
|
labelled with `networking.knative.dev/visibility=cluster-local` so that it is not published to the external gateway.
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ To configure a Knative Service so that it is only available on the cluster-local
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
You can deploy the [Hello World sample](../../../serving/samples/hello-world/helloworld-go/README.md) and then convert it to be an cluster-local Service by labelling the Service:
|
You can deploy the [Hello World sample](../samples/hello-world/helloworld-go/README.md) and then convert it to be an cluster-local Service by labelling the Service:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl label kservice helloworld-go networking.knative.dev/visibility=cluster-local
|
kubectl label kservice helloworld-go networking.knative.dev/visibility=cluster-local
|
|
@ -30,7 +30,7 @@ When a `tag` attribute is applied to a Route, an address for the specific traffi
|
||||||
|
|
||||||
In this example, you can access the staging target by accessing `staging-<route name>.<namespace>.<domain>`. The targets for `example-service-2` and `example-service-3` can only be accessed using the main route, `<route name>.<namespace>.<domain>`.
|
In this example, you can access the staging target by accessing `staging-<route name>.<namespace>.<domain>`. The targets for `example-service-2` and `example-service-3` can only be accessed using the main route, `<route name>.<namespace>.<domain>`.
|
||||||
|
|
||||||
When a traffic target is tagged, a new Kubernetes Service is created for that Service, so that other Services can access it within the cluster. From the previous example, a new Kubernetes Service called `staging-<route name>` will be created in the same namespace. This Service has the ability to override the visibility of this specific Route by applying the label `networking.knative.dev/visibility` with value `cluster-local`. See the documentation on [private services](../../developer/serving/services/private-services.md) for more information about how to restrict visibility on specific Routes.
|
When a traffic target is tagged, a new Kubernetes Service is created for that Service, so that other Services can access it within the cluster. From the previous example, a new Kubernetes Service called `staging-<route name>` will be created in the same namespace. This Service has the ability to override the visibility of this specific Route by applying the label `networking.knative.dev/visibility` with value `cluster-local`. See the documentation on [private services](services/private-services.md) for more information about how to restrict visibility on specific Routes.
|
||||||
|
|
||||||
## Traffic routing examples
|
## Traffic routing examples
|
||||||
|
|
|
@ -9,7 +9,7 @@ To change the {default-domain} value there are a few steps involved:
|
||||||
!!! tip
|
!!! tip
|
||||||
Customizing a domain template affects your cluster globally.
|
Customizing a domain template affects your cluster globally.
|
||||||
If you want to customize the domain of each service, use `DomainMapping` instead.
|
If you want to customize the domain of each service, use `DomainMapping` instead.
|
||||||
For more information, see [Configuring custom domains](../developer/serving/services/custom-domains.md).
|
For more information, see [Configuring custom domains](services/custom-domains.md).
|
||||||
|
|
||||||
## Edit using kubectl
|
## Edit using kubectl
|
||||||
|
|
||||||
|
|
|
@ -13,7 +13,7 @@ Before installing Knative, you must meet the following prerequisites:
|
||||||
- If you have multiple nodes in your cluster, for each node you need at least 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
- If you have multiple nodes in your cluster, for each node you need at least 2 CPUs, 4 GB of memory, and 20 GB of disk storage.
|
||||||
- You have a cluster that uses Kubernetes v1.20 or newer.
|
- You have a cluster that uses Kubernetes v1.20 or newer.
|
||||||
- You have installed the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
- You have installed the [`kubectl` CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
||||||
- Your Kubernetes cluster must have access to the internet, because Kubernetes needs to be able to fetch images. To pull from a private registry, see [Deploying images from a private container registry](/docs/developer/serving/deploying-from-private-registry/).
|
- Your Kubernetes cluster must have access to the internet, because Kubernetes needs to be able to fetch images. To pull from a private registry, see [Deploying images from a private container registry](/docs/serving/deploying-from-private-registry/).
|
||||||
|
|
||||||
!!! caution
|
!!! caution
|
||||||
The system requirements provided are recommendations only. The requirements for your installation might vary, depending on whether you use optional components, such as a networking layer.
|
The system requirements provided are recommendations only. The requirements for your installation might vary, depending on whether you use optional components, such as a networking layer.
|
||||||
|
|
Loading…
Reference in New Issue