Pianifica l'avvio o l'arresto di una VM di Compute Engine

Nota: Google Compute Engine ora dispone di una funzionalità di pianificazione delle istanze che può essere utilizzata per avviare e arrestare le istanze tramite la console Google Cloud , Google Cloud CLI o tramite l'API. L'approccio fornito in questo tutorial per l'utilizzo di Cloud Scheduler è ancora funzionale ed è necessario per pianificare l'avvio e l'arresto di altre risorse che non sono istanze VM di Compute Engine, ad esempio le istanze Cloud SQL.

Questo tutorial mostra come utilizzare le funzioni Cloud Scheduler e Cloud Run per avviare e arrestare automaticamente le istanze Compute Engine in base a una pianificazione regolare utilizzando le etichette delle risorse.

Architettura dell'applicazione

Questa soluzione include i seguenti Google Cloud componenti:

• Istanza Compute Engine che vogliamo eseguire in base a una pianificazione.
• Funzioni Cloud Run per avviare e arrestare l'istanza che vogliamo pianificare.
• Messaggi Pub/Sub inviati e ricevuti per ogni evento di avvio e interruzione.
• Job Cloud Scheduler per effettuare chiamate in base a una pianificazione prestabilita per avviare e arrestare l'istanza.

Requisiti per le località

Alcuni componenti sono supportati solo in determinate regioni:

• Istanza Compute Engine: supportata in qualsiasi regione elencata in Regioni e zone.
• Cloud Run Functions: supportate nelle regioni elencate in Località.
• Messaggi Pub/Sub: supportati a livello globale poiché Pub/Sub è un servizio globale.
• I job Cloud Scheduler con destinazioni Pub/Sub sono supportati in qualsiasi Google Cloud posizione.

Nota: fortunatamente, per questa applicazione, nessun componente deve essere eseguito nella stessa regione di qualsiasi altro componente. Pertanto, anche se esegui il deployment dei job Cloud Scheduler in una determinata regione, puoi posizionare l'istanza Compute Engine ovunque. Detto questo, è anche vero che se posizioni i componenti nella stessa regione, la latenza sarà migliore.

Perché non HTTP anziché Pub/Sub?

Potresti voler semplificare questa architettura utilizzando le funzioni Cloud Run Trigger HTTP anziché Trigger Pub/Sub.

Questo tutorial utilizza Pub/Sub come trigger delle funzioni Cloud Run perché questo metodo era in precedenza più sicuro dell'utilizzo di HTTP. Tuttavia, anche HTTP è una scelta valida e ora può essere protetto richiedendo l'autenticazione.

Per scoprire di più sulla protezione delle funzioni Cloud Run, consulta la panoramica sulla sicurezza di Cloud Run Functions. Per un confronto tra i trigger HTTP e Pub/Sub, consulta la documentazione sui trigger di Cloud Run Functions.

Configura l'istanza Compute Engine

Console

1. Nella console Google Cloud , vai alla pagina Istanze VM.
   Vai alla pagina Istanze VM.
2. Fai clic su Crea istanza.
3. Imposta Nome su dev-instance.
4. Nella sezione Etichette, fai clic su Aggiungi etichette.
5. Fai clic su Aggiungi etichetta.
6. Inserisci env in Chiave e dev in Valore.
7. In Regione, seleziona us-west1.
8. In Zona, seleziona us-west1-b.
9. Fai clic su Salva.
10. Fai clic su Crea nella parte inferiore della pagina.

gcloud

gcloud compute instances create dev-instance \
    --network default \
    --zone us-west1-b \
    --labels=env=dev

Nota: per semplicità, questo tutorial crea una sola istanza. Tuttavia, l'architettura qui può essere utilizzata per arrestare e avviare più istanze in cui l'etichetta risorsa env ha il valore dev.

Esegui il deployment di funzioni attivate da Pub/Sub tramite Cloud Run Functions

Crea ed esegui il deployment delle funzioni

Console

Crea la funzione di avvio.

