From 2ee82f4454ea981ac68e6db0ab8e7909c8bbdda3 Mon Sep 17 00:00:00 2001 From: Ben Moss Date: Fri, 2 Jul 2021 14:55:40 -0400 Subject: [PATCH] Split mkdocs config into separate files (#3928) --- config/nav.yml | 242 ++++++++++++++++++++++++++++++++ config/redirects.yml | 80 +++++++++++ mkdocs.yml | 320 +------------------------------------------ 3 files changed, 324 insertions(+), 318 deletions(-) create mode 100644 config/nav.yml create mode 100644 config/redirects.yml diff --git a/config/nav.yml b/config/nav.yml new file mode 100644 index 000000000..d1f5c84dd --- /dev/null +++ b/config/nav.yml @@ -0,0 +1,242 @@ +INHERIT: redirects.yml + +nav: + - Home: index.md + - Getting Started: + - Before you begin: getting-started/README.md + - Knative Quickstart: getting-started/install-knative-quickstart.md + - Using Knative Serving: + - First Knative Service: getting-started/first-service.md + - Scaling to Zero: getting-started/first-autoscale.md + - Traffic Splitting: getting-started/first-traffic-split.md + - Using Knative Eventing: + - Introducing Knative Eventing: getting-started/getting-started-eventing.md + - Sources, Brokers, Triggers, Sinks: getting-started/first-broker.md + - Introducing the CloudEvents Player: getting-started/first-source.md + - Creating your first Trigger: getting-started/first-trigger.md + - Clean Up: getting-started/clean-up.md + - What's Next?: getting-started/next-steps.md + # Administration guide + - Administration guide: + - Overview: admin/README.md + - Installing Knative: + - Overview: admin/install/README.md + # Serving Installation + - Install Knative Serving: + - Install Serving with YAML: admin/install/serving/install-serving-with-yaml.md + - Knative Serving installation files: admin/install/serving/serving-installation-files.md + # Eventing Installation + - Install Knative Eventing: + - Install Eventing with YAML: admin/install/eventing/install-eventing-with-yaml.md + - Knative Eventing installation files: admin/install/eventing/eventing-installation-files.md + # Operator Installation + - Knative Operator: + - Installing with the Operator: admin/install/knative-with-operators.md + - Configuring Knative Eventing CRDs: admin/install/operator/configuring-eventing-cr.md + - Configuring Knative Serving CRDs: admin/install/operator/configuring-serving-cr.md + # Istio Installation + - Installing Istio for Knative: admin/install/installing-istio.md + # Vendor docs + - Using a Knative-based Offering: admin/install/knative-offerings.md + - Checking your Knative version: check-install-version.md + - Upgrading your installation: + - Overview: admin/upgrade/README.md + - Upgrading with the Knative Operator: admin/upgrade/upgrade-installation-with-operator.md + - Upgrading with kubectl: admin/upgrade/upgrade-installation.md + - Logging: admin/collecting-logs/README.md + # Administrator metrics + - Metrics: + - About metrics: admin/collecting-metrics/README.md + - Knative Eventing metrics: admin/collecting-metrics/eventing-metrics/metrics.md + - Knative Serving metrics: admin/collecting-metrics/serving-metrics/metrics.md + - Uninstalling Knative: admin/install/uninstall.md + # Serving config + - Knative Serving configuration: + - Configure Deployment resources: admin/serving/deployment.md + # Eventing config + - Knative Eventing configuration: + - Configure Broker defaults: admin/eventing/broker-configuration.md + - Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md + # Developer guide + - Developer guide: + - Overview: developer/README.md + - Knative Serving: + - Services: + - About Knative Services: developer/serving/services/README.md + - Creating a Service: developer/serving/services/creating-services.md + - Configuring private Services: developer/serving/services/private-services.md + - Configuring custom domains: developer/serving/services/custom-domains.md + - Configure resource requests and limits: developer/serving/services/configure-requests-limits-services.md + - Troubleshooting: + - Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md + - Knative Eventing: + - Event sources: + - ApiServerSource: + - Overview: developer/eventing/sources/apiserversource/README.md + - Creating an ApiServerSource object: developer/eventing/sources/apiserversource/getting-started/README.md + - ApiServerSource reference: developer/eventing/sources/apiserversource/reference.md + - ContainerSource: + - Creating a ContainerSource object: developer/eventing/sources/containersource/README.md + - ContainerSource Reference: developer/eventing/sources/containersource/reference.md + - Event delivery: developer/eventing/event-delivery.md + - Event sinks: + - About sinks: developer/eventing/sinks/README.md + - KafkaSink: developer/eventing/sinks/kafka-sink.md + # Developer concepts + - Concepts: + - Duck typing: developer/concepts/duck-typing.md + # Serving + - Knative Serving: + - Overview: serving/README.md + - Developer Topics: + - Deploying from private registries: serving/deploying-from-private-registry.md + - Tag resolution: serving/tag-resolution.md + - Gradually rolling out latest Revisions: serving/rolling-out-latest-revision.md + - Creating and using Subroutes: serving/using-subroutes.md + - Load balancing: + - Overview: serving/load-balancing/README.md + - Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md + - Autoscaling: + - Overview: serving/autoscaling/README.md + - Supported autoscaler types: serving/autoscaling/autoscaler-types.md + - Metrics: serving/autoscaling/autoscaling-metrics.md + - Targets: serving/autoscaling/autoscaling-targets.md + - Configuring scale to zero: serving/autoscaling/scale-to-zero.md + - Configuring concurrency: serving/autoscaling/concurrency.md + - Configuring the requests per second (RPS) target: serving/autoscaling/rps-target.md + - Configuring scale bounds: serving/autoscaling/scale-bounds.md + - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md + - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md + # Admin topics - serving + - Administrator Topics: + - Kubernetes services: serving/knative-kubernetes-services.md + - Accessing request traces: serving/accessing-traces.md + - Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md + - Exclude namespaces from the Knative webhook: serving/webhook-customizations.md + - Configuring high-availability components: serving/config-ha.md + - Installing cert-manager: serving/installing-cert-manager.md + - Configuring HTTPS connections: serving/using-a-tls-cert.md + - Enabling auto-TLS certs: serving/using-auto-tls.md + - Feature/Extension Flags: serving/feature-flags.md + - Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md + - Setting up a custom domain: serving/using-a-custom-domain.md + - Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md + - Code samples: + - Overview: serving/samples/README.md + - Routing and managing traffic: serving/samples/blue-green-deployment.md + - Cloud Events apps: + - Overview: serving/samples/cloudevents/README.md + - .NET: serving/samples/cloudevents/cloudevents-dotnet/README.md + - Go: serving/samples/cloudevents/cloudevents-go/README.md + - Node.js: serving/samples/cloudevents/cloudevents-nodejs/README.md + - Rust: serving/samples/cloudevents/cloudevents-rust/README.md + - Java and Spring: serving/samples/cloudevents/cloudevents-spring/README.md + - Java and Vert.x: serving/samples/cloudevents/cloudevents-vertx/README.md + - GitHub Webhook - Go: serving/samples/gitwebhook-go/README.md + - gRPC Server - Go: serving/samples/grpc-ping-go/README.md + - Hello world apps: + - Overview: serving/samples/hello-world/README.md + - .NET: serving/samples/hello-world/helloworld-csharp/README.md + - Go: serving/samples/hello-world/helloworld-go/README.md + - Java (Spark): serving/samples/hello-world/helloworld-java-spark/README.md + - Hello World - Spring Boot Java: serving/samples/hello-world/helloworld-java-spring/README.md + - Kotlin: serving/samples/hello-world/helloworld-kotlin/README.md + - Node.js: serving/samples/hello-world/helloworld-nodejs/README.md + - PHP: serving/samples/hello-world/helloworld-php/README.md + - Python: serving/samples/hello-world/helloworld-python/README.md + - Ruby: serving/samples/hello-world/helloworld-ruby/README.md + - Scala: serving/samples/hello-world/helloworld-scala/README.md + - Shell: serving/samples/hello-world/helloworld-shell/README.md + - Routing services - Go: serving/samples/knative-routing-go/README.md + - multi-container samples: serving/samples/multi-container/README.md + - RESTful service - Go: serving/samples/rest-api-go/README.md + - Secrets - Go: serving/samples/secrets-go/README.md + - Tag Header Based Routing: serving/samples/tag-header-based-routing/README.md + - Traffic splitting: serving/samples/traffic-splitting/README.md + # Eventing + - Knative Eventing: + - Overview: eventing/README.md + - Getting started: eventing/getting-started.md + - Event sources: + - Overview: eventing/sources/README.md + - PingSource: eventing/sources/ping-source/README.md + - SinkBinding: + - Overview: eventing/sources/sinkbinding/README.md + - Creating a SinkBinding object: eventing/sources/sinkbinding/getting-started.md + - SinkBinding reference: eventing/sources/sinkbinding/reference.md + - Camel source: eventing/sources/apache-camel-source/README.md + - Kafka source: eventing/sources/kafka-source/README.md + - Creating an event source: + - Overview: eventing/sources/creating-event-sources/README.md + - Writing an event source using Javascript: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md + - Using the sample event source: + - Overview: eventing/sources/creating-event-sources/writing-event-source/README.md + - Design of an Event Source: eventing/sources/creating-event-sources/writing-event-source/01-theory.md + - Lifecycle and Types: eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md + - Controller Implemetation: eventing/sources/creating-event-sources/writing-event-source/03-controller.md + - Reconciler Implementation: eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md + - Receive Adapter Implementation: eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md + - Publishing to your cluster: eventing/sources/creating-event-sources/writing-event-source/06-yaml.md + - Moving to knative-sandbox: eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md + - Event registry: eventing/event-registry.md + - Flows: + - Overview: eventing/flows/README.md + - Parallel: eventing/flows/parallel.md + - Sequence: + - Overview: eventing/flows/sequence/README.md + - Displaying sequence output: eventing/flows/sequence/sequence-reply-to-event-display/README.md + - Using Sequences in series: eventing/flows/sequence/sequence-reply-to-sequence/README.md + - Create additional events: eventing/flows/sequence/sequence-terminal/README.md + - Using with Broker and Trigger: eventing/flows/sequence/sequence-with-broker-trigger/README.md + - Channels: + - Overview: eventing/channels/README.md + - Channel types and defaults: eventing/channels/channel-types-defaults.md + - Creating a channel using cluster or namespace defaults: eventing/channels/create-default-channel.md + - Available Channels: eventing/channels/channels-crds.md + - Subscriptions: eventing/channels/subscriptions.md + - Sugar Controller: eventing/sugar/README.md + - Brokers: + - Overview: eventing/broker/README.md + - Creating a broker: eventing/broker/create-mtbroker.md + - Triggers: eventing/broker/triggers/README.md + - Broker configuration example: eventing/broker/example-mtbroker.md + - Apache Kafka Broker: + - Overview: eventing/broker/kafka-broker/README.md + - Debugging: eventing/debugging/README.md + - Accessing CloudEvent traces: eventing/accessing-traces.md + - Experimental Features: eventing/experimental-features.md + - Code samples: + - Overview: eventing/samples/README.md + - Container source: eventing/sources/container-source/README.md + - Hello World: + - Overview: eventing/samples/helloworld/README.md + - GO: eventing/samples/helloworld/helloworld-go/README.md + - Python: eventing/samples/helloworld/helloworld-python/README.md + - Apache Kafka: + - Overview: eventing/samples/kafka/README.md + - Binding Example: eventing/samples/kafka/binding/README.md + - Channel Example: eventing/samples/kafka/channel/README.md + - Parallel: + - Overview: eventing/samples/parallel/README.md + - Multiple Cases: eventing/samples/parallel/multiple-branches/README.md + - Mutual Exclusivity: eventing/samples/parallel/mutual-exclusivity/README.md + - CloudAuditLogsSource: eventing/sources/cloud-audit-logs-source/README.md + - CloudPubSubSource: eventing/sources/cloud-pubsub-source/README.md + - CloudSchedulerSource: eventing/sources/cloud-scheduler-source/README.md + - CloudStorageSource: eventing/sources/cloud-storage-source/README.md + - GitHub source: eventing/sources/github-source/README.md + - GitLab source: eventing/sources/gitlab-source/README.md + - IoT core: eventing/samples/iot-core/README.md + # Reference docs + - Reference: + - Serving: reference/api/serving-api.md + - Eventing: reference/api/eventing-api.md + # Client + - Client: + - Overview: client/README.md + - Installing kn: client/install-kn.md + - Customizing kn: client/configure-kn.md + - kn plugins: client/kn-plugins.md + - "Join the Community ➠": /community/ + - "Read the Blog ➠": /blog/ + diff --git a/config/redirects.yml b/config/redirects.yml new file mode 100644 index 000000000..02b59f467 --- /dev/null +++ b/config/redirects.yml @@ -0,0 +1,80 @@ +plugins: + - redirects: + redirect_maps: + admin/install/install-eventing-with-yaml.md: admin/install/eventing/install-eventing-with-yaml.md + admin/install/install-serving-with-yaml.md: admin/install/serving/install-serving-with-yaml.md + client/connecting-kn-to-your-cluster/index.md: 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/index.md: eventing/broker/kafka-broker/README.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: admin/collecting-metrics/eventing-metrics/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/sources/cloud-pubsub-source/README.md + eventing/samples/kubernetes-event-source/index.md: developer/eventing/sources/apiserversource/getting-started/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/sources/sinkbinding/README.md + eventing/samples/writing-event-source-easy-way/index.md: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md + eventing/samples/writing-event-source/01-theory/index.md: eventing/sources/creating-event-sources/writing-event-source/01-theory.md + eventing/samples/writing-event-source/02-lifecycle-and-types/index.md: eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md + eventing/samples/writing-event-source/03-controller/index.md: eventing/sources/creating-event-sources/writing-event-source/03-controller.md + eventing/samples/writing-event-source/04-reconciler/index.md: eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md + eventing/samples/writing-event-source/05-receive-adapter/index.md: eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md + eventing/samples/writing-event-source/06-yaml/index.md: eventing/sources/creating-event-sources/writing-event-source/06-yaml.md + eventing/samples/writing-event-source/07-knative-sandbox/index.md: eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md + eventing/samples/writing-event-source/index.md: eventing/sources/creating-event-sources/writing-event-source/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: eventing/sources/ping-source/README.md + eventing/triggers/index.md: eventing/broker/triggers/README.md + help/README.md: help/contributor/README.md + install/README.md: admin/install/README.md + install/check-install-version.md: check-install-version.md + install/collecting-logs/index.md: admin/collecting-logs/README.md + install/collecting-metrics/index.md: admin/collecting-metrics/README.md + install/getting-started-knative-app/index.md: serving/getting-started-knative-app.md + install/install-eventing-with-yaml.md: admin/install/eventing/install-eventing-with-yaml.md + # This doesn't exist anymore, we should probably replace it + install/install-extensions.md: admin/install/README.md + install/install-kn/index.md: client/install-kn.md + install/install-serving-with-yaml.md: admin/install/serving/install-serving-with-yaml.md + install/installation-files.md: admin/install/README.md + install/installing-istio.md: admin/install/installing-istio.md + install/knative-offerings.md: admin/install/knative-offerings.md + install/knative-with-operators.md: admin/install/knative-with-operators.md + install/operator/configuring-eventing-cr.md: admin/install/operator/configuring-eventing-cr.md + install/operator/configuring-serving-cr.md: admin/install/operator/configuring-serving-cr.md + install/prerequisites.md: admin/install/README.md + operator/configuring-eventing-cr/index.md: admin/install/operator/configuring-eventing-cr.md + operator/configuring-serving-cr/index.md: admin/install/operator/configuring-serving-cr.md + reference/resources/index.md: client/README.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/configuring-autoscaling/index.md: serving/autoscaling/README.md + serving/creating-domain-mappings.md: developer/serving/services/custom-domains.md + serving/debugging-application-issues.md: developer/serving/troubleshooting/debugging-application-issues.md + serving/metrics.md: admin/collecting-metrics/serving-metrics/metrics.md + serving/samples/autoscale-go/index.md: serving/autoscaling/autoscale-go/README.md + serving/services/README.md: developer/serving/services/README.md + serving/services/creating-services.md: developer/serving/services/creating-services.md + serving/services/deployment.md: admin/serving/deployment.md + serving/services/private-services.md: developer/serving/services/private-services.md + serving/using-an-ssl-cert/index.md: serving/using-a-tls-cert.md + uninstall.md: admin/install/uninstall.md + upgrade/index.md: admin/upgrade/README.md + upgrade/upgrade-installation-with-operator.md: admin/upgrade/upgrade-installation-with-operator.md + upgrade/upgrade-installation.md: admin/upgrade/upgrade-installation.md + + diff --git a/mkdocs.yml b/mkdocs.yml index ff88d4250..15a8b21ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,5 @@ +INHERIT: config/nav.yml + site_name: Knative site_url: https://knative.dev/docs site_description: Knative Documentation @@ -7,246 +9,6 @@ extra_css: repo_url: https://github.com/knative/docs edit_uri: edit/mkdocs/docs -nav: - - Home: index.md - - Getting Started: - - Before you begin: getting-started/README.md - - Knative Quickstart: getting-started/install-knative-quickstart.md - - Using Knative Serving: - - First Knative Service: getting-started/first-service.md - - Scaling to Zero: getting-started/first-autoscale.md - - Traffic Splitting: getting-started/first-traffic-split.md - - Using Knative Eventing: - - Introducing Knative Eventing: getting-started/getting-started-eventing.md - - Sources, Brokers, Triggers, Sinks: getting-started/first-broker.md - - Introducing the CloudEvents Player: getting-started/first-source.md - - Creating your first Trigger: getting-started/first-trigger.md - - Clean Up: getting-started/clean-up.md - - What's Next?: getting-started/next-steps.md - # Administration guide - - Administration guide: - - Overview: admin/README.md - - Installing Knative: - - Overview: admin/install/README.md - # Serving Installation - - Install Knative Serving: - - Install Serving with YAML: admin/install/serving/install-serving-with-yaml.md - - Knative Serving installation files: admin/install/serving/serving-installation-files.md - # Eventing Installation - - Install Knative Eventing: - - Install Eventing with YAML: admin/install/eventing/install-eventing-with-yaml.md - - Knative Eventing installation files: admin/install/eventing/eventing-installation-files.md - # Operator Installation - - Knative Operator: - - Installing with the Operator: admin/install/knative-with-operators.md - - Configuring Knative Eventing CRDs: admin/install/operator/configuring-eventing-cr.md - - Configuring Knative Serving CRDs: admin/install/operator/configuring-serving-cr.md - # Istio Installation - - Installing Istio for Knative: admin/install/installing-istio.md - # Vendor docs - - Using a Knative-based Offering: admin/install/knative-offerings.md - - Checking your Knative version: check-install-version.md - - Upgrading your installation: - - Overview: admin/upgrade/README.md - - Upgrading with the Knative Operator: admin/upgrade/upgrade-installation-with-operator.md - - Upgrading with kubectl: admin/upgrade/upgrade-installation.md - - Logging: admin/collecting-logs/README.md - # Administrator metrics - - Metrics: - - About metrics: admin/collecting-metrics/README.md - - Knative Eventing metrics: admin/collecting-metrics/eventing-metrics/metrics.md - - Knative Serving metrics: admin/collecting-metrics/serving-metrics/metrics.md - - Uninstalling Knative: admin/install/uninstall.md - # Serving config - - Knative Serving configuration: - - Configure Deployment resources: admin/serving/deployment.md - # Eventing config - - Knative Eventing configuration: - - Configure Broker defaults: admin/eventing/broker-configuration.md - - Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md - # Developer guide - - Developer guide: - - Overview: developer/README.md - - Knative Serving: - - Services: - - About Knative Services: developer/serving/services/README.md - - Creating a Service: developer/serving/services/creating-services.md - - Configuring private Services: developer/serving/services/private-services.md - - Configuring custom domains: developer/serving/services/custom-domains.md - - Configure resource requests and limits: developer/serving/services/configure-requests-limits-services.md - - Troubleshooting: - - Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md - - Knative Eventing: - - Event sources: - - ApiServerSource: - - Overview: developer/eventing/sources/apiserversource/README.md - - Creating an ApiServerSource object: developer/eventing/sources/apiserversource/getting-started/README.md - - ApiServerSource reference: developer/eventing/sources/apiserversource/reference.md - - ContainerSource: - - Creating a ContainerSource object: developer/eventing/sources/containersource/README.md - - ContainerSource Reference: developer/eventing/sources/containersource/reference.md - - Event delivery: developer/eventing/event-delivery.md - - Event sinks: - - About sinks: developer/eventing/sinks/README.md - - KafkaSink: developer/eventing/sinks/kafka-sink.md - # Developer concepts - - Concepts: - - Duck typing: developer/concepts/duck-typing.md - # Serving - - Knative Serving: - - Overview: serving/README.md - - Developer Topics: - - Deploying from private registries: serving/deploying-from-private-registry.md - - Tag resolution: serving/tag-resolution.md - - Gradually rolling out latest Revisions: serving/rolling-out-latest-revision.md - - Creating and using Subroutes: serving/using-subroutes.md - - Load balancing: - - Overview: serving/load-balancing/README.md - - Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md - - Autoscaling: - - Overview: serving/autoscaling/README.md - - Supported autoscaler types: serving/autoscaling/autoscaler-types.md - - Metrics: serving/autoscaling/autoscaling-metrics.md - - Targets: serving/autoscaling/autoscaling-targets.md - - Configuring scale to zero: serving/autoscaling/scale-to-zero.md - - Configuring concurrency: serving/autoscaling/concurrency.md - - Configuring the requests per second (RPS) target: serving/autoscaling/rps-target.md - - Configuring scale bounds: serving/autoscaling/scale-bounds.md - - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md - - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md - # Admin topics - serving - - Administrator Topics: - - Kubernetes services: serving/knative-kubernetes-services.md - - Accessing request traces: serving/accessing-traces.md - - Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md - - Exclude namespaces from the Knative webhook: serving/webhook-customizations.md - - Configuring high-availability components: serving/config-ha.md - - Installing cert-manager: serving/installing-cert-manager.md - - Configuring HTTPS connections: serving/using-a-tls-cert.md - - Enabling auto-TLS certs: serving/using-auto-tls.md - - Feature/Extension Flags: serving/feature-flags.md - - Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md - - Setting up a custom domain: serving/using-a-custom-domain.md - - Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md - - Code samples: - - Overview: serving/samples/README.md - - Routing and managing traffic: serving/samples/blue-green-deployment.md - - Cloud Events apps: - - Overview: serving/samples/cloudevents/README.md - - .NET: serving/samples/cloudevents/cloudevents-dotnet/README.md - - Go: serving/samples/cloudevents/cloudevents-go/README.md - - Node.js: serving/samples/cloudevents/cloudevents-nodejs/README.md - - Rust: serving/samples/cloudevents/cloudevents-rust/README.md - - Java and Spring: serving/samples/cloudevents/cloudevents-spring/README.md - - Java and Vert.x: serving/samples/cloudevents/cloudevents-vertx/README.md - - GitHub Webhook - Go: serving/samples/gitwebhook-go/README.md - - gRPC Server - Go: serving/samples/grpc-ping-go/README.md - - Hello world apps: - - Overview: serving/samples/hello-world/README.md - - .NET: serving/samples/hello-world/helloworld-csharp/README.md - - Go: serving/samples/hello-world/helloworld-go/README.md - - Java (Spark): serving/samples/hello-world/helloworld-java-spark/README.md - - Hello World - Spring Boot Java: serving/samples/hello-world/helloworld-java-spring/README.md - - Kotlin: serving/samples/hello-world/helloworld-kotlin/README.md - - Node.js: serving/samples/hello-world/helloworld-nodejs/README.md - - PHP: serving/samples/hello-world/helloworld-php/README.md - - Python: serving/samples/hello-world/helloworld-python/README.md - - Ruby: serving/samples/hello-world/helloworld-ruby/README.md - - Scala: serving/samples/hello-world/helloworld-scala/README.md - - Shell: serving/samples/hello-world/helloworld-shell/README.md - - Routing services - Go: serving/samples/knative-routing-go/README.md - - multi-container samples: serving/samples/multi-container/README.md - - RESTful service - Go: serving/samples/rest-api-go/README.md - - Secrets - Go: serving/samples/secrets-go/README.md - - Tag Header Based Routing: serving/samples/tag-header-based-routing/README.md - - Traffic splitting: serving/samples/traffic-splitting/README.md - # Eventing - - Knative Eventing: - - Overview: eventing/README.md - - Getting started: eventing/getting-started.md - - Event sources: - - Overview: eventing/sources/README.md - - PingSource: eventing/sources/ping-source/README.md - - SinkBinding: - - Overview: eventing/sources/sinkbinding/README.md - - Creating a SinkBinding object: eventing/sources/sinkbinding/getting-started.md - - SinkBinding reference: eventing/sources/sinkbinding/reference.md - - Camel source: eventing/sources/apache-camel-source/README.md - - Kafka source: eventing/sources/kafka-source/README.md - - Creating an event source: - - Overview: eventing/sources/creating-event-sources/README.md - - Writing an event source using Javascript: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md - - Using the sample event source: - - Overview: eventing/sources/creating-event-sources/writing-event-source/README.md - - Design of an Event Source: eventing/sources/creating-event-sources/writing-event-source/01-theory.md - - Lifecycle and Types: eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md - - Controller Implemetation: eventing/sources/creating-event-sources/writing-event-source/03-controller.md - - Reconciler Implementation: eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md - - Receive Adapter Implementation: eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md - - Publishing to your cluster: eventing/sources/creating-event-sources/writing-event-source/06-yaml.md - - Moving to knative-sandbox: eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md - - Event registry: eventing/event-registry.md - - Flows: - - Overview: eventing/flows/README.md - - Parallel: eventing/flows/parallel.md - - Sequence: - - Overview: eventing/flows/sequence/README.md - - Displaying sequence output: eventing/flows/sequence/sequence-reply-to-event-display/README.md - - Using Sequences in series: eventing/flows/sequence/sequence-reply-to-sequence/README.md - - Create additional events: eventing/flows/sequence/sequence-terminal/README.md - - Using with Broker and Trigger: eventing/flows/sequence/sequence-with-broker-trigger/README.md - - Channels: - - Overview: eventing/channels/README.md - - Channel types and defaults: eventing/channels/channel-types-defaults.md - - Creating a channel using cluster or namespace defaults: eventing/channels/create-default-channel.md - - Available Channels: eventing/channels/channels-crds.md - - Subscriptions: eventing/channels/subscriptions.md - - Sugar Controller: eventing/sugar/README.md - - Brokers: - - Overview: eventing/broker/README.md - - Creating a broker: eventing/broker/create-mtbroker.md - - Triggers: eventing/broker/triggers/README.md - - Broker configuration example: eventing/broker/example-mtbroker.md - - Apache Kafka Broker: - - Overview: eventing/broker/kafka-broker/README.md - - Debugging: eventing/debugging/README.md - - Accessing CloudEvent traces: eventing/accessing-traces.md - - Experimental Features: eventing/experimental-features.md - - Code samples: - - Overview: eventing/samples/README.md - - Container source: eventing/sources/container-source/README.md - - Hello World: - - Overview: eventing/samples/helloworld/README.md - - GO: eventing/samples/helloworld/helloworld-go/README.md - - Python: eventing/samples/helloworld/helloworld-python/README.md - - Apache Kafka: - - Overview: eventing/samples/kafka/README.md - - Binding Example: eventing/samples/kafka/binding/README.md - - Channel Example: eventing/samples/kafka/channel/README.md - - Parallel: - - Overview: eventing/samples/parallel/README.md - - Multiple Cases: eventing/samples/parallel/multiple-branches/README.md - - Mutual Exclusivity: eventing/samples/parallel/mutual-exclusivity/README.md - - CloudAuditLogsSource: eventing/sources/cloud-audit-logs-source/README.md - - CloudPubSubSource: eventing/sources/cloud-pubsub-source/README.md - - CloudSchedulerSource: eventing/sources/cloud-scheduler-source/README.md - - CloudStorageSource: eventing/sources/cloud-storage-source/README.md - - GitHub source: eventing/sources/github-source/README.md - - GitLab source: eventing/sources/gitlab-source/README.md - - IoT core: eventing/samples/iot-core/README.md - # Reference docs - - Reference: - - Serving: reference/api/serving-api.md - - Eventing: reference/api/eventing-api.md - # Client - - Client: - - Overview: client/README.md - - Installing kn: client/install-kn.md - - Customizing kn: client/configure-kn.md - - kn plugins: client/kn-plugins.md - - "Join the Community ➠": /community/ - - "Read the Blog ➠": /blog/ - theme: name: material logo: images/logo/rgb/knative-logo-rgb.png @@ -302,84 +64,6 @@ plugins: filename: ".index" collapse_single_pages: true strict: false - # Redirects - - redirects: - redirect_maps: - admin/install/install-eventing-with-yaml.md: admin/install/eventing/install-eventing-with-yaml.md - admin/install/install-serving-with-yaml.md: admin/install/serving/install-serving-with-yaml.md - client/connecting-kn-to-your-cluster/index.md: 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/index.md: eventing/broker/kafka-broker/README.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: admin/collecting-metrics/eventing-metrics/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/sources/cloud-pubsub-source/README.md - eventing/samples/kubernetes-event-source/index.md: developer/eventing/sources/apiserversource/getting-started/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/sources/sinkbinding/README.md - eventing/samples/writing-event-source-easy-way/index.md: eventing/sources/creating-event-sources/writing-event-source-easy-way/README.md - eventing/samples/writing-event-source/01-theory/index.md: eventing/sources/creating-event-sources/writing-event-source/01-theory.md - eventing/samples/writing-event-source/02-lifecycle-and-types/index.md: eventing/sources/creating-event-sources/writing-event-source/02-lifecycle-and-types.md - eventing/samples/writing-event-source/03-controller/index.md: eventing/sources/creating-event-sources/writing-event-source/03-controller.md - eventing/samples/writing-event-source/04-reconciler/index.md: eventing/sources/creating-event-sources/writing-event-source/04-reconciler.md - eventing/samples/writing-event-source/05-receive-adapter/index.md: eventing/sources/creating-event-sources/writing-event-source/05-receive-adapter.md - eventing/samples/writing-event-source/06-yaml/index.md: eventing/sources/creating-event-sources/writing-event-source/06-yaml.md - eventing/samples/writing-event-source/07-knative-sandbox/index.md: eventing/sources/creating-event-sources/writing-event-source/07-knative-sandbox.md - eventing/samples/writing-event-source/index.md: eventing/sources/creating-event-sources/writing-event-source/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: eventing/sources/ping-source/README.md - eventing/triggers/index.md: eventing/broker/triggers/README.md - help/README.md: help/contributor/README.md - install/README.md: admin/install/README.md - install/check-install-version.md: check-install-version.md - install/collecting-logs/index.md: admin/collecting-logs/README.md - install/collecting-metrics/index.md: admin/collecting-metrics/README.md - install/getting-started-knative-app/index.md: serving/getting-started-knative-app.md - install/install-eventing-with-yaml.md: admin/install/eventing/install-eventing-with-yaml.md - # This doesn't exist anymore, we should probably replace it - install/install-extensions.md: admin/install/README.md - install/install-kn/index.md: client/install-kn.md - install/install-serving-with-yaml.md: admin/install/serving/install-serving-with-yaml.md - install/installation-files.md: admin/install/README.md - install/installing-istio.md: admin/install/installing-istio.md - install/knative-offerings.md: admin/install/knative-offerings.md - install/knative-with-operators.md: admin/install/knative-with-operators.md - install/operator/configuring-eventing-cr.md: admin/install/operator/configuring-eventing-cr.md - install/operator/configuring-serving-cr.md: admin/install/operator/configuring-serving-cr.md - install/prerequisites.md: admin/install/README.md - operator/configuring-eventing-cr/index.md: admin/install/operator/configuring-eventing-cr.md - operator/configuring-serving-cr/index.md: admin/install/operator/configuring-serving-cr.md - reference/resources/index.md: client/README.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/configuring-autoscaling/index.md: serving/autoscaling/README.md - serving/creating-domain-mappings.md: developer/serving/services/custom-domains.md - serving/debugging-application-issues.md: developer/serving/troubleshooting/debugging-application-issues.md - serving/metrics.md: admin/collecting-metrics/serving-metrics/metrics.md - serving/samples/autoscale-go/index.md: serving/autoscaling/autoscale-go/README.md - serving/services/README.md: developer/serving/services/README.md - serving/services/creating-services.md: developer/serving/services/creating-services.md - serving/services/deployment.md: admin/serving/deployment.md - serving/services/private-services.md: developer/serving/services/private-services.md - serving/using-an-ssl-cert/index.md: serving/using-a-tls-cert.md - uninstall.md: admin/install/uninstall.md - upgrade/index.md: admin/upgrade/README.md - upgrade/upgrade-installation-with-operator.md: admin/upgrade/upgrade-installation-with-operator.md - upgrade/upgrade-installation.md: admin/upgrade/upgrade-installation.md copyright: "Copyright © 2021 The Knative Authors"