Разработка функций в Functions Framework и их развертывание в Yandex Serverless Containers

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

1. Создайте сервисный аккаунт serverless-containers-sa:

   yc iam service-account create \
     --name serverless-containers-sa
   

   Результат:

   done (1s)
   id: aje7tnmd885t********
   folder_id: b1gt6g8ht345********
   created_at: "2025-02-14T11:09:54.376880905Z"
   name: serverless-containers-sa
   

   Сохраните идентификаторы сервисного аккаунта (значение поля id) и каталога (значение поля folder_id) — они понадобятся на следующем шаге.

   Подробнее о команде yc iam service-account create читайте в справочнике CLI.

2. Назначьте созданному сервисному аккаунту роль container-registry.images.puller на каталог, указав сохраненные на предыдущем шаге идентификаторы каталога и сервисного аккаунта:

   yc resource-manager folder add-access-binding <идентификатор_каталога> \
     --role container-registry.images.puller \
     --subject serviceAccount:<идентификатор_сервисного_аккаунта>
   

   Результат:

   done (2s)
   effective_deltas:
     - action: ADD
       access_binding:
        role_id: container-registry.images.puller
         subject:
           id: aje7tnmd885t********
           type: serviceAccount
   

   Подробнее о команде yc resource-manager folder add-access-binding читайте в справочнике CLI.

Чтобы создать сервисный аккаунт, воспользуйтесь методом REST API create для ресурса ServiceAccount или вызовом gRPC API ServiceAccountService/Create.

Чтобы назначить сервисному аккаунту роль на каталог, воспользуйтесь методом REST API updateAccessBindings для ресурса Folder или вызовом gRPC API FolderService/UpdateAccessBindings.

Создайте реестр functions-framework-registry:

yc container registry create \
  --name functions-framework-registry

Результат:

done (1s)
id: crpfn9p374a3********
folder_id: b1gt6g8ht345********
name: functions-framework-registry
status: ACTIVE
created_at: "2025-02-14T11:44:23.698Z"

Сохраните идентификатор (значение поля id) созданного реестра, он понадобится позднее.

Подробнее о команде yc container registry create читайте в справочнике CLI.

Чтобы создать реестр, воспользуйтесь методом create для ресурса Registry или вызовом gRPC API RegistryService/Create.

Чтобы создать функцию на Python:

1. Установите Python и менеджер пакетов pip:

   sudo apt update && \
   sudo apt install python3 python3-pip -y
   

2. Создайте директорию для нового проекта:

   mkdir my-first-function && \
   cd my-first-function
   

3. Установите фреймворк Functions Framework:

   sudo pip install functions-framework
   

4. Создайте файл main.py с кодом функции, открыв его в текстовом редакторе:

   nano main.py
   

5. Добавьте в файл main.py следующий код:

   import flask
   import functions_framework
   
   @functions_framework.http
   def helloWorld(request: flask.Request) -> flask.typing.ResponseReturnValue:
       return "Hello, World!"
   

6. Локально запустите вашу функцию, чтобы убедиться, что все работает:

   1. Запустите функцию:

      functions-framework --target helloWorld --debug
      

      Результат:

      * Serving Flask app 'hello'
      * Debug mode: on
      WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
      * Running on all addresses (0.0.0.0)
      * Running on http://127.0.0.1:8080
      * Running on http://192.168.1.15:8080
      Press CTRL+C to quit
      * Restarting with watchdog (inotify)
      * Debugger is active!
      * Debugger PIN: 817-187-***
      

   2. Откройте дополнительное окно терминала и в этом окне выполните команду:

      curl http://localhost:8080/
      

      Результат:

      Hello, World!
      

   Таким же способом вы можете запустить функцию в режиме отладки и использовать точки останова с помощью современных IDE.

Чтобы создать функцию на Go:

1. Установите Go версии 1.18 или выше.

2. Создайте директорию для нового проекта:

   mkdir my-first-function && \
   cd my-first-function
   

3. Создайте новый модуль:

   go mod init example.com/helloWorld
   

4. Создайте файл function.go с кодом функции, открыв его в текстовом редакторе:

   nano function.go
   

