From ab18e467fa46624e9fd4fec8563c37c6eaec6deb Mon Sep 17 00:00:00 2001 From: Travis Reeder Date: Fri, 17 Nov 2017 15:53:44 -0800 Subject: [PATCH] updates functions -> fnserver (#516) * updates functions -> fn-server and fnlb -> fn-lb * changed to fnserver and fnlb --- .gitignore | 2 +- Makefile | 10 +++++----- api/server/server.go | 2 +- build.ps1 | 7 +++---- docs/operating/databases/boltdb.md | 6 +++--- docs/operating/databases/postgres.md | 18 +++++++++--------- docs/operating/extending.md | 4 ++-- docs/operating/kubernetes/fn-service.yaml | 2 +- docs/operating/options.md | 7 +++---- docs/operating/windows.md | 4 ++-- fnlb/.gitignore | 1 + fnlb/README.md | 2 +- test/fnlb-test-harness/README.md | 10 +++++----- 13 files changed, 37 insertions(+), 38 deletions(-) diff --git a/.gitignore b/.gitignore index 8b2e6aebe..e822a20ce 100644 --- a/.gitignore +++ b/.gitignore @@ -29,4 +29,4 @@ tmp/ fnlb/fnlb /fn .DS_Store -/fn-server +/fnserver diff --git a/Makefile b/Makefile index 12d6e02e9..dd96a0b8f 100644 --- a/Makefile +++ b/Makefile @@ -8,10 +8,10 @@ dep-up: glide up -v build: - go build -o functions + go build -o fnserver install: - go build -o ${GOPATH}/bin/fn-server + go build -o ${GOPATH}/bin/fnserver test: ./test.sh @@ -29,17 +29,17 @@ test-build-arm: GOARCH=arm64 $(MAKE) build run: build - GIN_MODE=debug ./functions + GIN_MODE=debug ./fnserver docker-dep: # todo: need to create a dep tool image for this (or just ditch this) docker run --rm -it -v ${CURDIR}:/go/src/github.com/fnproject/fn -w /go/src/github.com/fnproject/fn treeder/glide install -v docker-build: - docker build --build-arg HTTPS_PROXY --build-arg HTTP_PROXY -t fnproject/fn-server:latest . + docker build --build-arg HTTPS_PROXY --build-arg HTTP_PROXY -t fnproject/fnserver:latest . docker-run: docker-build - docker run --rm --privileged -it -e NO_PROXY -e HTTP_PROXY -e LOG_LEVEL=debug -e "DB_URL=sqlite3:///app/data/fn.db" -v ${CURDIR}/data:/app/data -p 8080:8080 fnproject/functions + docker run --rm --privileged -it -e NO_PROXY -e HTTP_PROXY -e LOG_LEVEL=debug -e "DB_URL=sqlite3:///app/data/fn.db" -v ${CURDIR}/data:/app/data -p 8080:8080 fnproject/fnserver docker-test-run-with-sqlite3: ./api_test.sh sqlite3 4 diff --git a/api/server/server.go b/api/server/server.go index 39c88f33b..c919b96d2 100644 --- a/api/server/server.go +++ b/api/server/server.go @@ -145,7 +145,7 @@ func traceWrap(c *gin.Context) { func setTracer() { var ( debugMode = false - serviceName = "fn-server" + serviceName = "fnserver" serviceHostPort = "localhost:8080" // meh zipkinHTTPEndpoint = viper.GetString(EnvZipkinURL) // ex: "http://zipkin:9411/api/v1/spans" diff --git a/build.ps1 b/build.ps1 index a2abb27e4..ffe0167f3 100644 --- a/build.ps1 +++ b/build.ps1 @@ -21,12 +21,11 @@ function quick() { } function build () { - docker run --rm -v ${pwd}:/go/src/github.com/fnproject/functions -w /go/src/github.com/fnproject/functions golang:alpine go build -o functions-alpine - docker build -t fnproject/functions:latest . -} + docker run --rm -v ${pwd}:/go/src/github.com/fnproject/fn -w /go/src/github.com/fnproject/fn golang:alpine go build -o fn-alpine + docker build -t fnproject/fnserver:latest . function run () { - docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -e LOG_LEVEL=debug -e "DB_URL=sqlite3:///app/data/fn.db" -v $PWD/data:/app/data -p 8080:8080 fnproject/functions + docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -e LOG_LEVEL=debug -e "DB_URL=sqlite3:///app/data/fn.db" -v $PWD/data:/app/data -p 8080:8080 fnproject/fnserver } switch ($cmd) diff --git a/docs/operating/databases/boltdb.md b/docs/operating/databases/boltdb.md index c4c5eeab9..9a0fce166 100644 --- a/docs/operating/databases/boltdb.md +++ b/docs/operating/databases/boltdb.md @@ -1,4 +1,4 @@ -# Fn using BoltDB +# Fn using SQLite3 SQLite3 is the default database, you just need to run the API. @@ -6,6 +6,6 @@ SQLite3 is the default database, you just need to run the API. To keep it persistent, add a volume flag to the command: -``` -docker run --rm -it --privileged -v $PWD/fn.db:/app/fn.db -p 8080:8080 fnproject/functions +```sh +docker run --rm -it --privileged -v $PWD/fn.db:/app/fn.db -p 8080:8080 fnproject/fnserver ``` diff --git a/docs/operating/databases/postgres.md b/docs/operating/databases/postgres.md index e9caf2af4..5c970f849 100644 --- a/docs/operating/databases/postgres.md +++ b/docs/operating/databases/postgres.md @@ -1,34 +1,34 @@ # Fn using Postgres -Let's presuppose you don't have even a postgres DB ready. +Let's suppose you don't have even a postgres DB ready. -### 1. Let's start a postgres instance: +## 1. Let's start a postgres instance -``` +```sh docker run --name func-postgres \ -e POSTGRES_PASSWORD=funcpass -d postgres ``` -### 2. Now let's create a new database for Functions +## 2. Now let's create a new database for Functions Creating database: -``` +```sh docker run -it --rm --link func-postgres:postgres postgres \ psql -h postgres -U postgres -c "CREATE DATABASE funcs;" ``` Granting access to postgres user -``` +```sh docker run -it --rm --link func-postgres:postgres postgres \ psql -h postgres -U postgres -c 'GRANT ALL PRIVILEGES ON DATABASE funcs TO postgres;' ``` -### 3. Now let's start Functions connecting to our new postgres instance +## 3. Now let's start Functions connecting to our new postgres instance -``` +```sh docker run --rm --privileged --link "func-postgres:postgres" \ -e "DB_URL=postgres://postgres:funcpass@postgres/funcs?sslmode=disable" \ - -it -p 8080:8080 fnproject/functions + -it -p 8080:8080 fnproject/fnserver ``` diff --git a/docs/operating/extending.md b/docs/operating/extending.md index e17c48276..ce92ab29f 100644 --- a/docs/operating/extending.md +++ b/docs/operating/extending.md @@ -30,8 +30,8 @@ package main import ( "context" - "github.com/fnproject/functions/api/server" - "github.com/fnproject/functions/api/models" + "github.com/fnproject/fn/api/server" + "github.com/fnproject/fn/api/models" ) type myCustomListener struct{} diff --git a/docs/operating/kubernetes/fn-service.yaml b/docs/operating/kubernetes/fn-service.yaml index f54b18240..e49d7a376 100644 --- a/docs/operating/kubernetes/fn-service.yaml +++ b/docs/operating/kubernetes/fn-service.yaml @@ -50,7 +50,7 @@ spec: spec: containers: - name: fn-service - image: fnproject/functions:latest + image: fnproject/fnserver:latest securityContext: privileged: true ports: diff --git a/docs/operating/options.md b/docs/operating/options.md index cfb60d056..ddaad6afb 100644 --- a/docs/operating/options.md +++ b/docs/operating/options.md @@ -5,7 +5,7 @@ This will run with docker in docker. ```sh -docker run --privileged --rm --name fns -it -v $PWD/data:/app/data -p 80:8080 fnproject/functions +docker run --privileged --rm --name fns -it -v $PWD/data:/app/data -p 80:8080 fnproject/fnserver ``` See below for starting without docker in docker. @@ -37,8 +37,7 @@ The default way to run Fn, as it is in the Quickstart guide, is to use docker-in a couple reasons why we did it this way: * It's clean. Once the container exits, there is nothing left behind including all the function images. -* You can set resource restrictions for the entire Fn instance. For instance, you can set `--memory` on -the docker run command to set the max memory for the Fn instance AND all of the functions it's running. +* You can set resource restrictions for the entire Fn instance. For instance, you can set `--memory` on the docker run command to set the max memory for the Fn instance AND all of the functions it's running. There are some reasons you may not want to use dind, such as using the image cache during testing or you're running [Windows](windows.md). @@ -48,7 +47,7 @@ There are some reasons you may not want to use dind, such as using the image cac One way is to mount the host Docker. Everything is essentially the same except you add a `-v` flag: ```sh -docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/data:/app/data -p 8080:8080 fnproject/functions +docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/data:/app/data -p 8080:8080 fnproject/fnserver ``` ### Run outside Docker diff --git a/docs/operating/windows.md b/docs/operating/windows.md index ddfa094e7..372969a44 100644 --- a/docs/operating/windows.md +++ b/docs/operating/windows.md @@ -3,7 +3,7 @@ Windows doesn't support Docker in Docker so you'll change the run command to the following: ```sh -docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -v ${pwd}/data:/app/data -p 8080:8080 fnproject/functions +docker run --rm --name functions -it -v /var/run/docker.sock:/var/run/docker.sock -v ${pwd}/data:/app/data -p 8080:8080 fnproject/fnserver ``` -Then everything should work as normal. +Then everything should work as normal. diff --git a/fnlb/.gitignore b/fnlb/.gitignore index 600ee636f..4a8bf778e 100644 --- a/fnlb/.gitignore +++ b/fnlb/.gitignore @@ -1,2 +1,3 @@ /fnlb /fnlb-alpine +/fnlb diff --git a/fnlb/README.md b/fnlb/README.md index d2daf584a..3299418c6 100644 --- a/fnlb/README.md +++ b/fnlb/README.md @@ -32,7 +32,7 @@ If running locally with functions servers in docker, running with docker links can make things easier (can use local addresses). for example: ```sh -docker run -d --name fn-8080 --privileged -p 8080:8080 fnproject/functions:latest +docker run -d --name fn-8080 --privileged -p 8080:8080 fnproject/fnserver:latest docker run -d --name fnlb --link fn-8080 -p 8081:8081 fnproject/fnlb:latest --nodes 127.0.0.1:8080 ``` diff --git a/test/fnlb-test-harness/README.md b/test/fnlb-test-harness/README.md index 09f4ce391..557aaafc6 100644 --- a/test/fnlb-test-harness/README.md +++ b/test/fnlb-test-harness/README.md @@ -28,11 +28,11 @@ fn routes create primesapp /primes jconning/primes:0.0.1 ``` STEP 2: Run five Fn nodes locally. Example (runs five nodes in the background using Docker): ``` -sudo docker run -d -it --name functions-8082 --privileged -v ${HOME}/data-8082:/app/data -p 8082:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/functions -sudo docker run -d -it --name functions-8083 --privileged -v ${HOME}/data-8083:/app/data -p 8083:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/functions -sudo docker run -d -it --name functions-8084 --privileged -v ${HOME}/data-8084:/app/data -p 8084:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/functions -sudo docker run -d -it --name functions-8085 --privileged -v ${HOME}/data-8085:/app/data -p 8085:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/functions -sudo docker run -d -it --name functions-8086 --privileged -v ${HOME}/data-8086:/app/data -p 8086:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/functions +sudo docker run -d -it --name functions-8082 --privileged -v ${HOME}/data-8082:/app/data -p 8082:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/fnserver +sudo docker run -d -it --name functions-8083 --privileged -v ${HOME}/data-8083:/app/data -p 8083:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/fnserver +sudo docker run -d -it --name functions-8084 --privileged -v ${HOME}/data-8084:/app/data -p 8084:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/fnserver +sudo docker run -d -it --name functions-8085 --privileged -v ${HOME}/data-8085:/app/data -p 8085:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/fnserver +sudo docker run -d -it --name functions-8086 --privileged -v ${HOME}/data-8086:/app/data -p 8086:8080 -e "DB_URL=postgres://dbUser:dbPassword@dbHost:5432/dbName" fnproject/fnserver ``` STEP 3: Run fnlb locally. Example (runs fnlb on the default port 8081): ```