Merge pull request #235 from fnproject/marleung/update-doc

Update tutorial and example

Author: marvin659

ContainerAsFunction/README.md

@@ -171,14 +171,19 @@ images are as small as possible--which is beneficial for a number of reasons.
 
 ## Custom Node.js Function Dockerfile
 
-The `fnproject/node` container image is built on Alpine so we'll need to install
+The `fnproject/node` container image is built on OracleLinux 9 so we'll need to install
 the
-[ImageMagick Alpine package](https://pkgs.alpinelinux.org/packages?name=imagemagick&branch=edge)
-using the `apk` package management utility.  You can do this with a Dockerfile
+[ImageMagick package in OracleLinux9 EPEL repository](https://yum.oracle.com/repo/OracleLinux/OL9/developer/EPEL/x86_64/index.html)
+using the `microdnf` package management utility.  You can do this with a Dockerfile
 `RUN` command:
 
 ```Dockerfile
-RUN apk add --no-cache imagemagick
+RUN microdnf update && \
+  microdnf install -y oracle-epel-release-el9 && \
+  microdnf install -y yum-utils && \
+  yum-config-manager --enable ol9_developer_EPEL && \
+  microdnf install -y ImageMagick && \
+  microdnf clean all
 ```
 
 We want to install ImageMagick into the runtime image, not the build image,
@@ -189,17 +194,23 @@ so we need to add the `RUN` command after the `FROM fnproject/node` command.
 `Dockerfile` and copy/paste the following as its content:
 
 ```Dockerfile
-FROM fnproject/node:dev as build-stage
+FROM fnproject/node:22-dev as build-stage
 WORKDIR /function
 ADD package.json /function/
 RUN npm install
 
-FROM fnproject/node
-RUN apk add --no-cache imagemagick
+FROM fnproject/node:22
+RUN microdnf update && \
+  microdnf install -y oracle-epel-release-el9 && \
+  microdnf install -y yum-utils && \
+  yum-config-manager --enable ol9_developer_EPEL && \
+  microdnf install -y ImageMagick && \
+  microdnf clean all
 WORKDIR /function
 ADD . /function/
 COPY --from=build-stage /function/node_modules/ /function/node_modules/
 ENTRYPOINT ["node", "func.js"]
+
 ```
 
 With this Dockerfile, the Node.js function, it's dependencies 
@@ -220,20 +231,18 @@ your function.  Give it a try:
 You should see output similar to:
 
 ```shell
-Building image imagedims:0.0.1
-Current Context:  default
-Sending build context to Docker daemon  27.65kB
-Step 1/10 : FROM fnproject/node:dev as build-stage
+Building image node-imagemagick:0.0.1 
+Dockerfile content
+-----------------------------------
+FROM fnproject/node:22-dev as build-stage
  ---> 016382f39a51
 ...
-Step 6/10 : RUN apk add --no-cache imagemagick
- ---> Using cache
- ---> 5c4a1e19767c
+[2/2] STEP 2/6: RUN microdnf update &&   microdnf install -y oracle-epel-release-el9 &&
 ...
-Successfully built 8f199b0bef00
-Successfully tagged imagedims:0.0.1
+Successfully tagged localhost/node-imagemagick:0.0.1
+1b78040d2468be947d08db185a684a756e2b329a769ee07f35f4e93e60cd2d22
 
-Function imagedims:0.0.1 built successfully.
+Function node-imagemagick:0.0.1 built successfully.
 ```
 
 Just like with a default build, the output is a container image.  From this

README.md

@@ -3,7 +3,7 @@
 Each of the tutorials below provides a step by step examination and walkthrough of a specific Fn feature or component.  Check back soon as new tutorials are being added regularly.
 
 ## Introduction to Fn
-Before deploying your first function, you need to [install the Fn cli and start an Fn Server](install/README.md).
+Before deploying your first function, you need to [install the Fn CLI and start an Fn Server](install/README.md).
 
 Now that the Fn Server is up and running, you can deploy your first function. Select your preferred language:
 

grafana/README.md

@@ -94,10 +94,23 @@ Check the output of the following docker command. This is used in subsequent doc
 
 <div>
 <blockquote>
-<code>docker network inspect bridge -f '&#123;&#123;range .IPAM.Config&#125;&#125;&#123;&#123;.Gateway&#125;&#125;&#123;&#123;end&#125;&#125;'</code>
+<code>docker network ls</code>
 </blockquote>
 </div>
 
+For Podman
+<div>
+<blockquote>
+<code>docker network inspect &lt;network name&gt; -f "&#123;&#123;range .Subnets&#125;&#125;&#123;&#123;.Gateway&#125;&#125;&#123;&#123;end&#125;&#125;"</code>
+</blockquote>
+</div>
+
+For Docker
+<div>
+<blockquote>
+<code>docker network inspect &lt;network name&gt; -f "&#123;&#123;range .IPAM.Config&#125;&#125;&#123;&#123;.Gateway&#125;&#125;&#123;&#123;end&#125;&#125;"</code>
+</blockquote>
+</div>
 <!-- Original command
 docker network inspect bridge -f '{{range .IPAM.Config}}{{.Gateway}}{{end}}'
 -->
@@ -116,7 +129,7 @@ Now start Prometheus, specifying the above config file.
 <blockquote>
 <code>docker run --rm --name=prometheus -d -p 9090:9090
  -v &#96;pwd&#96;/prometheus.yml:/etc/prometheus/prometheus.yml
- --add-host=&quot;fnserver:&#96;docker network inspect bridge -f &apos;&#123;&#123;range .IPAM.Config&#125;&#125;&#123;&#123;.Gateway&#125;&#125;&#123;&#123;end&#125;&#125;&apos;&#96;&quot; prom/prometheus</code>
+ --add-host=&quot;fnserver:&lt;gateway IP&gt;&quot; prom/prometheus</code>
 </blockquote>
 </div>
 
@@ -151,7 +164,7 @@ From the same terminal window and the same directory as above, start Grafana on
 <div>
 <blockquote>
 <code>docker run --name=grafana -d -p 5000:3000 
---add-host=&quot;prometheus:&#96;docker network inspect bridge -f &apos;&#123;&#123;range .IPAM.Config&#125;&#125;&#123;&#123;.Gateway&#125;&#125;&#123;&#123;end&#125;&#125;&apos;&#96;&quot; grafana/grafana</code>
+--add-host=&quot;prometheus:&lt;gateway IP&gt;&quot; grafana/grafana</code>
 </blockquote>
 </div>
 
@@ -181,8 +194,7 @@ Create a datasource to obtain metrics from Prometheus:
 >In the form that opens:
 >* Set **Name** to `PromDS`
 >* Set **Type** to `Prometheus`
->* Set **URL** to `http://prometheus:9090` 
->* Set **Access** to `proxy`
+>* Set **URL** to `http://<your host IP address>:9090` 
 >* Click **Add**
 >* Click **Save and test**
 
@@ -275,7 +287,7 @@ To view the available `Fn docker stats` metrics:
 
 >![user input](../images/userinput.png)
 >```shell
->curl  --silent http://localhost:8080/metrics | grep 'Metric fn_docker_stats'
+>curl  --silent http://localhost:8080/metrics | grep 'fn_docker_stats'
 >```
 
 And you will see the following metrics:

grafana/myfunc/func.go

@@ -1,12 +1,36 @@
 package main
 
 import (
-  "fmt"
-  "time"
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"log"
+	"time"
+
+	fdk "github.com/fnproject/fdk-go"
 )
 
 func main() {
-  fmt.Println("Before sleep for 500 ms")
-  time.Sleep(time.Duration(500) * time.Millisecond)
-  fmt.Println("After sleep for 500 ms")
+	fdk.Handle(fdk.HandlerFunc(myHandler))
+}
+
+type Person struct {
+	Name string `json:"name"`
+}
+
+func myHandler(ctx context.Context, in io.Reader, out io.Writer) {
+	p := &Person{Name: "World"}
+	json.NewDecoder(in).Decode(p)
+	msg := struct {
+		Msg string `json:"message"`
+	}{
+		Msg: fmt.Sprintf("Hello %s", p.Name),
+	}
+	log.Print("Inside Go Hello World function")
+
+	fmt.Println("Before sleep for 500 ms")
+	time.Sleep(time.Duration(500) * time.Millisecond)
+	fmt.Println("After sleep for 500 ms")
+	json.NewEncoder(out).Encode(&msg)
 }

grafana/myfunc/func.yaml

@@ -1,4 +1,11 @@
+schema_version: 20180708
 name: myfunc
-version: 0.0.1
+version: 0.0.7
 runtime: go
+build_image: fnproject/go:1.24-dev
+run_image: fnproject/go:1.24
 entrypoint: ./func
+triggers:
+- name: myfunc
+  type: http
+  source: /myfunc

grafana/myfunc/go.mod

@@ -0,0 +1,4 @@
+
+module func
+
+require github.com/fnproject/fdk-go v0.0.66

grafana/myfunc/run.bash

@@ -13,12 +13,10 @@ Setting up a working Fn installation involves these three simple steps:
 
 Before we can install Fn you'll need:
 
-1. A computer running Linux or MacOS.  If you have a Windows machine the
-easiest thing to do is install [VirtualBox](https://www.virtualbox.org/)
-and run a free Linux virtual machine.
-2. [Docker](https://www.docker.com/) 17.10 (or higher) needs to be
+1. A computer running Linux, MacOS or Windows.
+2. [Docker](https://www.docker.com/) 17.10 (or higher), Podman (5.7.0 or higher) or Rancher Desktop (1.22.0 or higher) needs to be
 installed and running.
-    * **Note:** Version 0.6.12+ of the Fn CLI added Podman support. To use Podman to build Fn images, see: [Using Fn with Podman instead of Docker](https://github.com/fnproject/docs/blob/master/fn/develop/podman.md) 
+    * **Note:** For Fn to work with Podman, please check out: [Using Fn with Podman instead of Docker](https://github.com/fnproject/docs/blob/master/fn/develop/podman.md) 
 
 > As you make your way through this tutorial, look out for this icon.
 ![](images/userinput.png) Whenever you see it, it's time for you to
@@ -38,12 +36,14 @@ Or, alternatively for Linux/Unix/MacOS from a terminal type the following:
 > curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh
 >```
 
+For Windows, you could download the binary from the release page: https://github.com/fnproject/cli/releases
+
 Once installed you'll see the Fn CLI version printed out.  You should see
 something similar to the following displayed (although likely with a later
 version number):
 
 ```txt
-fn version 0.5.86
+fn version 0.6.48
         ______
        / ____/___
       / /_  / __ \
@@ -145,8 +145,8 @@ You should see the version of the Fn CLI (client) and server displayed (your
 version will likely differ):
 
 ```txt
-Client version:  0.5.86
-Server version:  0.3.728
+Client version:  0.6.48
+Server version:  0.3.768
 ```
 
 **Note:**
@@ -320,10 +320,6 @@ You can confirm using the `which fn` command, the output should look like `/User
 (Alternatively, you can use `~/lbin/fn` if you don't want to add to your `PATH` environment variable.)
 
 
-#### For Windows Systems
-The best way for Windows users is to run Fn inside a Linux virtual machine either in the cloud or using [VirtualBox](https://www.virtualbox.org/) locally.
-
-
 ## Learn More
 
 Congratulations! You've installed Fn and started up an Fn server. Now you are

install/README.md

@@ -33,12 +33,12 @@ As a first step, let's create and run our initial Docker image.
 Here is the dockerfile for the application.
 
 ```txt
-FROM oraclelinux:7-slim
+FROM oraclelinux:9-slim
 
-RUN  yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
-     yum-config-manager --disable ol7_developer_EPEL && \
-     yum -y install oracle-instantclient19.3-basiclite nodejs && \
-     rm -rf /var/cache/yum
+RUN microdnf update && \
+    microdnf install -y oracle-instantclient-release-26ai-el9 && \
+    microdnf install -y oracle-instantclient-basiclite nodejs && \
+    microdnf clean all
 
 WORKDIR /myapp
 ADD package.json /myapp/
@@ -65,7 +65,7 @@ The application is made of two parts. First, the `package.json` file defines any
     "myapp"
   ],
   "dependencies": {
-    "oracledb" : "^3.1"
+    "oracledb" : "^6.10.0"
   },
   "author": "Fn Example",
   "license": "MIT"
@@ -100,7 +100,7 @@ We are now ready to build the Docker image.
 
 (4) This returns the version of the Oracle DB driver:
 ```txt
-3.1.2
+6.10.0
 ```
 
 That's it. You have a working Docker image.
@@ -114,12 +114,12 @@ Now let's convert that working Docker image into a function.
 The first step is some changes to the docker file.
 
 ```txt
-FROM oraclelinux:7-slim
+FROM oraclelinux:9-slim
 
-RUN  yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
-     yum-config-manager --disable ol7_developer_EPEL && \
-     yum -y install oracle-instantclient19.3-basiclite nodejs && \
-     rm -rf /var/cache/yum
+RUN microdnf update && \
+    microdnf install -y oracle-instantclient-release-26ai-el9 && \
+    microdnf install -y oracle-instantclient-basiclite nodejs && \
+    microdnf clean all
 
 WORKDIR /function
 ADD . /function/
@@ -146,12 +146,12 @@ Next, we update the `package.json` file.
 ```js
 {
 	"name": "hellodb",
-    "version": "1.0.0",
+  "version": "1.0.0",
 	"description": "Node DB Test function",
 	"main": "func.js",
 	"dependencies": {
-		"@fnproject/fdk": ">=0.0.13",
-		"oracledb" : "^3.1"
+		"@fnproject/fdk": ">=0.0.88",
+		"oracledb" : "^6.10.0"
 	},
     "author": "Fn Example",
 	"license": "Apache-2.0"
@@ -206,7 +206,7 @@ This deploys the function locally.
 This returns the version of the Oracle DB driver in JSON format:
 
 ```js
-{"version":"3.1.2"}
+{"version":"6.10.0"}
 ```
 
 That's it. You have converted a Node Docker image into a function.

node/custom-db/README.md

@@ -1,9 +1,9 @@
-FROM oraclelinux:7-slim
+FROM oraclelinux:9-slim
 
-RUN  yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
-     yum-config-manager --disable ol7_developer_EPEL && \
-     yum -y install oracle-instantclient19.3-basiclite nodejs && \
-     rm -rf /var/cache/yum
+RUN microdnf update && \
+    microdnf install -y oracle-instantclient-release-26ai-el9 && \
+    microdnf install -y oracle-instantclient-basiclite nodejs && \
+    microdnf clean all
 
 WORKDIR /myapp
 ADD package.json /myapp/