These guidelines represent best practices for developing modern apps for cloud platforms. For more detailed reading about good app design for the cloud, see The Twelve-Factor App.
Apps written in supported frameworks often run unmodified on Ops Manager if the app design follows a few simple guidelines. Following these guidelines facilitates app deployment to Ops Manager and other cloud platforms.
For more information about the features of HTTP routing handled by the Gorouter in Ops Manager, see HTTP routing. For more information about the lifecycle of app containers, see App container lifecycle.
Apps running on Ops Manager should not write files to the local file system for the following reasons:
Local file system storage is short-lived. When an app instance crashes or stops, the resources assigned to that instance are reclaimed by the platform, including any local disk changes made since the app started. When the instance is restarted, the app starts with a new disk image. Although your app can write local files while it is running, the files disappear after the app restarts.
Instances of the same app do not share a local file system. Each app instance runs in its own isolated container. Therefore, a file written by one instance is not visible to other instances of the same app. If the files are temporary, this should not be a problem. However, if your app needs the data in the files to persist across app restarts, or the data needs to be shared across all running instances of the app, the local file system should not be used. VMware recommends using a shared data service like a database or blobstore for this purpose.
For example, instead of using the local file system, you can use a Ops Manager service such as the MongoDB document database or a relational database like MySQL or PostgreSQL. Another option is to use cloud storage providers such as Amazon S3, Google Cloud Storage, Dropbox, or Box. If your app needs to communicate across different instances of itself, consider a cache like Redis or a messaging-based architecture with RabbitMQ.
If you must use a file system for your app because, for example, your app interacts with other apps through a network attached file system or because your app is based on legacy code that you cannot rewrite, consider using volume services to bind a network attached file system to your app. For more information, see Using an External File System (Volume Services).
In an environment with shared domains, cookies might be accessible across apps.
Many tracking tools such as Google Analytics and Mixpanel use the highest available domain to set their cookies. For an app using a shared domain such as
example.com, a cookie set to use the highest domain has a
Domain attribute of
.example.com in its HTTP response header. For example, an app at
my-app.shared-domain.example.com might be able to access the cookies for an app at
Clients connect to apps running on Ops Manager by making requests to URLs associated with the app. Ops Manager allows HTTP requests to apps on ports 80 and 443. For more information, see Routes and Domains.
Ops Manager also supports WebSocket handshake requests over HTTP containing the
Upgrade header. The Ops Manager router handles the upgrade and initiates a TCP connection to the app to form a WebSocket connection.
To support WebSockets, the operator must configure the load balancer correctly. Depending on the configuration, clients may have to use a different port for WebSocket connections, such as port 4443, or a different domain name. For more information, see Supporting WebSockets.
For app management purposes, Ops Manager may need to stop and restart your app instances. If this occurs, Ops Manager performs the following steps:
Ops Manager sends a single
termination signal to the root process that your start command invokes.
Ops Manager waits 10 seconds to allow your app to cleanly shut down any child processes and handle any open connections.
After 10 seconds, Ops Manager forcibly shuts down your app.
Your app should accept and handle the termination signal to ensure that it shuts down gracefully. To achieve this, the app is expected to follow the steps below when shutting down:
For an implementation of the expected shutdown behavior in Golang, see the Sample HTTP App repository on GitHub.
By default, when you push an app, all files in the app’s project directory tree are uploaded to your Ops Manager instance, except version control and configuration files or folders with the following names:
In addition to these, if API request diagnostics are directed to a log file and the file is within the project directory tree, it is excluded from the upload. You can direct these API request diagnostics to a log file using
cf config --trace or the
CF_TRACE environment variable.
If the app directory contains other files, such as
log files, or complete subdirectories that are not required to build and run your app, you might want to add them to a
.cfignore file to exclude them from upload. Especially with a large app, uploading unnecessary files can slow app deployment.
To use a
.cfignore file, create a text file named
.cfignore in the root of your app directory structure. In this file, specify the files or file types you wish to exclude from upload. For example, these lines in a
.cfignore file exclude the “tmp” and “log” directories.
The file types you might want to exclude vary, based on the app frameworks you use. For examples of commonly-used
.gitignore files, see the gitignore repository on GitHub.
Singleton apps may become temporarily unavailable for reasons that include:
During an upgrade, Ops Manager gracefully shuts down the apps running on each Diego Cell and restarts them on another Diego Cell. Single app instances may become temporarily unavailable if the replacement instance does not become healthy within the Diego Cell’s evacuation timeout, which defaults to 10 minutes.
Unexpected faults in Ops Manager system components or underlying infrastructure, such as container-host VMs or IaaS availability zones, might cause lone app instances to disappear or become unroutable for a minute or two.
To avoid the risk of an app becoming temporarily unavailable, developers can run more than one instance of the app.
A buildpack consists of bundles of detection and configuration scripts that provide framework and runtime support for your apps. When you deploy an app that needs a buildpack, Ops Manager installs the buildpack on the Diego Cell where the app runs.
For more information, see Buildpacks.