Merge pull request #51032 from rh-max/srvls-functions-updates

[SRVOCF-438] Serverless functions - updates and additions

Author: abrennan89

modules/serverless-create-func-kn.adoc

@@ -9,6 +9,9 @@
 
 Before you can build and deploy a function, you must create it by using the Knative (`kn`) CLI. You can specify the path, runtime, template, and image registry as flags on the command line, or use the `-c` flag to start the interactive experience in the terminal.
 
+:FeatureName: {FunctionsProductName}
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
 .Prerequisites
 
 * The {ServerlessOperatorName} and Knative Serving are installed on the cluster.
@@ -22,23 +25,19 @@ Before you can build and deploy a function, you must create it by using the Knat
 ----
 $ kn func create -r <repository> -l <runtime> -t <template> <path>
 ----
-** Accepted runtime values include `node`, `go`, `python`, `quarkus`, and `typescript`.
-** Accepted template values include `http` and `events`.
+** Accepted runtime values include `quarkus`, `node`, `typescript`, `go`, `python`, `springboot`, and `rust`.
+** Accepted template values include `http` and `cloudevents`.
 +
 .Example command
 [source,terminal]
 ----
-$ kn func create -l typescript -t events examplefunc
+$ kn func create -l typescript -t cloudevents examplefunc
 ----
 +
 .Example output
 [source,terminal]
 ----
-Project path:  /home/user/demo/examplefunc
-Function name: examplefunc
-Runtime:       typescript
-Template:      events
-Writing events to /home/user/demo/examplefunc
+Created typescript function in /home/user/demo/examplefunc
 ----
 +
 ** Alternatively, you can specify a repository that contains a custom template.
@@ -52,9 +51,5 @@ $ kn func create -r https://github.com/boson-project/templates/ -l node -t hello
 .Example output
 [source,terminal]
 ----
-Project path:  /home/user/demo/examplefunc
-Function name: examplefunc
-Runtime:       node
-Template:      hello-world
-Writing events to /home/user/demo/examplefunc
+Created node function in /home/user/demo/examplefunc
 ----

modules/serverless-functions-podman-macos.adoc

@@ -0,0 +1,56 @@
+// Module included in the following assemblies:
+//
+// * serverless/functions/serverless-functions-setup.adoc
+
+:_content-type: PROCEDURE
+[id="serverless-functions-podman-macos_{context}"]
+= Setting up podman on macOS
+
+To use advanced container management features, you might want to use podman with {FunctionsProductName}. To do so on macOS, you need to start the podman machine and configure the Knative (`kn`) CLI to connect to it.
+
+.Procedure
+
+. Create the podman machine:
++
+[source,terminal]
+----
+$ podman machine init --memory=8192 --cpus=2 --disk-size=20
+----
+
+. Start the podman machine, which serves the Docker API on a UNIX socket:
++
+[source,terminal]
+----
+$ podman machine start
+Starting machine "podman-machine-default"
+Waiting for VM ...
+Mounting volume... /Users/myuser:/Users/user
+
+[...truncated output...]
+
+You can still connect Docker API clients by setting DOCKER_HOST using the
+following command in your terminal session:
+
+	export DOCKER_HOST='unix:///Users/myuser/.local/share/containers/podman/machine/podman-machine-default/podman.sock'
+
+Machine "podman-machine-default" started successfully
+----
++
+[NOTE]
+====
+On most macOS systems, this socket is located at `/Users/myuser/.local/share/containers/podman/machine/podman-machine-default/podman.sock`.
+====
+
+. Establish the environment variable that is used to build a function:
++
+[source,terminal]
+----
+$ export DOCKER_HOST='unix:///Users/myuser/.local/share/containers/podman/machine/podman-machine-default/podman.sock'
+----
+
+. Run the build command inside your function project directory with the `-v` flag to see verbose output. You should see a connection to your local UNIX socket:
++
+[source,terminal]
+----
+$ kn func build -v
+----

modules/serverless-kn-func-invoke.adoc

@@ -3,16 +3,25 @@
 // * serverless/functions/serverless-functions-getting-started.adoc
 // * serverless/reference/kn-func-ref.adoc
 
-:_content-type: REFERENCE
+:_content-type: PROCEDURE
 [id="serverless-kn-func-invoke_{context}"]
 = Invoking a deployed function with a test event
 
 You can use the `kn func invoke` CLI command to send a test request to invoke a function either locally or on your {product-title} cluster. This command can be used to test that a function is working and able to receive events correctly.
 
-.Example command
+.Prerequisites
+
+* The {ServerlessOperatorName} and Knative Serving are installed on the cluster.
+* You have installed the Knative (`kn`) 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 must have already deployed the function that you want to invoke.
+
+.Procedure
+
+* Invoke a function:
++
 [source,terminal]
 ----
 $ kn func invoke
 ----
-
-The `kn func invoke` command executes on the local directory by default, and assumes that this directory is a function project.
+** The `kn func invoke` command executes on the local directory by default, and assumes that this directory is a function project.

serverless/functions/serverless-functions-setup.adoc

@@ -24,17 +24,17 @@ Functions are deployed as a Knative service. If you want to use event-driven arc
 ====
 
 ifdef::openshift-enterprise[]
-* The xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[`oc` CLI] is installed on your cluster.
+* You have the xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[`oc` CLI] installed.
 endif::[]
 // need to wait til CLI docs are added to OSD and ROSA for this link to work
 // TODO: remove these conditionals once this is available
 ifdef::openshift-dedicated,openshift-rosa[]
-* The `oc` CLI is installed on your cluster.
+* You have the `oc` CLI installed.
 endif::[]
 
-* The xref:../../serverless/cli_tools/installing-kn.adoc#installing-kn[Knative (`kn`) CLI] is installed on your cluster. Installing the Knative CLI enables the use of `kn func` commands which you can use to create and manage functions.
+* You have the xref:../../serverless/cli_tools/installing-kn.adoc#installing-kn[Knative (`kn`) CLI] installed. Installing the Knative 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.
+* You have installed Docker Container Engine or podman version 3.4.7 or higher, and have access to an available image registry, such as the OpenShift Container 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].
@@ -55,6 +55,7 @@ ifdef::openshift-dedicated,openshift-rosa[]
 endif::[]
 
 include::modules/serverless-functions-podman.adoc[leveloffset=+1]
+include::modules/serverless-functions-podman-macos.adoc[leveloffset=+1]
 
 [id="next-steps_serverless-functions-setup"]
 == Next steps