Salva e carica gli snapshot dell'ambiente

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Nota: questa pagina non è ancora stata revisionata per Cloud Composer 3 e mostra i contenuti per Cloud Composer 2.

In questa pagina viene spiegato come salvare e caricare lo stato dell'ambiente utilizzando gli snapshot dell'ambiente.

Puoi configurare l'ambiente in modo che salvi automaticamente gli snapshot. Per maggiori informazioni, consulta Configurare gli snapshot pianificati.

Informazioni sugli snapshot dell'ambiente

Gli snapshot di ambiente archiviano lo stato dell'ambiente. Puoi salvare e caricare gli snapshot dell'ambiente on demand.

Puoi utilizzare gli snapshot per:

• Ripristina l'ambiente a uno stato precedente. Crea backup dell'ambiente utilizzando gli snapshot, quindi carica uno degli snapshot per ripristinare l'ambiente. Ad esempio, puoi eseguire il rollback di un'operazione di aggiornamento che installa pacchetti PyPI o esegue l'override delle opzioni di configurazione di Airflow, anche dopo che l'ambiente è stato aggiornato correttamente.

• Esegui upgrade affiancati e ambienti di copia. Crea uno snapshot di un ambiente esistente, crea un nuovo ambiente che utilizza la stessa versione o una successiva di Cloud Composer, quindi applica lo snapshot a questo nuovo ambiente. Questa procedura è simile alla migrazione. Assicurati di mettere in pausa i DAG prima di creare lo snapshot, per evitare esecuzioni di DAG duplicate.

Come vengono archiviati gli snapshot

Uno snapshot dell'ambiente è un insieme di file che descrivono lo stato dell'ambiente e archivia il backup dei dati dell'ambiente.

Puoi creare più snapshot dell'ambiente. Gli snapshot dell'ambiente non sono incrementali. Puoi utilizzare qualsiasi snapshot indipendentemente dagli altri.

Cloud Composer non elimina gli snapshot quando elimini il tuo ambiente.

Per impostazione predefinita, Cloud Composer archivia gli snapshot nella cartella snapshots/ del bucket dell'ambiente. Puoi anche specificare una località personalizzata quando crei uno snapshot.

Mentre l'interfaccia utente di Cloud Storage visualizza i dati come cartelle per comodità, i bucket funzionano in una struttura flat. Il modo in cui lavori con il salvataggio e il caricamento degli snapshot nella console Google Cloud non cambia, ma tienilo presente quando esegui operazioni direttamente sui file del tuo bucket. Per maggiori informazioni, consulta Spazio dei nomi dell'oggetto.

Considerazioni sulla sicurezza per gli snapshot

Avviso: la chiave Fernet del tuo ambiente viene archiviata insieme al backup del database Airflow. Ciò significa che le informazioni sensibili come le password e gli extra di connessione di Airflow possono essere decriptati da uno snapshot di ambiente.

Per ridurre questo rischio per la sicurezza, puoi archiviare le informazioni sensibili utilizzate dai DAG di Airflow, come chiavi o password, in Secret Manager. Per maggiori informazioni, consulta Configurare Secret Manager per il tuo ambiente.

Assicurati di controllare le autorizzazioni di sicurezza per il bucket del tuo ambiente. Se archivi gli snapshot dell'ambiente in un bucket personalizzato, assicurati che le autorizzazioni di accesso siano configurate correttamente nel progetto. Quando assegni le autorizzazioni, assicurati che l'account di servizio dell'ambiente disponi di autorizzazioni sufficienti per salvare e caricare gli snapshot del bucket.

Quali dati vengono salvati negli snapshot

Cloud Composer salva i seguenti dati in snapshot:

• Override della configurazione Airflow.
• Variabili di ambiente.
• Elenco di pacchetti PyPI personalizzati, come requisiti.
• Un backup del database Airflow, inclusi gli stati delle attività eseguite e la cronologia delle esecuzioni dei DAG.
• Un backup delle cartelle /dags, /data e /plugins dal bucket dell'ambiente.
• La chiave Fernet dell'ambiente.
• Altre informazioni sulla configurazione dell'ambiente, come i parametri di scalabilità e prestazioni dell'ambiente. Cloud Composer non utilizza queste informazioni quando carica gli snapshot.

Quali dati vengono caricati dagli snapshot

