Skip to content

Commit adb603d

Browse files
abrennan89vikram-redhat
authored andcommitted
Adding admin guide for Serverless docs
1 parent aaecdde commit adb603d

29 files changed

+123
-80
lines changed

_topic_map.yml

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2740,13 +2740,22 @@ Name: Serverless applications
27402740
Dir: serverless
27412741
Distros: openshift-enterprise,openshift-webscale
27422742
Topics:
2743+
# Release notes
2744+
- Name: Release Notes
2745+
File: serverless-release-notes
2746+
# Support
2747+
- Name: Support
2748+
File: serverless-support
27432749
# Intro / getting started
27442750
- Name: Getting started
27452751
File: serverless-getting-started
2746-
# Installing OpenShift Serverless
2747-
- Name: Installing OpenShift Serverless
2748-
Dir: installing_serverless
2752+
- Name: Installing the Knative CLI
2753+
File: installing-kn
2754+
# Admin guide
2755+
- Name: Administration guide
2756+
Dir: admin_guide
27492757
Topics:
2758+
#Installation
27502759
- Name: Installing OpenShift Serverless
27512760
File: installing-openshift-serverless
27522761
- Name: Installing Knative Serving
@@ -2759,8 +2768,14 @@ Topics:
27592768
File: upgrading-serverless
27602769
- Name: Removing OpenShift Serverless
27612770
File: removing-openshift-serverless
2762-
- Name: Installing the Knative CLI
2763-
File: installing-kn
2771+
# Admin console
2772+
- Name: Creating Eventing components as a cluster administrator
2773+
File: serverless-cluster-admin-eventing
2774+
- Name: Creating Serving components as a cluster administrator
2775+
File: serverless-cluster-admin-serving
2776+
# Metering
2777+
- Name: Using metering with OpenShift Serverless
2778+
File: serverless-metering
27642779
# Architecture
27652780
- Name: Architecture
27662781
Dir: architecture
@@ -2836,18 +2851,9 @@ Topics:
28362851
Topics:
28372852
- Name: Monitoring serverless components
28382853
File: serverless-monitoring
2839-
# Metering
2840-
- Name: Using metering with OpenShift Serverless
2841-
File: serverless-metering
28422854
# Integrations
28432855
- Name: Integrations
28442856
Dir: integrations
28452857
Topics:
28462858
- Name: Using NVIDIA GPU resources with serverless applications
28472859
File: gpu-resources
2848-
# Release notes
2849-
- Name: Release Notes
2850-
File: serverless-release-notes
2851-
# Support
2852-
- Name: Support
2853-
File: serverless-support

applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ ifdef::openshift-enterprise,openshift-webscale[]
3131

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

34-
* You have xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[installed the OpenShift Serverless Operator].
35-
* 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].
34+
* You have xref:../../serverless/admin_guide/installing-openshift-serverless.adoc#installing-openshift-serverless[installed the OpenShift Serverless Operator].
35+
* You have xref:../../serverless/admin_guide/installing-knative-serving.adoc#installing-knative-serving[created a `KnativeServing` resource in the `knative-serving` namespace].
3636

3737
endif::[]
3838

cli_reference/kn-cli-tools.adoc

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,30 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

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

11-
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}].
11+
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}].
1212

1313
[NOTE]
1414
====
15-
{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}.
15+
{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}.
1616
====
1717

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

22-
* xref:../serverless/serving-creating-managing-apps.adoc#serving-creating-managing-apps[Deploy serverless applications] from the command line.
21+
The `kn` CLI is designed to make serverless computing tasks simple and concise.
22+
Key features of the `kn` CLI include:
23+
24+
* Deploy serverless applications from the command line.
2325
* Manage features of Knative Serving, such as services, revisions, and traffic-splitting.
24-
// TODO: add docs about revisions
2526
* Create and manage Knative Eventing components, such as event sources and triggers.
26-
+
27-
[NOTE]
28-
====
29-
Knative Eventing is currently available as a Technology Preview feature of {ServerlessProductName}.
30-
====
31-
* Create xref:../serverless/event_sources/serverless-sinkbinding.adoc#serverless-sinkbinding[sink binding] to connect existing Kubernetes applications and Knative services.
32-
* Extend `kn` with flexible plugin architecture, similar to `kubectl`.
33-
// * Easily integrate {ServerlessProductName} with OpenShift Pipelines by using `kn` in an OpenShift Pipelines task
34-
// TODO: Add integrations later when we have docs about this.
35-
// TODO: add docs about these deployment types?
36-
* Configure xref:../serverless/knative_serving/configuring-knative-serving-autoscaling.adoc#configuring-knative-serving-autoscaling[autoscaling] parameters for Knative services.
27+
* Create sink bindings to connect existing Kubernetes applications and Knative services.
28+
* Extend the `kn` CLI with flexible plug-in architecture, similar to the `kubectl` CLI.
29+
* Configure autoscaling parameters for Knative services.
3730
* Scripted usage, such as waiting for the results of an operation, or deploying custom rollout and rollback strategies.
3831

