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 compilare una funzione Cloud Run che vuoi eseguire su Cloud Run.

Esistono due metodi per creare immagini container con i buildpack:

• Esegui la build localmente con l'interfaccia a riga di comando pack per testare localmente la funzione e creare rapidamente un prototipo delle modifiche prima del deployment.
• Esegui la compilazione in remoto con Cloud Build. La compilazione con Cloud Build è utile per le funzioni con processi di compilazione che richiedono molte risorse e può anche contribuire a proteggere la catena di approvvigionamento del software.

Configurare il progetto per compilare le 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. A tale scopo, includi un project.toml nella stessa cartella del codice sorgente. Il file project.toml debe 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 le funzioni Cloud Run, 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 compilare in locale le 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.

Compilare una funzione in locale

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

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

Sostituisci IMAGE_NAME con il nome dell'immagine del contenitore.

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

Creare una funzione di esempio localmente

Gli esempi riportati di seguito mostrano come compilare un sample localmente.

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:

   Vai

   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:

   Vai

   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:

   Vai

   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. Vai alla funzione in esecuzione visitando localhost:8080.

Build remote

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

Prima di iniziare

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build and Artifact Registry APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

7. To initialize the gcloud CLI, run the following command:

   gcloud init

8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

9. Make sure that billing is enabled for your Google Cloud project.

10. Enable the Cloud Build and Artifact Registry APIs.

    Enable the APIs

11. Install the Google Cloud CLI.

12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

13. To initialize the gcloud CLI, run the following command:

    gcloud init

Se hai già installato Google Cloud CLI in precedenza, assicurati di avere la versione più recente disponibile eseguendo gcloud components update.

14. Assicurati che il tuo Google Cloud progetto 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 Google Cloud progetto.

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

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

       Ad esempio, per creare un repository docker in us-west2 con la descrizione "Repository Docker", 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

       Nell'elenco dovresti vedere il nome scelto per il tuo repository Docker.

Creare una funzione da remoto

Utilizza il comando gcloud builds submit per compilare e caricare l'immagine del contenitore nel repository.

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

Crea con il comando

Per eseguire la compilazione 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 dei container, ad esempio us-west2
• PROJECT_ID con l'ID del tuo Google Cloud progetto.
• 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

Eseguire la compilazione con i file di configurazione

Puoi utilizzare un file di configurazione per definire i dettagli di configurazione del repository di immagini per semplificare il comando di compilazione. Il file di configurazione utilizza il formato del file YAML e deve includere un passaggio di compilazione che utilizza l'interfaccia a riga di comando pack.

1. Crea un nome file YAML cloudbuild.yaml che includa l'URI del repository delle 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
  images:
  - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

Sostituisci:

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

1. Crea l'applicazione.

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

   gcloud builds submit .
   

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

Esempio: crea una funzione di esempio in remoto

Gli esempi riportati di seguito mostrano come compilare un esempio da remoto e verificare che l'immagine container sia stata trasferita al tuo 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:

   Vai

   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:

   Vai

   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 tuo repository di contenitori. Esempio: us-west2-docker.pkg.dev
   • PROJECT_ID con l'ID del tuo Google Cloud progetto.
   • 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 dei contenitori, ad esempio us-west2.
   • PROJECT_ID con l'ID del tuo Google Cloud progetto.
   • 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.
• Configura le immagini di compilazione.
• Velocizza le build con le immagini in cache.