Menjalankan skrip shutdown

Linux Windows

Buat dan jalankan skrip shutdown yang menjalankan perintah tepat sebelum instance virtual machine (VM) dihentikan atau dimulai ulang. Hal ini berguna jika Anda mengandalkan skrip otomatis untuk memulai dan mematikan instance, sehingga instance memiliki waktu untuk membersihkan atau melakukan tugas, seperti mengekspor log, atau menyinkronkan dengan sistem lain.

Skrip shutdown sangat berguna untuk VM dalam grup instance terkelola dengan autoscaler. Jika autoscaler menghentikan VM dalam grup, skrip shutdown akan berjalan sebelum VM berhenti dan skrip shutdown akan melakukan tindakan apa pun yang Anda tentukan. Skrip ini berjalan selama periode shutdown terbatas sebelum VM berhenti. Misalnya, skrip shutdown Anda mungkin menyalin data yang diproses ke Cloud Storage atau mencadangkan log apa pun.

Skrip shutdown memiliki fungsi yang sangat mirip dengan skrip startup. Banyak dokumentasi untuk skrip startup juga berlaku untuk skrip shutdown.

Untuk tugas shutdown dan mulai ulang, VM selalu menjalankan skrip shutdown sebagai berikut:

Untuk VM Linux, dengan menggunakan pengguna root.
Untuk VM Windows, dengan menggunakan akun System.

Sebelum memulai

Pelajari Skrip startup.
Pahami apa itu server metadata.
Siapkan autentikasi, jika Anda belum melakukannya. Autentikasi adalah proses verifikasi identitas Anda untuk akses ke layanan dan API Google Cloud. Untuk menjalankan kode atau contoh dari lingkungan pengembangan lokal, Anda dapat melakukan autentikasi ke Compute Engine sebagai berikut.

Pilih tab untuk melihat bagaimana Anda berencana menggunakan contoh di halaman ini:
Konsol

Saat menggunakan Konsol Google Cloud untuk mengakses API dan layanan Google Cloud, Anda tidak perlu menyiapkan autentikasi.
gcloud
1. Instal Google Cloud CLI, lalu initialize dengan menjalankan perintah berikut:
  gcloud init
  Catatan: Jika Anda telah menginstal gcloud CLI sebelumnya, pastikan Anda memiliki versi baru dengan menjalankan gcloud components update.
2. Menetapkan region dan zona default.
Terraform

Untuk menggunakan contoh Terraform di halaman ini dari lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.
1. Menginstal Google Cloud CLI.
2. Untuk initialize gcloud CLI, jalankan perintah berikut:
  gcloud init
3. Buat kredensial autentikasi lokal untuk Akun Google Anda:
  gcloud auth application-default login
Untuk informasi selengkapnya, lihat Siapkan autentikasi untuk lingkungan pengembangan lokal.
REST

Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.

Izin yang diperlukan untuk langkah ini

Untuk melakukan tugas ini, Anda harus memiliki izin berikut:

Semua izin yang diperlukan untuk membuat instance
compute.instances.setMetadata pada instance

Spesifikasi

Batasan

Ada beberapa batasan yang perlu diperhatikan saat menggunakan skrip shutdown:

Skrip shutdown memiliki waktu terbatas untuk selesai dijalankan sebelum instance berhenti:
- On-demand instance: 90 detik setelah Anda menghentikan atau menghapus instance
- Preemptible instance: 30 detik setelah preemption instance dimulai
Compute Engine menjalankan skrip shutdown hanya berdasarkan upaya terbaik. Dalam kasus yang jarang terjadi, Compute Engine tidak dapat menjamin bahwa skrip shutdown akan selesai.
Di Windows, Local Group Policy digunakan untuk meluncurkan skrip shutdown.
- Paket penginstalan mengonfigurasi setelan Local Group Policy Computer Configuration/Windows Setting/Scripts (Startup/Shutdown) untuk meluncurkan skrip setelah penonaktifan sistem.

Menghentikan pemanggilan skrip

Skrip shutdown dipicu oleh Peristiwa konfigurasi lanjutan dan antarmuka daya (ACPI) tertentu, seperti mulai ulang atau berhenti. Ada banyak cara untuk memulai ulang atau menghentikan instance, tetapi hanya beberapa cara yang dapat memicu skrip shutdown agar berjalan. Skrip shutdown dijalankan sebagai bagian dari tindakan berikut:

