App 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 might 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.

Contents

• Considerations for designing and running an app in the cloud

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

  • Pushing your app using Cloud Foundry CLI (cf push)
  • Deploying with app manifests
  • App manifest attribute reference
  • Deploying your app with Docker
  • Deploying your large apps
  • Starting, restarting, and restaging apps
  • Pushing an app with multiple processes
  • Running cf push sub-step commands
  • Configuring 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 per-route options
  • 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 in your apps
  • Scaling an app Using cf scale
  • Using app health checks
  • Cloud Foundry API 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 file system (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.