Your first deploy
Practice deploying a simple “hello world” application using the cloud.gov command line interface (CLI).
First, set up your command line interface (CLI) (if you haven’t already).
cf login -a api.fr.cloud.gov --sso
- It’ll say
One Time Code ( Get one at
)– visit this login link in your browser.
- If you use a cloud.gov account, you may need to log in using your email address, password, and multi-factor authentication token. (EPA, FDIC, GSA, and NSF: use your agency button.)
- After you log in, the page will display your 10-character Temporary Authentication Code.
- Copy and paste that 10-character code into the command line (no typing indicators will show), and enter it.
Target your “sandbox”
If you have a federal email address, when you log in for the first time, cloud.gov will start automatically creating a sandbox space for you. You might need to wait up to 5 minutes before it becomes available.
Here’s how to deploy a test app in your sandbox using the CLI.
Enter the following
cf target command:
cf target -o <ORG> -s <SPACE>
<ORG> is a Cloud Foundry organization named “sandbox-<agencypart>”, where <agencypart> is whatever comes right before
.mil in your
e-mail address. For example, this may be
sandbox-epa. In most cases, your
<SPACE> is the part of your email before the
firstname.lastname. To get a list of your available organizations, type
cf target -o sandbox-gsa -s harry.truman
Deploy a test application
- Get code for “hello world” applications (repository):
- Using git:
git clone https://github.com/18F/cf-hello-worlds.git
- Using git:
- Move into that directory, for example:
- Look at the collection of tiny apps, and
cdinto the directory for the language/framework you feel most comfortable with. For example:
Deploy the application, where
APPNAMEshould be something unique like
python-truman). By default, your
APPNAMEwill become part of the route to make your application publicly reachable, usually
https://APPNAME.app.cloud.gov/or similar, and route names must be unique across the platform.
cf push APPNAME
- You’ll see a series of messages noting the stages of creating the app. When complete, it’ll say “App started” and give information about your app. Use the
urls: [ROUTENAME].app.cloud.gov) to visit your app on the web.
- Try editing the app locally (without committing) and run
cf push <APPNAME>again to see your changes. The changes will be reflected even without being committed to Git. cloud.gov is not Git-aware – it simply deploys whatever is contained in the directory that you
pushfrom. You can set up continuous deployment from a Git repository.
- Visit the dashboard (
https://dashboard.fr.cloud.gov/) to see your options for managing your application via your browser.
- If you’re done, you can delete your app by running
cf delete <APPNAME>(it’s up to you whether to keep it running for more experiments or delete it).
Next, check out Concepts for an overview of cloud.gov terms and architecture.
Then, head over to deployment instructions and architecture principles for an introduction to deploying your own applications on cloud.gov.
Good to know
Check out Status, which tells you about cloud.gov service disruptions. You can use “Subscribe to Updates” in the upper right corner to get email or SMS notifications about platform problems that may affect cloud.gov users.
cloud.gov is based on Cloud Foundry, so in general, the the Cloud Foundry documentation and other Cloud Foundry resources mostly apply to cloud.gov. For example, you can also try deploying the sample apps maintained by the Cloud Foundry community.