Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
450 changes: 225 additions & 225 deletions config/redirects.yml

Large diffs are not rendered by default.

28 changes: 0 additions & 28 deletions docs/concepts/eventing-resources/brokers.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/serving/revisions/README.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/snippets/about-brokers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/concepts/eventing-resources/brokers.md
- /docs/eventing/broker/README.md
- versioned/eventing/broker/README.md
-->

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.
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/about-eventing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/eventing/README.md
- /docs/concepts/README.md
- versioned/eventing/README.md
- versioned/README.md
-->
Knative Eventing is a collection of APIs that enable you to use an [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture){target=_blank} with your applications. You can use these APIs to create components that route events from event producers (known as sources) to event consumers (known as sinks) that receive events. Sinks can also be configured to respond to HTTP requests by sending a response event.

Expand Down
3 changes: 2 additions & 1 deletion docs/snippets/about-functions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/functions/README.md
- versioned/functions/README.md
- versioned/README.md
-->
Knative Functions provides a simple programming model for using functions on Knative, without requiring in-depth knowledge of Knative, Kubernetes, containers, or dockerfiles.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/about-revisions-garbage-collection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- docs/serving/revisions/revision-admin-config-options.md
- docs/serving/revisions/revision-developer-config-options.md
- versioned/serving/revisions/revision-admin-config-options.md
- versioned/serving/revisions/revision-developer-config-options.md
-->
When Revisions of a Knative Service are inactive, they are automatically cleaned up and cluster resources are reclaimed after a set time period. This is known as *[garbage collection](https://kubernetes.io/docs/concepts/architecture/garbage-collection/){target=_blank}*.

Expand Down
3 changes: 1 addition & 2 deletions docs/snippets/about-revisions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/concepts/servng-resources/revisions.md
- /docs/serving/revisions/README.md
- versioned/serving/revisions/README.md
-->
Revisions are Knative Serving resources that contain point-in-time snapshots of the application code and configuration for each change made to a Knative Service.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/about-serving.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/serving/README.md
- /docs/concepts/README.md
- versioned/serving/README.md
- versioned/README.md
-->
Knative Serving defines a set of objects as Kubernetes Custom Resource
Definitions (CRDs). These resources are used to define and control how your
Expand Down
5 changes: 0 additions & 5 deletions docs/snippets/about-subscribers.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/snippets/about-triggers.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/snippets/build-func-intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/building-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/building-functions.md
-->
Building a function creates an OCI container image for your function that can be pushed to a container registry. It does not run or deploy the function, which can be useful if you want to build a container image for your function locally, but do not want to automatically run the function or deploy it to a cluster, for example, in a testing scenario.
3 changes: 2 additions & 1 deletion docs/snippets/create-a-function.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/concepts/eventing-resources/brokers.md
- versioned/functions/creating-functions.md
- versioned/getting-started/create-a-function.md
-->
After you have installed Knative Functions, you can create a function project by using the `func` CLI or the `kn func` plugin:

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/deploy-func-intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/deploying-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/deploying-functions.md
-->
Deploying a function creates an OCI container image for your function, and pushes this container image to your image registry. The function is deployed to the cluster as a Knative Service. Redeploying a function updates the container image and resulting Service that is running on your cluster. Functions that have been deployed to a cluster are accessible on the cluster just like any other Knative Service.
2 changes: 1 addition & 1 deletion docs/snippets/functions-templates-intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/functions/README.md
- versioned/functions/README.md
-->
Knative Functions provides templates that can be used to create basic functions, by initiating a function project boilerplate when you run a `create` command.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/install-func-CLI.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/functions/install-func.md
- /docs/getting-started/install-func.md
- versioned/functions/install-func.md
- versioned/getting-started/install-func.md
-->
=== "Homebrew"

Expand Down
3 changes: 2 additions & 1 deletion docs/snippets/install-functions-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/functions/install-func.md
- versioned/functions/install-func.md
- versioned/getting-started/install-func.md
-->
You can install Knative Functions either by using the standalone `func` CLI, or by installing the `kn func` plugin that is available for the Knative `kn` CLI.
4 changes: 2 additions & 2 deletions docs/snippets/install-kn-func-plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/functions/install-func.md
- /docs/getting-started/install-func.md
- versioned/functions/install-func.md
- versioned/getting-started/install-func.md
-->
=== "kn plugin"

Expand Down
6 changes: 3 additions & 3 deletions docs/snippets/install-kn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Snippet used in the following topics:
- /docs/client/install-kn.md
- /docs/getting-started/quickstart-install.md
- docs/install/quickstart-install.md
- versioned/client/install-kn.md
- versioned/getting-started/quickstart-install.md
- versioned/install/quickstart-install.md
-->

## Install the Knative CLI
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/proc-building-function.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/building-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/building-functions.md
-->
The `build` command uses the project name and the image registry name to construct a fully qualified container image name for the function. If the function project has not previously been built, you are prompted to provide an **image registry**.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/proc-deploying-function.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/deploying-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/deploying-functions.md
-->
The `deploy` command uses the function project name as the Knative Service name. When the function is built, the project name and the image registry name are used to construct a fully qualified image name for the function.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/proc-running-function.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/running-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/running-functions.md
-->
The `run` command builds an image for your function if required, and runs this image locally, instead of deploying it on a cluster.

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/quickstart-install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/quickstart-install.md
- /docs/install/quickstart-install.md
- versioned/getting-started/quickstart-install.md
- versioned/install/quickstart-install.md
-->
## Install the Knative quickstart plugin

Expand Down
6 changes: 3 additions & 3 deletions docs/snippets/quickstart-prereqs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/README.md
- /docs/install/quickstart-install.md
- /docs/getting-started/quickstart-install.md
- versioned/getting-started/README.md
- versioned/install/quickstart-install.md
- versioned/getting-started/quickstart-install.md
-->
## Before you begin

Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/run-func-intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Snippet used in the following topics:
- /docs/getting-started/build-run-deploy-func.md
- /docs/functions/running-functions.md
- versioned/getting-started/build-run-deploy-func.md
- versioned/functions/running-functions.md
-->
Running a function creates an OCI container image for your function before running the function in your local environment, but does not deploy the function to a cluster. This can be useful if you want to run your function locally for a testing scenario.
10 changes: 2 additions & 8 deletions docs/.nav.yml → docs/versioned/.nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,7 @@ nav:
###############################################################################
# Concepts
###############################################################################
- Concepts:
- Overview: concepts/README.md
- Resources:
- Serving resources:
- Revisions: concepts/serving-resources/revisions.md
- Eventing resources:
- Brokers: concepts/eventing-resources/brokers.md
- Duck types: concepts/duck-typing.md
- Overview: README.md
###############################################################################
# Getting started
###############################################################################
Expand Down Expand Up @@ -214,6 +207,7 @@ nav:
- Developer configuration options: eventing/brokers/broker-developer-config-options.md
- Triggers:
- Using Triggers: eventing/triggers/README.md
- Duck types: eventing/concepts/duck-typing.md
- Event sources:
- About event sources: eventing/sources/README.md
- ApiServerSource:
Expand Down
16 changes: 8 additions & 8 deletions docs/concepts/README.md → docs/versioned/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ These components can be used independently or together, allowing you to adopt Kn

### Request Flow in Serving

![Knative Serving data flow: requests arrive at an HTTP router, then travel to either the activator or a pod with a queue-proxy and the user application. The Knative autoscaler collects metrics from the activator and the queue-proxy to determine how many pods to run.](../serving/images/request-flow.png){draggable=false}
![Knative Serving data flow: requests arrive at an HTTP router, then travel to either the activator or a pod with a queue-proxy and the user application. The Knative autoscaler collects metrics from the activator and the queue-proxy to determine how many pods to run.](./serving/images/request-flow.png){draggable=false}

When a request is made to a Knative Service:

Expand All @@ -84,7 +84,7 @@ When a request is made to a Knative Service:
4. **Queue-Proxy**: All requests pass through the Queue-Proxy sidecar, which enforces concurrency limits and collects metrics
5. **Application**: The request reaches your application container

For detailed information, see the [request flow documentation](../serving/request-flow.md).
For detailed information, see the [request flow documentation](serving/request-flow.md).

### GPU Resources and LLM Inference

Expand Down Expand Up @@ -261,9 +261,9 @@ Consider alternatives when:

## Next Steps

- **Installation**: Get started with [Knative installation](../install/README.md)
- **Quick Start**: Try the [Knative Quickstart](../getting-started/README.md) for hands-on experience
- **Serving Guide**: Learn more about [Knative Serving](../serving/README.md)
- **Eventing Guide**: Explore [Knative Eventing](../eventing/README.md) capabilities
- **Functions Guide**: Build your first [Knative Function](../functions/README.md)
- **Examples**: Browse [sample applications](../samples/README.md) and use cases
- **Installation**: Get started with [Knative installation](install/README.md)
- **Quick Start**: Try the [Knative Quickstart](getting-started/README.md) for hands-on experience
- **Serving Guide**: Learn more about [Knative Serving](serving/README.md)
- **Eventing Guide**: Explore [Knative Eventing](eventing/README.md) capabilities
- **Functions Guide**: Build your first [Knative Function](functions/README.md)
- **Examples**: Browse [sample applications](samples/README.md) and use cases
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,4 @@ control rules.

## Additional resources

- [Brokers concept documentation](../../concepts/eventing-resources/brokers.md)
- [Broker specifications](https://github.com/knative/specs/blob/main/specs/eventing/overview.md#broker){target=_blank}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading