Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Commit

Permalink
Add docs for scheduled events for Kubeless
Browse files Browse the repository at this point in the history
  • Loading branch information
Andres committed Sep 26, 2017
1 parent a1398a9 commit d692b84
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/providers/kubeless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ If you have questions, join the [chat in gitter](https://gitter.im/serverless/se
<ul>
<li><a href="./events/http.md">HTTP Events</a></li>
<li><a href="./events/pubsub.md">PubSub Events</a></li>
<li><a href="./events/scheduler.md">Scheduled Events</a></li>
</ul>
</div>
</div>
Expand Down
3 changes: 3 additions & 0 deletions docs/providers/kubeless/cli-reference/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
8 changes: 2 additions & 6 deletions docs/providers/kubeless/events/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
34 changes: 34 additions & 0 deletions docs/providers/kubeless/events/scheduler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--
title: Serverless Framework - Kubeless Events - Schedule
menuText: Schedule
menuOrder: 3
description: Scheduled Events in Kubeless
layout: Doc
-->

<!-- DOCS-SITE-LINK:START automatically generated -->
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/kubeless/events/schedule)
<!-- DOCS-SITE-LINK:END -->

# 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.
2 changes: 1 addition & 1 deletion docs/providers/kubeless/guide/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/kubeless/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/providers/kubeless/guide/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down

0 comments on commit d692b84

Please sign in to comment.