https://github.com/dolph/serverless-app-python
WORK IN PROGRESS
https://github.com/dolph/serverless-app-python
Last synced: about 1 year ago
JSON representation
WORK IN PROGRESS
- Host: GitHub
- URL: https://github.com/dolph/serverless-app-python
- Owner: dolph
- License: apache-2.0
- Created: 2018-12-21T19:08:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-10T21:57:32.000Z (over 7 years ago)
- Last Synced: 2025-02-10T01:38:02.877Z (over 1 year ago)
- Language: Python
- Homepage: https://console.bluemix.net/developer/appservice/starter-kits/python-example-serverless-app
- Size: 354 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bluemix.net)
[](https://console.bluemix.net/docs/runtimes/python/index.html#python_runtime)
# Create and deploy a serverless Python application
> We have similar patterns available for [Node.js](https://github.com/IBM/serverless-app-node) and [Swift](https://github.com/IBM/serverless-app-swift), as well!
This repository has code to create a serverless Backend for Frontend ([BFF](https://samnewman.io/patterns/architectural/bff/)) using Python and IBM Cloud Functions, backed by a NoSQL database. No full stack application management required. Cloud Functions supplies basic Create, Read, Update, and Delete operations in a serverless environment. These functions are mapped to an API gateway, which can be integrated into an iOS app, for example, to enable persistence of data into a Cloudant NoSQL Database.
When you have completed this code pattern, you will understand how to:
* Create a set of Cloud Function Actions that manage the database integration
* Integrate this Backend for Frontend within your Mobile or Web apps
* Manage the release of the Cloud Functions with a DevOps pipeline
## Included Components
* [Cloudant NoSQL DB](https://console.bluemix.net/catalog/services/cloudant): A fully managed data layer designed for modern web and mobile applications that leverages a flexible JSON schema.
* [API Connect](http://developer.ibm.com/apiconnect/): Create and run secure APIs and microservices.
* [Continuous Delivery](https://console.bluemix.net/catalog/services/continuous-delivery): Enable tool integrations that support your development, deployment, and operation tasks.
* [GitLab](https://about.gitlab.com/): GitLab unifies issues, code review, CI, and CD into a single UI.
* [AppID](https://console.bluemix.net/catalog/services/app-id): Use the IBM Cloud App ID service to add authentication to your mobile and web apps and protect your back-end systems.
## Featured Technologies
* [Serverless](https://www.ibm.com/cloud-computing/bluemix/openwhisk): An event-action platform that allows you to execute code in response to an event.
* [Python](https://www.python.org/): A general purpose programming language.
## Steps
> As an alternative to the steps below, you can [create this project as a starter kit on IBM Cloud](https://console.bluemix.net/developer/appservice/create-project?starterKit=c4ea37d0-62e0-32e8-bbb1-27e1a742b94c&defaultLanguage=PYTHON&env_id=ibm%3Ayp%3Aus-south&tenantNavMode=true&defaultDeploymentToolchain=), which automatically provisions required services, and injects service credentials into a custom fork of this pattern. Then, you can skip directly to step 4 below.
1. [Install developer tools](#1-install-developer-tools)
1. [Configure your DevOps pipeline](#2-configure-your-devops-pipeline)
1. [Deploy your serverless application](#3-deploy-your-serverless-application)
1. [Integrate with your own frontend application](#4-integrate-with-your-own-frontend-application)
### 1. Install developer tools
Install the `ibmcloud` CLI binary by following the [IBM Cloud CLI](https://console.bluemix.net/docs/cli/reference/ibmcloud/download_cli.html) docs.
Install the Cloud Functions plugin for the `ibmcloud` CLI:
```bash
ibmcloud plugin install Cloud-Functions -r "IBM Cloud"
```
Finally, download the latest `wskdeploy` binary from the [Whisk Deploy releases](https://github.com/apache/incubator-openwhisk-wskdeploy/releases) page.
### 2. Configure your DevOps pipeline
The `.bluemix` directory contains all of the configuration files that the toolchain requires to function. At a minimum, the `.bluemix` directory must contain the following files:
- `toolchain.yml`
- `deploy.json`
- `pipeline.yml`
Detailed information regarding toolchain configuration can be found in our [docs](https://console.bluemix.net/docs/services/ContinuousDelivery/toolchains_custom.html#toolchains_custom).
Update the toolchain (`.bluemix/toolchain.yml`) with your desired changes.
Login into the IBM Cloud, substituting your own values for ``, ``, and ``:
```bash
ibmcloud login -a -o -s
```
Push your application to stage the toolchain:
```bash
ibmcloud app push
```
### 3. Deploy your serverless application
Your application is deployed using the IBM Continuous Delivery pipeline. Your toolchain provides an integrated set of tools to automatically build, deploy, and manage your apps.
#### Manage Cloud Functions and API Connect Manually
Download your code locally by navigate to your App dashboard from the [Apple Development Console](https://console.bluemix.net/developer/appledevelopment/apps) or [Web Apps Console](https://console.bluemix.net/developer/appservice/apps) and select **Download Code**.
You have the option to perform either a [Local Deployment](#local-deployment) or an [IBM DevOps deployment](#ibm-devops-deployment).
##### Local Deployment
If you're on Mac or Linux, ensure the `deploy.sh` script is executable and run it:
```
chmod +x deploy.sh
./deploy.sh
```
Or, if you'd rather run the `wskdeploy` command directly, you use the `--param` command line flags to provide values for the `services.cloudant.database` and `services.cloudant.url` values.
```bash
/wskdeploy -m "manifest.yml" --param "services.cloudant.url" "" --param "services.cloudant.database" "products"
```
Where `` is the URL value from your Cloudant service credentials.
##### IBM DevOps Deployment
Once you have connected your app to IBM Devops you need to add your Cloudant URL to the delivery pipeline environment variables. Note: this is a one-time action.
First click on the **Cloudant** service link when viewing the app dashboard. Then click on **Service Credentials**, and then click on the **View Credentials** link for your Cloudant instance. Copy the `url` value for use in the delivery pipeline.
Next, go back to your app dashboard and click **View Toolchain**, then click on the **Delivery Pipeline**. The delivery pipeline may have executed without any errors, but you need to specify the Cloudant URL before the Cloud Functions actions will operate as expected. Next, click on the gear icon for the **DEPLOY** phase, then click **Configure Phase** and click **Environment Properties**. Paste the Cloudant URL for the `DATABASE_URL` environment variable.
Next, run your **DEPLOY** phase again to complete the deployment.
### 4. Integrate with your own frontend application
Cloudant NoSQL DB provides access to a fully managed NoSQL JSON data layer that's always-on. This service is compatible with CouchDB, and accessible through a simple to use HTTP interface for mobile and web application models.
You can then review the [Actions](https://console.bluemix.net/openwhisk/actions) in the IBM Cloud Console interface, along with your [Cloud Functions APIs](https://console.bluemix.net/openwhisk/apimanagement).
Method
HTTP request
Description
Create
POST /database
Inserts an object
Read
GET /database/objectId
Retrieves an object
ReadAll
GET /database
Retrieves all objects
Delete
DELETE /database/objectId
Deletes an object
DeleteAll
DELETE /database
Deletes all objects
update
PUT /database/objectId
Updates content of an object
## License
This code pattern is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the [Developer Certificate of Origin, Version 1.1](https://developercertificate.org/) and the [Apache License, Version 2](https://www.apache.org/licenses/LICENSE-2.0.txt).
[Apache License FAQ](https://www.apache.org/foundation/license-faq.html#WhatDoesItMEAN)