Awesome
One micro-service, multiple deployment options
This project contains one simple micro-service that gets deployed:
-
as a Cloud Foundry application,
-
as a container in a Kubernetes cluster,
-
and as a Cloud Functions action.
<center> <img src="architecture.png" width="600" /> </center>
Watch this Youtube video that walks you through the deployment of the service and test the behavior of the deployment options when the service crashes:
<center> <a href="https://youtu.be/Bdl9s2LxUZo"><img src="youtube.png" width="600" /></a> </center>Requirements
- An IBM Cloud account. Either sign up, or use an existing account.
About the micro-service
The micro-service used in this project computes Fibonacci numbers.
From Wikipedia: In mathematics, the Fibonacci numbers are the numbers in the following integer sequence, called the Fibonacci sequence, and characterized by the fact that every number after the first two is the sum of the two preceding ones:
0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, ...
The implementation of the Fibonacci sequence is done in service/lib/fibonacci.js. The same implementation is used across all deployment options.
Deploy the services in IBM Cloud with the toolchain
-
Identify an IBM Cloud region, Cloud Foundry organization and space where to deploy the services.
-
Create a standard Kubernetes cluster
-
Create a registry namespace
And then
-
Select the GitHub box.
- Decide whether you want to clone or fork the repository.
- If you decide to Clone, set a name for your GitHub repository.
-
Select the Delivery Pipeline box.
- Specify the IBM Cloud API key to use or create one
- Select the region, organization and space where you want to deploy the web application. A random route will be used for the application. :warning: Make sure the organization and the space have no space in their names.
- Select the Kubernetes cluster where to deploy the service, together with the Docker registry name where to store the Docker image
-
Click Create.
-
Select the Delivery Pipeline.
-
Wait until all stages complete.
-
Open the Deploy log for the CLOUD FOUNDRY, CLOUD FUNCTIONS and KUBERNETES stages. Each log has a link at the end pointing to the location where the services have been deployed. Click on the links to add the service to the visual tester.
-
The services are ready. Review the Service API to call the services.
Service API
Once deployed, the service implements 3 API calls:
- compute the Fibonacci number after n iterations,
- let the computation run for t milliseconds,
- and simulate a crash of the service.
Depending on which compute option you are using, use the following cURL calls:
| Endpoint Type | Endpoint | URL |
|---|---|---|
| Cloud Foundry | iteration | curl -v http://fibonacci-service-<random-string>.mybluemix.net/fibonacci?iteration=1000 |
| duration | curl -v http://fibonacci-service-<random-string>.mybluemix.net/fibonacci?duration=5000 | |
| crash | curl -v -X POST http://fibonacci-service-<random-string>.mybluemix.net/fibonacci?crash=true | |
| Kubernetes | iteration | curl -v http://<cluster-ip>:30080/fibonacci?iteration=1000 |
| duration | curl -v http://<cluster-ip>:30080/fibonacci?duration=5000 | |
| crash | curl -v -X POST http://<cluster-ip>:30080/fibonacci?crash=true | |
| Cloud Functions | iteration | curl -v https://openwhisk.ng.bluemix.net/api/v1/web/<namespace>/default/fibonacci?iteration=1000 |
| duration | curl -v https://openwhisk.ng.bluemix.net/api/v1/web/<namespace>/default/fibonacci?duration=5000 | |
| crash | curl -v -X POST https://openwhisk.ng.bluemix.net/api/v1/web/<namespace>/default/fibonacci?crash=true |
Code Structure
Cloud Foundry application
| File | Description |
|---|---|
| app.js | Main application, start the express web server and expose the service API |
| lib/fibonacci.js | The implementation of the Fibonacci sequence, shared by all deployment options |
| package.json | List the packages required by the application |
| manifest.yml | Description of the application to be deployed |
| .cfignore | List files to ignore when deploying the application to Cloud Foundry |
Kubernetes deployment
| File | Description |
|---|---|
| app.js | Main application, start the express web server and expose the service API |
| lib/fibonacci.js | The implementation of the Fibonacci sequence, shared by all deployment options |
| package.json | List the packages required by the application |
| Dockerfile | Description of the Docker image |
| fibonacci-deployment.yml | Specification file for the deployment of the service in Kubernetes |
Cloud Functions action
The Cloud Functions action is deployed as a zip action where several files are packaged into a zip file and the zip file is passed to Cloud Functions as the implementation for the action. deploy.js takes care of packaging the zip file.
| File | Description |
|---|---|
| handler.js | Implementation of the Cloud Functions action |
| lib/fibonacci.js | The implementation of the Fibonacci sequence, shared by all deployment options |
| package.json | Specify the action entry point (handler.js) |
| deploy.js | Helper to deploy and undeploy the Cloud Functions action |
Tester web app
Under the tester directory is a simple web application to register and test the deployed micro-services. It can be pushed to IBM Cloud with cf push or simply executed locally with python -m SimpleHTTPServer 28080 as example.
Contribute
Please create a pull request with your desired changes.
Troubleshooting
Cloud Foundry
Use
ibmcloud cf logs fibonacci-service
to look at the live logs for the web application.
Kubernetes
Use
kubectl proxy
and look at the status of the resources in the console.
Cloud Functions
Use
ibmcloud cloud-functions activation poll
and perform an invocation of the action.
License
See License.txt for license information.