39-
== Installing `kn`
32+
[id="kn-cli-tools-installing-kn"]
33+
== Installing the Knative CLI
4034

41-
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`)].
35+
See xref:../serverless/installing-kn.adoc#installing-kn[Installing the Knative CLI].
Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
11
// Module included in the following assemblies:
22
//
3-
// serverless/serving-creating-managing-apps.adoc
3+
// serverless/admin_guide/serverless-cluster-admin-serving.adoc
44

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

88
.Prerequisites
9+
910
To create serverless applications using the *Administrator* perspective, ensure that you have completed the following steps.
1011

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

1415
.Procedure
1516

16-
. Navigate to the *Serverless* → *Services* page.
17-
+
18-
image::serverless-create-service-admin.png[Services page]
19-
. Click *Create Service*.
17+
. Navigate to the *Serverless* -> *Serving* page.
18+
. In the *Create* list, select *Service*.
2019
. Manually enter YAML or JSON definitions, or by dragging and dropping a file into the editor.
21-
+
22-
image::service-yaml-admin.png[Text editor]
2320
. Click *Create*.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/admin_guide/serverless-cluster-admin-eventing.adoc
4+
5+
[id="serverless-creating-broker-admin-web-console_{context}"]
6+
= Creating a broker by using the Administrator perspective
7+
8+
If you have cluster administrator permissions, you can create a broker by using the Administrator perspective in the web console.
9+
10+
.Prerequisites
11+
12+
* The {ServerlessOperatorName} and Knative Eventing are installed on your {product-title} cluster.
13+
* You have cluster administrator permissions for {product-title}.
14+
15+
.Procedure
16+
17+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Serverless* -> *Eventing*.
18+
. In the *Create* list, select *Broker*. You will be directed to the *Create Broker* page.
19+
. Optional: Modify the YAML configuration for the broker.
20+
. Click *Create*.

modules/serverless-install-kafka-odc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Cluster administrators can enable the use of Apache Kafka functionality in an {S
1616

1717
.Procedure
1818

19-
. In the *Administrator* perspective, navigate to *Operators* *Installed Operators*.
19+
. In the *Administrator* perspective, navigate to *Operators* -> *Installed Operators*.
2020
. Check that the *Project* dropdown at the top of the page is set to *Project: knative-eventing*.
2121
. Click *Knative Kafka* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Kafka* tab.
2222
. Click *Create Knative Kafka*.

modules/serverless-install-serving-web-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= Installing Knative Serving using the web console
77

88
.Procedure
9-
. In the *Administrator* perspective of the {product-title} web console, navigate to *Operators* *Installed Operators*.
9+
. In the *Administrator* perspective of the {product-title} web console, navigate to *Operators* -> *Installed Operators*.
1010
. Check that the *Project* dropdown at the top of the page is set to *Project: knative-serving*.
1111
. Click *Knative Serving* in the list of *Provided APIs* for the {ServerlessOperatorName} to go to the *Knative Serving* tab.
1212
+

modules/serverless-install-web-console.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This procedure describes how to install and subscribe to the {ServerlessOperator
99

1010
.Procedure
1111

12-
. In the {product-title} web console, navigate to the *Operators* *OperatorHub* page.
12+
. In the {product-title} web console, navigate to the *Operators* -> *OperatorHub* page.
1313
. Scroll, or type they keyword *Serverless* into the *Filter by keyword box* to find the {ServerlessOperatorName}.
1414
+
1515
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
2121
.. Select the *4.6* channel as the *Update Channel*. The *4.6* channel will enable installation of the latest stable release of the {ServerlessOperatorName}.
2222
.. Select *Automatic* or *Manual* approval strategy.
2323
. Click *Install* to make the Operator available to the selected namespaces on this {product-title} cluster.
24-
. From the *Catalog* *Operator Management* page, you can monitor the {ServerlessOperatorName} subscription’s installation and upgrade progress.
24+
. From the *Catalog* -> *Operator Management* page, you can monitor the {ServerlessOperatorName} subscription’s installation and upgrade progress.
2525
.. 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*.
2626
.. If you selected an *Automatic* approval strategy, the upgrade status should resolve to *Up to date* without intervention.
2727

2828
.Verification steps
2929

30-
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.
30+
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.
3131

3232
If it does not:
3333

34-
. Switch to the *Catalog* *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
35-
. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* *Pods* page that are reporting issues to troubleshoot further.
34+
. Switch to the *Catalog* -> *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
35+
. Check the logs in any pods in the `openshift-serverless` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.

modules/serverless-upgrade-sub-channel.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ If you have selected Manual updates, you will need to complete additional steps
1717
.Procedure
1818

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

0 commit comments

Comments
 (0)