SRVCOM-1451: Add service mesh, monitoring, metrics docs for OSD

abrennan89 · abrennan89 · commit a7665832d695 · 2022-02-24T16:45:06.000-06:00
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -251,6 +251,8 @@ Topics:
 #     File: serverless-event-sinks
 #   - Name: Event delivery
 #     File: serverless-event-delivery
+#   - Name: Listing event sources and event source types
+#     File: serverless-listing-event-sources
 #   - Name: Creating an API server source
 #     File: serverless-apiserversource
 #   - Name: Creating a ping source
@@ -267,7 +269,6 @@ Topics:
 #     File: serverless-triggers
 #   - Name: Knative Kafka
 #     File: serverless-kafka-developer
-# # Admin guide
 # - Name: Administer
 #   Dir: admin_guide
 #   Topics:
@@ -285,8 +286,27 @@ Topics:
 #     File: knative-serving-CR-config
 #   - Name: Autoscaling
 #     File: serverless-admin-autoscaling
+#   - Name: Integrating Service Mesh with OpenShift Serverless
+#     File: serverless-ossm-setup
+#   - Name: Monitoring serverless components
+#     File: serverless-admin-monitoring
+#   - Name: Metrics
+#     File: serverless-admin-metrics
 #   - Name: High availability on OpenShift Serverless
 #     File: serverless-ha
+# - Name: Monitor
+#   Dir: monitor
+#   Topics:
+#   - Name: Cluster logging with OpenShift Serverless
+#     File: cluster-logging-serverless
+#   - Name: Tracing requests using Jaeger
+#     File: serverless-tracing
+#   - Name: Metrics
+#     File: serverless-serving-metrics
+#   - Name: Monitoring Knative services
+#     File: serverless-service-monitoring
+#   - Name: Autoscaling dashboard
+#     File: serverless-autoscaling-dashboard
 # - Name: Support
 #   File: serverless-support
 # - Name: Security
@@ -334,6 +354,19 @@ Topics:
 #     File: installing-kn
 #   - Name: Knative CLI advanced configuration
 #     File: advanced-kn-config
+# - Name: Reference
+#   Dir: reference
+#   Topics:
+#   - Name: Knative CLI flags
+#     File: kn-flags-reference
+#   - Name: Knative Serving CLI commands
+#     File: kn-serving-ref
+#   - Name: Knative Eventing CLI commands
+#     File: kn-eventing-ref
+#   - Name: Functions commands
+#     File: kn-func-ref
+#   - Name: kn event
+#     File: kn-event-ref
 ---
 Name: Support
 Dir: support
diff --git a/modules/serverless-admin-monitoring-eventing-broker-trigger.adoc b/modules/serverless-admin-monitoring-eventing-broker-trigger.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view metrics for broker
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-admin-monitoring-eventing-channel.adoc b/modules/serverless-admin-monitoring-eventing-channel.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view metrics for channe
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You installed the {ServerlessOperatorName}, the Knative Eventing component, and the `KnativeKafka` custom resource.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-admin-monitoring-eventing-cpu-memory.adoc b/modules/serverless-admin-monitoring-eventing-cpu-memory.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view source CPU and mem
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-admin-monitoring-eventing-sources.adoc b/modules/serverless-admin-monitoring-eventing-sources.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view metrics for event
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You have installed the {ServerlessOperatorName}, as well as the Knative Eventing component.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-admin-monitoring-health-status.adoc b/modules/serverless-admin-monitoring-health-status.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view the overall health
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You have installed the {ServerlessOperatorName}, as well as the Knative Serving or Knative Eventing components.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-admin-monitoring-serving-cpu-memory.adoc b/modules/serverless-admin-monitoring-serving-cpu-memory.adoc
@@ -10,7 +10,15 @@ You can use the {product-title} monitoring dashboards to view revision CPU and m
 
 .Prerequisites
 
