Merge pull request #9 from alexellis/push_file_alias

Add 'push' action and -f for URLs

Author: alexellis

MANUAL_CLI.md

@@ -0,0 +1,60 @@
+### Manual CLI options
+
+In addition to YAML file support, you can use the CLI to build and deploy individual functions as follows:
+
+#### Worked example with Node.js
+
+So if you want to write in another language, just prepare a Dockerfile and build an image manually, like in the [FaaS samples](https://github.com/alexellis/faas/tree/master/sample-functions).
+
+**Build a FaaS function in NodeJS from a template:**
+
+This will generate a Docker image for a Node.js function using the code in `/samples/info`.
+
+* The `faas-cli` can accept a `-lang` option of `python` or `node` and is `node` by default.
+
+```
+   $ ./faas-cli -action=build \
+      -image=alexellis2/node_info \
+      -name=node_info \
+      -handler=./sample/node_info
+
+Building: alexellis2/node_info with Docker. Please wait..
+...
+Image: alexellis2/node_info built.
+```
+
+You can customise the code by editing the handler.js file and changing the `-handler` parameter. You can also edit the packages.json file, which will be used during the build to make sure all your dependencies are available at runtime.
+
+For example:
+
+```
+"use strict"
+
+module.exports = (context, callback) => {
+    console.log("echo - " + context);
+    
+    callback(undefined, {status: "done"});
+}
+```
+
+The CLI will then build a Docker image containing the FaaS watchdog and a bootstrap file to invoke your NodeJS function.
+
+**Deploy the Docker image as a FaaS function:**
+
+Now we can deploy the image as a named function called `node_info`.
+
+```
+$ ./faas-cli -action=deploy \
+   -image=alexellis2/node_info \
+   -name=node_info
+
+200 OK
+
+URL: http://localhost:8080/function/node_info
+```
+
+> This tool can be used to deploy any Docker image as a FaaS function, as long as it includes the watchdog binary as the `CMD` or `ENTRYPOINT` of the image.
+
+*Deploy remotely*
+
+You can deploy to a remote FaaS instance as along as you push the image to the Docker Hub, or another accessible Docker registry. Specify your remote gateway with the following flag: `-gateway=http://remote-site.com:8080`

README.md

@@ -33,7 +33,15 @@ This url_ping function is defined in the samples/url__ping folder makes use of P
 * Build the files in the .yml file:
 
 ```
-$ ./faas-cli -action build -yaml ./samples.yml
+$ ./faas-cli -action build -f ./samples.yml
+```
+
+> `-f` specifies the file or URL to download your YAML file from. The long version of the `-f` flag is: `-yaml`.
+
+You can also download over HTTP/s:
+
+```
+$ ./faas-cli -action build -f https://github.com/alexellis/faas-cli/blob/master/samples.yml
 ```
 
 Docker along with a Python template will be used to build an image named alexellis2/faas-urlping.
@@ -43,7 +51,7 @@ Docker along with a Python template will be used to build an image named alexell
 Now you can use the following command to deploy your function(s):
 
 ```
-$ ./faas-cli -action deploy -yaml ./samples.yml
+$ ./faas-cli -action deploy -f ./samples.yml
 ```
 
 * Possible entries for functions are documented below:
@@ -78,7 +86,7 @@ $ curl --data-binary @README.md http://localhost:8080/function/node_info
 $ uname -a | curl http://localhost:8080/function/node_info --data-binary @-
 ```
 
-*Read on for manual CLI instructions.*
+> For further instructions on the manual CLI flags (without using a YAML file) read [manual_cli.md](https://github.com/alexellis/faas-cli/blob/master/MANUAL_CLI.md)
 
 ### Installation / pre-requirements
 
@@ -118,64 +126,3 @@ $ go build
 This project is part of the FaaS project licensed under the MIT License.
 
 For more details see the [Contributing guide](https://github.com/alexellis/faas-cli/blob/master/CONTRIBUTING.md).
-
-### Manual CLI options
-
-*Update: read-on for YAML support.*
-
-#### Worked example with Node.js
-
-So if you want to write in another language, just prepare a Dockerfile and build an image manually, like in the [FaaS samples](https://github.com/alexellis/faas/tree/master/sample-functions).
-
-**Build a FaaS function in NodeJS from a template:**
-
-This will generate a Docker image for a Node.js function using the code in `/samples/info`.
-
-* The `faas-cli` can accept a `-lang` option of `python` or `node` and is `node` by default.
-
-```
-   $ ./faas-cli -action=build \
-      -image=alexellis2/node_info \
-      -name=node_info \
-      -handler=./sample/node_info
-
-Building: alexellis2/node_info with Docker. Please wait..
-...
-Image: alexellis2/node_info built.
-```
-
-You can customise the code by editing the handler.js file and changing the `-handler` parameter. You can also edit the packages.json file, which will be used during the build to make sure all your dependencies are available at runtime.
-
-For example:
-
-```
-"use strict"
-
-module.exports = (context, callback) => {
-    console.log("echo - " + context);
-    
-    callback(undefined, {status: "done"});
-}
-```
-
-The CLI will then build a Docker image containing the FaaS watchdog and a bootstrap file to invoke your NodeJS function.
-
-**Deploy the Docker image as a FaaS function:**
-
-Now we can deploy the image as a named function called `node_info`.
-
-```
-$ ./faas-cli -action=deploy \
-   -image=alexellis2/node_info \
-   -name=node_info
-
-200 OK
-
-URL: http://localhost:8080/function/node_info
-```
-
-> This tool can be used to deploy any Docker image as a FaaS function, as long as it includes the watchdog binary as the `CMD` or `ENTRYPOINT` of the image.
-
-*Deploy remotely*
-
-You can deploy to a remote FaaS instance as along as you push the image to the Docker Hub, or another accessible Docker registry. Specify your remote gateway with the following flag: `-gateway=http://remote-site.com:8080`

app.go

@@ -20,9 +20,14 @@ import (
 	"bytes"
 	"os"
 
+	"net/url"
+
 	"github.com/alexellis/faas/gateway/requests"
 )
 
+const providerName = "faas"
+const defaultNetwork = "func_functions"
+
 func main() {
 	// var handler string
 	var handler string
@@ -36,6 +41,7 @@ func main() {
 	var replace bool
 	var nocache bool
 	var yamlFile string
+	var yamlFileShort string
 
 	flag.StringVar(&handler, "handler", "", "handler for function, i.e. handler.js")
 	flag.StringVar(&image, "image", "", "Docker image name to build")
@@ -48,27 +54,44 @@ func main() {
 	flag.BoolVar(&nocache, "no-cache", false, "do not use Docker's build cache")
 
 	flag.StringVar(&yamlFile, "yaml", "", "use a yaml file for a set of functions")
+	flag.StringVar(&yamlFileShort, "f", "", "use a yaml file for a set of functions (same as -yaml)")
 
 	flag.Parse()
 
+	// support short-argument -f
+	if len(yamlFile) == 0 && len(yamlFileShort) > 0 {
+		yamlFile = yamlFileShort
+	}
+
 	var services Services
 	if len(yamlFile) > 0 {
-		fileData, err := ioutil.ReadFile(yamlFile)
-		if err != nil {
-			fmt.Printf("Error: %s\n", err.Error())
-			return
+		var err error
+		var fileData []byte
+		urlParsed, err := url.Parse(yamlFile)
+		if err == nil && len(urlParsed.Scheme) > 0 {
+			fmt.Println("Parsed: " + urlParsed.String())
+			fileData, err = fetchYaml(urlParsed)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+		} else {
+			fileData, err = ioutil.ReadFile(yamlFile)
+			if err != nil {
+				fmt.Printf("Error: %s\n", err.Error())
+				return
+			}
 		}
+
 		err = yaml.Unmarshal(fileData, &services)
 		if err != nil {
 			fmt.Printf("Error with YAML file: %s\n", err.Error())
 			return
 		}
-
-		if services.Provider.Name != "faas" {
-			fmt.Println("'faas' is the only valid provider for the faas-cli.")
+		if services.Provider.Name != providerName {
+			fmt.Printf("'%s' is the only valid provider for this tool - found: %s.\n", providerName, services.Provider.Name)
 			return
 		}
-
 	}
 
 	if len(action) == 0 {
@@ -103,12 +126,16 @@ func main() {
 		break
 	case "deploy":
 		if len(services.Functions) > 0 {
+			if len(services.Provider.Network) == 0 {
+				services.Provider.Network = defaultNetwork
+			}
+
 			for k, function := range services.Functions {
 				function.Name = k
 				// fmt.Println(k, function)
 				fmt.Printf("Deploying: %s.\n", function.Name)
 
-				deployFunction(function.FProcess, services.Provider.GatewayURL, function.Name, function.Image, function.Language, replace, function.Environment)
+				deployFunction(function.FProcess, services.Provider.GatewayURL, function.Name, function.Image, function.Language, replace, function.Environment, services.Provider.Network)
 			}
 		} else {
 			if len(image) == 0 {
@@ -119,17 +146,28 @@ func main() {
 				fmt.Println("Give a -name for your function as it will be deployed on FaaS")
 				return
 			}
-			var envs map[string]string
-			deployFunction(fprocess, gateway, functionName, image, language, replace, envs)
+
+			deployFunction(fprocess, gateway, functionName, image, language, replace, map[string]string{}, defaultNetwork)
 		}
 		break
+	case "push":
+		if len(services.Functions) > 0 {
+			for k, function := range services.Functions {
+				function.Name = k
+				fmt.Printf("Pushing: %s to remote repository.\n", function.Name)
+				pushImage(function.Image)
+			}
+		} else {
+			fmt.Println("The '-action push' flag only works with a YAML file.")
+			return
+		}
 	default:
-		fmt.Println("-action must be 'build' or 'deploy'.")
+		fmt.Println("-action must be 'build', 'deploy' or 'push'.")
 		break
 	}
 }
 
-func deployFunction(fprocess string, gateway string, functionName string, image string, language string, replace bool, envVars map[string]string) {
+func deployFunction(fprocess string, gateway string, functionName string, image string, language string, replace bool, envVars map[string]string, network string) {
 
 	// Need to alter Gateway to allow nil/empty string as fprocess, to avoid this repetition.
 	fprocessTemplate := "node index.js"
@@ -144,10 +182,11 @@ func deployFunction(fprocess string, gateway string, functionName string, image
 		deleteFunction(gateway, functionName)
 	}
 
+	// TODO: allow registry auth to be specified or read from local Docker credentials store
 	req := requests.CreateFunctionRequest{
 		EnvProcess: fprocessTemplate,
 		Image:      image,
-		Network:    "func_functions",
+		Network:    "func_functions", // todo: specify network as an override
 		Service:    functionName,
 		EnvVars:    envVars,
 	}
@@ -177,7 +216,8 @@ func deleteFunction(gateway string, functionName string) {
 	delRes, delErr := c.Do(req)
 
 	if delErr != nil {
-		fmt.Println(delErr.Error())
+		fmt.Printf("Error removing existing function: %s, gateway=%s, functionName=%s\n", delErr.Error(), gateway, functionName)
+		return
 	}
 	switch delRes.StatusCode {
 	case 200:
@@ -187,6 +227,10 @@ func deleteFunction(gateway string, functionName string) {
 	}
 }
 
+func pushImage(image string) {
+	execBuild("./", []string{"docker", "push", image})
+}
+
 func buildImage(image string, handler string, functionName string, language string, nocache bool) {
 
 	switch language {
@@ -278,3 +322,20 @@ func execBuild(tempPath string, builder []string) {
 	targetCmd.Start()
 	targetCmd.Wait()
 }
+
+func fetchYaml(address *url.URL) ([]byte, error) {
+	req, err := http.NewRequest("GET", address.String(), nil)
+	if err != nil {
+		return nil, err
+	}
+	c := http.Client{}
+	res, err := c.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+
+	resBytes, err := ioutil.ReadAll(res.Body)
+
+	return resBytes, err
+}

sample/hmac.yml

@@ -1,6 +1,6 @@
 provider:
   name: faas
-  gateway: http://localhost:80
+  gateway: http://localhost:8080
 
 functions:
   hmac:

samples.yml

@@ -1,6 +1,7 @@
 provider:
   name: faas
   gateway: http://localhost:8080
+  network: "func_functions" # this is optional and defaults to func_functions
 
 functions:
   url_ping:

schema.go

@@ -4,6 +4,7 @@ package main
 type Provider struct {
 	Name       string `yaml:"name"`
 	GatewayURL string `yaml:"gateway"`
+	Network    string `yaml:"network"`
 }
 
 // Function as deployed or built on FaaS