5. Добавьте в файл function.go следующий код:

   package function
   
   import (
     "fmt"
     "net/http"
   
     "github.com/GoogleCloudPlatform/functions-framework-go/functions"
   )
   
   func init() {
     functions.HTTP("helloWorld", helloWorld)
   }
   
   // helloWorld writes "Hello, World!" to the HTTP response.
   func helloWorld(w http.ResponseWriter, r *http.Request) {
     fmt.Fprintln(w, "Hello, World!")
   }
   

6. Локально запустите вашу функцию, чтобы убедиться, что все работает:

   1. Создайте директорию cmd:

      mkdir cmd
      

   2. В директории cmd создайте файл main.go:

      nano cmd/main.go
      

   3. Добавьте в файл main.go следующий код:

      package main
      
      import (
        "log"
        "os"
      
        // Blank-import the function package so the init() runs
        _ "example.com/helloWorld"
        "github.com/GoogleCloudPlatform/functions-framework-go/funcframework"
      )
      
      func main() {
        // Use PORT environment variable, or default to 8080.
        port := "8080"
        if envPort := os.Getenv("PORT"); envPort != "" {
          port = envPort
        }
        
        // By default, listen on all interfaces. If testing locally, run with 
        // LOCAL_ONLY=true to avoid triggering firewall warnings and 
        // exposing the server outside of your own machine.
        hostname := ""
        if localOnly := os.Getenv("LOCAL_ONLY"); localOnly == "true" {
          hostname = "127.0.0.1"
        } 
        if err := funcframework.StartHostPort(hostname, port); err != nil {
          log.Fatalf("funcframework.StartHostPort: %v\n", err)
        }
      }
      

   4. Обновите зависимости:

      go mod tidy
      

   5. Запустите локальный сервер:

      FUNCTION_TARGET=helloWorld \
      LOCAL_ONLY=true \
      go run cmd/main.go
      

   6. Откройте дополнительное окно терминала и в этом окне выполните команду:

      curl http://localhost:8080/
      

      Результат:

      Hello, World!
      

   Таким же способом вы можете запустить функцию в режиме отладки и использовать точки останова с помощью современных IDE.

1. Создайте контейнер my-first-function:

   yc serverless container create \
     --name my-first-function
   

   Результат:

   done (1s)
   id: bba0tc5nv6j0********
   folder_id: b1gt6g8ht345********
   created_at: "2025-02-14T15:26:04.744Z"
   name: my-first-function
   url: https://bba0tc5nv6j0********.containers.yandexcloud.net/
   status: ACTIVE
   

   Сохраните полученную ссылку для вызова контейнера (значение поля url) — она понадобится при тестировании работы функции в контейнере.

   Подробнее о команде yc serverless container create читайте в справочнике CLI.

2. Создайте ревизию созданного ранее контейнера:

   yc serverless container revision deploy \
     --container-name my-first-function \
     --image "cr.yandex/<идентификатор_реестра>/my-first-function:some-tag" \
     --service-account-id <идентификатор_сервисного_аккаунта> \
     --no-logging
   

   Где:

   • <идентификатор_реестра> — сохраненный ранее идентификатор реестра Container Registry.
   • <идентификатор_сервисного_аккаунта> — сохраненный ранее идентификатор сервисного аккаунта serverless-containers-sa.
   • --no-logging — параметр отключает запись логов в лог-группу. Уберите этот параметр из команды, чтобы записывать логи в журнал выполнения контейнера. Запись и хранение логов тарифицируются.

   Результат:

   done (16s)
   id: bba6f1jllc3t********
   container_id: bbakbil5lg7j********
   created_at: "2025-02-14T20:48:06.424Z"
   image:
     image_url: cr.yandex/crpfn9p374a3********/my-first-function:some-tag
     image_digest: sha256:1b8bac8da5e64dd4359f81d71a7803f212af385f9718a7a4f9a40bca********
   resources:
     memory: "134217728"
     cores: "1"
     core_fraction: "100"
   execution_timeout: 3s
   concurrency: "1"
   service_account_id: aje7tnmd885t********
   status: ACTIVE
   log_options:
     disabled: true
     folder_id: b1gt6g8ht345********
   runtime:
     http: {}
   

   Подробнее о команде yc serverless container revision deploy читайте в справочнике CLI.

Чтобы создать контейнер, воспользуйтесь методом REST API create для ресурса Container или вызовом gRPC API ContainerService/Create.

Чтобы создать ревизию контейнера, воспользуйтесь методом REST API deployRevision для ресурса Container или вызовом gRPC API ContainerService/DeployRevision.