Skip to content
This repository was archived by the owner on Dec 15, 2021. It is now read-only.

Commit 58e82cc

Browse files
author
Andres Martinez Gotor
committed
Update docs
1 parent f7736a4 commit 58e82cc

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

docs/release-flow.md

-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ _Note: These steps are suitable for being automated in the Travis release job_
3030

3131
Once the new version is available, there are several projects/files that require to be updated in order to point to the latest version:
3232

33-
- Kubeless root README: Update the installation instructions to point to the latest release.
3433
- Kubeless docs site: To point to the latest version in the docs of http://kubeless.io rebuild the last build on https://travis-ci.org/kubeless/kubeless-website.
3534
- Kubeless chart: Update the references for the different images or any other required change in the `chart` folder of this repository.
3635
- Serverless plugin: Update the `KUBELESS_VERSION` environment variable in the `.travis` file to point to the latest version.
3736
- [Optional] Brew recipes: An automated PR will be generated in the `homebrew-core` repository with the new version and commit ID. Unless the recipe should contain breaking changes the update will be handled by the homebrew team. If it is not the case the [recipe](https://github.com/Homebrew/homebrew-core/blob/master/Formula/kubeless.rb) manually.
38-
- KubeApps: Update the reference of the controller image and checkout the kubeless submodule to point to the tagged commit. After that ping a KubeApps maintainer to merge the changes and update the manifests in the KubeApps repository. You can find an example of update [here](https://github.com/kubeapps/manifest/pull/34).

docs/runtimes.md

+22-11
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
11
# Kubeless Runtime Variants
22

3-
By default Kubeless has support for the following runtimes:
3+
By default Kubeless has support for runtimes in different states: stable and incubator. You can find the different runtimes available in this repository:
44

5-
- Python: For the branches 2.7, 3.4 and 3.6
6-
- NodeJS: For the branches 6 and 8, as well as NodeJS [distroless](https://github.com/GoogleContainerTools/distroless) for the branch 8
7-
- Ruby: For the branches 2.3, 2.4 and 2.5
8-
- PHP: For the branch 7.2
9-
- Golang: For the branch 1.10
10-
- .NET: For the branch 2.0
11-
- Ballerina: For the branch 0.981.0
5+
[https://github.com/kubeless/runtimes](https://github.com/kubeless/runtimes).
126

13-
You can see the list of supported runtimes executing:
7+
You can also see the list of supported runtimes that your Kubeless installation can use executing:
148

159
```console
1610
$ kubeless get-server-config
1711
INFO[0000] Current Server Config:
1812
INFO[0000] Supported Runtimes are: python2.7, python3.4, python3.6, nodejs6, nodejs8, ruby2.3, ruby2.4, ruby2.5, php7.2, go1.10, dotnetcore2.0, java1.8, ballerina0.981.0
1913
```
2014

21-
Each runtime is encapsulated in a container image. The reference to these images are injected in the Kubeless configuration. You can find the source code of all runtimes in [`docker/runtime`](https://github.com/kubeless/kubeless/tree/master/docker/runtime).
15+
Each runtime is encapsulated in a container image. The reference to these images are injected in the Kubeless configuration.
2216

2317
### NodeJS
2418

@@ -48,6 +42,8 @@ $ kubeless function deploy myFunction --runtime nodejs6 \
4842
--from-file test.js
4943
```
5044

45+
It's also possible to add another piece of configuration for your NPM file if the variable `NPM_CONFIG_EXTRA` is set. In case it's used, the build process will execute `npm config set $NPM_CONFIG_EXTRA` before installing dependencies.
46+
5147
Depending on the size of the payload sent to the NodeJS function it is possible to find the error `413 PayloadTooLargeError`. It is possible to increase this limit setting the environment variable `REQ_MB_LIMIT`. This will define the maximum size in MB that the function will accept:
5248

5349
```console
@@ -139,6 +135,21 @@ $ kubeless function deploy myFunction --runtime nodejs_distroless8 \
139135
--from-file test.js
140136
```
141137

138+
#### CloudEvents 0.1 Variant
139+
140+
[CloudEvents](https://cloudevents.io) is a CNCF effort to standardize the way events are represented in the Cloud. There is a variant of the Node.js 8 runtime that is ready to receive events that follow that specification (v0.1).
141+
142+
This variant expects the header `application/cloudevents+json` in order to be parsed as a JSON cloud event or the different headers that are defined in the [specification](https://github.com/cloudevents/spec/blob/master/spec.md) adapting them to the Kubeless function format.
143+
144+
The same example Node.js function from above can then be deployed:
145+
146+
```console
147+
$ kubeless function deploy myFunction --runtime nodejsCE8 \
148+
--dependencies package.json \
149+
--handler test.foobar \
150+
--from-file test.js
151+
```
152+
142153
### Python
143154

144155
#### Example
@@ -196,7 +207,7 @@ Go functions require to import the package `github.com/kubeless/kubeless/pkg/fun
196207

197208
#### Server implementation
198209

199-
The Go HTTP server doesn't include any framework since the native packages includes enough functionality to fit our needs. Since there is not a standard package that manages server logs that functionality is implemented in the same server. It is also required to implement the `ResponseWriter` interface in order to retrieve the Status Code of the response.
210+
The Go HTTP server doesn't include any framework since the native packages includes enough functionality to fit our needs. Since there is not a standard package that manages server logs that functionality is implemented in the same server. It is also required to implement the `ResponseWriter` interface in order to retrieve the Status Code of the response. Apart from that we enable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) to accept any request.
200211

201212
#### Debugging compilation
202213

0 commit comments

Comments
 (0)