Managing Services

This page describes creating a service and viewing information about a service. Services are the main resources of Cloud Run. Each service has a unique and permanent URL that will not change over time as you deploy new revisions to it.

For Cloud Run (fully managed), the service's permanent domain consists of the service name and a hash.

Creating a service

You create a new service by deploying a container image to it for the first time. Deploying a new service has more instructions.

Viewing the list of services in your project

You can view a list of the available services in your project using Cloud Console or the gcloud command line:

Console

To view the services list:

  1. Go to Cloud Run

  2. Examine the displayed list of services for your project:

    services list

Command line

To list the services in your project:

gcloud run services list

Note that each service has an associated URL.

You can filter this list by properties of the service definition, such as an assigned label.

Cloud Code

To view the services list with Cloud Code, read the Cloud Run Explorer guides for IntelliJ and Visual Studio Code.

Copying a service

You can make a copy of an existing service using Cloud Console or YAML. You can change anything you want in the copy, including name and region.

Console

To copy a service:

  1. Go to Cloud Run

  2. Select the service to copy from the displayed list of services for your project:

    services list

    1. Click Copy.

    2. In the service copy page, set or change any values you want to change, such as region, etc. If you are keeping the same region, you must provide a new name for the service.

    3. Click Create to make a copy and deploy it using the new service name.

YAML

You can download and view existing service configuration using the gcloud run services describe --format export command, which yields cleaned results in YAML format. You can then modify the fields described below and upload the modified YAML using the gcloud beta run services replace command. Make sure you only modify fields as documented.

  1. To view and download the configuration:

    gcloud run services describe SERVICE --format export > service.yaml
  2. Make any desired configuration changes to the service as described in the various configuration pages.

     apiVersion: serving.knative.dev/v1
     kind: Service
     metadata:
       annotations:
         ...
       name: SERVICE
       ...
     spec:
       template:
         metadata:
           annotations:
           ...
           name: REVISION-NAME
    
    • If you are not deploying the copy to a different region, replace SERVICE with the name you want to use for the copy. If you are deploying the copy to a different region, you can use the old name.
    • Make sure the value for REVISION-NAME starts with the service name (SERVICE). For example, if the new service name is mynewfoo, then the revision name must be in the format mynewfoo-whatever. Optionally delete the value altogether and a new revision name is created automatically.
  3. Copy the service using the following command:

    gcloud beta run services replace service.yaml

    Use the --region flag to deploy the copy to a different region.

Viewing more details about a service

To see more details about a service,

Console

To view a service's details:

  1. Go to Cloud Run

  2. Click on the desired service in the displayed list of services for your project to open the service details view:

    revision list

  3. Note the REVISIONS, LOGS and DETAILS tabs. The revisions tab shows the list of revisions, the logs tab shows the service logs, and the details tab shows the current authentication or connectivity settings.

Command line

To view details about a service:

gcloud run services describe SERVICE
Replace SERVICE with the name of the service.

You can use the --format flag to format the output. For example as YAML:

gcloud run services describe SERVICE --format yaml

You can use --format export to export as YAML without automatically generated labels or status:

gcloud run services describe SERVICE --format export

You can also use the --format flag to get the URL of the service:

gcloud run services describe SERVICE --format='value(status.url)'

Cloud Code

To view a services details with Cloud Code, read the Cloud Run Explorer guides for IntelliJ and Visual Studio Code.

For more details on service revisions, see Managing Revisions.

Changing Cloud Run for Anthos service connectivity settings

A Cloud Run for Anthos service can have either of two connection options:

  • external, which allows external access to your service
  • internal which restricts access only to other Cloud Run for Anthos services or services in your cluster that use istio.

You can use the console or the gcloud command line to change the settings.

Console

To change service connectivity settings:

  1. Go to Cloud Run

  2. Click on the desired service in the displayed list of services for your project to open the service details view.

  3. Click the DETAILS tab:

    Details tab

  4. In the Connectivity line, click the edit icon next to the current setting.

  5. Select the desired setting and click Save.

Command line

To change service connectivity settings, update the service with the desired connectivity setting:

gcloud run services update [SERVICE] --connectivity=[OPTION]
  • Replace [SERVICE] with the name of the service you are updating. You can omit this parameter entirely, but you will be prompted for the service name if you omit it.
  • Replace [OPTION] with internal or external.

Disabling an existing service

Cloud Run (fully managed) does not offer a direct way to make a service stop serving traffic, but you can achieve a similar result by revoking the permission to invoke the service to identities that are invoking the service. Notably, if your service is "public", remove allUsers from the Cloud Run Invoker role (roles/run.invoker).

Deleting existing services

Deleting a service deletes all resources related to this service, including all revisions of this service whether they are serving traffic or not.

When deleting a service, the container images used by the deleted revisions are not deleted automatically from Container Registry. To delete container images from Container Registry see Deleting images.

Note that deleting a service is permanent: there is no undo or restore. However, if after deleting a service, you deploy a new service with the same name in the same region, it will have the same endpoint URL.

Console

To delete a service:

  1. Go to Cloud Run

  2. Locate the service you want to delete in the services list, and click its checkbox to select it.

  3. Click DELETE. This deletes all revisions of the service.

Command line

To delete a service, use the command:

gcloud run services delete [SERVICE]

Replace [SERVICE] with the name of your service.