helm-chart

Helm Chart for Deploying funcX stack

This application includes:

FuncX Web-Service
Kuberentes endpoint
Postgres database
Redis Shared Data Structure

Preliminaries

The following dependencies must be set up before you can deploy the helm chart:

Kubernetes Endpoint

We can deploy the kubernetes endpoint as a pod as part of the chart. It needs to have a valid copy of the funcx's funcx_sdk_tokens.json which can be created by running on your local workstation and running

 funcx-endpoint start

You will be prompted to follow the authorization link and paste the resulting token into the console. Once you do that, funcx-endpoint will create a ~/.funcx directory and provide you with a token file.

The Kubernetes endpoint expects this file to be available as a Kubernetes secret named funcx-sdk-tokens.

You can install this secret with:

pushd ~/.funcx 
kubectl create secret generic funcx-sdk-tokens --from-file=credentials/funcx_sdk_tokens.json
popd

Forwarder

The forwarder needs to be able to open and manage arbitrary ports which is not compatible with some of Kubernetes requirements. For now we will run it as a docker container, but outside of the cluster.

Launch a copy of forwarder outside of kubernetes, listening on port 8080: shell script docker run --rm -it -p 8080:3031 funcx/forwarder:213_helm_chart

How to Install FuncX

Make a clone of this repository

Download subcharts:

 helm dependency update funcx

Create your own values.yaml inside the Git ignored directory deployed_values/

Obtain Globus Client ID and Secret. Paste them into your values.yaml as

webService:
  globusClient: <<your app client>>
  globusKey: <<your app secret>>

Install the helm chart:

helm install -f deployed_values/values.yaml funcx funcx

You can access your web service through the ingres or via a port forward to the web service pod. Instructions are provided in the displayed notes.
You should be able to see the endpoint registering with the web service in their respective logs, along with the forwarder log

Database Setup

Until we migrate the webservice to use an ORM, we need to set the database schema up using a SQL script. This is accomplished by an init-container that is run prior to starting up the web service container. This setup image checks to see if the tables are there. If not, it runs the setup script.

Values

There are a few values that can be set to adjust the deployed system configuration

Value	Desciption	Default
`webService.image`	Docker image name for the web service	funcx/web-service
`webService.tag`	Docker image tag for the web service	213_helm_chart
`webService.pullPolicy`	Kubernetes pull policy for the web service container	IfNotPresent
`webService.dbSetupImage`	Docker image name for the web service database setup image	funcx/web-service-db
`webService.dbSetupTag`	Docker image tag for the web service database setup	213_helm_chart
`webService.dbSetupPullPolicy`	Kubernetes pull policy for the web service database setup container	IfNotPresent
`webService.advertisedRedisPort`	Redis port that the forwarder (outside of cluster) can reach	6379
`webService.advertisedRedisHost`	Redis host that the forwarder (outside of cluster) can reach	localhost
`webService.globusClient`	Client ID for globus app. Obtained from http://developers.globus.org
`webService.globusKey`	Secret for globus app. Obtained from http://developers.globus.org
`webService.replicas`	Number of replica web services to deploy	1
`endpoint.enabled`	Deploy an internal kubernetes endpoint?	true
`endpoint.replicas`	Number of replica endpoint pods to deploy	1
`endpoint.image`	Docker image name for the endpoint	funcx/kube-endpoint
`endpoint.tag`	Docker image tag for the endpoint	213_helm_chart
`endpoint.pullPolicy`	Kubernetes pull policy for the endpoint container	IfNotPresent
`forwarder.enabled`	Deploy an internal kubernetes forwarder?	true
`forwarder.minInterchangePort`	The minimum port to assign interchanges. This will be the first port opened int he pod	54000
`forwarder.maxInterchangePort`	The maximum port to assign interchanges. Only the first three ports are opened in the pod	54002
`forwarder.image`	Docker image name for the forwarder	funcx/funcx/forwarder
`forwarder.tag`	Docker image tag for the forwarder	dev
`forwarder.pullPolicy`	Kubernetes pull policy for the forwarder container	IfNotPresent
`ingress.enabled`	Deploy an ingres to route traffic to web app?	false
`ingress.host`	Host name for the ingress. You will be able to reach your web service via a url that starts with the helm release name and ends with this host	uc.ssl-hep.org
`postgres.enabled`	Deploy a postgres instance?	true

Subcharts

This chart uses two subcharts to supply dependent services. You can update settings for these by referenceing the subchart name and values from their READMEs.

For example

postgresql.postgresqlUsername: funcx

Subchart	Link to Documentation
postgresql	https://github.com/bitnami/charts/tree/master/bitnami/postgresql
redis	https://github.com/bitnami/charts/tree/master/bitnami/redis

tskluzac / helm-chart