Bluemix Python Web application

This repository is part of lab for the NYU DevOps class for Fall 2018, CSCI-GA.2820-001

The sample code is using Flask microframework with Flask-RESTful and is intented to test the Python support on IBM Cloud environment which is based on Cloud Foundry. It also uses Cloudant as a database for storing JSON objects.

IBM Cloud contains the Python buildpack from Cloud Foundry and so will be auto-detected as long as a requirements.txt or a setup.py is located in the root of your application.

Follow the steps below to get the lab code and see how to deploy manually.

Prerequisite Installation using Vagrant

The easiest way to use this lab is with Vagrant and VirtualBox. if you don't have this software the first step is down download and install VirtualBox and Vagrant

Get the lab code

From a terminal navigate to a location where you want this application code to be downloaded to and issue:

git clone https://github.com/nyu-devops/lab-bluemix-cf.git
cd lab-bluemix-cf
vagrant up
vagrant ssh
cd /vagrant

This will place you into an Ubuntu VM all set to run the code.

Run the tests

Before you modify any code you should always run teh test suit to be sure that nothing is broken bedfore you start.

You can run the tests to make sure that the code works with the following command:

nosetests

Run the Service

In order to run the service you will need to have some environment variables set (in true 12-factor fashion). This reo has an examle called dot-env-example which you can simply use. Copy it to a file called .env with this command:

cp dot-env-example .env

You only need to do this once. Now every time you tun the applciation, it will pick up those environment variatbels whcih tell it where to find the database and how to login.

You can run the code to test it out in your browser with the following command:

honcho start

You should be able to see it at: http://localhost:8080/

When you are done, you can use Ctrl+C to stop the server and then exit and shut down the vm with:

Deploy to IBM Cloud manually

Before you can deploy this applicaiton to IBM Cloud you MUST edit the manifest.yml file and change the name of the application to something unique. I recommend changing the last two letters to your initials as a start. If that doesnt work, start adding numbers to make it unique.

Then from a terminal login into Bluemix and set the api endpoint to the Bluemix region you wish to deploy to:

ic cf login -a api.ng.bluemix.net

The login will ask you for you email(username) and password, plus the organization and space if there is more than one to choose from.

From the root directory of the application code execute the following to deploy the application to Bluemix. (By default the route (application URL) will be based on your application name so make sure your application name is unique or use the -n option on the cf push command to define your hostname)

ic cf push <YOUR_APP_NAME> -m 64M

to deploy when you don't have a requirements.txt or setup.py then use:

ic cf push <YOUR_APP_NAME> -m 64M -b https://github.com/cloudfoundry/python-buildpack

to deploy with a different hostname to the app name:

ic cf push <YOUR_APP_NAME> -m 64M -n <YOUR_HOST_NAME>

View App

Once the application is deployed and started open a web browser and point to the application route defined at the end of the cf push command i.e. http://lab-bluemix-xx.mybluemix.net/. This will execute the code under the / app route defined in the server.py file. Navigate to /pets to see a list of pets returned as JSON objects.

Structure of application

Procfile - Contains the command to run when you application starts on Bluemix. It is represented in the form web: <command> where <command> in this sample case is to run the py command and passing in the the server.py script.

requirements.txt - Contains the external python packages that are required by the application. These will be downloaded from the python package index and installed via the python package installer (pip) during the buildpack's compile stage when you execute the cf push command. In this sample case we wish to download the Flask package at version 1.0.2 and Cloudant package at version 2.9.0.

runtime.txt - Controls which python runtime to use. In this case we want to use Python 3.8.8.

README.md - this readme.

manifest.yml - Controls how the app will be deployed in Bluemix and specifies memory and other services like Redis that are needed to be bound to it.

service - the python package that contains fthe applciation. This is implemented as a simple Flask-RESTful application. The routes are defined in the application using the api.add_resource() calls. This application has a / route and a /pets route defined.

The application deployed to IBM Cloud needs to listen to the port defined by the VCAP_APP_PORT environment variable as seen here:

port = os.getenv('VCAP_APP_PORT', '8080')
if __name__ == "__main__":
    app.run(host='0.0.0.0', port=int(port))

This is the port given to your application so that http requests can be routed to it. If the property is not defined then it falls back to port 5000 which is the default port for Flask allowing you to run this sample application locally.

ggrace7/lab-bluemix-cf