The script provided in this folder installs an end-to-end working solution, which showcases how workload deployed on IBM Cloud Code Engine can connect to backends (e.g. databases, nginx, docling-serve) hosted on IBM VPC infrastructure.

Mainly, this sample covers the following typical use case:

• As a user I want to access my database backend on TCP port XYZ from workload deployed on Code Engine, without exposing my VPC to the public internet.

Use case: Database backend

To simulate the database use case the script deploys a PostgreSQL database on the origin server VSI, a Code Engine app (see Golang source code), and a Code Engine job (see Node.js source code). Each job run instance will issue a single SQL insert statement storing a random greeting message in the database. The purpose of the application is to query all existing records and expose them as a JSON object through its HTTPS endpoint. The request flows look as depicted in the diagram below:

Please note: The custom domain mentioned in the flow is not part of this scripted sample, but is a worthful addition in real-world solutions. Custom domains can be easily configured through Code Engine domain mappings (see https://cloud.ibm.com/docs/codeengine?topic=codeengine-app-domainmapping for further information)

Following diagram depicts the component overview of the sample solution:

To learn more about Private Path services, please refer to https://cloud.ibm.com/docs/vpc?topic=vpc-private-path-service-intro

To run this end-to-end sample, open a terminal, login into your IBM Cloud account using the IBM Cloud CLI and execute the following command:

./run

The script deletes all created resources right after the sample scenario has been verified by the script. However, for playing around with the setup, the cleanup can be skipped using the environment variable CLEANUP_ON_SUCCESS:

CLEANUP_ON_SUCCESS=false ./run

Per default, the script will tear up all resources in the IBM Cloud location Washington (eu-es). To change the region, utilize the environment variable REGION

REGION=eu-de ./run

To adjust naming of all IBM Cloud resources, the following environment variable NAME_PREFIXcan be overriden (default: ce-to-private-path):

NAME_PREFIX=my-prefix ./run

To analyze issues that may appear in your account, it could be useful to skip the deletion of IBM Cloud resources by setting environment variable CLEANUP_ON_ERROR to false:

CLEANUP_ON_ERROR=false ./run

To clean up all IBM Cloud resources, that have been created as part of the provided script, run:

./run clean

In order to connect to the VSI via ssh, you can specify the name of an VPC SSH key using the env variable VPC_SSH_KEY to configured enroll it on the created VSI. Furthermore, you'll need to set the env variable DEBUG=true, which will make sure that the VPC Floating IP will remain attached to the originserver VSI.

VPC_SSH_KEY=<name-of-ssh-key> DEBUG=true CLEANUP_ON_SUCCESS=false ./run

Connecting a Private Path service with a Code Engine project opens up a wide variety of integration scenarios, including connecting to on-premise infrastructure.