Accessing services with SSH
Page last updated:
You can gain direct command line access to your deployed service instance using SSH. This allows you to, for example, access your database to run raw SQL commands to edit the schema, import and export data, or debug app data issues.
To establish direct command line access to a service, you deploy a host app and use its SSH and port forwarding features to communicate with the service instance through the app container. The technique described here works with TCP services such as MySQL or Redis.
This article assumes you are using Cloud Foundry Command Line Interface (cf CLI) v6.15.0 or later, but at least v7 is recommended.
Note: If you have mutual TLS between the Gorouter and app containers, app containers accept incoming communication only from the Gorouter. This disables
cf ssh. For more information, see the TLS to Apps and Other Back End Services section of the HTTP Routing topic.
Note: The procedure in this topic requires use of a service key, and not all services support service keys. Some services support credentials through app binding only.
Create a service instance
In your terminal window, log in to your deployment with
cf marketplaceto list the marketplace services available.
$ cf marketplace mysql 100mb MySQL databases on demand
Create your service instance. As part of the create-service command, indicate the service name, the service plan, and the name you choose for your service instance.
$ cf create-service MySQL 100mb MY-DB
Push your host app
To push an app that acts as the host for the SSH tunnel, push any app that successfully deploys to Cloud Foundry.
Note: Your app must be prepared before you push it. See the Pushing an App topic for details on preparing apps for pushing.
Push your app:
cf push YOUR-HOST-APP
Activate SSH for your app:
cf enable-ssh YOUR-HOST-APP
Note: To activate SSH access to your app, SSH access must also be activated for both the space that contains the app and Cloud Foundry. For more information, see App SSH Overview.
Create your service key
To establish SSH access to your service instance, you must create a service key that contains critical information for configuring your SSH tunnel.
Create a service key for your service instance using the cf create-service-key command.
cf create-service-key MY-DB EXTERNAL-ACCESS-KEY
Retrieve your new service key using the cf service-key command.
cf service-key MY-DB EXTERNAL-ACCESS-KEY
$ cf service-key MY-DB EXTERNAL-ACCESS-KEY Getting key EXTERNAL-ACCESS-KEY for service instance MY-DB as email@example.com
Configure your SSH tunnel
Configure an SSH tunnel to your service instance using cf ssh. Tailor the following example command with information from your service key.
$ cf ssh -L 63306:us-cdbr-iron-east-01.mysql.net:3306 YOUR-HOST-APP
- You can use any available local port for port forwarding; for example,
us-cdbr-iron-east-01.mysql.netis the address provided under
hostnamein the service key retrieved above.
3306is the port provided under
YOUR-HOST-APPis the name of your host app.
After you enter the command, open another terminal and perform the following steps in Access Your Service Instance.
Access your service instance
To establish direct command line access to your service instance, use the relevant command line tool for that service. This example uses the MySQL command line client to access the MySQL service instance.
$ mysql -u b5136e448be920 -h 0 -p -D ad_b2fca6t49704585d -P 63306
b5136e448be920with the username provided under
usernamein your service key.
mysqlto connect to your local machine (use
-h 127.0.0.1for Windows).
mysqlto prompt for a password. When prompted, use the password provided under
passwordin your service key.
ad_b2fca6t49704585dwith the database name provided under
namein your service key.
mysqlto connect on port