Specificare le dipendenze in Ruby

Le funzioni Cloud Run scritte in Ruby utilizzano Bundler per accedere alle dipendenze. Le dipendenze possono essere scaricate durante il deployment della funzione o impacchettate localmente insieme alla funzione.

Ogni funzione deve fornire un Gemfile che specifica il functions_framework gem, insieme a eventuali gem aggiuntivi necessari per la funzione. Gemfile deve trovarsi nella stessa directory del file app.rb contenente il codice della funzione. Inoltre, la funzione deve fornire un file di blocco che specifichi tutte le dipendenze trascendenti e le relative versioni esatte. Questo file, Gemfile.lock, si trova anche nella stessa directory insieme a Gemfile.

Quando esegui il deployment della funzione, Cloud Run scarica e installa le dipendenze dichiarate in Gemfile e Gemfile.lock utilizzando bundler.

Gemfile elenca i pacchetti richiesti dalla funzione, insieme a eventuali vincoli di versione facoltativi. Per ulteriori dettagli, consulta il riferimento Gemfile.

Di seguito è riportato un esempio di Gemfile:

source "https://rubygems.org"

gem "functions_framework", "~> 0.7"
gem "google-cloud-storage", "~> 1.29"

Esegui il seguente comando per installare il gem functions_framework e altre dipendenze:

bundle install

Il file Gemfile.lock viene generato da Bundler quando analizza le dipendenze e blocca le versioni esatte di ogni gem da installare. In questo modo, ad esempio, la funzione viene dispiattata con le stesse versioni delle dipendenze di quelle utilizzate nei test locali. Il formato esatto di Gemfile.lock è privato del bundler e non è destinato a essere modificato manualmente.

Se hai già utilizzato il bundler per installare le dipendenze ed eseguire i test localmente, probabilmente hai già un file Gemfile.lock. In caso contrario, puoi generarne uno eseguendo:

bundle lock

Functions Framework è una dipendenza obbligatoria per tutte le funzioni. Sebbene le funzioni Cloud Run lo installino per tuo conto al momento della creazione della funzione, ti consigliamo di includerlo come dipendenza esplicita per maggiore chiarezza.

Se la funzione si basa su dipendenze private, ti consigliamo di eseguire il mirroring di functions-framework nel tuo registry privato. Includi functions-framework sottoposto a mirroring come dipendenza della funzione per evitare di installare il pacchetto dalla rete internet pubblica.

Imballaggio delle dipendenze locali

Puoi anche creare il pacchetto e implementare le dipendenze insieme alla funzione. Questo approccio è utile se la dipendenza non è disponibile tramite il gestore dei pacchetti RubyGems.

Per pacchettizzare un gem localmente, includilo in una directory nella struttura della directory della funzione e fornisci il percorso nella voce Gemfile della dipendenza. La directory del gem deve includere un file gemspec valido e deve trovarsi all'interno della gerarchia delle directory della funzione in modo che il codice venga disegnato insieme alla funzione. Ad esempio, puoi utilizzare una struttura di directory come la seguente:

myfunction/
├── Gemfile
├── Gemfile.lock
├── app.rb
└── my_private_gem/
    ├── lib/
    |   └── my_private_gem.rb
    └── my_private_gem.gemspec

La voce Gemfile potrebbe avere il seguente aspetto:

source "https://rubygems.org"

gem "functions_framework", "~> 0.7"
gem "my_private_gem", path: "./my_private_gem"

Consulta la sezione Riferimento a Gemfile per ulteriori informazioni sul riferimento ai percorsi dei gem locali.