1. Vai alla pagina Cloud Run Functions nella console Google Cloud .
   Vai alla pagina Cloud Run Functions.
2. Fai clic su Crea funzione.
3. Per Ambiente, seleziona 1ª generazione.
4. Imposta Nome funzione su startInstancePubSub.
5. Lascia invariato il valore predefinito per Regione.
6. Per Tipo di trigger, seleziona Cloud Pub/Sub.
7. In Seleziona un argomento Cloud Pub/Sub, fai clic su Crea un argomento.
8. Dovrebbe essere visualizzata la finestra di dialogo Crea argomento.
   1. In ID argomento, inserisci start-instance-event.
   2. Fai clic su Crea per completare la finestra di dialogo.
9. Fai clic su Salva nella parte inferiore della casella Trigger.
10. Fai clic su Avanti nella parte inferiore della pagina.
11. Per Runtime, seleziona Node.js 16 o versioni successive.
12. In Punto di ingresso, inserisci startInstancePubSub.
13. Sul lato sinistro dell'editor di codice, seleziona index.js.

14. Sostituisci il codice iniziale con il seguente:

    const compute = require('@google-cloud/compute');
    const instancesClient = new compute.InstancesClient();
    const operationsClient = new compute.ZoneOperationsClient();
    
    async function waitForOperation(projectId, operation) {
      while (operation.status !== 'DONE') {
        [operation] = await operationsClient.wait({
          operation: operation.name,
          project: projectId,
          zone: operation.zone.split('/').pop(),
        });
      }
    }
    
    /**
     * Starts Compute Engine instances.
     *
     * Expects a PubSub message with JSON-formatted event data containing the
     * following attributes:
     *  zone - the GCP zone the instances are located in.
     *  label - the label of instances to start.
     *
     * @param {!object} event Cloud Function PubSub message event.
     * @param {!object} callback Cloud Function PubSub callback indicating
     *  completion.
     */
    exports.startInstancePubSub = async (event, context, callback) => {
      try {
        const project = await instancesClient.getProjectId();
        const payload = _validatePayload(event);
        const options = {
          filter: `labels.${payload.label}`,
          project,
          zone: payload.zone,
        };
    
        const [instances] = await instancesClient.list(options);
    
        await Promise.all(
          instances.map(async instance => {
            const [response] = await instancesClient.start({
              project,
              zone: payload.zone,
              instance: instance.name,
            });
    
            return waitForOperation(project, response.latestResponse);
          })
        );
    
        // Operation complete. Instance successfully started.
        const message = 'Successfully started instance(s)';
        console.log(message);
        callback(null, message);
      } catch (err) {
        console.log(err);
        callback(err);
      }
    };
    
    /**
     * Validates that a request payload contains the expected fields.
     *
     * @param {!object} payload the request payload to validate.
     * @return {!object} the payload object.
     */
    const _validatePayload = event => {
      let payload;
      try {
        payload = JSON.parse(Buffer.from(event.data, 'base64').toString());
      } catch (err) {
        throw new Error('Invalid Pub/Sub message: ' + err);
      }
      if (!payload.zone) {
        throw new Error("Attribute 'zone' missing from payload");
      } else if (!payload.label) {
        throw new Error("Attribute 'label' missing from payload");
      }
      return payload;
    };

15. Sul lato sinistro dell'editor di codice, seleziona package.json.

16. Sostituisci il codice iniziale con il seguente:

    {
      "name": "cloud-functions-schedule-instance",
      "version": "0.1.0",
      "private": true,
      "license": "Apache-2.0",
      "author": "Google Inc.",
      "repository": {
        "type": "git",
        "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
      },
      "engines": {
        "node": ">=16.0.0"
      },
      "scripts": {
        "test": "c8 mocha -p -j 2 test/*.test.js --timeout=20000"
      },
      "devDependencies": {
        "c8": "^10.0.0",
        "mocha": "^10.0.0",
        "proxyquire": "^2.0.0",
        "sinon": "^18.0.0"
      },
      "dependencies": {
        "@google-cloud/compute": "^4.0.0"
      }
    }
    

