Creare una funzione con i buildpack

Questa guida mostra come utilizzare i buildpack con il codice sorgente della funzione per creare un'immagine container. Ad esempio, utilizza i buildpack per creare una funzione Cloud Run di cui vuoi eseguire il deployment su Cloud Run.

Esistono due metodi per creare immagini container con i buildpack:

• Crea localmente con l'interfaccia a riga di comando pack per testare la funzione localmente e prototipare rapidamente le modifiche prima del deployment.
• Crea build in remoto con Cloud Build. La creazione con Cloud Build è utile per le funzioni che hanno processi di build a elevato consumo di risorse e può anche contribuire a proteggere la catena di fornitura del software.

Configura il progetto per creare funzioni

Per creare funzioni con i buildpack:

• Includi la libreria Functions Framework.

• Imposta la variabile di ambiente GOOGLE_FUNCTION_TARGET sul nome della funzione che utilizzi come punto di ingresso. Per farlo, includi un file project.toml nella stessa cartella del codice sorgente. Il file project.toml deve avere la seguente configurazione:

[[build.env]]
    name = "GOOGLE_FUNCTION_TARGET"
    value =  "ENTRY_POINT"

Sostituisci ENTRY_POINT con il metodo della funzione.

Per informazioni dettagliate su come utilizzare le variabili di ambiente con Cloud Run Functions, consulta Configurare i servizi Cloud Run Functions.

Build locali

Pack è uno strumento CLI gestito dal progetto CNB per supportare l'utilizzo dei buildpack. Utilizza l'interfaccia a riga di comando pack per creare localmente le tue funzioni in un'immagine container.

Prima di iniziare

1. Installa Docker Community Edition (CE) sulla tua workstation. Docker viene utilizzato da pack come generatore di immagini OCI.
2. Installa Pack CLI.
3. Installa lo strumento di controllo del codice sorgente Git per recuperare l'applicazione di esempio da GitHub.

Crea una funzione in locale

Utilizza il comando pack build e specifica il builder predefinito --builder=gcr.io/buildpacks/builder per creare le immagini container in locale.

pack build --builder=gcr.io/buildpacks/builder IMAGE_NAME

Sostituisci IMAGE_NAME con il nome dell'immagine container.

Puoi anche personalizzare l'immagine container estendendo le immagini di build ed esecuzione.

Crea una funzione di esempio localmente

Gli esempi riportati di seguito mostrano come creare un campione in locale.

1. Clona il repository di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

2. Passa alla directory che contiene il codice campione dell'applicazione:

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. Utilizza pack per creare la funzione di esempio:

   Go

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-go

   Java

   pack build --builder gcr.io/buildpacks/builder:v1 sample-functions-java-mvn

   Node.js

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-node

   Python

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-python

   Ruby

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-ruby

4. Esegui l'immagine utilizzando docker:

   Go

   docker run -p8080:8080 sample-functions-framework-go

   Java

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-java-mvn

   Node.js

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-node

   Python

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-python

   Ruby

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-ruby

5. Visita la funzione in esecuzione andando alla pagina localhost:8080.

Build remoti

Utilizza Cloud Build per creare la funzione in un'immagine container e Artifact Registry come repository di container per archiviare ed eseguire il deployment di ogni immagine.

Prima di iniziare

Accedi al tuo account Google Cloud . Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.

In the Google Cloud console, on the project selector page, select or create 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 the resourcemanager.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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs.

Roles required to enable APIs

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

Enable the APIs

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

In the Google Cloud console, on the project selector page, select or create 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 the resourcemanager.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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs.

Roles required to enable APIs

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

Enable the APIs

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

Se hai già installato Google Cloud CLI, assicurati di avere l'ultima versione disponibile eseguendo gcloud components update.

