Merge pull request #42212 from abrennan89/OSD2

abrennan89 · web-flow · commit 9b66dd831b2c · 2022-02-23T16:02:52.000-06:00
SRVCOM-1451: Adding functions, install, CLI, and HA docs for OSD
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -219,15 +219,23 @@ Topics:
 #  Topics:
 #  - Name: About OpenShift Serverless
 #    File: about-serverless
+#  - Name: About OpenShift Serverless Functions
+#    File: serverless-functions-about
 #  - Name: Event sources
 #    File: knative-event-sources
 #  - Name: Channels and subscriptions
 #    File: serverless-channels
-#- Name: CLI tools
-#  Dir: cli_tools
+#- Name: Install
+#  Dir: install
 #  Topics:
-#  - Name: Knative CLI advanced configuration
-#    File: advanced-kn-config
+#  - Name: Installing the OpenShift Serverless Operator
+#    File: install-serverless-operator
+#  - Name: Installing Knative Serving
+#    File: installing-knative-serving
+#  - Name: Installing Knative Eventing
+#    File: installing-knative-eventing
+#  - Name: Removing OpenShift Serverless
+#    File: removing-openshift-serverless
 #- Name: Develop
 #  Dir: develop
 #  Topics:
@@ -253,13 +261,51 @@ Topics:
 #    File: serverless-triggers
 #  - Name: Knative Kafka
 #    File: serverless-kafka-developer
+# Admin guide
 #- Name: Administer
 #  Dir: admin_guide
 #  Topics:
 #  - Name: Configuring Knative Eventing defaults
 #    File: serverless-configuring-eventing-defaults
 #  - Name: Knative Kafka
 #    File: serverless-kafka-admin
+#  - Name: High availability on OpenShift Serverless
+#    File: serverless-ha
+# Functions
+#- Name: Functions
+#  Dir: functions
+#  Topics:
+#  - Name: Setting up OpenShift Serverless Functions
+#    File: serverless-functions-setup
+#  - Name: Getting started with functions
+#    File: serverless-functions-getting-started
+#  - Name: Developing Node.js functions
+#    File: serverless-developing-nodejs-functions
+#  - Name: Developing TypeScript functions
+#    File: serverless-developing-typescript-functions
+#  - Name: Developing Golang functions
+#    File: serverless-developing-go-functions
+#  - Name: Developing Python functions
+#    File: serverless-developing-python-functions
+#  - Name: Developing Quarkus functions
+#    File: serverless-developing-quarkus-functions
+#  - Name: Using functions with Knative Eventing
+#    File: serverless-functions-eventing
+#  - Name: Function project configuration in func.yaml
+#    File: serverless-functions-yaml
+#  - Name: Accessing secrets and config maps from functions
+#    File: serverless-functions-accessing-secrets-configmaps
+#  - Name: Adding annotations to functions
+#    File: serverless-functions-annotations
+#  - Name: Functions development reference guide
+#    File: serverless-functions-reference-guide
+#- Name: CLI tools
+#  Dir: cli_tools
+#  Topics:
+#  - Name: Installing the Knative CLI
+#    File: installing-kn
+#  - Name: Knative CLI advanced configuration
+#    File: advanced-kn-config
 ---
 Name: Support
 Dir: support
diff --git a/modules/serverless-config-replicas-eventing.adoc b/modules/serverless-config-replicas-eventing.adoc
@@ -10,7 +10,14 @@ You can scale Knative Eventing components by modifying the `spec.high-availabili
 
 .Prerequisites
 
-* You have access to an {product-title} cluster with cluster administrator permissions.
+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 administrator or dedicated administrator access.
+endif::[]
+
 * The {ServerlessOperatorName} and Knative Eventing are installed on your cluster.
 
 .Procedure
diff --git a/modules/serverless-config-replicas-kafka.adoc b/modules/serverless-config-replicas-kafka.adoc
@@ -10,7 +10,14 @@ You can scale Knative Kafka components by modifying the `spec.high-availability.
 
 .Prerequisites
 
-* You have access to an {product-title} cluster with cluster administrator permissions.
+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 administrator or dedicated administrator access.
+endif::[]
+
 * The {ServerlessOperatorName} and Knative Kafka are installed on your cluster.
 
 .Procedure
diff --git a/modules/serverless-config-replicas-serving.adoc b/modules/serverless-config-replicas-serving.adoc
@@ -10,7 +10,14 @@ You can scale Knative Serving components by modifying the `spec.high-availabilit
 
 .Prerequisites
 
-* You have access to an {product-title} cluster with cluster administrator permissions.
+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 administrator or dedicated administrator access.
+endif::[]
+
 * The {ServerlessOperatorName} and Knative Serving are installed on your cluster.
 
 .Procedure
diff --git a/modules/serverless-deleting-crds.adoc b/modules/serverless-deleting-crds.adoc
@@ -15,7 +15,14 @@ Removing the Operator and API CRDs also removes all resources that were defined
 
 .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 administrator or dedicated administrator access.
+endif::[]
+
 * You have uninstalled Knative Serving and removed the {ServerlessOperatorName}.
 
 .Procedure
diff --git a/modules/serverless-install-eventing-web-console.adoc b/modules/serverless-install-eventing-web-console.adoc
@@ -10,7 +10,14 @@ You can use the following procedure to install Knative Eventing by using the {pr
 
 .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 administrator or dedicated administrator access.
+endif::[]
+
 * You have logged in to the {product-title} web console.
 * You have installed the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-install-eventing-yaml.adoc b/modules/serverless-install-eventing-yaml.adoc
@@ -10,7 +10,14 @@ You can use the following procedure to install Knative Eventing by applying YAML
 
 .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 administrator or dedicated administrator access.
+endif::[]
+
 * You have installed the {ServerlessOperatorName}.
 
 .Procedure
diff --git a/modules/serverless-install-serving-web-console.adoc b/modules/serverless-install-serving-web-console.adoc
@@ -10,7 +10,14 @@ You can use the following procedure to install Knative Serving by using the {pro
 
 .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 administrator or dedicated administrator access.
+endif::[]
+
 * You have logged in to the {product-title} web console.
 * You have installed the {ServerlessOperatorName}.
 
diff --git a/modules/serverless-install-serving-yaml.adoc b/modules/serverless-install-serving-yaml.adoc
@@ -10,7 +10,14 @@ You can use the following procedure to install Knative Serving by applying YAML
 
 .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 administrator or dedicated administrator access.
+endif::[]
+
 * You have installed the {ServerlessOperatorName}.
 
 .Procedure
diff --git a/modules/serverless-install-web-console.adoc b/modules/serverless-install-web-console.adoc
@@ -10,7 +10,14 @@ This procedure describes how to install and subscribe to the {ServerlessOperator
 
 .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 logged in to the {product-title} web console.
 
 .Procedure
diff --git a/modules/serverless-uninstalling-knative-eventing.adoc b/modules/serverless-uninstalling-knative-eventing.adoc
@@ -10,7 +10,13 @@ To uninstall Knative Eventing, you must remove its custom resource (CR) and dele
 
 .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 administrator or dedicated administrator access.
+endif::[]
 
 .Procedure
 
diff --git a/modules/serverless-uninstalling-knative-serving.adoc b/modules/serverless-uninstalling-knative-serving.adoc
@@ -10,7 +10,13 @@ To uninstall Knative Serving, you must remove its custom resource (CR) and delet
 
 .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 administrator or dedicated administrator access.
+endif::[]
 
 .Procedure
 
diff --git a/serverless/cli_tools/installing-kn.adoc b/serverless/cli_tools/installing-kn.adoc
@@ -11,7 +11,11 @@ Installation options for the `oc` CLI may vary depending on your operating syste
 
 The Knative CLI (`kn`) does not have its own login mechanism. To log in to the cluster, you must install the `oc` CLI and use the `oc login` command.
 
+ifdef::openshift-enterprise[]
 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.
+endif::[]
+// need to wait til CLI docs are added to OSD for this link to work
+// TODO: remove this conditional once this is available
 
 {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/install/install-serverless-operator.adoc#install-serverless-operator[Installing the {ServerlessOperatorName}] documentation.
 
diff --git a/serverless/functions/serverless-functions-getting-started.adoc b/serverless/functions/serverless-functions-getting-started.adoc
@@ -23,10 +23,14 @@ include::modules/serverless-deploy-func-kn.adoc[leveloffset=+1]
 include::modules/serverless-kn-func-emit.adoc[leveloffset=+1]
 include::modules/serverless-functions-using-integrated-registry.adoc[leveloffset=+1]
 
+ifdef::openshift-enterprise[]
 [role="_additional-resources"]
 == Additional resources
 
 * See xref:../../registry/securing-exposing-registry.adoc#securing-exposing-registry[Exposing a default registry manually].
+endif::[]
+// need to wait til registry docs are added to OSD for this link to work
+// TODO: remove these conditionals once this is available
 
 [id="next-steps_serverless-functions-getting-started"]
 == Next steps
diff --git a/serverless/functions/serverless-functions-setup.adoc b/serverless/functions/serverless-functions-setup.adoc
@@ -24,21 +24,46 @@ To enable the use of {FunctionsProductName} on your cluster, you must complete t
 Functions are deployed as a Knative service. If you want to use event-driven architecture with your functions, you must also install Knative Eventing.
 ====
 
+ifdef::openshift-enterprise[]
 * The xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[`oc` CLI] is installed on your cluster.
+endif::[]
+// need to wait til CLI docs are added to OSD for this link to work
+// TODO: remove these conditionals once this is available
+ifdef::openshift-dedicated[]
+* The `oc` CLI is installed on your cluster.
+endif::[]
 
 * The xref:../../serverless/cli_tools/installing-kn.adoc#installing-kn[Knative (`kn`) CLI] is installed on your cluster. Installing the `kn` CLI enables the use of `kn func` commands which you can use to create and manage functions.
 
 * You have installed Docker Container Engine or podman version 3.3 or higher, and have access to an available image registry.
 
+ifdef::openshift-enterprise[]
 * If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have followed the {product-title} documentation on xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets[Allowing pods to reference images from other secured registries].
+endif::[]
+// need to wait til images docs are added to OSD for this link to work
+// TODO: remove these conditionals once this is available
+ifdef::openshift-dedicated[]
+* If you are using link:https://quay.io/[Quay.io] as the image registry, you must ensure that either the repository is not private, or that you have allowed pods on your cluster to reference images from other secured registries.
+endif::[]
 
+ifdef::openshift-enterprise[]
 * If you are using the OpenShift Container Registry, a cluster administrator must xref:../../registry/securing-exposing-registry.adoc#securing-exposing-registry[expose the registry].
+endif::[]
+// need to wait til registry docs are added to OSD for this link to work
+// TODO: remove these conditionals once this is available
+ifdef::openshift-dedicated[]
+* If you are using the OpenShift Container Registry, a cluster or dedicated administrator must expose the registry.
+endif::[]
 
 include::modules/serverless-functions-podman.adoc[leveloffset=+1]
 
 [id="next-steps_serverless-functions-setup"]
 == Next steps
 
+ifdef::openshift-enterprise[]
 * For more information about Docker Container Engine or podman, see xref:../../architecture/understanding-development.adoc#container-build-tool-options[Container build tool options].
+endif::[]
+// need to wait til build tool docs are added to OSD for this link to work
+// TODO: remove these conditionals once this is available
 
 * See xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-functions-getting-started[Getting started with functions].
diff --git a/serverless/install/install-serverless-operator.adoc b/serverless/install/install-serverless-operator.adoc
@@ -9,6 +9,7 @@ toc::[]
 
 You can install the {ServerlessOperatorName} to an {product-title} cluster by following the procedures in this document.
 
+ifdef::openshift-enterprise[]
 [id="install-serverless-operator-before-you-begin"]
 == Before you begin
 
@@ -17,21 +18,28 @@ Read the following information about supported configurations and prerequisites
 * {ServerlessProductName} is supported for installation in a restricted network environment.
 
 * {ServerlessProductName} currently cannot be used in a multi-tenant configuration on a single cluster.
+endif::[]
 
 include::modules/serverless-cluster-sizing-req.adoc[leveloffset=+2]
 
+ifdef::openshift-enterprise[]
 [id="install-serverless-operator-scaling-with-machinesets"]
 === Scaling your cluster using machine sets
 
 You can use the {product-title} `MachineSet` API to manually scale your cluster up to the desired size. The minimum requirements usually mean that you must scale up one of the default machine sets by two additional machines. See xref:../../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a machine set].
+endif::[]
+// TODO: Add OSD specific docs for auto scaling machine sets? These docs aren't available for OSD so we need to look into what's required to doc here.
+// QE thread related: https://coreos.slack.com/archives/CD87JDUB0/p1643986092796179
 
 include::modules/serverless-install-web-console.adoc[leveloffset=+1]
 
 [id="additional-resources_install-serverless-operator"]
 [role="_additional-resources"]
 == Additional resources
 
+ifdef::openshift-enterprise[]
 * For more information about using {ServerlessProductName} on a restricted network environment, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
+endif::[]
 
 * HA is enabled for some Knative components by default. You can configure HA by following the documentation on xref:../../serverless/admin_guide/serverless-ha.adoc#serverless-ha[Configuring high availability replicas on {ServerlessProductName}].
 