17. Fai clic su Esegui il deployment nella parte inferiore della pagina.

Crea la funzione di interruzione.

1. Dovresti trovarti nella pagina Cloud Run Functions della console Google Cloud .
2. Fai clic su Crea funzione.
3. Per Ambiente, seleziona 1ª generazione.
4. Imposta Nome funzione su stopInstancePubSub.
5. Lascia invariato il valore predefinito per Regione.
6. Per Tipo di trigger, seleziona Cloud Pub/Sub.
7. In Seleziona un argomento Cloud Pub/Sub, fai clic su Crea un argomento.
8. Dovrebbe essere visualizzata la finestra di dialogo Crea argomento.
   1. In ID argomento, inserisci stop-instance-event.
   2. Fai clic su Crea per completare la finestra di dialogo.
9. Fai clic su Salva nella parte inferiore della casella Trigger.
10. Fai clic su Avanti nella parte inferiore della pagina.
11. Per Runtime, seleziona Node.js 16 o versioni successive.
12. In Punto di ingresso, inserisci stopInstancePubSub.
13. Sul lato sinistro dell'editor di codice, seleziona index.js.

14. Sostituisci il codice iniziale con il seguente:

    const compute = require('@google-cloud/compute');
    const instancesClient = new compute.InstancesClient();
    const operationsClient = new compute.ZoneOperationsClient();
    
    async function waitForOperation(projectId, operation) {
      while (operation.status !== 'DONE') {
        [operation] = await operationsClient.wait({
          operation: operation.name,
          project: projectId,
          zone: operation.zone.split('/').pop(),
        });
      }
    }
    
    /**
     * Stops Compute Engine instances.
     *
     * Expects a PubSub message with JSON-formatted event data containing the
     * following attributes:
     *  zone - the GCP zone the instances are located in.
     *  label - the label of instances to stop.
     *
     * @param {!object} event Cloud Function PubSub message event.
     * @param {!object} callback Cloud Function PubSub callback indicating completion.
     */
    exports.stopInstancePubSub = async (event, context, callback) => {
      try {
        const project = await instancesClient.getProjectId();
        const payload = _validatePayload(event);
        const options = {
          filter: `labels.${payload.label}`,
          project,
          zone: payload.zone,
        };
    
        const [instances] = await instancesClient.list(options);
    
        await Promise.all(
          instances.map(async instance => {
            const [response] = await instancesClient.stop({
              project,
              zone: payload.zone,
              instance: instance.name,
            });
    
            return waitForOperation(project, response.latestResponse);
          })
        );
    
        // Operation complete. Instance successfully stopped.
        const message = 'Successfully stopped instance(s)';
        console.log(message);
        callback(null, message);
      } catch (err) {
        console.log(err);
        callback(err);
      }
    };
    
    /**
     * Validates that a request payload contains the expected fields.
     *
     * @param {!object} payload the request payload to validate.
     * @return {!object} the payload object.
     */
    const _validatePayload = event => {
      let payload;
      try {
        payload = JSON.parse(Buffer.from(event.data, 'base64').toString());
      } catch (err) {
        throw new Error('Invalid Pub/Sub message: ' + err);
      }
      if (!payload.zone) {
        throw new Error("Attribute 'zone' missing from payload");
      } else if (!payload.label) {
        throw new Error("Attribute 'label' missing from payload");
      }
      return payload;
    };

15. Sul lato sinistro dell'editor di codice, seleziona package.json.

16. Sostituisci il codice iniziale con il seguente:

    {
      "name": "cloud-functions-schedule-instance",
      "version": "0.1.0",
      "private": true,
      "license": "Apache-2.0",
      "author": "Google Inc.",
      "repository": {
        "type": "git",
        "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
      },
      "engines": {
        "node": ">=16.0.0"
      },
      "scripts": {
        "test": "c8 mocha -p -j 2 test/*.test.js --timeout=20000"
      },
      "devDependencies": {
        "c8": "^10.0.0",
        "mocha": "^10.0.0",
        "proxyquire": "^2.0.0",
        "sinon": "^18.0.0"
      },
      "dependencies": {
        "@google-cloud/compute": "^4.0.0"
      }
    }
    

