Function Template

Overview

Repository for the template used to create serverless functions which can be deployed to cloud providers and converted to Docker images to be used by the Apollo orchestration platform.

Get the code

git clone https://github.com/Apollo-Workflows/Apollo-Template
cd Apollo-Template

Documentation

• Add your own function
• Build OpenFaaS Docker images
• Python layers:
  • Create a custom AWS Python layer
  • Create a custom IBM Python layer
• Add a function to auto deployment:
  • For AWS
  • For IBM

Autodeploy

1. Save the credentials for your cloud provider in the according subfolder:

   • AWS: Go to the service IAM and create a new user with the access type Programmatic access and attach the AdministratorAccess policy, which is part of the existing policies. You can copy the Access key ID and Secret access key and put it into the following format and save it under aws/credentials:

     [default]
     aws_access_key_id = <Your access key ID>
     aws_secret_access_key = <Your secret access key>
     

   • IBM:

   • Create the ibmcloud_api_key here add it to ibm/terraform.tfvars

   • Add S3 credentials from AWS to ibm/s3Credentials.json

2. • A: Deploy to all providers: Run from root dir docker run --rm -it --entrypoint=/app/deployAll.sh -v ${PWD}:/app/ chrisengelhardt/apollo-autodeploy
   • B: Deploy on a single provider with custom settings:
     • Go to the directory of the corresponding provider
     • Run docker run --network=host --rm -v ${PWD}:/app/ -v ${PWD}/../functions:/functions/ chrisengelhardt/apollo-autodeploy to deploy the functions
     • Run docker run --network=host --rm -v ${PWD}:/app/ -v ${PWD}/../functions:/functions/ chrisengelhardt/apollo-autodeploy --mappings to create the typeMappings.json file required by Apollo

Note 1: For IBM you have to create a namespace first and place it into ibm.tf on all lines with namespace = "YOURNAMESPACE".

Note 2: On some systems, the Docker container used during the deployment process can sometimes have problems connecting to the Internet, resulting in an error message. Known fixes for the problem are:

• Kill the corresponding container and rerun the script
• OR restart your computer and rerun the script