Developer Guide

Page last updated:

This guide provides instructions for deploying, running, and managing apps and services with Cloud Foundry.

Overview

Developing, running, and managing apps on Cloud Foundry may include:

• Deploying and scaling apps with diverse languages, frameworks, and dependencies

• Finding software services in the services marketplace, such as databases, email, or message servers

• Creating your own Cloud Foundry service based on an external server

• Creating service instances and binding them to your apps

• Streaming app logs to an external log management service

• Troubleshooting app deployment and health


If you do these things, you are a Cloud Foundry developer, and the contents of this guide are for you.

To deploy a local Cloud Foundry environment for experimentation or debugging purposes, you can use CF Dev. For more information, see CF Dev.

Contents

• Considerations for Designing and Running an App in the Cloud: Some considerations you should keep in mind when designing and running an app through Cloud Foundry.

• Cloud Foundry Dev: A lightweight Cloud Foundry that runs on your workstation, for developing apps locally.

• cf push: How to use cf push and troubleshoot when running cf push.

  • Pushing an App
  • Deploying with App Manifests
  • App Manifest Attribute Reference
  • Deploying an App with Docker
  • Deploying a Large App
  • Starting, Restarting, and Restaging Apps
  • Pushing an App with Multiple Processes
  • Running cf push Sub-Step Commands
  • Rolling App Deployments
  • Pushing Apps with Sidecar Processes
  • Using Blue-Green Deployment to Reduce Downtime and Risk
  • Troubleshooting App Deployment and Health

• Routes and Domains: How to configure routes and domains.

  • Configuring Routes and Domains
  • Configuring Cloud Foundry to Route Traffic to Apps on Custom Ports
  • Routing HTTP/2 and gRPC Traffic to Apps

• Managing Apps with the cf CLI: How to manage apps through the Cloud Foundry Command Line Interface (cf CLI).

  • Running Tasks
  • Scaling an App Using cf scale
  • Using App Health Checks
  • App Revisions
  • Configuring Container-to-Container Networking

• Managing Services: How to use software services from your apps.

  • Services Overview
  • Managing Service Instances with the cf CLI
  • Sharing Service Instances
  • Delivering Service Credentials to an App
  • Managing Service Keys
  • Managing App Requests with Route Services
  • Configuring Play Framework Service Connections
  • Using an External Filesystem (Volume Services)
  • User-Provided Service Instances

• Streaming App Logs: How to stream app logs to third-party log management services.

  • Streaming App Logs to Log Management Services
  • Service-Specific Instructions for Streaming App Logs
  • Streaming App Logs to Splunk
  • Streaming App Logs with Fluentd
  • Streaming App Logs to Azure OMS Log Analytics

• SSH for Apps and Services: How to configure and use SSH access to apps and services.

  • App SSH Overview
  • Accessing Apps with SSH
  • Accessing Services with SSH

• Cloud Foundry Environment Variables: The environment variables that the Cloud Foundry runtime and buildpacks set for a deployed app.

• Cloud Controller API Client Libraries: Libraries for calling the Cloud Controller, the executive component of Cloud Foundry, programmatically.