Add examples for all go sdk operations

README.md

@@ -141,6 +141,8 @@ if err != nil {
 }
 ```
 
+Please refer [examples](https://github.com/openfaas/go-sdk/tree/master/examples) folder for code examples of each operation
+
 ## License
 
 License: MIT

example/README.md

@@ -0,0 +1,17 @@
+### Examples
+Folder containes examples about how to use [openfaas](https://www.openfaas.com/) `go-sdk` API for different supported operations. Each subfolder contains a `main.go` file which can be executed independently. Before running them, please expose relevant environment variables such as `OPENFAAS_USERNAME`, `OPENFAAS_PASSWORD` and `OPENFAAS_GATEWAY_URL`. Do note, these are not standard environment variables. You can change them in your usecase.
+
+Below is list of examples
+1. [Deploy Function](./deploy-function/main.go)
+2. [Update Function](./update-function/main.go)
+3. [Scale Function](./scale-function/main.go)
+4. [Get All Functions Of A Namespace](./get-functions/main.go)
+5. [Create Namespace](./create-namespace/main.go)
+6. [Update Namespace](./update-namespace/main.go)
+7. [Get All Namespaces](./get-namepsaces/main.go)
+8. [Create Secret](./create-secret/main.go)
+9. [Update Secret](./update-secret/main.go)
+10. [Get Logs Of A Function](./logs/main.go)
+
+
+

example/create-namespace/main.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+	"time"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	status, err := client.CreateNamespace(context.Background(), types.FunctionNamespace{
+		Name: "test-namespace",
+		Labels: map[string]string{
+			"env": "dev",
+		},
+		Annotations: map[string]string{
+			"imageregistry": "https://hub.docker.com/",
+		},
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Create Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	fmt.Println("Wait for 15 seconds....")
+	fmt.Println("Get Namespace")
+	time.Sleep(15 * time.Second)
+	ns, err := client.GetNamespace(context.Background(), "test-namespace")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("Namespace: %v \n", ns)
+
+	// delete namespace
+	err = client.DeleteNamespace(context.Background(), "test-namespace")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Delete Failed: %s", err)
+		os.Exit(1)
+	}
+}

example/create-secret/main.go

@@ -0,0 +1,59 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	status, err := client.CreateSecret(context.Background(), types.Secret{
+		Name:      "env-store-test",
+		Namespace: "openfaas-fn",
+		// secret support both binary and string values
+		// Use Value field to store string values
+		RawValue: []byte("this is secret"),
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Create Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	// Get Secrets
+	secrets, err := client.GetSecrets(context.Background(), "openfaas-fn")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+
+	for _, s := range secrets {
+		fmt.Printf("Secret: %v \n", s)
+	}
+
+	err = client.DeleteSecret(context.Background(), "env-store-test", "openfaas-fn")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Delete Failed: %s", err)
+		os.Exit(1)
+	}
+
+}

example/deploy-function/main.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+	"time"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	status, err := client.Deploy(context.Background(), types.FunctionDeployment{
+		Service:    "env-store-test",
+		Image:      "ghcr.io/openfaas/alpine:latest",
+		Namespace:  "openfaas-fn",
+		EnvProcess: "env",
+		Labels: &map[string]string{
+			"purpose": "test",
+		},
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Deploy Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	fmt.Println("Wait for 15 seconds....")
+	fmt.Println("Get Function")
+	time.Sleep(15 * time.Second)
+	fn, err := client.GetFunction(context.Background(), "env-store-test", "openfaas-fn")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("Function: %v \n", fn)
+
+	// delete function
+	err = client.DeleteFunction(context.Background(), "env-store-test", "openfaas-fn")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Delete Failed: %s", err)
+		os.Exit(1)
+	}
+}

example/get-functions/main.go

@@ -0,0 +1,62 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	fns, err := client.GetFunctions(context.Background(), "openfaas-fn")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("No Of Functions: %d\n", len(fns))
+
+	status, err := client.Deploy(context.Background(), types.FunctionDeployment{
+		Service:    "env-store-test",
+		Image:      "ghcr.io/openfaas/alpine:latest",
+		Namespace:  "openfaas-fn",
+		EnvProcess: "env",
+		Labels: &map[string]string{
+			"purpose": "test",
+		},
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Deploy Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	fns, err = client.GetFunctions(context.Background(), "openfaas-fn")
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("No Of Functions: %d\n", len(fns))
+
+	err = client.DeleteFunction(context.Background(), "env-store-test", "openfaas-fn")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Delete Failed: %s", err)
+		os.Exit(1)
+	}
+}

example/get-namepsaces/main.go

@@ -0,0 +1,57 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	ns, err := client.GetNamespaces(context.Background())
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("No Of Namespaces: %d\n", len(ns))
+
+	status, err := client.CreateNamespace(context.Background(), types.FunctionNamespace{
+		Name: "test-namespace",
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Create Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	ns, err = client.GetNamespaces(context.Background())
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Failed: %s", err)
+		os.Exit(1)
+	}
+	fmt.Printf("No Of Namespaces: %d\n", len(ns))
+
+	// delete namespace
+	err = client.DeleteNamespace(context.Background(), "test-namespace")
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Delete Failed: %s", err)
+		os.Exit(1)
+	}
+}

example/logs/main.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+	"time"
+
+	"github.com/openfaas/faas-provider/types"
+	"github.com/openfaas/go-sdk"
+)
+
+func main() {
+	// NOTE: You can have any name for environment variables. below defined variables names are not standard names
+	username := os.Getenv("OPENFAAS_USERNAME")
+	password := os.Getenv("OPENFAAS_PASSWORD")
+
+	gatewayURL, _ := url.Parse(os.Getenv("OPENFAAS_GATEWAY_URL"))
+	auth := &sdk.BasicAuth{
+		Username: username,
+		Password: password,
+	}
+
+	client := sdk.NewClient(gatewayURL, auth, http.DefaultClient)
+
+	// Deploy function
+	status, err := client.Deploy(context.Background(), types.FunctionDeployment{
+		Service:    "env-store-test",
+		Image:      "ghcr.io/openfaas/alpine:latest",
+		Namespace:  "openfaas-fn",
+		EnvProcess: "env",
+	})
+	// non 200 status value will have some error
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Status: %d Deploy Failed: %s", status, err)
+		os.Exit(1)
+	}
+
+	// Follow is allows the user to request a stream of logs until the timeout
+	follow := false
+	// Tail sets the maximum number of log messages to return, <=0 means unlimited
+	tail := 5
+	// Since is the optional datetime value to start the logs from
+	since := time.Now().Add(-30 * time.Second)
+
+	logsChan, err := client.GetLogs(context.Background(), "env-store-test", "openfaas-fn", follow, tail, &since)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Get Logs Failed: %s", err)
+		os.Exit(1)
+	}
+
+	fmt.Println("Logs Received....")
+	for line := range logsChan {
+		fmt.Println(line)
+	}
+}