Panduan memulai: Men-deploy fungsi ke Cloud Run menggunakan gcloud CLI

Halaman ini menunjukkan cara menggunakan Cloud Run untuk men-deploy fungsi HTTP menggunakan gcloud CLI.

Sebelum memulai

  1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

  2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  4. Aktifkan API Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging .

    Mengaktifkan API

  5. Menginstal Google Cloud CLI.

  6. Untuk initialize gcloud CLI, jalankan perintah berikut: 

    gcloud init

  7. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  8. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  9. Aktifkan API Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging .

    Mengaktifkan API

  10. Menginstal Google Cloud CLI.

  11. Untuk initialize gcloud CLI, jalankan perintah berikut: 

    gcloud init
  12. Guna menetapkan project default untuk layanan Cloud Run Anda: 
     gcloud config set project PROJECT_ID
     Ganti PROJECT_ID dengan nama project yang Anda buat untuk panduan memulai ini.

  13. Jika Anda dikenai kebijakan organisasi pembatasan domain yang membatasi pemanggilan yang tidak diautentikasi untuk project, Anda perlu mengakses layanan yang di-deploy seperti yang dijelaskan di bagian Menguji layanan pribadi.

  14. Agar Cloud Build dapat membangun sumber Anda, berikan izin Akun Layanan Cloud Build ke akun layanan default Compute Engine dengan menjalankan perintah berikut:

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@ \
    --role=roles/cloudbuild.builds.builder

    Ganti PROJECT_NUMBER dengan Google Cloud Anda nomor project, dan PROJECT_ID dengan data Google Cloud project ID Anda.

    Anda dapat menemukan nomor project dan ID project Anda di Selamat datang halaman Konsol Google Cloud.

Menuliskan fungsi contoh

Untuk menulis aplikasi, ikuti langkah-langkah berikut:

Node.js

  1. Buat sebuah direktori baru bernama helloworld dan ubah ke direktori tersebut:

       mkdir helloworld
   cd helloworld

  2. Buat file package.json di direktori helloworld untuk menentukan Dependensi Node.js:

    {
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "scripts": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^10.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

  3. Buat file index.js dalam direktori helloworld dengan perintah berikut Contoh Node.js:

    const functions = require('@google-cloud/functions-framework');

// Register an HTTP function with the Functions Framework that will be executed
// when you make an HTTP request to the deployed function's endpoint.
functions.http('helloGET', (req, res) => {
  res.send('Hello World!');
});

Python

  1. Buat sebuah direktori baru bernama helloworld dan ubah ke direktori tersebut:

       mkdir helloworld
   cd helloworld

  2. Buat file requirements.txt di direktori helloworld, untuk menentukan Dependensi Python:

    functions-framework==3.5.0
flask==3.0.3
google-cloud-error-reporting==1.9.1
MarkupSafe==2.1.3

    Langkah ini akan menambahkan paket yang dibutuhkan oleh contoh.

  3. Buat file main.py dalam direktori helloworld dengan perintah berikut Contoh Python:

    import functions_framework

@functions_framework.http
def hello_get(request):
    """HTTP Cloud Function.
    Args:
        request (flask.Request): The request object.
        <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
    Returns:
        The response text, or any set of values that can be turned into a
        Response object using `make_response`
        <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
    Note:
        For more information on how Flask integrates with Cloud
        Functions, see the `Writing HTTP functions` page.
        <https://cloud.google.com/functions/docs/writing/http#http_frameworks>
    """
    return "Hello World!"

Go

  1. Buat sebuah direktori baru bernama helloworld dan ubah ke direktori tersebut:

       mkdir helloworld
   cd helloworld

  2. Buat file go.mod untuk mendeklarasikan modul go:

    module github.com/GoogleCloudPlatform/golang-samples/functions/helloworld

go 1.21

require github.com/GoogleCloudPlatform/functions-framework-go v1.8.1

require (
	github.com/cloudevents/sdk-go/v2 v2.15.2 // indirect
	github.com/google/go-cmp v0.6.0 // indirect
	github.com/google/uuid v1.6.0 // indirect
	github.com/json-iterator/go v1.1.12 // indirect
	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
	github.com/modern-go/reflect2 v1.0.2 // indirect
	go.uber.org/multierr v1.11.0 // indirect
	go.uber.org/zap v1.27.0 // indirect
	golang.org/x/time v0.5.0 // indirect
)

    Anda dapat membuat file go.mod secara langsung dalam format seperti yang ditunjukkan, atau Anda dapat menginisialisasinya dari direktori project dengan:

       go mod init github.com/GoogleCloudPlatform/golang-samples/functions/functionsv2/helloworld/go.mod

  3. Buat file hello_http.go dalam direktori helloworld dengan contoh kode Go berikut:

    
// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"fmt"
	"net/http"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)

func init() {
	functions.HTTP("HelloGet", helloGet)
}

// helloGet is an HTTP Cloud Function.
func helloGet(w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "Hello, World!")
}

Java

  1. Buat sebuah direktori baru bernama helloworld dan ubah ke direktori tersebut:

       mkdir helloworld
   cd helloworld

  2. Buat struktur project berikut untuk memuat direktori sumber dan file sumber:

    mkdir -p ~/helloworld/src/main/java/functions