17. Fai clic su Esegui il deployment nella parte inferiore della pagina.

gcloud

Crea gli argomenti Pub/Sub.

gcloud pubsub topics create start-instance-event

gcloud pubsub topics create stop-instance-event

Ottieni il codice

1. Scarica il codice.

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.

2. Vai alla directory corretta.

   cd nodejs-docs-samples/functions/scheduleinstance/

Crea le funzioni di avvio e arresto.

Dovresti trovarti nella directory nodejs-docs-samples/functions/scheduleinstance/.

gcloud functions deploy startInstancePubSub \
    --trigger-topic start-instance-event \
    --runtime nodejs18 \
    --allow-unauthenticated

gcloud functions deploy stopInstancePubSub \
    --trigger-topic stop-instance-event \
    --runtime nodejs18 \
    --allow-unauthenticated

Nota: se hai difficoltà a eseguire il deployment delle funzioni, consulta la documentazione Deployment dal computer locale.

(Facoltativo) Verifica il funzionamento delle funzioni

Console

Arresta l'istanza

1. Vai alla pagina Cloud Run Functions nella console Google Cloud .
   Vai alla pagina Cloud Run Functions.
2. Fai clic sulla funzione denominata stopInstancePubSub.
3. Dovresti visualizzare diverse schede: Generale, Attivatore, Origine, Autorizzazioni e Test. Fai clic sulla scheda Test.

4. Per Evento di trigger, inserisci quanto segue:

   {"data":"eyJ6b25lIjoidXMtd2VzdDEtYiIsICJsYWJlbCI6ImVudj1kZXYifQo="}
   

   • Si tratta semplicemente della stringa con codifica base64 per {"zone":"us-west1-b", "label":"env=dev"}

   • Se vuoi codificare la tua stringa, puoi utilizzare qualsiasi strumento di codifica base64 online.

     Nota :se vuoi saperne di più sulla pubblicazione di dati su Pub/Sub, consulta la Guida per i publisher.

5. Fai clic sul pulsante Testa la funzione.

6. Al termine dell'esecuzione, dovresti visualizzare Successfully stopped instance dev-instance stampato in Output. L'operazione potrebbe richiedere fino a 60 secondi.

   • Se invece vedi error: 'Error: function failed to load.', aspetta circa 10 secondi affinché la funzione venga implementata e riprova.

   • Se invece vedi error: 'Error: function execution attempt timed out.', passa al passaggio successivo per verificare se l'istanza impiega molto tempo per arrestarsi.

   • Se invece termina l'esecuzione, ma non mostra nulla, probabilmente è andato in timeout. Passa al passaggio successivo per verificare se l'istanza richiede solo molto tempo per spegnersi.

7. Nella console Google Cloud , vai alla pagina Istanze VM.
   Vai alla pagina Istanze VM.

8. Verifica che accanto al nome dell'istanza dev-instance sia presente un quadrato grigio, che indica che è stata arrestata. L'operazione potrebbe richiedere fino a 30 secondi.

   • Se il caricamento non sembra terminare, prova a fare clic su Aggiorna nella parte superiore della pagina.

Avvia l'istanza

1. Vai alla pagina Cloud Run Functions nella console Google Cloud .
   Vai alla pagina Cloud Run Functions.
2. Fai clic sulla funzione denominata startInstancePubSub.
3. Dovresti visualizzare diverse schede: Generale, Attivatore, Origine, Autorizzazioni e Test. Fai clic sulla scheda Test.

4. Per Evento di trigger, inserisci quanto segue:

   {"data":"eyJ6b25lIjoidXMtd2VzdDEtYiIsICJsYWJlbCI6ImVudj1kZXYifQo="}
   

   • Anche in questo caso, si tratta semplicemente della stringa codificata in base64 per {"zone":"us-west1-b", "label":"env=dev"}

