US flag signifying that this is a United States Federal Government website An official website of the United States government

Your first deploy

Your first deploy

Practice deploying a simple “hello world” application using the cloud.gov command line interface (CLI).

Get ready

First, set up your command line interface (CLI) (if you haven’t already).

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.

Start with the following cf target command:

cf target -o <ORG> -s <SPACE>

Your <ORG> is a Cloud Foundry organization named “sandbox-<agencypart>”, where <agencypart> is whatever comes right before .gov or .mil in your e-mail address. For example, this may be sandbox-gsa or sandbox-epa. In most cases, your <SPACE> is the part of your email before the @, e.g. firstname.lastname.

For example:

cf target -o sandbox-gsa -s harry.truman

Deploy a test application

  1. Get code for “hello world” applications (repository):
  2. Move into that directory, for example: cd cf-hello-worlds
  3. Look at the collection of tiny apps, and cd into the directory for the language/framework you feel most comfortable with. For example: cd python-flask
  4. Deploy the application, where APPNAME should be something unique like FRAMEWORK-YOURNAME (e.g. nodejs-aidan). By default, your APPNAME will 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
    
  5. 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 line (urls: [ROUTENAME].app.cloud.gov) to visit your app on the web.

  6. 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 push from. You can set up continuous deployment from a Git repository.

  7. Visit the dashboard (https://dashboard.fr.cloud.gov/) to see your options for managing your application via your browser.

  8. 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 steps

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.