touch ~/helloworld/src/main/java/functions/HelloWorld.java

  3. Update file HelloWorld.java dengan contoh kode Java berikut:

    
package functions;

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class HelloWorld implements HttpFunction {
  // Simple function to return "Hello World"
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    writer.write("Hello World!");
  }
}

  4. Buat file pom.xml dalam direktori helloworld, lalu tambahkan berikut ini Dependensi Java:

    <?xml version="1.0" encoding="UTF-8"?>

<!--
  Copyright 2020 Google LLC

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>

  <parent>
    <groupId>com.google.cloud.samples</groupId>
    <artifactId>shared-configuration</artifactId>
    <version>1.2.0</version>
  </parent>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <artifactId>libraries-bom</artifactId>
        <groupId>com.google.cloud</groupId>
        <scope>import</scope>
        <type>pom</type>
        <version>26.32.0</version>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- The following dependencies are only required for testing -->
    <dependency>
      <groupId>com.google.truth</groupId>
      <artifactId>truth</artifactId>
      <version>1.4.0</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava-testlib</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-core</artifactId>
      <version>5.10.0</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <!-- version 3.0.0-M4 does not load JUnit5 correctly -->
        <!-- see https://issues.apache.org/jira/browse/SUREFIRE-1750 -->
        <version>3.2.5</version>
        <configuration>
          <includes>
            <include>**/*Test.java</include>
          </includes>
          <skipTests>${skipTests}</skipTests>
          <reportNameSuffix>sponge_log</reportNameSuffix>
          <trimStackTrace>false</trimStackTrace>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

.NET

  1. Instal .NET SDK 6.0. Panduan memulai ini hanya berfungsi untuk .NET versi 6.

  2. Dari konsol, buat project web kosong baru menggunakan perintah dotnet.

    dotnet new web -o helloworld-csharp

  3. Ubah direktori menjadi helloworld-csharp:

  4. Ganti kode contoh di file project helloworld-csharp.csproj dengan yang berikut:

    <Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.2.1" />
  </ItemGroup>
</Project>

  5. Ganti kode contoh di file Program.cs dengan kode berikut:

    
using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace HelloWorld;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
        await context.Response.WriteAsync("Hello World!", context.RequestAborted);
    }
}

Men-deploy cloud function

Penting: Panduan memulai ini mengasumsikan bahwa Anda memiliki peran pemilik atau editor dalam project yang Anda gunakan untuk panduan memulai tersebut. Jika tidak, lihat peran Cloud Run Source Developer guna mendapatkan izin yang diperlukan untuk men-deploy resource Cloud Run dari sumber.

Untuk men-deploy fungsi Cloud Run, ikuti langkah-langkah berikut:

  1. Deploy fungsi dengan menjalankan perintah berikut di direktori yang berisi kode contoh:

    Node.js 

    gcloud beta run deploy nodejs-http-function \
      --source . \
      --function helloGET \
      --base-image nodejs20 \
      --region REGION \
      --allow-unauthenticated

    Ganti REGION dengan Google Cloud region layanan tempat Anda ingin men-deploy fungsi tersebut. Misalnya, us-central1.

    Python

    gcloud beta run deploy python-http-function \
      --source . \
      --function hello_get \
      --base-image python312 \
      --region REGION \
      --allow-unauthenticated

    Ganti REGION dengan Google Cloud region layanan tempat Anda ingin men-deploy fungsi tersebut. Misalnya, us-central1.

    Go 

    gcloud beta run deploy go-http-function \
       --source . \
       --function HelloGet \
       --base-image go122 \
       --region REGION \
       --allow-unauthenticated

    Ganti REGION dengan Google Cloud region layanan tempat Anda ingin men-deploy fungsi tersebut. Misalnya, us-central1.

    Java

    Jalankan perintah berikut di direktori yang berisi file pom.xml:

    gcloud beta run deploy java-http-function \
       --source . \
       --function functions.HelloWorld \
       --base-image java21 \
       --region REGION \
       --allow-unauthenticated

    Ganti REGION dengan Google Cloud region layanan tempat Anda ingin men-deploy fungsi tersebut. Misalnya, us-central1.

    .NET 

    gcloud beta run deploy csharp-http-function \
      --source . \
      --function HelloWorld.Function \
      --base-image dotnet6 \
      --region REGION \
      --allow-unauthenticated

    Ganti REGION dengan Google Cloud region layanan tempat Anda ingin men-deploy fungsi tersebut. Misalnya, us-central1.

  2. Setelah deployment selesai, Google Cloud CLI akan menampilkan URL tempat layanan berjalan. Buka URL di browser Anda untuk melihat {i>output<i} dari fungsi Anda.

Untuk mempelajari cara menambahkan pemicu Eventarc ke fungsi Anda, lihat Panduan Deploy fungsi untuk mendapatkan petunjuk.

Pembersihan

Meskipun Cloud Run tidak mengenakan biaya saat layanannya tidak digunakan, Anda mungkin tetap dikenai biaya atas penyimpanan image container di Artifact Registry. Anda dapat menghapus image container atau menghapus project Google Cloud untuk menghindari tagihan. Menghapus project Google Cloud Anda akan menghentikan penagihan untuk semua resource yang digunakan dalam project tersebut.

  1. Di konsol Google Cloud, buka halaman Manage resource.

    Buka Manage resource

  2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Delete.
  3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Langkah selanjutnya