When migrating off IBM Cloud Features, IBM Cloud Code Engine is likely one of the attainable deployment targets. Code Engine presents apps, jobs and (not too long ago perform) you can (or want) to choose from. On this submit, we offer some dialogue factors and share suggestions and methods on easy methods to work with Code Engine features.
IBM Cloud Code Engine is a totally managed, serverless platform to (not solely) run your containerized workloads. It has evolved a lot since March 2021, after I printed the weblog submit “Migrating Cloud Functions Code to Code Engine.” In 2021, there have been solely Code Engine apps and jobs. Earlier this year, Code Engine added support for functions (Features-as-a-Service, or FaaS).
On this submit, I’m going to take a contemporary have a look at that matter and talk about the choices on easy methods to transfer from IBM Cloud Functions to Code Engine.
Apps, jobs and features
IBM Cloud Code Engine options three different ways to run your business logic:
- An app is a repeatedly run course of that solutions to HTTP requests.
- A job runs to deal with a activity after which terminates.
- A perform is a stateless code snippet that’s invoked by an HTTP request and, after producing a response, terminates. Furthermore, jobs often run considerably longer than features (“batch processing”).
There are lots of extra characteristics that help distinguish between apps, jobs and features. In brief, apps are a superb match if you wish to craft a REST API or deploy an online utility with backend/frontend performance. You will have full management over the HTTP server and its sources.
Jobs, however, are long-running processes that don’t require any consumer interplay. They might be typical batch actions, analytics processing and even AI mannequin coaching.
Lastly, features can react to incoming HTTP requests in a short time. They serve low-latency use circumstances effectively, like chatbot integrations or webhooks. In distinction to apps, you don’t and can’t outline and configure the HTTP server.
When coming from Cloud Features, you could have skilled that there are lots of use cases supported by Cloud Functions. Equally, a perform might have totally different attributes which can be essential relying on the case:
- The invocation or start-up time (chilly begin) could be essential, resulting in an general brief response time.
- In different circumstances, the price (billing) might need been the aggressive issue.
- The simplicity and agility, brought on by a perform as unit for growth and deployment in a DevSecOps course of leads some initiatives to go for features.
Usually, it’s a mixture of the above that results in individuals preferring features (FaaS) over different runtime or compute choices.
From Cloud Features to Code Engine
When shifting from Cloud Features to Code Engine, the next perform traits must be taken under consideration when deciding to on an app, a job or a Code Engine perform:
- Is an http endpoint wanted to invoke the code?
- Is the processing triggered by an occasion?
- What programming language is used for the prevailing perform and the way huge are the required libraries?
- How lengthy does the processing take, what compute sources are wanted, is parallel processing desired?
The information Migrating IBM Cloud Functions to Code Engine has an in depth overview with Code Engine app, job and performance traits. They aid you to pick out the very best entity in your current workload. Moreover, the present Code Engine function limitations and the overall limits and quotas for Code Engine must be taken under consideration. The part Migrating IBM Cloud Functions Actions to Code Engine Functions FAQ would possibly aid you determine easy methods to migrate.
Suggestions and methods for Code Engine features
The next suggestions and methods are based mostly on my experiences with shifting current code from Cloud Features to Code Engine features. They assist in slicing down deployment cycles by first using native checks to implement related performance in combining Code Engine features and jobs and designing built-in APIs by making use of Code Engine system variables.
Native testing of features
Apps are common net functions, jobs are like scripts, and each might be examined regionally in a number of methods. As a result of features are code snippets, some wrapper is required to show them into packages. The next method has served me effectively to this point.
With the perform code in a subdirectory “func,” I make the most of both the Python or Node.js wrapper code proven beneath and place it within the mum or dad listing. There, I additionally keep information with take a look at configurations as JSON objects, similar to what is passed by Code Engine to the function on invocation. For testing, I run the wrapper together with the configuration file as parameter. The wrappers for Python and Node.js are proven beneath:
# syntax: python wrapper.py params.json
# import the Code Engine perform: func/__main__.py
from func.__main__ import foremost
import sys, json
if __name__ == "__main__":
# open file, learn JSON config
with open(str(sys.argv)) as confFile:
# invoke the CE perform and print the consequence
// syntax: node wrapper.js params.json
// require the Code Engine perform: func/foremost.js
// learn the file with perform parameters
const fs = require("fs");
const knowledge = fs.readFileSync(course of.argv);
// invoke the CE perform and log the consequence
Typically, you would possibly want the HTTP endpoint of a perform and the probably longer execution time of a job. In that case, create each a perform and a job. Then, make the most of the Code Engine API to create a job run from throughout the perform. On this hybrid method, the perform can get referred to as by way of its HTTP endpoint and it terminates after kicking off the job run. A job may then run as much as 24 hours and profit from the parallel job processing capabilities in Code Engine. You could find a pattern implementation of this sample within the Code Engine code examples.
Atmosphere variables and API design
For designing your API and features namespace, you possibly can make the most of Code Engine-injected environment variables like
__ce_method. The previous holds the trail part of the requested URL like “/object”, and the latter has the HTTP methodology like GET or POST. By switching on the provided values for these variables, you possibly can serve a number of API features from the identical Code Engine perform. The profit is a single base URL.
Relying in your challenge and code administration, you would possibly even wish to mix this method with separating every API perform implementation into its personal file—much like the wrapper method proven above.
IBM Cloud Functions have many use circumstances and properties, so there isn’t a easy mapping to a particular Code Engine entity (i.e., app, job or perform). By evaluating an current (Cloud Features) perform’s attribute to these of the Code Engine entities, you possibly can choose the very best match. In lots of circumstances, a Code Engine perform could be a sensible choice. For these circumstances, we shared suggestions and methods that you need to use in your Features-as-a-Service challenge with Code Engine.
Use the next IBM Cloud Code Engine documentation to get began: