Skip to content

code_engine.md

Latest commit

 

History

History
135 lines (92 loc) · 5.48 KB

code_engine.md

File metadata and controls

135 lines (92 loc) · 5.48 KB
Raw

IBM Cloud Code Engine

IBM Code Engine allows you to run your application, job or container on a managed serverless platform. Auto-scale workloads and only pay for the resources you consume.

Installation

  1. Install IBM Cloud backend dependencies:
python3 -m pip install lithops[ibm]

Configuration

  1. If you don't have an IAM API key created, navigate to the IBM IAM dashboard.

  2. Click Create an IBM Cloud API Key and provide the necessary information.

  3. Copy the generated IAM API key (you can only see the key the first time you create it, so make sure to copy it).

  4. Navigate to the resource groups dashboard, and copy the desired resource group ID.

  5. Edit your Lithops config and add the following keys:

    lithops:
    backend: code_engine

ibm:
    iam_api_key: <IAM_API_KEY>
    region: <REGION>
    resource_group_id: <RESOURCE_GROUP_ID>

Summary of configuration keys for IBM Cloud:

IBM IAM:

Group Key Default Mandatory Additional info
ibm iam_api_key yes IBM Cloud IAM API key to authenticate against IBM services. Obtain the key here
ibm region yes IBM Region. One of: eu-gb, eu-de, eu-es, us-south, us-east, br-sao, ca-tor, jp-tok, jp-osa, au-syd
ibm resource_group_id yes Resource group id from your IBM Cloud account. Get it from here. Required to auto-create a Code Engine project

Code Engine:

Group Key Default Mandatory Additional info
code_engine project_name no Name of an existing Code Engine project. If not provided, Lithops creates lithops-<region>-<user_key> automatically
code_engine region no Code Engine region. One of: eu-gb, eu-de, eu-es, us-south, us-east, br-sao, ca-tor, jp-tok, jp-osa, au-syd. Lithops uses the region set under the ibm section if not set here
code_engine docker_server docker.io no Container registry URL
code_engine docker_user no Container registry user name
code_engine docker_password no Container registry password/token. For Docker Hub, log in to your Docker Hub account and generate a new access token here
code_engine max_workers 1000 no Max number of workers per FunctionExecutor()
code_engine worker_processes 1 no Number of Lithops processes within a given worker. This can be used to parallelize function activations within a worker. It is recommended to set this value to the same number of CPUs as the container.
code_engine runtime no Docker image name.
code_engine runtime_cpu 0.125 no CPU limit. Default 0.125 vCPU. See valid combinations
code_engine runtime_memory 256 no Memory limit in MB. Default 256 MB. See valid combinations
code_engine runtime_timeout 600 no Runtime timeout in seconds. Default 600 seconds
code_engine connection_retries no If specified, number of API call retries in case of connection failure with error code 500

Runtime

Use your own runtime

If a pre-built runtime is not provided, Lithops will automatically build the default runtime the first time you run a script. For this task it uses the Docker command installed locally on your machine. To make this work, you need to:

  1. Install the Docker CE version.

  2. Login to your container registry account:

    docker login

Custom runtime

If you need to create a runtime with custom system packages and libraries, please follow Building and managing Lithops runtimes to run the functions

Configure a private container registry for your runtime

Configure Docker Hub

To configure Lithops to access a private repository in your Docker Hub account, you need to extend the Code Engine config and add the following keys:

code_engine:
    ....
    docker_server    : docker.io
    docker_user      : <container registry username>
    docker_password  : <container registry access TOKEN>

Configure IBM Container Registry

To configure Lithops to access to a private repository in your IBM Container Registry, you need to extend the Code Engine config and add the following keys:

code_engine:
    ....
    docker_server    : us.icr.io  # Change-me if you have the CR in another region
    docker_user      : iamapikey
    docker_password  : <IBM IAM API KEY>
    docker_namespace : <namespace>  # namespace name from https://cloud.ibm.com/registry/namespaces

Test Lithops

Once you have your compute and storage backends configured, you can run a Hello World function with:

lithops hello -b code_engine -s ibm_cos

Viewing the execution logs

You can view the function executions logs in your local machine using the lithops client:

lithops logs poll

Clean up resources

Delete Lithops runtimes, job runs, and cached metadata:

lithops clean -b code_engine -s ibm_cos

To also delete the Code Engine project and local cache:

lithops clean -b code_engine -s ibm_cos --all