Saat instance dihentikan karena permintaan instances.delete atau permintaan instances.stop ke API.
Saat Compute Engine menghentikan preemptible instance sebagai bagian dari proses preemption.
Saat instance dihentikan melalui permintaan ke sistem operasi tamu, seperti sudo shutdown atau sudo reboot.
Saat Anda menghentikan instance secara manual melalui Konsol Google Cloud atau alat gcloud compute.

Skrip shutdown tidak akan berjalan jika instance direset menggunakan instances().reset.

Skrip shutdown dapat berupa jenis file apa pun. Jika ada skrip shutdown yang muncul, Compute Engine akan:

Menyalin skrip ke file lokal dalam instance.
Menetapkan izin pada file agar file tersebut dapat dieksekusi.
Menjalankan file saat instance dihentikan.

Misalnya, Anda dapat menyediakan skrip Python alih-alih skrip bash. Perlu diingat bahwa Compute Engine menjalankan skrip kata demi kata, apa pun jenis skripnya.

Untuk menjalankan skrip yang bukan merupakan bash, tambahkan baris shebang di bagian atas file untuk memberi tahu sistem operasi mana yang akan digunakan penafsir. Misalnya, untuk skrip Python, Anda dapat menambahkan baris Shebang seperti:

#!/usr/bin/python

Menghentikan waktu eksekusi skrip

Sebelum instance dihentikan atau dimulai ulang, skrip shutdown memiliki jangka waktu terbatas untuk dijalankan. Selama periode ini, Compute Engine akan mencoba menjalankan skrip shutdown Anda. Jika skrip membutuhkan waktu lebih lama dari jangka waktu ini untuk diselesaikan, instance akan otomatis berhenti dan semua tugas yang berjalan akan berakhir. Jika Anda mematikan atau memulai ulang instance dengan membuat permintaan ke sistem operasi tamu menggunakan perintah sudo shutdown, batas ini tidak akan berlaku.

Durasi periode shutdown berbeda-beda bergantung pada jenis instance. Preemptible instance memiliki periode shutdown yang lebih singkat daripada instance biasanya. Untuk mengetahui informasi selengkapnya tentang batas waktu shutdown pada setiap jenis instance, lihat Periode shutdown.

Secara umum, skrip shutdown Anda harus selesai berjalan dalam periode shutdown agar sistem operasi memiliki waktu untuk menyelesaikan proses shutdown dan menghapus buffer ke disk.

Menggunakan skrip shutdown lokal

Skrip shutdown lokal adalah skrip yang ada di komputer lokal Anda. Teruskan skrip shutdown lokal sebagai file atau dengan memberikan kontennya secara langsung ke Compute Engine.

Skrip shutdown dapat melakukan tindakan sebanyak yang Anda butuhkan, tetapi jika Anda meneruskan file secara lokal, skrip Anda tidak boleh melebihi batas panjang nilai metadata sebesar 256 KB. Untuk menggunakan skrip yang melebihi batas panjang, simpan file Anda di Cloud Storage. Lihat Menggunakan skrip shutdown dari Cloud Storage untuk informasi lebih lanjut.

Memberikan file skrip shutdown

Anda hanya dapat meneruskan file skrip shutdown lokal melalui alat command line gcloud.

gcloud

Untuk meneruskan file skrip shutdown lokal, berikan flag --metadata-from-file, diikuti dengan pasangan kunci metadata, shutdown-script=PATH/TO/FILE, dengan PATH/TO/FILE sebagai jalur relatif ke skrip shutdown. Contoh:

gcloud compute instances create example-instance \
    --metadata-from-file shutdown-script=examples/scripts/install.sh

Terraform

Untuk menentukan skrip shutdown secara langsung, gunakan resource google_compute_instance dengan jalur ke skrip shutdown di metadata.

resource "google_compute_instance" "shutdown_content_from_file" {
  name         = "instance-name-shutdown-content-from-file"
  machine_type = "f1-micro"
  zone         = "us-central1-c"
  metadata = {
    # Shuts down Apache server
    shutdown-script = file("${path.module}/shutdown-script.sh")
  }
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }
  network_interface {
    # A default network is created for all Google Cloud projects
    network = "default"
    access_config {
    }
  }
}

Menyediakan konten skrip shutdown secara langsung

Atau, Anda dapat meneruskan konten skrip shutdown secara langsung.

Konsol

Di Konsol Google Cloud, tentukan skrip shutdown secara langsung menggunakan kunci metadata shutdown-script:

Buka halaman Create an instance.

Buka Create an instance
Tentukan detail VM.
Luaskan bagian Advanced options.
Luaskan Management, dan lakukan tindakan berikut:
1. Di bagian Metadata, klik Add item.
2. Di kolom Key, masukkan shutdown-script untuk kunci metadata.
3. Di kolom Value, tambahkan konten skrip shutdown Anda.
Lanjutkan dengan proses pembuatan VM.

