From d692b8448e078534d009e523a05ec5c97258b053 Mon Sep 17 00:00:00 2001 From: Andres Date: Tue, 26 Sep 2017 10:29:08 +0200 Subject: [PATCH] Add docs for scheduled events for Kubeless --- docs/providers/kubeless/README.md | 1 + .../kubeless/cli-reference/remove.md | 3 ++ docs/providers/kubeless/events/http.md | 8 ++--- docs/providers/kubeless/events/scheduler.md | 34 +++++++++++++++++++ docs/providers/kubeless/guide/deploying.md | 2 +- docs/providers/kubeless/guide/installation.md | 2 +- docs/providers/kubeless/guide/intro.md | 2 +- 7 files changed, 43 insertions(+), 9 deletions(-) create mode 100644 docs/providers/kubeless/events/scheduler.md diff --git a/docs/providers/kubeless/README.md b/docs/providers/kubeless/README.md index 08234732967..b9bba665a2d 100644 --- a/docs/providers/kubeless/README.md +++ b/docs/providers/kubeless/README.md @@ -68,6 +68,7 @@ If you have questions, join the [chat in gitter](https://gitter.im/serverless/se diff --git a/docs/providers/kubeless/cli-reference/remove.md b/docs/providers/kubeless/cli-reference/remove.md index 2b6992a4999..ea1bd14b633 100644 --- a/docs/providers/kubeless/cli-reference/remove.md +++ b/docs/providers/kubeless/cli-reference/remove.md @@ -20,5 +20,8 @@ serverless remove It will remove the Kubeless Function objects from your Kubernetes cluster, the Kubernetes Deployments and the Kubernetes Services associated with the Serverless service. +## Options +- `--verbose` or `-v` Shows additional information during the removal. + ## Provided lifecycle events - `remove:remove` diff --git a/docs/providers/kubeless/events/http.md b/docs/providers/kubeless/events/http.md index a6440fe42a8..8196f46f2b4 100644 --- a/docs/providers/kubeless/events/http.md +++ b/docs/providers/kubeless/events/http.md @@ -84,10 +84,6 @@ If the events HTTP definitions contain a `path` attribute, when deploying this S ``` kubectl get ingress -NAME HOSTS ADDRESS PORTS AGE -ingress-create * 192.168.99.100 80 2m -ingress-delete * 192.168.99.100 80 2m -ingress-read-all * 192.168.99.100 80 2m -ingress-read-one * 192.168.99.100 80 2m -ingress-update * 192.168.99.100 80 2m +NAME HOSTS ADDRESS PORTS AGE +ingress-1506350705094 192.168.99.100.nip.io 80 28s ``` \ No newline at end of file diff --git a/docs/providers/kubeless/events/scheduler.md b/docs/providers/kubeless/events/scheduler.md new file mode 100644 index 00000000000..387bcfe6352 --- /dev/null +++ b/docs/providers/kubeless/events/scheduler.md @@ -0,0 +1,34 @@ + + + +### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/kubeless/events/schedule) + + +# Kubeless Scheduled Events + +Kubeless functions can be triggered following a certain schedule. The schedule can be specified events section of the `serverless.yml` following the Cron notation: + +``` +service: clock + +provider: + name: kubeless + runtime: nodejs6 + +plugins: + - serverless-kubeless + +functions: + clock: + handler: handler.printClock + events: + - schedule: "* * * * *" +``` + +When deploying this `serverless.yml` file, Kubeless will create a Kubernetes cron job that will trigger the function `printClock` every minute. diff --git a/docs/providers/kubeless/guide/deploying.md b/docs/providers/kubeless/guide/deploying.md index 9c8288c1de1..cdb4883d9ef 100644 --- a/docs/providers/kubeless/guide/deploying.md +++ b/docs/providers/kubeless/guide/deploying.md @@ -76,7 +76,7 @@ Kubeless will create a [Kubernetes Deployment](https://kubernetes.io/docs/concep ## Deploy Function -This deployment method updates a single function. It performs the platform API call to deploy your package without the other resources. It is much faster than redeploying your whole service each time. +This deployment method updates or deploys a single function. It performs the platform API call to deploy your package without the other resources. It is much faster than redeploying your whole service each time. ```bash serverless deploy function --function myFunction diff --git a/docs/providers/kubeless/guide/installation.md b/docs/providers/kubeless/guide/installation.md index c1a1a181a52..483a8751687 100644 --- a/docs/providers/kubeless/guide/installation.md +++ b/docs/providers/kubeless/guide/installation.md @@ -26,7 +26,7 @@ Go to the official [Node.js website](https://nodejs.org), download and follow th **Note:** Serverless runs on Node v4 or higher. -You can verify that Node.js is installed successfully by runnning `node --version` in your terminal. You should see the corresponding Node version number printed out. +You can verify that Node.js is installed successfully by running `node --version` in your terminal. You should see the corresponding Node version number printed out. ## Installing the Serverless Framework diff --git a/docs/providers/kubeless/guide/intro.md b/docs/providers/kubeless/guide/intro.md index 52165829269..a6227c9418f 100644 --- a/docs/providers/kubeless/guide/intro.md +++ b/docs/providers/kubeless/guide/intro.md @@ -24,7 +24,7 @@ Here are the Serverless Framework's main concepts and how they pertain to Kubele ### Functions -A Function is an [Kubeless Function](http://kubeless.io/). It's an independent unit of deployment, like a microservice. It's merely code, deployed in the cloud, that is most often written to perform a single job such as: +A Function is a [Kubeless Function](http://kubeless.io/). It's an independent unit of deployment, like a microservice. It's merely code, deployed in the cloud, that is most often written to perform a single job such as: * *Saving a user to the database* * *Processing a file in a database*