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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions _topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2740,13 +2740,22 @@ Name: Serverless applications
Dir: serverless
Distros: openshift-enterprise,openshift-webscale
Topics:
# Release notes
- Name: Release Notes
File: serverless-release-notes
# Support
- Name: Support
File: serverless-support
# Intro / getting started
- Name: Getting started
File: serverless-getting-started
# Installing OpenShift Serverless
- Name: Installing OpenShift Serverless
Dir: installing_serverless
- Name: Installing the Knative CLI
File: installing-kn
# Admin guide
- Name: Administration guide
Dir: admin_guide
Topics:
#Installation
- Name: Installing OpenShift Serverless
File: installing-openshift-serverless
- Name: Installing Knative Serving
Expand All @@ -2759,8 +2768,15 @@ Topics:
File: upgrading-serverless
- Name: Removing OpenShift Serverless
File: removing-openshift-serverless
- Name: Installing the Knative CLI
File: installing-kn
# Eventing
- Name: Creating Eventing components
File: serverless-cluster-admin-eventing
# Serving
- Name: Creating Serving components
File: serverless-cluster-admin-serving
# Metering
- Name: Using metering with OpenShift Serverless
File: serverless-metering
# Architecture
- Name: Architecture
Dir: architecture
Expand Down Expand Up @@ -2836,18 +2852,9 @@ Topics:
Topics:
- Name: Monitoring serverless components
File: serverless-monitoring
# Metering
- Name: Using metering with OpenShift Serverless
File: serverless-metering
# Integrations
- Name: Integrations
Dir: integrations
Topics:
- Name: Using NVIDIA GPU resources with serverless applications
File: gpu-resources
# Release notes
- Name: Release Notes
File: serverless-release-notes
# Support
- Name: Support
File: serverless-support
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The *Developer* perspective in the web console provides you the following option
* *Helm Chart*: Explore the *Developer Catalog* to select the required Helm chart to simplify deployment of applications and services.

ifdef::openshift-enterprise,openshift-webscale[]
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines], xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[OpenShift Serverless], and xref:../../virt/install/installing-virt-web.adoc#virt-subscribing-to-the-catalog_installing-virt-web[OpenShift Virtualization] Operators are installed, respectively.
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines], xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[OpenShift Serverless], and xref:../../virt/install/installing-virt-web.adoc#virt-subscribing-to-the-catalog_installing-virt-web[OpenShift Virtualization] Operators are installed, respectively.
endif::[]

== Prerequisites
Expand All @@ -31,8 +31,8 @@ ifdef::openshift-enterprise,openshift-webscale[]

To create serverless applications, in addition to the preceding prerequisites, ensure that:

* You have xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[installed the OpenShift Serverless Operator].
* You have xref:../../serverless/installing_serverless/installing-knative-serving.adoc#installing-knative-serving[created a knative-serving namespace and a KnativeServing resource in the knative-serving namespace].
* You have xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[installed the OpenShift Serverless Operator].
* You have xref:../../serverless/admin_guide/installing-knative-serving.adoc#installing-knative-serving[created a `KnativeServing` resource in the `knative-serving` namespace].

endif::[]

Expand Down
34 changes: 14 additions & 20 deletions cli_reference/kn-cli-tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,30 @@ include::modules/common-attributes.adoc[]

toc::[]

`kn` enables simple interaction with Knative components on {product-title}.
The Knative `kn` CLI enables simple interaction with Knative components on {product-title}.

You can enable Knative on {product-title} by installing {ServerlessProductName}. For more information, see the documentation on xref:../serverless/serverless-getting-started.adoc#serverless-getting-started[Getting started with {ServerlessProductName}].
You can enable Knative on {product-title} by installing {ServerlessProductName}. For more information, see xref:../serverless/serverless-getting-started.adoc#serverless-getting-started[Getting started with {ServerlessProductName}].

[NOTE]
====
{ServerlessProductName} cannot be installed using the `kn` CLI. A cluster administrator must install the {ServerlessOperatorName} and set up the Knative components, as described in the xref:../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[Serverless applications] documentation for {product-title}.
{ServerlessProductName} cannot be installed using the `kn` CLI. A cluster administrator must install the {ServerlessOperatorName} and set up the Knative components, as described in the xref:../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[Serverless applications] documentation for {product-title}.
====

[id="kn-cli-tools-key-features"]
== Key features
`kn` is designed to make serverless computing tasks simple and concise.
Key features of `kn` include:

* xref:../serverless/serving-creating-managing-apps.adoc#serving-creating-managing-apps[Deploy serverless applications] from the command line.
The `kn` CLI is designed to make serverless computing tasks simple and concise.
Key features of the `kn` CLI include:

* Deploy serverless applications from the command line.
* Manage features of Knative Serving, such as services, revisions, and traffic-splitting.
// TODO: add docs about revisions
* Create and manage Knative Eventing components, such as event sources and triggers.
+
[NOTE]
====
Knative Eventing is currently available as a Technology Preview feature of {ServerlessProductName}.
====
* Create xref:../serverless/event_sources/serverless-sinkbinding.adoc#serverless-sinkbinding[sink binding] to connect existing Kubernetes applications and Knative services.
* Extend `kn` with flexible plugin architecture, similar to `kubectl`.
// * Easily integrate {ServerlessProductName} with OpenShift Pipelines by using `kn` in an OpenShift Pipelines task
// TODO: Add integrations later when we have docs about this.
// TODO: add docs about these deployment types?
* Configure xref:../serverless/knative_serving/configuring-knative-serving-autoscaling.adoc#configuring-knative-serving-autoscaling[autoscaling] parameters for Knative services.
* Create sink bindings to connect existing Kubernetes applications and Knative services.
* Extend the `kn` CLI with flexible plug-in architecture, similar to the `kubectl` CLI.
* Configure autoscaling parameters for Knative services.
* Scripted usage, such as waiting for the results of an operation, or deploying custom rollout and rollback strategies.

== Installing `kn`
[id="kn-cli-tools-installing-kn"]
== Installing the Knative CLI

For information about installing `kn` for use with {ServerlessProductName}, see the documentation on xref:../serverless/installing_serverless/installing-kn.adoc#installing-kn[Installing the Knative CLI (`kn`)].
See xref:../serverless/installing-kn.adoc#installing-kn[Installing the Knative CLI].
11 changes: 4 additions & 7 deletions modules/creating-serverless-apps-admin-console.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
// Module included in the following assemblies:
//
// serverless/serving-creating-managing-apps.adoc
// serverless/admin_guide/serverless-cluster-admin-serving.adoc

[id="creating-serverless-apps-admin-console_{context}"]
= Creating serverless applications using the Administrator perspective

.Prerequisites

To create serverless applications using the *Administrator* perspective, ensure that you have completed the following steps.

* The {ServerlessOperatorName} and Knative Serving are installed.
* You have logged in to the web console and are in the *Administrator* perspective.

.Procedure

. Navigate to the *Serverless* → *Services* page.
+
image::serverless-create-service-admin.png[Services page]
. Click *Create Service*.
. Navigate to the *Serverless* -> *Serving* page.
. In the *Create* list, select *Service*.
. Manually enter YAML or JSON definitions, or by dragging and dropping a file into the editor.
+
image::service-yaml-admin.png[Text editor]
. Click *Create*.
20 changes: 20 additions & 0 deletions modules/serverless-creating-broker-admin-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Module included in the following assemblies:
//
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc

[id="serverless-creating-broker-admin-web-console_{context}"]
= Creating a broker by using the Administrator perspective

If you have cluster administrator permissions, you can create a broker by using the Administrator perspective in the web console.

.Prerequisites

* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
* You have cluster administrator permissions for {product-title}.

.Procedure

. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
. In the *Create* list, select *Broker*. You will be directed to the *Create Broker* page.
. Optional: Modify the YAML configuration for the broker.
. Click *Create*.
25 changes: 25 additions & 0 deletions modules/serverless-creating-channel-admin-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc

[id="serverless-creating-channel-admin-web-console_{context}"]
= Creating a channel by using the Administrator perspective

If you have cluster administrator permissions, you can create a channel by using the Administrator perspective in the web console.

.Prerequisites

* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
* You have cluster administrator permissions for {product-title}.

.Procedure

. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
. In the *Create* list, select *Channel*. You will be directed to the *Channel* page.
. Select the type of `Channel` object that you want to create from the *Type* drop-down.
+
[NOTE]
====
Currently only `InMemoryChannel` channel objects are supported by default. Kafka channels are available as a Technology Preview if you have installed Apache Kafka on {ServerlessProductName}.
====
. Click *Create*.
19 changes: 19 additions & 0 deletions modules/serverless-creating-event-source-admin-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Module included in the following assemblies:
//
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc

[id="serverless-creating-event-source-admin-web-console_{context}"]
= Creating an event source by using the Administrator perspective

If you have cluster administrator permissions, you can create an event source by using the Administrator perspective in the web console.

.Prerequisites

* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
* You have cluster administrator permissions for {product-title}.

.Procedure

. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
. In the *Create* list, select *Event Source*. You will be directed to the *Event Sources* page.
. Select the event source type that you want to create.
23 changes: 23 additions & 0 deletions modules/serverless-creating-subscription-admin-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Module included in the following assemblies:
//
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc

[id="serverless-creating-subscription-admin-web-console_{context}"]
= Creating a subscription by using the Administrator perspective

If you have cluster administrator permissions and have created a channel, you can create a subscription to connect your broker to a subscriber by using the Administrator perspective in the web console.

.Prerequisites

* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
* You have cluster administrator permissions for {product-title}.
* You have created a channel.
* You have created a Knative service to use as a subscriber.

.Procedure

. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
. In the *Channel* tab, select the Options menu {kebab} for the channel that you want to add a subscription to.
. Click *Add Subscription* in the list.
. In the *Add Subscription* dialogue box, select a *Subscriber* for the subscription. The subscriber is the Knative service that will receive events from the channel.
. Click *Add*.
23 changes: 23 additions & 0 deletions modules/serverless-creating-trigger-admin-web-console.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Module included in the following assemblies:
//
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc

[id="serverless-creating-trigger-admin-web-console_{context}"]
= Creating a trigger by using the Administrator perspective

If you have cluster administrator permissions and have created a broker, you can create a trigger to connect your broker to a subscriber by using the Administrator perspective in the web console.

.Prerequisites

* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
* You have cluster administrator permissions for {product-title}.
* You have created a broker.
* You have created a Knative service to use as a subscriber.

.Procedure

. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
. In the *Broker* tab, select the Options menu {kebab} for the broker that you want to add a trigger to.
. Click *Add Trigger* in the list.
. In the *Add Trigger* dialogue box, select a *Subscriber* for the trigger. The subscriber is the Knative service that will receive events from the broker.
. Click *Add*.
2 changes: 1 addition & 1 deletion modules/serverless-install-kafka-odc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Cluster administrators can enable the use of Apache Kafka functionality in an {S

.Procedure

. In the *Administrator* perspective, navigate to *Operators* *Installed Operators*.
. In the *Administrator* perspective, navigate to *Operators* -> *Installed Operators*.
. Check that the *Project* dropdown at the top of the page is set to *Project: knative-eventing*.
. Click *Knative Kafka* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Kafka* tab.
. Click *Create Knative Kafka*.
Expand Down
2 changes: 1 addition & 1 deletion modules/serverless-install-serving-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
= Installing Knative Serving using the web console

.Procedure
. In the *Administrator* perspective of the {product-title} web console, navigate to *Operators* *Installed Operators*.
. In the *Administrator* perspective of the {product-title} web console, navigate to *Operators* -> *Installed Operators*.
. Check that the *Project* dropdown at the top of the page is set to *Project: knative-serving*.
. Click *Knative Serving* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Serving* tab.
+
Expand Down
10 changes: 5 additions & 5 deletions modules/serverless-install-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This procedure describes how to install and subscribe to the {ServerlessOperator

.Procedure

. In the {product-title} web console, navigate to the *Operators* *OperatorHub* page.
. In the {product-title} web console, navigate to the *Operators* -> *OperatorHub* page.
. Scroll, or type they keyword *Serverless* into the *Filter by keyword box* to find the {ServerlessOperatorName}.
+
image::serverless-search.png[{ServerlessOperatorName} in the {product-title} web console]
Expand All @@ -21,15 +21,15 @@ image::serverless-search.png[{ServerlessOperatorName} in the {product-title} web
.. Select the *4.6* channel as the *Update Channel*. The *4.6* channel will enable installation of the latest stable release of the {ServerlessOperatorName}.
.. Select *Automatic* or *Manual* approval strategy.
. Click *Install* to make the Operator available to the selected namespaces on this {product-title} cluster.
. From the *Catalog* *Operator Management* page, you can monitor the {ServerlessOperatorName} subscription’s installation and upgrade progress.
. From the *Catalog* -> *Operator Management* page, you can monitor the {ServerlessOperatorName} subscription’s installation and upgrade progress.
.. If you selected a *Manual* approval strategy, the subscription’s upgrade status will remain *Upgrading* until you review and approve its install plan. After approving on the *Install Plan* page, the subscription upgrade status moves to *Up to date*.
.. If you selected an *Automatic* approval strategy, the upgrade status should resolve to *Up to date* without intervention.

.Verification steps

After the Subscription’s upgrade status is *Up to date*, select *Catalog* *Installed Operators* to verify that the {ServerlessOperatorName} eventually shows up and its *Status* ultimately resolves to *InstallSucceeded* in the relevant namespace.
After the Subscription’s upgrade status is *Up to date*, select *Catalog* -> *Installed Operators* to verify that the {ServerlessOperatorName} eventually shows up and its *Status* ultimately resolves to *InstallSucceeded* in the relevant namespace.

If it does not:

. Switch to the *Catalog* *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* *Pods* page that are reporting issues to troubleshoot further.
. Switch to the *Catalog* -> *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.
4 changes: 2 additions & 2 deletions modules/serverless-upgrade-sub-channel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ If you have selected Manual updates, you will need to complete additional steps
.Procedure

. Select the `openshift-operators` namespace in the {product-title} web console.
. Navigate to the *Operators* *Installed Operators* page.
. Navigate to the *Operators* -> *Installed Operators* page.
. Select the *{ServerlessOperatorName} Operator*.
. Click *Subscription* *Channel*.
. Click *Subscription* -> *Channel*.
. In the *Change Subscription Update Channel* window, select *4.6*, and then click *Save*.
. Wait until all pods have been upgraded in the `knative-serving` namespace and the `KnativeServing` custom resource reports the latest Knative Serving version.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ After you install the {ServerlessOperatorName}, you can install Knative Eventing
This guide provides information about installing Knative Eventing using the default settings.
// However, you can configure more advanced settings in the KnativeEventing custom resource definition.

// For more information about configuration options for the KnativeEventing custom resource definition, see xref:../installing_serverless/serverless-install-config-options.adoc#serverless-install-config-options[Advanced installation configuration options].
// For more information about configuration options for the KnativeEventing custom resource definition, see xref:../../serverless/admin_guide/serverless-install-config-options.adoc#serverless-install-config-options[Advanced installation configuration options].

[id="installing-knative-eventing-prerequisites"]
== Prerequisites
Expand All @@ -24,4 +24,4 @@ include::modules/serverless-install-eventing-yaml.adoc[leveloffset=+1]
[id="installing-knative-eventing-next-steps"]
== Next steps

* Install the Knative CLI to use `kn` commands with Knative Eventing. For example, `kn source` commands. See the documentation on xref:../installing_serverless/installing-kn#installing-kn[Installing the Knative CLI (`kn`)].
* Install the Knative CLI to use `kn` commands with Knative Eventing. For example, `kn source` commands. See xref:../../serverless/installing-kn.adoc#installing-kn[Installing the Knative CLI].
Loading