-* You have cluster administrator permissions, and access to the *Administrator* perspective in the {product-title} web console.
+ifdef::openshift-enterprise[]
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 * You have installed the {ServerlessOperatorName}, as well as the Knative Serving component.
 * The {product-title} monitoring stack is enabled on your cluster. You can enable monitoring for {ServerlessProductName} during installation by checking the box to *Enable operator recommended cluster monitoring on this namespace* when installing the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-deprecated-removed-features-osd.adoc b/modules/serverless-deprecated-removed-features-osd.adoc
@@ -0,0 +1,50 @@
+// Module included in the following assemblies:
+//
+// * serverless/serverless-release-notes.adoc
+
+:_content-type: REFERENCE
+[id="serverless-deprecated-removed-features-osd_{context}"]
+= Deprecated and removed features
+
+Some features available in previous releases have been deprecated or removed.
+
+Deprecated functionality is still included in {ServerlessProductName} and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments. For the most recent list of major functionality deprecated and removed within {ServerlessProductName}, refer to the table below.
+
+In the table, features are marked with the following statuses:
+
+* *-*: _Not yet available_
+* *TP*: _Technology Preview_
+* *GA*: _General Availability_
+* *DEP*: _Deprecated_
+* *REM*: _Removed_
+
+.Deprecated and removed features tracker
+[cols="3,1",options="header"]
+|====
+|Feature |1.20
+
+|`kn func emit` (`kn func invoke` in 1.21+)
+|TP
+
+|Service Mesh mTLS
+|GA
+
+|`kn func` TypeScript templates
+|TP
+
+|`kn func` Rust templates
+|TP
+
+|`emptyDir` volumes
+|GA
+
+|`KafkaBinding` API
+|DEP
+
+|HTTPS redirection
+|GA
+
+|Kafka broker
+|TP
+
+|====
diff --git a/modules/serverless-jaeger-config.adoc b/modules/serverless-jaeger-config.adoc
@@ -10,7 +10,14 @@ You can use the following procedure to set up Jaeger for use with {ServerlessPro
 
 .Prerequisites
 
+ifdef::openshift-enterprise[]
 * You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
 * You have installed the {ServerlessOperatorName} and Knative Serving.
 * You have installed the Jaeger Operator.
 * You have installed the `oc` CLI.
diff --git a/modules/serverless-ossm-enabling-serving-metrics.adoc b/modules/serverless-ossm-enabling-serving-metrics.adoc
@@ -12,7 +12,15 @@ If Service Mesh is enabled with mTLS, metrics for Knative Serving are disabled b
 
 * You have installed the {ServerlessOperatorName} and Knative Serving on your cluster.
 * You have installed {ProductName} with the mTLS functionality enabled.
+
+ifdef::openshift-enterprise[]
 * You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
 * You have installed the `oc` CLI.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
diff --git a/modules/serverless-ossm-setup-with-kourier.adoc b/modules/serverless-ossm-setup-with-kourier.adoc
@@ -8,7 +8,14 @@
 
 .Prerequisites
 
+ifdef::openshift-enterprise[]
 * You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
 * You have installed the `oc` CLI.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 * You have installed the {ServerlessOperatorName} and Knative Serving on your cluster.
diff --git a/modules/serverless-ossm-setup.adoc b/modules/serverless-ossm-setup.adoc
@@ -11,7 +11,15 @@ You can integrate {ProductShortName} with {ServerlessProductName} without using
 .Prerequisites
 
 * You have installed {ProductName}. {ServerlessProductName} with {ProductShortName} only is supported for use with {ProductName} version 2.0.5 or higher.
+
+ifdef::openshift-enterprise[]
 * You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
 * You have installed the {ServerlessOperatorName}.
 +
 [IMPORTANT]
diff --git a/modules/serverlesss-ossm-external-certs.adoc b/modules/serverlesss-ossm-external-certs.adoc
@@ -10,7 +10,14 @@ By default, the {ProductShortName} mTLS feature only secures traffic inside of t
 
 .Prerequisites
 
+ifdef::openshift-enterprise[]
 * You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
 * You have installed the {ServerlessOperatorName} and Knative Serving.
 * You have installed the `oc` CLI.
 * You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
diff --git a/serverless/admin_guide/serverless-admin-metrics.adoc b/serverless/admin_guide/serverless-admin-metrics.adoc
@@ -12,8 +12,17 @@ Metrics enable cluster administrators to monitor how {ServerlessProductName} clu
 [id="prerequisites_serverless-admin-metrics"]
 == Prerequisites
 
+ifdef::openshift-enterprise[]
 * See the {product-title} documentation on xref:../../monitoring/managing-metrics.adoc#managing-metrics[Managing metrics] for information about enabling metrics for your cluster.
-* To view metrics for Knative components on {product-title}, you need cluster administrator permissions, and access to the web console *Administrator* perspective.
+
+* You have access to an {product-title} account with cluster administrator access.
+endif::[]
+
+ifdef::openshift-dedicated[]
+* You have access to an {product-title} account with cluster or dedicated administrator access.
+endif::[]
+
+* You have access to the *Administrator* perspective in the {product-title} web console.
 
 [WARNING]
 ====
diff --git a/serverless/monitor/serverless-service-monitoring.adoc b/serverless/monitor/serverless-service-monitoring.adoc
@@ -29,6 +29,7 @@ include::modules/serverless-monitoring-services-examining-metrics.adoc[leveloffs
 
 include::modules/serverless-monitoring-services-examining-metrics-dashboard.adoc[leveloffset=+1]
 
+ifdef::openshift-enterprise[]
 [id="additional-resources_serverless-service-monitoring"]
 [role="_additional-resources"]
 == Additional resources
@@ -40,3 +41,4 @@ include::modules/serverless-monitoring-services-examining-metrics-dashboard.adoc
 * xref:../../monitoring/managing-metrics.adoc#specifying-how-a-service-is-monitored[Enabling monitoring for user-defined projects]
 
 * xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Specifying how a service is monitored]
+endif::[]
diff --git a/serverless/monitor/serverless-tracing.adoc b/serverless/monitor/serverless-tracing.adoc
@@ -16,7 +16,9 @@ The units of work might be executed in different processes or hosts.
 
 Developers can visualize call flows in large architectures with distributed tracing. which is useful for understanding serialization, parallelism, and sources of latency.
 
+ifdef::openshift-enterprise[]
 For more information about distributed tracing, see xref:../../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[distributed tracing architecture] and xref:../../distr_tracing/distr_tracing_install/distr-tracing-installing.adoc#install-distributed-tracing[Installing distributed tracing].
+endif::[]
 
 // Serverless specific modules
 include::modules/serverless-jaeger-config.adoc[leveloffset=+1]
diff --git a/serverless/serverless-release-notes.adoc b/serverless/serverless-release-notes.adoc
@@ -25,15 +25,18 @@ include::modules/serverless-api-versions.adoc[leveloffset=+1]
 ifdef::openshift-enterprise[]
 include::modules/serverless-deprecated-removed-features.adoc[leveloffset=+1]
 endif::[]
-// Add OSD
+
+ifdef::openshift-dedicated[]
+include::modules/serverless-deprecated-removed-features-osd.adoc[leveloffset=+1]
+endif::[]
 
 // Release notes included, most to least recent
 // OCP + OSD
+include::modules/serverless-rn-1-20-0.adoc[leveloffset=+1]
 // include::modules/serverless-rn-1-21-0.adoc[leveloffset=+1]
 
 // OCP only
 ifdef::openshift-enterprise[]
-include::modules/serverless-rn-1-20-0.adoc[leveloffset=+1]
 include::modules/serverless-rn-1-19-0.adoc[leveloffset=+1]
 include::modules/serverless-rn-1-18-0.adoc[leveloffset=+1]
 endif::[]