gcloud

Dengan menggunakan Google Cloud CLI, gunakan flag --metadata untuk memberikan isi skrip shutdown Anda, diikuti dengan pasangan kunci shutdown-script=CONTENTS, dengan CONTENTS sebagai konten skrip shutdown Anda.

gcloud compute instances create example-instance --metadata shutdown-script="#! /bin/bash
> # Shuts down Apache server
> /etc/init.d/apache2 stop"

Terraform

Untuk menentukan skrip shutdown secara langsung, gunakan resource google_compute_instance dengan skrip shutdown di metadata.

resource "google_compute_instance" "default" {
  name         = "instance-name-shutdown-content-directly"
  machine_type = "f1-micro"
  zone         = "us-central1-c"
  metadata = {
    # Shuts down Apache server
    shutdown-script = "#! /bin/bash /etc/init.d/apache2 stop"
  }
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }
  network_interface {
    # A default network is created for all Google Cloud projects
    network = "default"
    access_config {
    }
  }
}

REST

Di API, berikan skrip shutdown sebagai bagian dari properti metadata dalam permintaan saat Anda membuat instance. Gunakan shutdown-script sebagai kunci metadata:

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances

{...
  "metadata": {
    "items": [
      {
       "key": "shutdown-script",
       "value": "#! /bin/bash\n\n# Shuts down Apache server\n/etc/init.d/apache2 stop"
      }
    ]
  }...
}

Menyediakan skrip shutdown pada instance Windows

Jalankan skrip shutdown pada instance Windows menggunakan kunci metadata khusus Windows berikut. Pilih dari salah satu tombol khusus yang tercantum di bawah. Setiap kunci harus cocok dengan jenis skrip yang ingin dijalankan.

Anda dapat menentukan beberapa skrip shutdown dengan meneruskan kunci yang berbeda ke instance, tetapi setiap kunci hanya dapat ditentukan sekali per virtual machine.

Kunci berikut dapat digunakan dengan skrip shutdown lokal, menggunakan petunjuk yang sama di atas.

Skrip shutdown `cmd`	Skrip shutdown `bat`	Skrip shutdown `ps1`
`windows-shutdown-script-cmd`	`windows-shutdown-script-bat`	`windows-shutdown-script-ps1`

Menggunakan skrip shutdown dari Cloud Storage

Anda dapat menyimpan dan menggunakan skrip shutdown dari Cloud Storage. Ikuti petunjuk dalam dokumentasi Skrip startup, tetapi ganti startup-script-url dengan shutdown-script-url.

Untuk instance Windows, ganti windows-startup-script-url dengan windows-shutdown-script-url.

Menerapkan skrip shutdown ke instance yang sedang berjalan

Untuk menambahkan skrip shutdown ke instance yang sedang berjalan, ikuti petunjuk dalam dokumentasi Menerapkan skrip startup ke instance yang berjalan, tetapi ganti kunci metadata dengan salah satu kunci berikut:

shutdown-script: Menyediakan konten skrip shutdown secara langsung dengan kunci ini. Dengan Google Cloud CLI, Anda dapat memberikan jalur ke file skrip shutdown, menggunakan flag --metadata-from-file dan kunci metadata shutdown-script.
shutdown-script-url: Menyediakan URL Cloud Storage ke file skrip shutdown dengan kunci ini.

Melihat output skrip shutdown

Linux

Anda dapat melihat output dari skrip shutdown Linux dengan melakukan salah satu hal berikut:

Menghubungkan ke instance dan menjalankan perintah berikut:
```
sudo journalctl -u google-shutdown-scripts.service
```
Melihat output melalui port serial 1 di Konsol Google Cloud dan memeriksa peristiwa google_metadata_script_runner.
Desktop IAP dari workstation Windows. Untuk mengetahui informasi selengkapnya, lihat repositori GoogleCloudPlatform/iap-desktop di GitHub.

Windows

Lihat output dari skrip shutdown Windows Server menggunakan salah satu dari yang berikut dan memeriksa peristiwa GCEMetadataScripts:

Port serial 1 di Konsol Google Cloud. Untuk informasi selengkapnya, lihat Melihat output port serial.
Log Aplikasi Penampil Acara Windows.
Desktop IAP dari workstation Windows. Untuk mengetahui informasi selengkapnya, lihat repositori GoogleCloudPlatform/iap-desktop di GitHub.