mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Adding admin guide for Serverless docs
This commit is contained in:
Ashleigh Brennan
@@ -2676,13 +2676,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
|
||||
@@ -2695,8 +2704,14 @@ Topics:
|
||||
File: upgrading-serverless
|
||||
- Name: Removing OpenShift Serverless
|
||||
File: removing-openshift-serverless
|
||||
- Name: Installing the Knative CLI
|
||||
File: installing-kn
|
||||
# Admin console
|
||||
- Name: Creating Eventing components as a cluster administrator
|
||||
File: serverless-cluster-admin-eventing
|
||||
- Name: Creating Serving components as a cluster administrator
|
||||
File: serverless-cluster-admin-serving
|
||||
# Metering
|
||||
- Name: Using metering with OpenShift Serverless
|
||||
File: serverless-metering
|
||||
# Architecture
|
||||
- Name: Architecture
|
||||
Dir: architecture
|
||||
@@ -2772,18 +2787,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
|
||||
|
||||
@@ -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:../../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:../../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
|
||||
@@ -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::[]
|
||||
|
||||
|
||||
@@ -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].
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
// 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.
|
||||
@@ -13,11 +14,7 @@ To create serverless applications using the *Administrator* perspective, ensure
|
||||
|
||||
.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
modules/serverless-creating-broker-admin-web-console.adoc
Normal file
20
modules/serverless-creating-broker-admin-web-console.adoc
Normal file
@@ -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*.
|
||||
@@ -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*.
|
||||
|
||||
@@ -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.
|
||||
+
|
||||
|
||||
@@ -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]
|
||||
@@ -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-operators` 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-operators` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.
|
||||
|
||||
@@ -18,9 +18,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.
|
||||
|
||||
|
||||
@@ -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
|
||||
@@ -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].
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
After you install the {ServerlessOperatorName}, you can install Knative Serving.
|
||||
This guide provides information about installing Knative Serving using the default settings. However, you can configure more advanced settings in the `KnativeServing` custom resource definition (CRD).
|
||||
For more information about configuration options for the `KnativeServing` CRD, 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 `KnativeServing` CRD, see xref:../../serverless/admin_guide/serverless-install-config-options.adoc#serverless-install-config-options[Advanced installation configuration options].
|
||||
|
||||
[id="installing-knative-serving-prerequisites"]
|
||||
== Prerequisites
|
||||
@@ -21,5 +21,5 @@ include::modules/serverless-install-serving-yaml.adoc[leveloffset=+1]
|
||||
[id="installing-knative-serving-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* For cloud events functionality on {ServerlessProductName}, you can install the Knative Eventing component. See the documentation on xref:../installing_serverless/installing-knative-eventing.adoc#installing-knative-eventing[Installing Knative Eventing].
|
||||
* Install the Knative CLI to use `kn` commands with Knative Serving. For example, `kn service` commands. See the documentation on xref:../installing_serverless/installing-kn#installing-kn[Installing the Knative CLI (`kn`)].
|
||||
* For cloud events functionality on {ServerlessProductName}, you can install the Knative Eventing component. See the documentation on xref:../../serverless/admin_guide/installing-knative-eventing.adoc#installing-knative-eventing[Installing Knative Eventing].
|
||||
* Install the Knative CLI to use `kn` commands with Knative Serving. For example, `kn service` commands. See the documentation on xref:../../serverless/installing-kn#installing-kn[Installing the Knative CLI (`kn`)].
|
||||
@@ -40,5 +40,5 @@ include::modules/serverless-install-web-console.adoc[leveloffset=+1]
|
||||
[id="installing-openshift-serverless-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* After the {ServerlessOperatorName} is installed, you can install the Knative Serving component. See the documentation on xref:../installing_serverless/installing-knative-serving.adoc#installing-knative-serving[Installing Knative Serving].
|
||||
* After the {ServerlessOperatorName} is installed, you can install the Knative Eventing component. See the documentation on xref:../installing_serverless/installing-knative-eventing.adoc#installing-knative-eventing[Installing Knative Eventing].
|
||||
* After the {ServerlessOperatorName} is installed, you can install the Knative Serving component. See the documentation on xref:../../serverless/admin_guide/installing-knative-serving.adoc#installing-knative-serving[Installing Knative Serving].
|
||||
* After the {ServerlessOperatorName} is installed, you can install the Knative Eventing component. See the documentation on xref:../../serverless/admin_guide/installing-knative-eventing.adoc#installing-knative-eventing[Installing Knative Eventing].
|
||||
@@ -21,7 +21,7 @@ include::modules/serverless-uninstalling-knative-eventing.adoc[leveloffset=+1]
|
||||
[id="removing-the-operator"]
|
||||
== Removing the {ServerlessOperatorName}
|
||||
|
||||
You can remove the {ServerlessOperatorName} from the host cluster by following the documentation on xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster].
|
||||
You can remove the {ServerlessOperatorName} from the host cluster by following the documentation on xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster].
|
||||
|
||||
[id="deleting-serverless-CRDs"]
|
||||
== Deleting {ServerlessProductName} custom resource definitions
|
||||
@@ -0,0 +1,19 @@
|
||||
include::modules/serverless-document-attributes.adoc[]
|
||||
[id="serverless-cluster-admin-eventing"]
|
||||
= Creating Eventing components as a cluster administrator
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: serverless-cluster-admin-eventing
|
||||
|
||||
toc::[]
|
||||
|
||||
If you have cluster administrator permissions on a {product-title} cluster, you can create Knative Eventing components with {ServerlessProductName} in the *Administrator* perspective of the web console or by using the `kn` and `oc` CLIs.
|
||||
|
||||
// Brokers
|
||||
include::modules/serverless-creating-broker-admin-web-console.adoc[leveloffset=+1]
|
||||
include::modules/serverless-creating-broker-admin.adoc[leveloffset=+1]
|
||||
include::modules/serverless-deleting-broker-admin.adoc[leveloffset=+1]
|
||||
|
||||
[id="serverless-cluster-admin-eventing-additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* See xref:../../serverless/event_workflows/serverless-using-brokers.adoc#serverless-using-brokers[Event delivery workflows using brokers and triggers].
|
||||
15
serverless/admin_guide/serverless-cluster-admin-serving.adoc
Normal file
15
serverless/admin_guide/serverless-cluster-admin-serving.adoc
Normal file
@@ -0,0 +1,15 @@
|
||||
include::modules/serverless-document-attributes.adoc[]
|
||||
[id="serverless-cluster-admin-serving"]
|
||||
= Creating Serving components as a cluster administrator
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: serverless-cluster-admin-serving
|
||||
|
||||
toc::[]
|
||||
|
||||
If you have cluster administrator permissions on a {product-title} cluster, you can create Knative Serving components with {ServerlessProductName} in the *Administrator* perspective of the web console or by using the `kn` and `oc` CLIs.
|
||||
|
||||
// Create services as an admin
|
||||
include::modules/creating-serverless-apps-admin-console.adoc[leveloffset=+1]
|
||||
|
||||
// [id="serverless-cluster-admin-serving-additional-resources"]
|
||||
// == Additional resources
|
||||
@@ -8,11 +8,11 @@ toc::[]
|
||||
|
||||
As a cluster administrator, you can use metering to analyze what is happening in your {ServerlessProductName} cluster.
|
||||
|
||||
For more information about metering on {product-title}, see xref:../metering/metering-about-metering.adoc#about-metering[About metering].
|
||||
For more information about metering on {product-title}, see xref:../../metering/metering-about-metering.adoc#about-metering[About metering].
|
||||
|
||||
[id="installing-metering-serverless_{context}"]
|
||||
== Installing metering
|
||||
For information about installing metering on {product-title}, see xref:../metering/metering-installing-metering.adoc#installing-metering[Installing Metering].
|
||||
For information about installing metering on {product-title}, see xref:../../metering/metering-installing-metering.adoc#installing-metering[Installing Metering].
|
||||
|
||||
include::modules/serverless-metering-datasources.adoc[leveloffset=+1]
|
||||
include::modules/serverless-metering-queries.adoc[leveloffset=+1]
|
||||
@@ -11,7 +11,7 @@ ApiServerSource watches for Kubernetes events and forwards them to the Knative E
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* You must have a current installation of xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[{ServerlessProductName}], including Knative Serving and Eventing, in your {product-title} cluster. This can be installed by a cluster administrator.
|
||||
* You must have a current installation of xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[{ServerlessProductName}], including Knative Serving and Eventing, in your {product-title} cluster. This can be installed by a cluster administrator.
|
||||
* Event sources need a service to use as an event _sink_. The sink is the service or application that events are sent to from the event source.
|
||||
* You must create or update a service account, role and role binding for the event source.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ After events have entered the broker, they can be filtered by https://github.com
|
||||
== Creating a broker
|
||||
|
||||
{ServerlessProductName} provides a `default` Knative broker that can be created by using the Knative CLI.
|
||||
You can also create the `default` broker by adding the `eventing.knative.dev/injection=enabled` label to a namespace if you are a cluster administrator, or by adding the `eventing.knative.dev/injection: enabled` annotation to a trigger if you are a developer.
|
||||
You can also create the `default` broker by adding the `eventing.knative.dev/injection: enabled` annotation to a trigger.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
@@ -27,17 +27,14 @@ Although both developers and cluster administrators can add a broker by injectio
|
||||
|
||||
include::modules/serverless-create-broker-kn.adoc[leveloffset=+2]
|
||||
include::modules/serverless-creating-broker-annotation.adoc[leveloffset=+2]
|
||||
include::modules/serverless-creating-broker-admin.adoc[leveloffset=+2]
|
||||
|
||||
[id="serverless-using-brokers-managing-brokers"]
|
||||
== Managing brokers
|
||||
|
||||
The `kn` CLI provides commands that can be used to list, describe, update, and delete brokers.
|
||||
Cluster administrators can also permanently delete a broker that was created using injection.
|
||||
|
||||
include::modules/serverless-list-broker-kn.adoc[leveloffset=+2]
|
||||
include::modules/serverless-describe-broker-kn.adoc[leveloffset=+2]
|
||||
include::modules/serverless-deleting-broker-admin.adoc[leveloffset=+2]
|
||||
|
||||
[id="serverless-using-brokers-triggers"]
|
||||
== Filtering events using triggers
|
||||
|
||||
@@ -12,7 +12,7 @@ toc::[]
|
||||
|
||||
Installation options for the `oc` CLI will vary depending on your operating system.
|
||||
|
||||
For more information on installing the `oc` CLI for your operating system and logging in with `oc`, see the xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI getting started] documentation.
|
||||
For more information on installing the `oc` CLI for your operating system and logging in with `oc`, see the xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI getting started] documentation.
|
||||
====
|
||||
|
||||
include::modules/serverless-installing-cli-web-console.adoc[leveloffset=+1]
|
||||
@@ -17,7 +17,7 @@ By default, Knative services have a fixed domain format:
|
||||
You can customize the domain for your Knative service by configuring the service as a private service and creating the required {ProductShortName} resources.
|
||||
|
||||
.Prerequisites
|
||||
* Install the xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] and xref:../../serverless/installing_serverless/installing-knative-serving.adoc#installing-knative-serving[Knative Serving].
|
||||
* Install the xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] and xref:../../serverless/admin_guide/installing-knative-serving.adoc#installing-knative-serving[Knative Serving].
|
||||
* Install xref:../../service_mesh/v1x/preparing-ossm-installation.adoc#preparing-ossm-installation-v1x[{ProductName}].
|
||||
* Complete the configuration steps in xref:../../serverless/networking/serverless-ossm.adoc#serverless-ossm[Using {ProductShortName} with {ServerlessProductName}].
|
||||
* You can configure a custom domain for an existing Knative service, or create a new sample service. To create a new service, see xref:../../serverless/serving-creating-managing-apps.adoc#serving-creating-managing-apps[Creating and managing serverless applications].
|
||||
|
||||
@@ -12,7 +12,7 @@ You can enable JSON Web Token (JWT) authentication for Knative services.
|
||||
[id="serverless-ossm-jwt-prerequisites"]
|
||||
== Prerequisites
|
||||
|
||||
* Install xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessProductName}].
|
||||
* Install xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessProductName}].
|
||||
* Install {ProductName}. {ServerlessProductName} is supported for use with both {ProductName} version xref:../../service_mesh/v1x/installing-ossm.adoc#installing-ossm[1.x] and version xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[2.x].
|
||||
* Configure xref:../../serverless/networking/serverless-ossm.adoc#serverless-ossm[{ProductShortName} with {ServerlessProductName}], including enabling sidecar injection for your Knative services.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ You can create a Transport Layer Security (TLS) key and certificates for a custo
|
||||
[id="serverless-ossm-tls-prereqs"]
|
||||
== Prerequisites
|
||||
|
||||
* Install xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessProductName}].
|
||||
* Install xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessProductName}].
|
||||
* Install {ProductName} xref:../../service_mesh/v1x/installing-ossm.adoc#installing-ossm-v1x[1.x] or xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm-v2x[2.x].
|
||||
* Complete the configuration steps in xref:../../serverless/networking/serverless-ossm.adoc#serverless-ossm[Using Service Mesh with OpenShift Serverless].
|
||||
* Configure a custom domain. See xref:../../serverless/networking/serverless-ossm-custom-domains.adoc#serverless-ossm-custom-domains[Using custom domains for Knative services with Service Mesh].
|
||||
|
||||
@@ -13,7 +13,7 @@ These options include setting custom domains, using TLS certificates, and using
|
||||
[id="serverless-ossm-prerequisites"]
|
||||
== Prerequisites
|
||||
|
||||
* Install the xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] and xref:../../serverless/installing_serverless/installing-knative-serving.adoc#installing-knative-serving[Knative Serving].
|
||||
* Install the xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] and xref:../../serverless/admin_guide/installing-knative-serving.adoc#installing-knative-serving[Knative Serving].
|
||||
* Install {ProductName}. {ServerlessProductName} is supported for use with both {ProductName} version xref:../../service_mesh/v1x/installing-ossm.adoc#installing-ossm[1.x] and version xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[2.x].
|
||||
|
||||
include::modules/serverless-ossm-setup.adoc[leveloffset=+1]
|
||||
|
||||
@@ -25,5 +25,5 @@ The set of supported features, configurations, and integrations for {ServerlessP
|
||||
[id="serverless-getting-started-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* Install the xref:../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] on your {product-title} cluster to get started.
|
||||
* Install the xref:../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[{ServerlessOperatorName}] on your {product-title} cluster to get started.
|
||||
* View the xref:../serverless/serverless-release-notes.adoc#serverless-release-notes[{ServerlessProductName} release notes].
|
||||
|
||||
@@ -8,13 +8,8 @@ toc::[]
|
||||
|
||||
include::modules/serverless-apps-intro.adoc[leveloffset=+1]
|
||||
|
||||
== Creating serverless applications using the {product-title} web console
|
||||
|
||||
You can create a serverless application using either the *Developer* or *Administrator* perspective in the {product-title} web console.
|
||||
|
||||
include::modules/creating-serverless-apps-admin-console.adoc[leveloffset=+2]
|
||||
|
||||
=== Creating serverless applications using the Developer perspective
|
||||
[id="serving-creating-managing-apps-ODC"]
|
||||
== Creating serverless applications using the Developer perspective
|
||||
|
||||
For more information about creating applications using the *Developer* perspective in {product-title}, see the documentation on xref:../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user