Salva e carica gli snapshot dell'ambiente

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Questa pagina spiega come salvare e caricare lo stato dell'ambiente utilizzando gli snapshot dell'ambiente.

Puoi configurare l'ambiente in modo da salvare automaticamente gli snapshot. Per ulteriori 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:

Come vengono archiviati gli snapshot

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

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

Cloud Composer non elimina gli snapshot quando elimini completamente gestito di Google Cloud.

Per impostazione predefinita, Cloud Composer archivia gli snapshot in snapshots/ cartella nel bucket dell'ambiente. Puoi anche specificare una posizione personalizzata quando crei uno snapshot.

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

Considerazioni sulla sicurezza per gli snapshot

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 ulteriori informazioni, consulta Configurare Secret Manager per il tuo ambiente.

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

Quali dati vengono salvati negli istantanei

Cloud Composer salva i seguenti dati in snapshot:

  • Override della configurazione di 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 di DAG.
  • Un backup delle cartelle /dags, /data e /plugins dal del bucket dell'ambiente.
  • Chiave Fernet dell'ambiente.
  • Altre informazioni sulla configurazione dell'ambiente, ad esempio la scala e i parametri di rendimento dell'ambiente. Cloud Composer non utilizza queste informazioni durante il caricamento 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).

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

  • Contenuti delle cartelle /dags, /data e /plugins dallo 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 del rimane invariato.

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

  • Configurazione dell'ambiente, ad esempio scalabilità e prestazioni dell'ambiente parametri.
  • Configurazione di networking dell'ambiente.
  • I contenuti del bucket dell'ambiente al di fuori di /dags, /data e /plugins cartelle.
  • Etichette dell'ambiente.

Eventuali impostazioni applicate nell'infrastruttura Cloud Composer senza utilizzare l'API Cloud Composer potrebbero andare perse quando carichi un snapshot.

Informazioni sulle operazioni parzialmente completate

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

  • Le operazioni riuscite caricano tutti i dati dallo snapshot.
  • Le operazioni non riuscite non introducono modifiche.
  • Le operazioni completate parzialmente caricano un sottoinsieme di dati dall'istantanea. Tale le operazioni vengono segnalate come non riuscite, ma il messaggio di errore indica dati caricati correttamente. Ad esempio, se i pacchetti PyPI sono installati, ma gli override dell'opzione di configurazione di Airflow non sono riusciti, l'errore questo è un messaggio di errore.

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

Prima di iniziare

  • In Cloud Composer 1 puoi solo salvare gli snapshot, ma non caricarli. Puoi Caricare snapshot da un ambiente Cloud Composer 1 a Cloud Composer 2. ambienti cloud-native.

  • 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 altro, devi prima creare un nuovo ambiente e poi 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 puoi caricare uno snapshot da Cloud Composer 2.0.2 in un ambiente con Cloud Composer 2.0.1. Come altro esempio, non puoi caricare un'istantanea da Airflow 2.2.3 ad Airflow 2.1.4.

  • Gli snapshot non modificano la versione di Cloud Composer. Se esegui l'upgrade dell'ambiente a una versione successiva di Cloud Composer e carichi uno snapshot da una versione precedente, l'ambiente mantiene la versione corrente di Cloud Composer. Ad esempio, il caricamento di uno snapshot da Cloud Composer 2.0.1 a Cloud Composer 2.0.2 non ripristina 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.

  • Il numero totale di oggetti nelle cartelle /dags, /plugins e /data in del bucket dell'ambiente deve essere inferiore a 100.000 per creare snapshot.

  • Se utilizzi il meccanismo XCom per trasferire i file, assicurati di [utilizzalo in base alle linee guida di Airflow][ext-airflow-xcom-backend]. Il trasferimento di file di grandi dimensioni o di un numero elevato di file utilizzando XCom influisce sul rendimento del database Airflow e può causare errori durante il caricamento degli snapshot o l'upgrade dell'ambiente. Valuta l'uso di alternative come come Cloud Storage, per trasferire grandi volumi di dati.

  • 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 bucket, l'account di servizio del tuo ambiente deve avere le autorizzazioni di lettura e scrittura per la località specificata. Ad esempio, il ruolo Amministratore oggetti archiviazione dispone di queste autorizzazioni. Tu può applicarla a un progetto o a un bucket specifico.

  • La creazione e lo stoccaggio degli snapshot comportano costi aggiuntivi correlati a Cloud Storage. Per ulteriori informazioni, vedi Prezzi.

Salvare uno snapshot di ambiente

Cloud Composer salva gli snapshot dell'ambiente sottocartella, in base alla cartella specificata. Il nome della cartella contiene l'ID progetto, la posizione dell'ambiente, il nome dell'ambiente e il timestamp relativo al 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 la posizione in cui archiviare lo snapshot:

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

    • Per archiviare lo snapshot nella cartella personalizzata, seleziona Usa 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 salvata la snapshot. Per impostazione predefinita, gli snapshot vengono salvati nella cartella /snapshots del del bucket dell'ambiente. Ad esempio: gs://us-central1-example-916807e1-bucket/snapshots. Puoi anche specificare in qualsiasi altra cartella.

Per salvare uno snapshot dell'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.

L'esempio seguente utilizza la posizione 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. Costruisci una richiesta API environments.saveSnapshot.

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

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Sostituisci:

  • SNAPSHOTS_FOLDER con l'URI di una cartella del bucket in cui memorizzare 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 gli snapshot risultanti non fanno parte della definizione di un ambiente. Poiché Terraform gestisce solo la configurazione dell'ambiente Cloud Composer, non puoi salvare o caricare gli snapshot dell'ambiente.

Carica uno snapshot di ambiente

In Cloud Composer 1 puoi solo salvare gli snapshot, ma non caricarli. Puoi Caricare snapshot da un ambiente Cloud Composer 1 a Cloud Composer 2. ambienti cloud-native. Ad esempio, quando esegui la migrazione dei tuoi ambienti a Cloud Composer 2.

Passaggi successivi