5. Fai clic sul pulsante Testa la funzione.

6. Al termine dell'esecuzione, dovresti visualizzare Successfully started instance dev-instance stampato in Output.

7. Nella console Google Cloud , vai alla pagina Istanze VM.
   Vai alla pagina Istanze VM.

8. Verifica che accanto al nome dell'istanza dev-instance sia presente un segno di spunta verde, che indica che è in esecuzione. L'avvio potrebbe richiedere fino a 30 secondi.

gcloud

Arresta l'istanza

1. Chiama la funzione per arrestare l'istanza.

   gcloud functions call stopInstancePubSub \
       --data '{"data":"eyJ6b25lIjoidXMtd2VzdDEtYiIsICJsYWJlbCI6ImVudj1kZXYifQo="}'
   

   • Si tratta semplicemente della stringa con codifica base64 per {"zone":"us-west1-b", "label":"env=dev"}

   • Se vuoi codificare la tua stringa, puoi utilizzare qualsiasi strumento. Ecco un esempio di utilizzo dello strumento a riga di comando base64:

     echo '{"zone":"us-west1-b", "label":"env=dev"}' | base64
     

     eyJ6b25lIjoidXMtd2VzdDEtYiIsICJsYWJlbCI6ImVudj1kZXYifQo=
     

     Nota: se vuoi saperne di più sulla pubblicazione di dati su Pub/Sub, consulta la Guida per i publisher.

   Al termine della funzione, dovresti visualizzare quanto segue:

   result: Successfully stopped instance dev-instance
   

   L'operazione potrebbe richiedere fino a 60 secondi.

   • Se invece ricevi l'errore:

     error: 'Error: function failed to load.`
     

     Attendi circa 10 secondi per il completamento del deployment della funzione e riprova.

   • Se invece ricevi l'errore:

     error: `Error: function execution attempt timed out.`
     

     Passa al passaggio successivo per verificare se l'istanza impiega molto tempo per arrestarsi.

   • Se invece non ricevi alcun risultato, probabilmente la funzione è scaduta. Passa al passaggio successivo per verificare se l'istanza impiega molto tempo per arrestarsi.

2. Verifica che l'istanza abbia lo stato TERMINATED. L'operazione potrebbe richiedere fino a 30 secondi.

   gcloud compute instances describe dev-instance \
       --zone us-west1-b \
       | grep status
   

   status: TERMINATED
   

Avvia l'istanza

1. Chiama la funzione per avviare l'istanza.

   gcloud functions call startInstancePubSub \
       --data '{"data":"eyJ6b25lIjoidXMtd2VzdDEtYiIsICJsYWJlbCI6ImVudj1kZXYifQo="}'
   

   • Anche in questo caso, si tratta semplicemente della stringa codificata in base64 per {"zone":"us-west1-b", "label":"env=dev"}

   Al termine della funzione, dovresti visualizzare quanto segue:

   result: Successfully started instance dev-instance
   

2. Verifica che l'istanza abbia lo stato RUNNING. L'avvio potrebbe richiedere fino a 30 secondi.

   gcloud compute instances describe dev-instance \
       --zone us-west1-b \
       | grep status
   

   status: RUNNING
   

Configura i job Cloud Scheduler per chiamare Pub/Sub

Creare i job

Console

Crea il job di avvio.

1. Vai alla pagina Cloud Scheduler nella console Google Cloud .
   Vai alla pagina Cloud Scheduler.
2. Fai clic su Crea un job.
3. Lascia la regione predefinita.
4. Imposta Nome su startup-dev-instances.
5. In Frequenza, inserisci 0 9 * * 1-5.
   • L'azione verrà eseguita alle 9:00 ogni giorno dal lunedì al venerdì.
