Pydictionary



A local registry can save on bandwidth costs and means your OpenFaaS functions don't leave your local computer when running faas-cli up

Collapsed Expanded 1.0.0-AC Hipchat Server 2.0.4 - 2.3.1 2016-08-25 Using PyDictionary to find meaning, antonym and synonym of the word. Download Version 1.0.0-AC. Released 2016-08-25. No Vendor Support. Free. Commercial - no charge. PyDictionary public PyDictionary(PyObject elements) Create a new dictionary with the element as content. Parameters: elements - The initial elements that is inserted in the dictionary.

Not only is it much quicker, but it's also simple to configure if you're using KinD.

Prerequisite:¶

You need to have Docker installed on your machine.

Install arkade¶

We will use arkade to install and deploy apps and services to Kubernetes.

arkade commands:

  • use arkade get to download CLI tools and applications.
  • use arkade install to install applications using helm charts or vanilla YAML files.
  • use arkade info to get back info about an app you've installed

Install kubectl¶

kubectl is a command line tool that talks to the Kubernetes API for performing actions on our cluster.

Create the KinD cluster with a local registry enabled¶

We will set up our local Kubernetes cluster using KinD (Kubernetes in Docker).

Install KinD¶

These instructions are adapted from the KinD documentation. Our goal is to keep everything locally including a local Docker registry.

The official KinD docs provides a shell script to create a Kubernetes cluster with local Docker registry enabled.

View the shell script in the KinD docs

Note:¶

You can find similar solutions for other local Kubernetes distributions:

  • k3d - local registries
  • minikube - registry add-on
  • microk8s - built-in registry

Make the script executable:

Run it to create your local cluster with registry:

Make sure the kubectl context is set to the newly created cluster:

If the result is not kind-kind then execute:

Make sure the cluster is running:

Make sure Docker registry is running.

Deploy OpenFaaS¶

Deploy OpenFaaS and its CLI:

Then log in and port-forward OpenFaaS using the instructions given, or run arkade info openfaas to get them a second time.

Create a Function¶

We will take an example of a simple function; a dictionary that returns the meaning of word you query. We will be using the PyDictionary module for this setup.

Pydictionary

Pydictionary Example

Pull python language template from store:

We will be using the python3-flask-debian template.

Setup your OPENFAAS_PREFIX variable to configure the address of your registry:

Note: Docker for Mac users may need to change 'localhost' to the IP address of their LAN or WiFi adapter as shown on ifconfig such as 192.168.0.14

Create a new function using the template:

This will create a directory for your function and a YAML config file with the function name you provided:

  • pydict/
  • pydict.yml

Add dependency to the pydict/requirements.txt file:

Update handler.py with the following code.

Our minimal function is complete.

Stack file¶

You will see that the OpenFaaS stack YAML file pydict.yml has localhost:5000 in its image destination.

Build Push Deploy¶

With our setup ready; we can now build our image, push it to the registry, and deploy it to Kubernetes. And using faas-cli it is possible with a single command!

Test the function¶

We can invoke our function from CLI using faas-cli or curl.

Wrapping Up¶

Python Dictionary Download

Now that you have a local registry, you can speed up your local development of functions by keeping the container images within your local computer.

Python English Dictionary Api

This tutorial is based upon the KinD docs and a post by Yankee Maharjan.