Creare una funzione con i buildpack

Esistono due metodi per creare immagini container con i buildpack:

• Crea localmente con l'interfaccia a riga di comando pack per testare localmente la funzione e prototipare rapidamente le modifiche prima del deployment.
• Crea build da 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 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 strumento di creazione 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.

Creare 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:

   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. Visita la funzione in esecuzione andando alla pagina localhost:8080.

Build remoti

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

Prima di iniziare

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.

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

Go to project selector

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

Enable the Cloud Build and Artifact Registry APIs.

Enable the APIs

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

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

Enable the Cloud Build and Artifact Registry APIs.

Enable the APIs

Install the Google Cloud CLI.

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

To initialize the gcloud CLI, run the following command:

gcloud init

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 progetto Google Cloud .

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

      Replace:
      • 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 "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

      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 del 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 container, ad esempio us-west2
• PROJECT_ID con 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 per semplificare il comando di build. Il file di configurazione utilizza il formato del file YAML e deve includere un passaggio di compilazione che utilizza la CLI pack.

1. Crea un nome file YAML cloudbuild.yaml che includa l'URI del repository dell'immagine 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 di container, ad esempio us-west2.
• PROJECT_ID con l'ID del tuo progetto Google Cloud .
• 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 .
   

Esempio: crea una funzione di esempio in remoto

Gli esempi riportati di seguito 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:

   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 repository del container. Esempio: us-west2-docker.pkg.dev
   • PROJECT_ID con 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 con 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.
• Configura le immagini di build.
• Velocizza le build con le immagini della cache.