gcloud-help/gcloud/run/services/proxy

NAME
    gcloud run services proxy - proxy a service to localhost authenticating as
        the active account or with the specified token

SYNOPSIS
    gcloud run services proxy (SERVICE : --namespace=NAMESPACE)
        [--platform=PLATFORM; default="managed"] [--port=PORT] [--tag=TAG]
        [--token=TOKEN]
        [--region=REGION
          | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION
          | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Runs a server on localhost that proxies requests to the specified Cloud Run
    Service with credentials attached.

    You can use this to test services protected with IAM authentication.

    The Cloud Run service must be reachable from the machine running this
    command. For example, if the Cloud Run Service is configured to only allow
    internal ingress, this command will not work from outside the service's VPC
    network.

EXAMPLES
    To proxy the service 'my-service' at localhost port 8080:

        $ gcloud run services proxy my-service --port=8080

    To proxy the existing traffic tag 'my-tag' on the service 'my-service:

        $ gcloud run services proxy my-service --tag=my-tag

POSITIONAL ARGUMENTS
     Service resource - Service to proxy locally. The arguments in this group
     can be used to specify the attributes of this resource.

     This must be specified.

       SERVICE
          ID of the service or fully qualified identifier for the service.

          To set the service attribute:
          ▸ provide the argument SERVICE on the command line.

          This positional argument must be specified if any of the other
          arguments in this group are specified.

       --namespace=NAMESPACE
          Specific to Cloud Run for Anthos: Kubernetes namespace for the
          service.

          To set the namespace attribute:
          ▸ provide the argument SERVICE on the command line with a fully
            specified name;
          ▸ provide the argument --namespace on the command line;
          ▸ set the property run/namespace;
          ▸ For Cloud Run on Kubernetes Engine, defaults to "default".
            Otherwise, defaults to project ID.;
          ▸ provide the argument project on the command line;
          ▸ set the property core/project.

FLAGS
     --platform=PLATFORM; default="managed"
        Target platform for running commands. Alternatively, set the property
        [run/platform]. PLATFORM must be one of:

         managed
            Fully managed version of Cloud Run. Use with the --region flag or
            set the [run/region] property to specify a Cloud Run region.
         gke
            Cloud Run for Anthos on Google Cloud. Use with the --cluster and
            --cluster-location flags or set the [run/cluster] and
            [run/cluster_location] properties to specify a cluster in a given
            zone.
         kubernetes
            Use a Knative-compatible kubernetes cluster. Use with the
            --kubeconfig and --context flags to specify a kubeconfig file and
            the context for connecting.

     --port=PORT
        Local port number to expose the proxied service. If not specified, it
        will be set to 8080.

     --tag=TAG
        Traffic tag of the service to expose via the proxy. If not specified,
        the default service URL will be proxied which may serve different
        revisions based on traffic-splits. Custom tags can be used to proxy
        specific revisions. Please see
        https://cloud.google.com/run/docs/rollouts-rollbacks-traffic-migration#tags.

     --token=TOKEN
        The specific identity token to add to all requests of the proxied
        service. If not specified, the identity token of the currently active
        authenticated account will be used (e.g. gcloud auth
        print-identity-token).

     Arguments to locate resources, depending on the platform used.

     At most one of these can be specified:

       Only applicable if connecting to Cloud Run (fully managed). Specify
       --platform=managed to use:

         --region=REGION
            Region in which the resource can be found. Alternatively, set the
            property [run/region].

       Only applicable if connecting to Cloud Run for Anthos deployed on Google
       Cloud. Specify --platform=gke to use:

         Cluster resource - Kubernetes Engine cluster to connect to. The
         arguments in this group can be used to specify the attributes of this
         resource. (NOTE) Some attributes are not given arguments in this group
         but can be set in other ways.

         To set the project attribute:
          ▫ provide the argument --cluster on the command line with a fully
            specified name;
          ▫ set the property run/cluster with a fully specified name;
          ▫ specify the cluster from a list of available clusters with a
            fully specified name;
          ▫ provide the argument --project on the command line;
          ▫ set the property core/project.

           --cluster=CLUSTER
              ID of the cluster or fully qualified identifier for the cluster.

              To set the cluster attribute:
              ◇ provide the argument --cluster on the command line;
              ◇ set the property run/cluster;
              ◇ specify the cluster from a list of available clusters.

           --cluster-location=CLUSTER_LOCATION
              Zone in which the cluster is located. Alternatively, set the
              property [run/cluster_location].

              To set the location attribute:
              ◇ provide the argument --cluster on the command line with a
                fully specified name;
              ◇ set the property run/cluster with a fully specified name;
              ◇ specify the cluster from a list of available clusters with a
                fully specified name;
              ◇ provide the argument --cluster-location on the command line;
              ◇ set the property run/cluster_location;
              ◇ specify the cluster location from a list of available zones.

       Only applicable if connecting to Cloud Run for Anthos deployed on
       VMware. Specify --platform=kubernetes to use:

         --context=CONTEXT
            The name of the context in your kubectl config file to use for
            connecting.

         --kubeconfig=KUBECONFIG
            The absolute path to your kubectl config file. If not specified,
            the colon- or semicolon-delimited list of paths specified by
            $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to
            ~/.kube/config.

GCLOUD WIDE FLAGS
    These flags are available to all commands: --access-token-file, --account,
    --billing-project, --configuration, --flags-file, --flatten, --format,
    --help, --impersonate-service-account, --log-http, --project, --quiet,
    --trace-token, --user-output-enabled, --verbosity.

    Run $ gcloud help for details.

NOTES
    These variants are also available:

        $ gcloud alpha run services proxy

        $ gcloud beta run services proxy