1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

SRVCOM-2108 Restructuring the about section

This commit is contained in:
Gabriel McGoldrick
2023-01-13 11:41:23 +00:00
committed by openshift-cherrypick-robot
parent 677727935d
commit 7a8b0f0a56
13 changed files with 51 additions and 39 deletions

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,21 @@
:_content-type: ASSEMBLY
[id="about-knative-eventing"]
= Knative Eventing
:context: about-knative-eventing
include::_attributes/common-attributes.adoc[]
Knative Eventing on {product-title} enables developers to use an link:https://www.redhat.com/en/topics/integration/what-is-event-driven-architecture[event-driven architecture] with serverless applications. An event-driven architecture is based on the concept of decoupled relationships between event producers and event consumers.
Event producers create events, and event _sinks_, or consumers, receive events. Knative Eventing uses standard HTTP POST requests to send and receive events between event producers and sinks. These events conform to the link:https://cloudevents.io[CloudEvents specifications], which enables creating, parsing, sending, and receiving events in any programming language.
Knative Eventing supports the following use cases:
Publish an event without creating a consumer:: You can send events to a broker as an HTTP POST, and use binding to decouple the destination configuration from your application that produces events.
Consume an event without creating a publisher:: You can use a trigger to consume events from a broker based on event attributes. The application receives events as an HTTP POST.
To enable delivery to multiple types of sinks, Knative Eventing defines the following generic interfaces that can be implemented by multiple Kubernetes resources:
Addressable resources:: Able to receive and acknowledge an event delivered over HTTP to an address defined in the `status.address.url` field of the event. The Kubernetes `Service` resource also satisfies the addressable interface.
Callable resources:: Able to receive an event delivered over HTTP and transform it, returning `0` or `1` new events in the HTTP response payload. These returned events may be further processed in the same way that events from an external event source are processed.

View File

@@ -0,0 +1,24 @@
:_content-type: ASSEMBLY
[id="about-knative-serving"]
= Knative Serving
:context: about-knative-serving
include::_attributes/common-attributes.adoc[]
Knative Serving supports developers who want to create, deploy, and manage link:https://www.redhat.com/en/topics/cloud-native-apps[cloud-native applications]. It provides a set of objects as Kubernetes custom resource definitions (CRDs) that define and control the behavior of serverless workloads on an {product-title} cluster.
Developers use these CRDs to create custom resource (CR) instances that can be used as building blocks to address complex use cases. For example:
* Rapidly deploying serverless containers.
* Automatically scaling pods.
[id="about-knative-serving-resources_{context}"]
== Knative Serving resources
Service:: The `service.serving.knative.dev` CRD automatically manages the life cycle of your workload to ensure that the application is deployed and reachable through the network. It creates a route, a configuration, and a new revision for each change to a user created service, or custom resource. Most developer interactions in Knative are carried out by modifying services.
Revision:: The `revision.serving.knative.dev` CRD is a point-in-time snapshot of the code and configuration for each modification made to the workload. Revisions are immutable objects and can be retained for as long as necessary.
Route:: The `route.serving.knative.dev` CRD maps a network endpoint to one or more revisions. You can manage the traffic in several ways, including fractional traffic and named routes.
Configuration:: The `configuration.serving.knative.dev` CRD maintains the desired state for your deployment. It provides a clean separation between code and configuration. Modifying a configuration creates a new revision.

View File

@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="about-serverless"]
= About {ServerlessProductName}
= {ServerlessProductName} overview
:context: about-serverless
include::_attributes/common-attributes.adoc[]
@@ -15,19 +15,9 @@ Because {ServerlessProductName} releases on a different cadence from {product-ti
For additional information about the {ServerlessProductName} life cycle and supported platforms, refer to the link:https://access.redhat.com/support/policy/updates/openshift#ossrvless[Platform Life Cycle Policy].
====
// Knative Serving
include::modules/about-knative-serving.adoc[leveloffset=+1]
// Knative Eventing
include::modules/about-knative-eventing.adoc[leveloffset=+1]
You can propagate an event from an xref:../../serverless/discover/knative-event-sources.adoc#knative-event-sources[event source] to multiple event sinks by using:
* xref:../../serverless/discover/serverless-channels.adoc#serverless-channels[Channels and subscriptions], or
* xref:../../serverless/develop/serverless-using-brokers.adoc#serverless-using-brokers[Brokers] and xref:../../serverless/develop/serverless-triggers.adoc#serverless-triggers[Triggers].
// add something about CLI tools?
[id="additional-resources_about-serverless"]
[role="_additional-resources"]
== Additional resources

1
serverless/about/images Symbolic link
View File

@@ -0,0 +1 @@
../../images/

1
serverless/about/modules Symbolic link
View File

@@ -0,0 +1 @@
../../modules/

View File

@@ -14,8 +14,8 @@ toc::[]
{FunctionsProductName} provides templates that can be used to create basic functions for the following runtimes:
// add xref links to docs once added
* xref:../../serverless/functions/serverless-developing-nodejs-functions.adoc#serverless-developing-nodejs-functions[Node.js]
* xref:../../serverless/functions/serverless-developing-quarkus-functions.adoc#serverless-developing-quarkus-functions[Quarkus]
* xref:../../serverless/functions/serverless-developing-nodejs-functions.adoc#serverless-developing-nodejs-functions[Node.js]
* xref:../../serverless/functions/serverless-developing-typescript-functions.adoc#serverless-developing-typescript-functions[TypeScript]
[id="next-steps_serverless-functions-about"]

1
serverless/about/snippets Symbolic link
View File

@@ -0,0 +1 @@
../../snippets/

View File

@@ -13,7 +13,7 @@ For additional information about the {ServerlessProductName} life cycle and supp
Release notes contain information about new and deprecated features, breaking changes, and known issues. The following release notes apply for the most recent {ServerlessProductName} releases on {product-title}.
For an overview of {ServerlessProductName} functionality, see xref:../serverless/discover/about-serverless.adoc#about-serverless[About {ServerlessProductName}].
For an overview of {ServerlessProductName} functionality, see xref:../serverless/about/about-serverless.adoc#about-serverless[About {ServerlessProductName}].
[NOTE]
====