Learn how to use a single command to build and deploya "Hello World" web application from a code sample to Google Cloudusing Cloud Run.

By following the steps in this quickstart, Cloud Run automaticallybuilds a Dockerfile for you when youdeploy from source code.

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Install the Google Cloud CLI.

Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects createPROJECT_ID

  ReplacePROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set projectPROJECT_ID

  ReplacePROJECT_ID with your Google Cloud project name.

If you're using an existing project for this guide,verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

Toinitialize the gcloud CLI, run the following command:

gcloudinit

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects createPROJECT_ID

  ReplacePROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set projectPROJECT_ID

  ReplacePROJECT_ID with your Google Cloud project name.

If you're using an existing project for this guide,verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

1. To set the default project for your Cloud Run service:

   gcloudconfigsetprojectPROJECT_ID

   ReplacePROJECT_ID with your Google Cloud project ID.

2. If you are under a domain restriction organization policyrestricting unauthenticated invocations for your project, you will need to access your deployed service as described underTesting private services.

3. Enable the Cloud Run Admin API and Cloud Build APIs:

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

   gcloudservicesenablerun.googleapis.com cloudbuild.googleapis.com

   After the Cloud Run Admin API is enabled, the Compute Engine default service account is automatically created.

4. ReviewCloud Run pricing or estimate costswith thepricing calculator.

Required roles

To get the permissions that you need to complete this quickstart, ask your administrator to grant you the following IAM roles:

• Cloud Run Source Developer (roles/run.sourceDeveloper) on the project
• Service Account User (roles/iam.serviceAccountUser) on the service identity
• Logs Viewer (roles/logging.viewer) on the project

For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Grant the Cloud Build service account access to your project

Cloud Build automatically uses theCompute Engine defaultservice account as the defaultCloud Build service account to build your source code andCloud Run resource, unless you override this behavior.

For Cloud Build to build your sources, grant the Cloud Build serviceaccount theCloud RunBuilder(roles/run.builder) role on your project:

gcloudprojectsadd-iam-policy-bindingPROJECT_ID\--member=serviceAccount:SERVICE_ACCOUNT_EMAIL_ADDRESS\--role=roles/run.builder

ReplacePROJECT_ID with your Google Cloudproject ID andSERVICE_ACCOUNT_EMAIL_ADDRESS with theemail address of the Cloud Build service account. If you're using theCompute Engine default service account as the Cloud Build service account, thenuse the following format for the service account email address:

PROJECT_NUMBER-compute@developer.gserviceaccount.com

ReplacePROJECT_NUMBER with your Google Cloudproject number.

For detailed instructions on how to find your project ID, and project number,seeCreatingand managing projects.

Granting the Cloud Run builder role takes a couple of minutes topropagate.

Write the sample application

To write a Ruby application:

1. Create a new directory namedhelloworld and change directory intoit:

   mkdirhelloworldcdhelloworld

2. Create a file namedapp.rb and paste the following code into it:

   require"sinatra"set:bind,"0.0.0.0"port=ENV["PORT"]||"8080"set:port,portget"/"doname=ENV["NAME"]||"World""Hello#{name}!"end

   This code creates a basic web server that listens on the port defined bythePORT environment variable.

3. Create a file nameGemfile and copy the following into it:

   source"https://rubygems.org"gem"sinatra","~>3.1"gem"thin"group:testdogem"rack-test"gem"rest-client"gem"rspec"gem"rspec_junit_formatter"gem"rspec-retry"gem"rubysl-securerandom"endgem"puma","~> 6.6"gem"rackup","~> 1.0"

4. If you don't have Bundler 2.0 or greater installed,install Bundler.

5. Generate aGemfile.lock file by running:

   bundle install

6. Create a new file namedDockerfile in the same directory as the sourcefiles:

   # Use the official Ruby image.# https://hub.docker.com/_/rubyFROMruby:3.4# Install production dependencies.WORKDIR/usr/src/appCOPYGemfileGemfile.lock./ENVBUNDLE_FROZEN=trueRUNgeminstallbundler &&bundleconfigset--localwithout'test'# Copy local code to the container image.COPY../RUNbundleinstall# Run the web service on container startup.CMD["ruby","./app.rb"]

7. Add a.dockerignore file to exclude files from your container image.

   DockerfileREADME.md.ruby-version.bundle/vendor/

Your app is finished and ready to be deployed.

Deploy to Cloud Run from source

Deploy from source automatically builds a container image from source codeand deploys it.

To deploy from source:

1. In your source code directory, deploy the current folder using thefollowing command:

   gcloudrundeploy--source.

   1. When you are prompted for the service name, press Enter to accept thedefault name, for examplehelloworld.

   2. If you are prompted to enable additional APIs on the project,for example, the Artifact Registry API, respond by pressingy.

   3. When you are prompted for region: select theregionof your choice, for exampleeurope-west1.

   4. If you are prompted to create a repository in the specified region, respond by pressingy.

   5. If you are prompted toallow public access:respondy. You might not see this prompt if there is a domainrestriction organization policy that prevents it; for more details see theBefore you begin section.

   Then wait a few moments until the deployment is complete. On success, thecommand line displays the service URL.

2. Visit your deployed service by opening the service URL in a web browser.

Clean up

To avoid additional charges to your Google Cloud account, delete all the resourcesyou deployed with this quickstart.

Delete your repository

Cloud Run doesn't charge you when your deployed service isn't in use.However, you might still becharged for storing the container image inArtifact Registry. To delete Artifact Registry repositories,follow the steps inDeleterepositories in the Artifact Registrydocumentation.

Delete your service

Cloud Run services don't incur costs until they receive requests.To delete your Cloud Run service, follow one of these steps:

gcloud run services deleteSERVICE --regionREGION

Delete your test project

Deleting your Google Cloud project stops billing for all resources in thatproject. To release all Google Cloud resources in your project, follow these steps:

Caution: Deleting a project has the following effects:
• Everything in the project is deleted. If you used an existing project for the tasks in this document, when you delete it, you also delete any other work you've done in the project.
• Custom project IDs are lost. When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as anappspot.com URL, delete selected resources inside the project instead of deleting the whole project.

Delete a Google Cloud project:

gcloud projects deletePROJECT_ID

What's next

For more information on building a container from code source and pushing toa repository, see:

• Developing Cloud Run services
• Building Containers
• Test a Cloud Run service locally
• Deploying from source code