From 0b4924f2b07037daf80bc6201dd97481641a25a1 Mon Sep 17 00:00:00 2001 From: Evan Anderson Date: Wed, 29 Oct 2025 10:10:41 -0700 Subject: [PATCH 1/2] Clean up absolute links in docs --- docs/snippets/about-brokers.md | 7 ------- docs/snippets/collecting-logs.md | 7 ++++++- docs/snippets/collecting-metrics.md | 5 +++++ docs/snippets/no-dns.md | 4 ++++ docs/snippets/prerequisites.md | 20 ------------------- docs/snippets/quickstart-prereqs.md | 4 ++-- docs/versioned/eventing/brokers/README.md | 4 +++- docs/versioned/eventing/faq/README.md | 2 +- .../serving/configuration/deployment.md | 2 +- docs/versioned/serving/request-flow.md | 2 +- 10 files changed, 23 insertions(+), 34 deletions(-) delete mode 100644 docs/snippets/about-brokers.md delete mode 100644 docs/snippets/prerequisites.md diff --git a/docs/snippets/about-brokers.md b/docs/snippets/about-brokers.md deleted file mode 100644 index d7e53dd9610..00000000000 --- a/docs/snippets/about-brokers.md +++ /dev/null @@ -1,7 +0,0 @@ - - -Brokers are Kubernetes custom resources that define an [event mesh](/docs/eventing/event-mesh) for collecting a pool of events. Brokers provide a discoverable endpoint for event ingress, and use Triggers for event delivery. Event producers can send events to a broker by POSTing the event. - -![Source 1 and Source 2 are transmitting some data -- ones and twos -- to the Broker, which then gets filtered by Triggers to the desired Sink.](https://user-images.githubusercontent.com/16281246/116248768-1fe56080-a73a-11eb-9a85-8bdccb82d16c.png){draggable=false} diff --git a/docs/snippets/collecting-logs.md b/docs/snippets/collecting-logs.md index f62a9cf05bc..d97b69621d2 100644 --- a/docs/snippets/collecting-logs.md +++ b/docs/snippets/collecting-logs.md @@ -1,9 +1,14 @@ + + # Logging You can use [Fluent Bit](https://docs.fluentbit.io/), a log processor and forwarder, to collect Kubernetes logs in a central directory. This is not required to run Knative, but can be helpful with -[Knative Serving](/docs/serving/), which automatically deletes pods and associated logs when they are no longer needed. +[Knative Serving](../../../serving/README.md), which automatically deletes pods and associated logs when they are no longer needed. Fluent Bit supports exporting to a number of other log providers. If you already have an existing log provider, for example, Splunk, Datadog, ElasticSearch, or Stackdriver, you can follow the [FluentBit documentation](https://docs.fluentbit.io/manual/pipeline/outputs) to configure log forwarders. diff --git a/docs/snippets/collecting-metrics.md b/docs/snippets/collecting-metrics.md index 813bb03b273..4fc42f54e01 100644 --- a/docs/snippets/collecting-metrics.md +++ b/docs/snippets/collecting-metrics.md @@ -1,3 +1,8 @@ + + # Collecting Metrics in Knative Knative leverages [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/) for exporting metrics. diff --git a/docs/snippets/no-dns.md b/docs/snippets/no-dns.md index a0826e52843..2a6bbd1f952 100644 --- a/docs/snippets/no-dns.md +++ b/docs/snippets/no-dns.md @@ -1,3 +1,7 @@ + === "No DNS" If you are using `curl` to access [the sample applications](/docs/getting-started/first-service/), or your own Knative app, and are unable to use the "Magic DNS (sslip.io)" or "Real DNS" methods, there is a temporary approach. This is useful for those who wish to evaluate Knative without altering their DNS configuration, as per the "Real DNS" method, or cannot use the "Magic DNS" method due to using, diff --git a/docs/snippets/prerequisites.md b/docs/snippets/prerequisites.md deleted file mode 100644 index 285ef089141..00000000000 --- a/docs/snippets/prerequisites.md +++ /dev/null @@ -1,20 +0,0 @@ -## Prerequisites - -Before installing Knative, you must meet the following prerequisites: - -- **For prototyping purposes**, Knative works on most local deployments of Kubernetes. For example, you can use a local, one-node cluster that has 3 CPUs and 4 GB of memory. - - !!! tip - You can install a local distribution of Knative for development purposes - using the [Knative Quickstart plugin](/docs/getting-started/quickstart-install/) - -- **For production purposes**, it is recommended that: - - - If you have only one node in your cluster, you need at least 6 CPUs, 6 GB of memory, and 30 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.28 or newer. -- 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/serving/deploying-from-private-registry/). - -!!! 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. diff --git a/docs/snippets/quickstart-prereqs.md b/docs/snippets/quickstart-prereqs.md index 455fefcad13..755dc1ed284 100644 --- a/docs/snippets/quickstart-prereqs.md +++ b/docs/snippets/quickstart-prereqs.md @@ -6,8 +6,8 @@ !!! warning Knative `quickstart` environments are for experimentation use only. - For a production ready installation, see the [YAML-based installation](/docs/install/yaml-install/) - or the [Knative Operator installation](/docs/install/operator/knative-with-operators/). + For a production ready installation, see the [YAML-based installation](../install/yaml-install/) + or the [Knative Operator installation](../install/operator/knative-with-operators/). Before you can get started with a Knative `quickstart` deployment you must install: diff --git a/docs/versioned/eventing/brokers/README.md b/docs/versioned/eventing/brokers/README.md index 08a4feb3410..bd82fa3f2bd 100644 --- a/docs/versioned/eventing/brokers/README.md +++ b/docs/versioned/eventing/brokers/README.md @@ -7,7 +7,9 @@ function: explanation # Brokers ---8<-- "about-brokers.md" +Brokers are Kubernetes custom resources that define an [event mesh](../event-mesh.md) for collecting a pool of events. Brokers provide a discoverable endpoint for event ingress, and use Triggers for event delivery. Event producers can send events to a broker by POSTing the event. + +![Source 1 and Source 2 are transmitting some data -- ones and twos -- to the Broker, which then gets filtered by Triggers to the desired Sink.](https://user-images.githubusercontent.com/16281246/116248768-1fe56080-a73a-11eb-9a85-8bdccb82d16c.png){draggable=false} ## Event delivery diff --git a/docs/versioned/eventing/faq/README.md b/docs/versioned/eventing/faq/README.md index 72cc7b3b06b..d942bd4efa1 100644 --- a/docs/versioned/eventing/faq/README.md +++ b/docs/versioned/eventing/faq/README.md @@ -10,4 +10,4 @@ function: reference ## What is a Sugar Controller? The Sugar Controller is an optional controller which will automatically create and clean up brokers based on the creation/deletion of namespaces and triggers. -For more information on how to enable and configure the sugar controller, read the [sugar controller documentation](/docs/eventing/sugar). +For more information on how to enable and configure the sugar controller, read the [sugar controller documentation](../sugar/README.md). diff --git a/docs/versioned/serving/configuration/deployment.md b/docs/versioned/serving/configuration/deployment.md index 4b6e7383697..357bfb1b6c6 100644 --- a/docs/versioned/serving/configuration/deployment.md +++ b/docs/versioned/serving/configuration/deployment.md @@ -180,4 +180,4 @@ The setting works with Service labels and will configure either a default or one See [Kubernetes RuntimeClass](https://kubernetes.io/docs/concepts/containers/runtime-class/) docs for more information. -Separately, there is a feature flag to allow [manual configuration of RuntimeClassName](/docs/serving/configuration/feature-flags/#kubernetes-runtime-class). +Separately, there is a feature flag to allow [manual configuration of RuntimeClassName](./feature-flags.md#kubernetes-runtime-class). diff --git a/docs/versioned/serving/request-flow.md b/docs/versioned/serving/request-flow.md index 60fb0bfef8b..80b59c62860 100644 --- a/docs/versioned/serving/request-flow.md +++ b/docs/versioned/serving/request-flow.md @@ -7,7 +7,7 @@ function: explanation # HTTP Request Flows -While [the overview](/docs/serving) describes the logical components and +While [the overview](./README.md) describes the logical components and [the architecture](./architecture.md) describes the over all architecture of Knative Serving, this page explains the behavior and flow of HTTP requests to an application which is running on Knative Serving. From f6cf00e600c68bb3b9fb07fc0d619992d2c52465 Mon Sep 17 00:00:00 2001 From: Dave Protasowski Date: Wed, 29 Oct 2025 14:39:03 -0400 Subject: [PATCH 2/2] update last link --- docs/versioned/serving/app-security/secure-pod-defaults.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/versioned/serving/app-security/secure-pod-defaults.md b/docs/versioned/serving/app-security/secure-pod-defaults.md index 94f3024e75a..c8870793356 100644 --- a/docs/versioned/serving/app-security/secure-pod-defaults.md +++ b/docs/versioned/serving/app-security/secure-pod-defaults.md @@ -7,6 +7,6 @@ function: how-to Knative Serving provides a `secure-pod-defaults` configuration option that allows operators to default Service configuration to run in the Kubernetes [restricted](https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted) Pod Security Standard profile without requiring application developers to explicitly set security properties. -These settings are controlled by operators so please refer to the [administration documentation](/docs/serving/configuration/secure-pod-defaults). +These settings are controlled by operators so please refer to the [administration documentation](../../configuration/secure-pod-defaults).