6. Per Fuso orario, seleziona il paese e il fuso orario che preferisci. Questo esempio utilizzerà United States e Los Angeles.
7. Fai clic su Continua.
8. In Tipo di target, seleziona Pub/Sub.
9. Seleziona start-instance-event dal menu a discesa degli argomenti.
10. In Messaggio, inserisci quanto segue:

    {"zone":"us-west1-b","label":"env=dev"}
    

11. Fai clic su Crea.

Crea il job di interruzione.

1. Dovresti trovarti nella pagina Cloud Scheduler della console Google Cloud .
2. Fai clic su Crea job.
3. Lascia la regione predefinita e fai clic su Avanti in fondo alla pagina.
4. Imposta Nome su shutdown-dev-instances.
5. In Frequenza, inserisci 0 17 * * 1-5.
   • Verrà eseguito alle 17:00 ogni giorno dal lunedì al venerdì.
6. Per Fuso orario, seleziona il paese e il fuso orario che preferisci. Questo esempio utilizzerà United States e Los Angeles.
7. Fai clic su Continua.
8. In Tipo di target, seleziona Pub/Sub.
9. Seleziona stop-instance-event dal menu a discesa degli argomenti.
10. In Messaggio, inserisci quanto segue:

    {"zone":"us-west1-b","label":"env=dev"}
    

11. Fai clic su Crea.

gcloud

Crea il job di avvio.

gcloud scheduler jobs create pubsub startup-dev-instances \
    --schedule '0 9 * * 1-5' \
    --topic start-instance-event \
    --message-body '{"zone":"us-west1-b", "label":"env=dev"}' \
    --time-zone 'America/Los_Angeles' \
    --location us-central1

Crea il job di interruzione.

gcloud scheduler jobs create pubsub shutdown-dev-instances \
    --schedule '0 17 * * 1-5' \
    --topic stop-instance-event \
    --message-body '{"zone":"us-west1-b", "label":"env=dev"}' \
    --time-zone 'America/Los_Angeles' \
    --location us-central1

Nota: i job Cloud Scheduler vengono implementati nella regione selezionata al momento della creazione. La regione del job non può essere modificata.

(Facoltativo) Verifica il funzionamento dei job

Console

Arresta l'istanza

1. Vai alla pagina Cloud Scheduler nella console Google Cloud .
   Vai alla pagina Cloud Scheduler.
2. Per il job denominato shutdown-dev-instances, fai clic sul pulsante Esegui ora sul lato destro della pagina.
3. Nella console Google Cloud , vai alla pagina Istanze VM.
   Vai alla pagina Istanze VM.
4. Verifica che accanto al nome dell'istanza dev-instance sia presente un quadrato grigio, che indica che è stata arrestata. Potrebbero essere necessari fino a 30 secondi per completare l'arresto.

Avvia l'istanza

1. Vai alla pagina Cloud Scheduler nella console Google Cloud .
   Vai alla pagina Cloud Scheduler.
2. Per il job denominato startup-dev-instances, fai clic sul pulsante Esegui ora sul lato destro della pagina.
3. Nella console Google Cloud , vai alla pagina Istanze VM.
   Vai alla pagina Istanze VM.
4. Verifica che accanto al nome dell'istanza dev-instance sia presente un segno di spunta verde, che indica che è in esecuzione. L'avvio potrebbe richiedere fino a 30 secondi.

gcloud

Arresta l'istanza

1. Esegui il job dello scheduler per arrestare l'istanza.

   gcloud beta scheduler jobs run shutdown-dev-instances
   

2. Verifica che l'istanza abbia lo stato TERMINATED. Potrebbero essere necessari fino a 30 secondi per completare l'arresto.

   gcloud compute instances describe dev-instance \
       --zone us-west1-b \
       | grep status
   

   status: TERMINATED
   

Avvia l'istanza

1. Esegui il job dello scheduler per avviare l'istanza.

   gcloud beta scheduler jobs run startup-dev-instances
   

2. Verifica che l'istanza abbia lo stato RUNNING. L'avvio potrebbe richiedere fino a 30 secondi.

   gcloud compute instances describe dev-instance \
       --zone us-west1-b \
       | grep status
   

   status: RUNNING