Connecting an IBM Cloud application
Applications running in IBM Cloud can be bound to your IBM Cloud® Databases for PostgreSQL deployment.
Connecting a Kubernetes Service application
There are two steps to connecting a Cloud databases deployment to a Kubernetes Service application. First, your deployment needs to be bound to your cluster and its connection strings that are stored in a secret. The second step is configuring your application to use the connection strings.
The sample app in the Connecting a Kubernetes Service Tutorial provides a sample application that uses Node.js and demonstrates how to bind the sample application to a Cloud Databases deployment.
Before connecting your Kubernetes Service application to a deployment, make sure that the deployment and cluster are both in the same region and resource group.
Binding your deployment
Public endpoints - If you are using the default public service endpoint to connect to your deployment, you can run the cluster service bind command with your cluster name, the resource group, and your deployment
name.
ibmcloud ks cluster service bind <CLUSTER_NAME> <RESOURCE_GROUP> <DEPLOYMENT_NAME_OR_CRN>
OR Private endpoints - If you want to use a private endpoint (if one is enabled on your deployment), then create a service key for Kubernetes to use when binding to the database.
ibmcloud resource service-key-create <PRIVATE_KEY> --instance-name <DEPLOYMENT_NAME_OR_CRN> --service-endpoint private
The private service endpoint is selected with --service-endpoint private. After that, you bind the database to the Kubernetes cluster through the private endpoint with the cluster service bind command.
ibmcloud ks cluster service bind <CLUSTER_NAME> <RESOURCE_GROUP> <DEPLOYMENT_NAME_OR_CRN> --key <PRIVATE_KEY>
Verify - Verify that the Kubernetes secret was created in your cluster namespace. Running the following command, you get the API key for accessing the instance of your deployment that is provisioned in your account.
kubectl get secrets --namespace=default
More information on binding services is found in the Kubernetes Service documentation.
Configuring in your Kubernetes app
When you bind your application to Kubernetes Service, it creates an environment variable from the cluster's secrets. Your deployment's connection information lives in BINDING as a JSON object. Load and parse the JSON object into
your application to retrieve the information your application's driver needs to make a connection to the database.
The Connection strings page contains a reference of the JSON fields.
For more information, see the Kubernetes Service documentation.