S. Brent FaulknerandSoam Vasani
0fd60eab3b
* include path parameters in params hash for ruby environment * Improve code organization and documentation for ruby environment. * Document Ruby examples
Fission: Ruby Environment
This is the Ruby environment for Fission.
It's a Docker image containing a Ruby 2.4.1 runtime. The image uses Rack with WEBrick to host the internal web server.
The environment works via convention where you create a Ruby method
called handler with a single optional argument, a Fission::Context
object.
The Fission::Context object gives access to the Rack env, and a
request object. Please see fission/context.rb for the public api.
The Fission::Request object is a subclass of Rack::Request and
provides access to parameters and headers. See fission/request.rb
for the public api.
Customizing this image
To add package dependencies, edit Gemfile to add what you need, and rebuild this image (instructions below).
Rebuilding and pushing the image
You'll need access to a Docker registry to push the image: you can sign up for Docker hub at hub.docker.com, or use registries from gcr.io, quay.io, etc. Let's assume you're using a docker hub account called USER. Build and push the image to the the registry:
docker build -t USER/ruby-env . && docker push USER/ruby-env
Using the image in fission
You can add this customized image to fission with "fission env create":
fission env create --name ruby --image USER/ruby-env
Or, if you already have an environment, you can update its image:
fission env update --name ruby --image USER/ruby-env
After this, fission functions that have the env parameter set to the same environment name as this command will use this environment.
Creating functions to use this image
See the examples README.