generator-saphanaacademy-faas

Yeoman Generator to jump-start Function-as-a-Service Applications

Installation

First, install Yeoman and generator-saphanaacademy-faas using npm

npm install -g yo
npm install -g generator-saphanaacademy-faas

SAP BTP, Kyma runtime

We assume you have pre-installed node.js.

The Kubernetes command-line tool kubectl is required with the kubelogin extension.

In order to deploy the project via the Makefile ensure that GNU Make is installed.

In order to deploy the project ensure that Helm is installed.

If using SAP HANA Cloud ensure you have created an instance and have configured a database mapping to the SAP BTP, Kyma runtime namespace that you will be deploying to.

Ensure that you have set the KUBECONFIG environment variable, have optionally created a namespace into which you would like to deploy the project. For example:

Mac/Linux:

chmod go-r {KUBECONFIG_FILE_PATH}
export KUBECONFIG={KUBECONFIG_FILE_PATH}
kubectl create ns dev

Windows:

$ENV:KUBECONFIG="{KUBECONFIG_FILE_PATH}"
kubectl create ns dev

You can also specify the path to your Kubeconfig file in the generator.

To generate your new project:

yo saphanaacademy-faas

NB: If you prefer a rich user experience when generating your projects consider the Application Wizard.

To deploy your new project to SAP BTP, Kyma runtime:

cd <projectName>
make helm-deploy

If you prefer, you can issue the helm commands manually (see the generated /Makefile) or use a CI/CD pipeline.

To undeploy your new project from SAP BTP, Kyma runtime:

cd <projectName>
make helm-undeploy

Important

Please pay special attention to messages produced by the generator - especially those regarding setting of API keys & credentials!

Video Tutorials

For hands-on video tutorials click here.

Getting To Know Yeoman

Yeoman has a heart of gold.
Yeoman is a person with feelings and opinions, but is very easy to work with.
Yeoman can be too opinionated at times but is easily convinced not to be.
Feel free to learn more about Yeoman.

npm