1. Assicurati che il tuo progetto Google Cloud abbia accesso a un repository di immagini container.

   Per configurare l'accesso a un repository Docker in Artifact Registry:

   1. Crea un nuovo repository Docker nella stessa posizione del tuo progetto Google Cloud .

      gcloud artifacts repositories create REPO_NAME \
      --repository-format=docker \
      --location=REGION --description="DESCRIPTION"

      Sostituisci:
      • REPO_NAME con il nome che scegli per il repository Docker.
      • REGION con la posizione all'interno o più vicina alla posizione del tuo progetto Google Cloud .
      • DESCRIPTION con una descrizione a tua scelta.

      Ad esempio, per creare un repository docker in us-west2 con la descrizione "Docker repository", esegui:

      gcloud artifacts repositories create buildpacks-docker-repo --repository-format=docker \
      --location=us-west2 --description="Docker repository"

   2. Verifica che il repository sia stato creato:

      gcloud artifacts repositories list

      Dovresti vedere il nome che hai scelto per il repository Docker nell'elenco.

Creare una funzione da remoto

Utilizzi il comando gcloud builds submit per creare e caricare l'immagine container nel repository.

Puoi scegliere di specificare l'immagine container nel comando stesso o utilizzare un file di configurazione.

Crea con il comando

Per eseguire la build senza un file di configurazione, specifica il flag image:

gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

Sostituisci:

• LOCATION con il nome della regione del repository del container, ad esempio us-west2
• PROJECT_ID: l'ID del tuo progetto Google Cloud .
• REPO_NAME con il nome del tuo repository Docker.
• IMAGE_NAME con il nome dell'immagine container.

Esempio:

gcloud builds submit --pack image=us-west2-docker.pkg.dev/my-project-id/my-buildpacks-docker-repo

Compilare con i file di configurazione

Puoi utilizzare un file di configurazione per definire i dettagli di configurazione del repository di immagini. Il file di configurazione utilizza il formato del file YAML e deve includere un passaggio di build che utilizza la CLI pack.

1. Crea un nome file YAML cloudbuild.yaml che includa l'URI del repository di immagini container.

    options:
      logging: CLOUD_LOGGING_ONLY
      pool: {}
    projectId: PROJECT_ID
    steps:
    - name: gcr.io/k8s-skaffold/pack
      entrypoint: pack
      args:
      - build
      - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
      - --builder
      - gcr.io/buildpacks/builder:latest
      - --network
      - cloudbuild
      - --publish
    - name: gcr.io/cloud-builders/docker
      entrypoint: pack
      args:
      - pull
      - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
    images:
    - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
   

   Sostituisci:

   • LOCATION con il nome della regione del repository di container, ad esempio us-west2.
   • PROJECT_ID: l'ID del tuo progetto Google Cloud .
   • REPO_NAME con il nome del tuo repository Docker.
   • IMAGE_NAME con il nome dell'immagine container.

2. Crea l'applicazione.

   Se hai chiamato il file di configurazione cloudbuild.yaml, esegui il comando seguente:

   gcloud builds submit .
   

   Suggerimento: se utilizzi un nome univoco per il file di configurazione, utilizza il flag --config.

Esempio: crea una funzione di esempio in remoto

Gli esempi seguenti mostrano come creare un campione in remoto e verificare che l'immagine container sia stata inviata al repository in Artifact Registry.

1. Clona il repository di esempio sulla tua macchina locale:

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

2. Passa alla directory che contiene il codice campione dell'applicazione:

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. Utilizza gcloud per inviare il codice sorgente dell'applicazione a Cloud Build:

   Go

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-go

   Java

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-gradle

   Node.js

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-node

   Python

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-python

   Ruby

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-ruby

   Sostituisci:

   • LOCATION con il nome della regione del repository del container. Esempio: us-west2-docker.pkg.dev
   • PROJECT_ID: l'ID del tuo progetto Google Cloud .
   • REPO_NAME con il nome del tuo repository Docker.

4. Verifica che la funzione di esempio sia stata pubblicata correttamente in REPO_NAME:

   gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME

   Sostituisci:

   • LOCATION con il nome della regione del repository di container, ad esempio us-west2.
   • PROJECT_ID: l'ID del tuo progetto Google Cloud .
   • REPO_NAME con il nome del tuo repository Docker.

Passaggi successivi

• Esegui il deployment dell'immagine della funzione in Cloud Run.
• Imposta le variabili di ambiente.
• Configurare le immagini di build.
• Velocizza le build con le immagini della cache.