Cloud Composer carica i seguenti dati dagli snapshot:

• Override della configurazione Airflow.
• Variabili di ambiente.

• Pacchetti PyPI personalizzati (a meno che tu non scelga di saltare l'installazione).

  Attenzione: Cloud Composer installa i pacchetti così come sono specificati nei requisiti. Ad esempio, se uno snapshot ha example_package>=1.0 come requisito, può essere installata una versione diversa del pacchetto quando carichi lo snapshot.

• I contenuti del database Airflow, inclusi gli stati delle attività eseguite e la cronologia delle esecuzioni dei DAG.

• I contenuti delle cartelle /dags, /data e /plugins dello snapshot vengono caricati nel bucket dell'ambiente.

• La chiave Fernet dello snapshot viene utilizzata per criptare nuovamente i dati dello snapshot con la chiave Fernet dell'ambiente. La chiave Fernet dell'ambiente rimane invariata.

Sebbene Cloud Composer archivi alcune informazioni sulla configurazione dell'ambiente negli snapshot, non viene utilizzato durante il caricamento degli snapshot. I seguenti parametri dell'ambiente non cambiano quando carichi uno snapshot:

• configurazione dell'ambiente, come la scalabilità dell'ambiente e i parametri delle prestazioni.
• Configurazione di networking dell'ambiente.
• Contenuti del bucket dell'ambiente al di fuori delle cartelle /dags, /data e /plugins.
• Etichette dell'ambiente.

Tutte le impostazioni applicate nell'infrastruttura Cloud Composer senza utilizzare l'API Cloud Composer potrebbero andare perse quando si carica uno snapshot.

Informazioni sulle operazioni parzialmente completate

Quando carichi uno snapshot, l'operazione può avere esito positivo, non riuscito o parzialmente completata:

• Le operazioni riuscite caricano tutti i dati dallo snapshot.
• Le operazioni non riuscite non introducono alcuna modifica.
• Le operazioni parzialmente completate caricano un sottoinsieme di dati dallo snapshot. Queste operazioni vengono segnalate come non riuscite, ma il messaggio di errore indica quali dati sono stati caricati correttamente. Ad esempio, se i pacchetti PyPI sono installati, ma gli override dell'opzione di configurazione di Airflow non sono riusciti, il messaggio di errore indica questo problema.

Per un'operazione parzialmente completata, puoi provare a caricare di nuovo lo stesso snapshot. Cloud Composer salta i passaggi riusciti nel tentativo precedente. Ad esempio, se un'operazione non è riuscita per un timeout, ma il database è stato caricato correttamente, al tentativo successivo il database non viene caricato di nuovo.

Prima di iniziare

• Gli snapshot sono supportati in Cloud Composer 2 versione 2.0.9 e successive. Cloud Composer 1 supporta il salvataggio degli snapshot dell'ambiente per le versioni >= 1.18.5.

• Gli snapshot non creano un ambiente. Se vuoi caricare uno snapshot da un ambiente a un ambiente diverso, devi prima creare un nuovo ambiente e quindi caricare lo snapshot al suo interno.

• Non puoi caricare snapshot in ambienti in stato di errore. Non è possibile correggere questi ambienti caricando uno snapshot. Puoi comunque caricare uno snapshot esistente in un nuovo ambiente.

• Puoi caricare snapshot solo sulla stessa versione o su una versione successiva di Cloud Composer o Airflow. Ad esempio, non è possibile caricare uno snapshot da Cloud Composer 2.0.2 in un ambiente con Cloud Composer 2.0.1. Come ulteriore esempio, non è possibile caricare uno snapshot da Airflow 2.2.3 ad Airflow 2.1.4.

• Gli snapshot non cambiano la versione di Cloud Composer. Se esegui l'upgrade dell'ambiente a una versione successiva di Cloud Composer e poi carichi uno snapshot di una versione precedente, il tuo ambiente manterrà comunque la versione attuale di Cloud Composer. Ad esempio, il caricamento di uno snapshot da Cloud Composer 2.0.1 a Cloud Composer 2.0.2 non reimposta l'ambiente a Cloud Composer 2.0.1.

• La dimensione massima del database Airflow che supporta gli snapshot è 20 GB. Se il database del tuo ambiente occupa più di 20 GB, riduci le dimensioni del database Airflow prima di salvare uno snapshot.

• La lunghezza massima del nome di un oggetto nel bucket dell'ambiente non deve essere superiore a 1024 simboli. In caso contrario, non sarà possibile creare snapshot.

• Se salvi gli snapshot in una località esterna al bucket dell'ambiente, l'account di servizio del tuo ambiente deve disporre delle autorizzazioni di lettura e scrittura per la località specificata. Ad esempio, il ruolo Amministratore oggetti Storage dispone di queste autorizzazioni. Puoi applicarla a un progetto o a un bucket specifico.

• La creazione e l'archiviazione di snapshot comporta costi aggiuntivi, correlati a Cloud Storage. Per ulteriori informazioni, consulta la sezione Prezzi.

Salva uno snapshot di ambiente

Cloud Composer salva gli snapshot dell'ambiente in una sottocartella, in base alla cartella specificata. Il nome della cartella contiene l'ID progetto, la località dell'ambiente, il nome dell'ambiente e il timestamp del salvataggio dello snapshot. Ad esempio: /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

Console

Per creare uno snapshot del tuo ambiente:

1. Nella console Google Cloud, vai alla pagina Ambienti.

   Vai ad Ambienti

2. Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Si apre la pagina Dettagli ambiente.

3. Fai clic su Salva snapshot.

4. Nella finestra di dialogo Salva snapshot, seleziona dove archiviare lo snapshot:

   • Per archiviare lo snapshot nella cartella /snapshots del bucket dell'ambiente, seleziona Utilizza la cartella dello snapshot nel bucket di ambiente (impostazione predefinita).

   • Per archiviare lo snapshot nella cartella personalizzata, seleziona Utilizza una cartella personalizzata in un altro bucket, quindi specifica una posizione.

5. Fai clic su Salva.

gcloud

Il comando gcloud beta composer environments snapshots save salva uno snapshot dell'ambiente.

• L'argomento snapshot-location specifica una cartella in cui viene salvato lo snapshot. Per impostazione predefinita, gli snapshot vengono salvati nella cartella /snapshots del bucket del tuo ambiente. Ad esempio, gs://us-central1-example-916807e1-bucket/snapshots. Puoi anche specificare qualsiasi altra cartella.

Per salvare uno snapshot del tuo ambiente, esegui:

gcloud beta composer environments snapshots save \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-location "SNAPSHOTS_FOLDER"

Sostituisci:

• ENVIRONMENT_NAME con il nome dell'ambiente.
• LOCATION con la regione in cui si trova l'ambiente.
• (Facoltativo) SNAPSHOTS_FOLDER con l'URI di una cartella del bucket in cui archiviare lo snapshot. Se ometti questo argomento, Cloud Composer salva lo snapshot nella cartella /snapshots del bucket dell'ambiente.

Nell'esempio seguente viene utilizzata la località predefinita:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1

L'esempio seguente viene salvato in una cartella personalizzata:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1 \
  --snapshot-location "gs://example-bucket/environment_snapshots"

API

1. Crea una richiesta API environments.saveSnapshot.

2. Nel corpo della richiesta, nel campo snapshotLocation, specifica la cartella in cui salvare lo snapshot.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Sostituisci:

• SNAPSHOTS_FOLDER con l'URI di una cartella del bucket in cui salvare lo snapshot.

Esempio:

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:saveSnapshot

{
  "snapshotLocation": "gs://us-central1-example-916807e1-bucket/snapshots"
}

Terraform

Non è possibile salvare e caricare snapshot dell'ambiente da Terraform.

Il salvataggio e il caricamento degli snapshot sono azioni eseguite in un ambiente e gli snapshot risultanti non fanno parte della definizione di un ambiente. Poiché Terraform gestisce solo la configurazione dell'ambiente Cloud Composer, non è possibile salvare o caricare snapshot dell'ambiente al suo interno.

Carica uno snapshot di ambiente

Avviso: dopo aver caricato uno snapshot, la cronologia delle esecuzioni del DAG viene ripristinata allo stato dello snapshot. Ciò potrebbe causare esecuzioni di DAG duplicate.

Considera la seguente situazione. Ad esempio, il catch-up è abilitato e Airflow esegue un DAG in base a una pianificazione tra il momento in cui è stato creato lo snapshot e quando è stato caricato. In questo caso, dopo aver caricato lo snapshot, Airflow non dispone di informazioni sull'esecuzione del DAG che si è verificata, quindi Airflow esegue nuovamente il DAG per lo stesso tempo e gli stessi dati.

Come ulteriore esempio, consideriamo un DAG che viene eseguito in base a una pianificazione giornaliera. Crei uno snapshot, Airflow esegue questo DAG e, successivamente, carichi lo snapshot lo stesso giorno. In questo caso, Airflow esegue nuovamente il DAG, anche se il recupero è disabilitato.

Console

Per caricare uno snapshot nell'ambiente Cloud Composer 2:

1. Nella console Google Cloud, vai alla pagina Ambienti.

   Vai ad Ambienti

2. Nell'elenco degli ambienti, fai clic sul nome del tuo ambiente. Si apre la pagina Dettagli ambiente.

3. Fai clic su Carica istantanea.

4. Nella finestra di dialogo Carica istantanea, fai clic su Sfoglia.

5. Seleziona una cartella in cui archiviare lo snapshot. Il nome della cartella elenca l'ID del progetto, la posizione dell'ambiente e il timestamp di salvataggio dello snapshot. Ad esempio, /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

6. (Facoltativo) Per saltare l'installazione dei pacchetti PyPI personalizzati dallo snapshot, seleziona Ignora l'installazione dei pacchetti PyPI. Se carichi uno snapshot di un ambiente con pacchetti PyPI personalizzati installati, Cloud Composer non installa questi pacchetti personalizzati.

7. Fai clic su Carica e attendi che Cloud Composer carichi lo snapshot.

gcloud

Il comando gcloud beta composer environments snapshots load carica uno snapshot nel tuo ambiente.

• L'argomento --snapshot-path specifica una cartella in cui si trova lo snapshot.

  Il nome della cartella elenca l'ID del progetto, la posizione dell'ambiente e il timestamp del salvataggio dello snapshot. Ad esempio, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

• (Facoltativo) L'argomento --skip-pypi-packages-installation ignora l'installazione dei pacchetti PyPI personalizzati dallo snapshot. Se carichi uno snapshot di un ambiente con pacchetti PyPI personalizzati installati, Cloud Composer non installa questi pacchetti personalizzati.

gcloud beta composer environments snapshots load \
  DESTINATION_ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-path "SNAPSHOT_PATH"

Sostituisci:

• DESTINATION_ENVIRONMENT_NAME con il nome dell'ambiente in cui vuoi caricare lo snapshot.
• LOCATION con la regione in cui si trova l'ambiente.
• SNAPSHOT_PATH con l'URI di un bucket, seguito dal percorso dello snapshot.

Esempio:

gcloud beta composer environments snapshots load \
  example-environment \
  --location us-central1 \
  --snapshot-path "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00"

API

1. Crea una richiesta API environments.loadSnapshot.

2. Nel corpo della richiesta, nel campo snapshotPath, specifica l'URI di un bucket, seguito dal percorso dello snapshot. Il nome della cartella elenca l'ID del progetto, la posizione dell'ambiente e il timestamp in cui è stato salvato lo snapshot. Ad esempio, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

3. (Facoltativo) Nel corpo della richiesta, nel campo skipPypiPackagesInstallation specifica se Cloud Composer deve saltare l'installazione dei pacchetti PyPI personalizzati dallo snapshot. Se carichi uno snapshot di un ambiente con pacchetti PyPI personalizzati installati, Cloud Composer non installa questi pacchetti personalizzati.

   Questo campo è facoltativo. Se ometti questo campo, Cloud Composer installa i pacchetti PyPI dallo snapshot.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Sostituisci:

• SNAPSHOT_PATH con l'URI di una cartella del bucket in cui archiviare lo snapshot.

Esempio:

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:loadSnapshot

{
  "snapshotPath": "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00",
  "skipPypiPackagesInstallation": "False"
}

Terraform

Non è possibile salvare e caricare snapshot dell'ambiente utilizzando Terraform.

Il salvataggio e il caricamento degli snapshot sono azioni eseguite in un ambiente e gli snapshot risultanti non fanno parte della definizione di un ambiente. Poiché Terraform gestisce solo la configurazione dell'ambiente Cloud Composer, non è possibile salvare o caricare snapshot dell'ambiente al suo interno.

Passaggi successivi

• Configura snapshot pianificati
• Crea ambienti
• Controllo dell'accesso