Template

Perhatian: Ini adalah versi Deployment Manager API yang tidak digunakan lagi. Sebagai gantinya, gunakan versi API terbaru.

Merepresentasikan resource Template, yang menentukan setelan untuk deployment Anda.

Untuk mengetahui daftar metode untuk resource ini, lihat bagian akhir halaman ini.

Representasi resource

Template merepresentasikan konfigurasi lengkap untuk Deployment.

{
  "name": string,
  "description": string,
  "modules": {
    (key): {
      "type": string,
      "healthCheckModule": {
        "host": string,
        "path": string,
        "port": integer,
        "checkIntervalSec": integer,
        "timeoutSec": integer,
        "unhealthyThreshold": integer,
        "healthyThreshold": integer,
        "description": string
      },
      "lbModule": {
        "targetModules": [
          string
        ],
        "ipProtocol": string,
        "healthChecks": [
          string
        ],
        "ipAddress": string,
        "portRange": string,
        "description": string
      },
      "replicaPoolModule": {
        "numReplicas": integer,
        "envVariables": {
          (key): {
            "value": string,
            "hidden": boolean
          }
        },
        "resourceView": string,
        "replicaPoolParams": {
          "v1beta1": {
            "machineType": string,
            "zone": string,
            "baseInstanceName": string,
            "serviceAccounts": [
              {
                "email": string,
                "scopes": [
                  string
                ]
              }
            ],
            "description": string,
            "tags": {
              "fingerPrint": string,
              "items": [
                string
              ]
            },
            "networkInterfaces": [
              {
                "name": string,
                "network": string,
                "networkIp": string,
                "accessConfigs": [
                  {
                    "name": string,
                    "type": string,
                    "natIp": string
                  }
                ]
              }
            ],
            "metadata": {
              "fingerPrint": string,
              "items": [
                {
                  "key": string,
                  "value": string
                }
              ]
            },
            "canIpForward": boolean,
            "autoRestart": boolean,
            "initAction": string,
            "onHostMaintenance": string,
            "disksToCreate": [
              {
                "boot": boolean,
                "autoDelete": boolean,
                "attachment": {
                  "deviceName": string,
                  "index": unsigned integer
                },
                "initializeParams": {
                  "sourceImage": string,
                  "diskSizeGb": long
                }
              }
            ],
            "disksToAttach": [
              {
                "source": string,
                "attachment": {
                  "deviceName": string,
                  "index": unsigned integer
                }
              }
            ]
          }
        },
        "healthChecks": [
          string
        ]
      },
      "autoscalingModule": {
        "minNumReplicas": integer,
        "maxNumReplicas": integer,
        "signalType": string,
        "targetUtilization": double,
        "targetModule": string,
        "description": string,
        "coolDownPeriodSec": integer
      },
      "firewallModule": {
        "description": string,
        "network": string,
        "sourceRanges": [
          string
        ],
        "sourceTags": [
          string
        ],
        "targetTags": [
          string
        ],
        "allowed": [
          {
            "IPProtocol": string,
            "ports": [
              string
            ]
          }
        ]
      },
      "networkModule": {
        "description": string,
        "IPv4Range": string,
        "gatewayIPv4": string
      }
    }
  },
  "actions": {
    (key): {
      "commands": [
        string
      ],
      "timeoutMs": integer
    }
  }
}
Nama properti Nilai Deskripsi Catatan
actions object Tindakan yang ditentukan untuk digunakan dalam modul yang ditentukan oleh template ini.
actions.(key) nested object Nama tindakan ini, yang digunakan saat menentukan Tindakan dalam definisi Modul.
actions.(key).commands[] list Daftar perintah yang akan dijalankan secara berurutan untuk tindakan ini.
actions.(key).timeoutMs integer Waktu tunggu dalam milidetik untuk menjalankan tindakan ini.
description string Deskripsi template ini.
modules object Daftar modul untuk template ini.
modules.(key) nested object Nama modul. Nama harus sesuai dengan ekspresi reguler berikut: [a-zA-Z0-9-_]{1,64}
modules.(key).autoscalingModule nested object Menentukan modul penskalaan otomatis.
modules.(key).autoscalingModule.coolDownPeriodSec integer Jumlah detik yang harus ditunggu oleh autoscaler di antara dua perubahan berturut-turut pada jumlah virtual machine. Anda harus menentukan interval yang setidaknya sama panjangnya dengan waktu inisialisasi virtual machine. Defaultnya adalah 5 detik.
modules.(key).autoscalingModule.description string Deskripsi opsional untuk modul penskalaan otomatis ini.
modules.(key).autoscalingModule.maxNumReplicas integer Jumlah maksimum replika yang ingin Anda skalakan secara otomatis.
modules.(key).autoscalingModule.minNumReplicas integer Jumlah minimum replika yang ingin Anda skalakan secara otomatis.
modules.(key).autoscalingModule.signalType string Sinyal yang harus digunakan Deployment Manager untuk menentukan apakah penskalaan otomatis diperlukan.

Nilai yang dapat diterima adalah:
  • "AVG_CPU": Menggunakan CPU rata-rata modul kumpulan replika target untuk menentukan kapan harus diskalakan.
modules.(key).autoscalingModule.targetModule string Modul kumpulan replika target yang akan diskalakan.
modules.(key).autoscalingModule.targetUtilization double Target pemanfaatan, antara (0, 1]. Autoscaler berfungsi untuk mempertahankan nilai sinyal yang Anda inginkan (saat ini, hanya CPU rata-rata) pada sekitar tingkat target ini. Misalnya, jika CPU rata-rata replika Anda jauh di bawah penggunaan target, autoscaler akan menskalakan ke bawah, hingga mencapai penggunaan target atau jumlah minimum replika. Jika CPU rata-rata di atas jumlah ini, autoscaler akan diskalakan hingga mencapai penggunaan target atau jumlah maksimum resource.
modules.(key).firewallModule nested object Membuat modul firewall, yang setara dengan Resource firewall Google Compute Engine.
modules.(key).firewallModule.allowed[] quilist Menentukan port dan protokol yang diizinkan untuk firewall ini.
modules.(key).firewallModule.allowed[].IPProtocol string Protokol IP yang diizinkan untuk modul Firewall ini. Dapat berupa tcp,udp, atau icmp atau nomor protokol IP.
modules.(key).firewallModule.allowed[].ports[] list Daftar port atau rentang port yang diizinkan (Contoh input meliputi: ["22"], [?33?, "12345-12349"].
modules.(key).firewallModule.description string Deskripsi firewall.
modules.(key).firewallModule.network string Modul Jaringan tempat firewall ini akan diterapkan. Jika tidak ditentukan, atau jika ditentukan sebagai default, firewall ini akan diterapkan ke jaringan default .
modules.(key).firewallModule.sourceRanges[] list Blok alamat IP yang menjadi sasaran aturan ini, dinyatakan dalam format CIDR. Salah satu atau kedua sourceRanges dan sourceTags dapat ditetapkan. Koneksi masuk diizinkan jika rentang atau tag sumber cocok dengan sourceRanges atau sourceTags.
modules.(key).firewallModule.sourceTags[] list Daftar tag instance yang menjadi sasaran aturan ini. Salah satu atau kedua sourceRanges dan sourceTags dapat ditetapkan. Koneksi masuk diizinkan jika rentang atau tag sumber cocok dengan sourceRanges atau sourceTags.
modules.(key).firewallModule.targetTags[] list  Daftar tag instance yang menunjukkan kumpulan instance yang berada di jaringan yang dapat membuat koneksi jaringan seperti yang ditentukan dalam allowed[]. Jika tidak ada targetTags yang ditentukan, aturan firewall akan berlaku untuk semua instance di jaringan yang ditentukan.
modules.(key).healthCheckModule nested object Menentukan modul health check yang akan digunakan untuk load balancing.
modules.(key).healthCheckModule.checkIntervalSec integer Menetapkan interval dalam detik untuk melakukan health check. Defaultnya adalah 5 detik.
modules.(key).healthCheckModule.description string Deskripsi modul health check ini.
modules.(key).healthCheckModule.healthyThreshold integer Menentukan jumlah percobaan ulang yang berhasil sebelum instance virtual machine yang tidak responsif ditandai sebagai responsif. Defaultnya adalah 2.
modules.(key).healthCheckModule.host string Nilai header host yang digunakan dalam permintaan health check ini. Misalnya, jika Anda menayangkan halaman web dari instance yang menggunakan domain www.domainsaya.com, sebaiknya tetapkan nama host sebagai www.domainsaya.com agar pemeriksaan status untuk host tersebut dilakukan. 

Secara default, kolom ini kosong dan Google Compute Engine akan otomatis menetapkan header host dalam permintaan kesehatan ke alamat IP eksternal yang sama dengan aturan penerusan yang terkait dengan kumpulan target ini. Misalnya, jika modul load balancing memiliki alamat IP eksternal 1.2.3.4 dan mengarahkan traffic ke kumpulan modul target bernama tp1 yang memiliki objek health check dengan setelan host default, header host akan ditetapkan ke 1.2.3.4.
modules.(key).healthCheckModule.path string Jalur permintaan untuk health check ini. Misalnya, /healthcheck. Nilai defaultnya adalah /
modules.(key).healthCheckModule.port integer Nomor port TCP untuk permintaan health check ini. Nilai defaultnya adalah 80.
modules.(key).healthCheckModule.timeoutSec integer Jika Google Compute Engine tidak menerima respons HTTP 200 dari instance pada timeoutSec, permintaan health check dianggap gagal. Defaultnya adalah 5 detik.
modules.(key).healthCheckModule.unhealthyThreshold integer Menentukan jumlah percobaan ulang yang berhasil sebelum instance virtual machine yang responsif ditandai sebagai tidak responsif. Defaultnya adalah 2.
modules.(key).lbModule nested object Menentukan modul load balancing.
modules.(key).lbModule.description string Deskripsi modul load balancing ini.
modules.(key).lbModule.healthChecks[] list Daftar health check yang akan digunakan untuk modul load balancing ini.
modules.(key).lbModule.ipAddress string IP statis eksternal yang dilayani oleh aturan penerusan ini. Ini dapat berupa IP statis yang dicadangkan, atau jika dibiarkan kosong atau tidak ditentukan, alamat IP sementara akan ditetapkan secara default. Beberapa aturan penerusan dapat menggunakan alamat IP yang sama selama rentang port dan protokolnya tidak tumpang-tindih. Misalnya, --ip="1.2.3.106".
modules.(key).lbModule.ipProtocol string Protokol yang ditangani modul load balancing ini. 

Nilai yang dapat diterima adalah:
modules.(key).lbModule.portRange string Daftar port yang menjadi tanggung jawab load balancer ini. Paket protokol yang ditentukan yang dikirim ke port ini akan diteruskan ke kumpulan target yang sesuai. Jika kolom ini dibiarkan kosong, load balancer akan mengirim traffic untuk semua port untuk protokol yang ditentukan. Dapat berupa satu port, atau rentang port.
modules.(key).lbModule.targetModules[] list Menentukan modul target yang menangani traffic dari load balancer ini. Modul traffic berisi satu atau beberapa instance virtual machine yang akan menerima traffic yang dikirim ke load balancer ini. 
modules.(key).networkModule nested object Menentukan modul Jaringan.
modules.(key).networkModule.IPv4Range string Rentang alamat internal yang sah di jaringan ini. Rentang ini adalah spesifikasi CIDR, misalnya: 192.168.0.0/16.
modules.(key).networkModule.description string Deskripsi jaringan.
modules.(key).networkModule.gatewayIPv4 string Alamat opsional yang digunakan untuk pemilihan rute default ke jaringan lain. Alamat ini harus berada dalam rentang yang ditentukan oleh IPv4Range, dan biasanya merupakan alamat pertama yang dapat digunakan dalam rentang tersebut. Jika tidak ditentukan, nilai defaultnya adalah alamat pertama yang dapat digunakan di IPv4Range.
modules.(key).replicaPoolModule nested object Menentukan modul kumpulan replika, yang membuat instance virtual machine Compute Engine.
modules.(key).replicaPoolModule.envVariables object Daftar variabel lingkungan.
modules.(key).replicaPoolModule.envVariables.(key) nested object Nama variabel lingkungan. Nama harus sesuai dengan ekspresi reguler berikut: [a-zA-Z_]+[a-zA-Z0-9_]+.
modules.(key).replicaPoolModule.envVariables.(key).hidden boolean Apakah variabel ini disembunyikan atau terlihat.
modules.(key).replicaPoolModule.envVariables.(key).value string Nilai variabel lingkungan.
modules.(key).replicaPoolModule.healthChecks[] list Daftar health check yang akan digunakan untuk modul kumpulan replika ini.
modules.(key).replicaPoolModule.numReplicas integer Jumlah replika dalam modul ini.
modules.(key).replicaPoolModule.replicaPoolParams nested object Informasi untuk ReplicaPoolModule.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1 nested object Spesifikasi ReplicaPoolParams untuk digunakan dengan ReplicaPools v1beta1.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.autoRestart boolean Apakah replika ini harus dimulai ulang jika mengalami kegagalan. Nilai defaultnya adalah true.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.baseInstanceName string Nama dasar untuk instance dalam ReplicaPool ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.canIpForward boolean Mengaktifkan Penerusan IP.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.description string Deskripsi tekstual opsional tentang resource.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToAttach[] list Daftar resource Disk Persisten yang ada untuk dilampirkan ke setiap replika dalam kumpulan. Setiap disk akan dipasang dalam mode hanya baca ke setiap replika.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToAttach[].attachment nested object Opsional. Cara disk akan dilampirkan ke Replika.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToAttach[].attachment.deviceName string Nama perangkat disk ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToAttach[].attachment.index unsigned integer Indeks berbasis nol yang akan ditetapkan ke disk ini, dengan 0 dicadangkan untuk disk booting. Jika tidak ditentukan, nilai ini akan ditetapkan oleh server.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToAttach[].source string URL yang sepenuhnya memenuhi syarat dari resource Persistent Disk. File ini harus berada di zona yang sama dengan Tampungan.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[] list Daftar resource Disk yang akan dibuat dan dilampirkan ke setiap Replika di Kumpulan. Saat ini, Anda hanya dapat menentukan satu disk dan harus berupa persistent disk root. Perhatikan bahwa Replica Pool akan membuat disk persisten root untuk setiap replika.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].attachment nested object Cara disk akan dilampirkan ke Replika.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].attachment.deviceName string Nama perangkat disk ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].attachment.index unsigned integer Indeks berbasis nol yang akan ditetapkan ke disk ini, dengan 0 dicadangkan untuk disk booting. Jika tidak ditentukan, nilai ini ditetapkan oleh server.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].autoDelete boolean Jika true, disk ini akan dihapus saat instance dihapus.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].boot boolean Jika true, menunjukkan bahwa ini adalah persistent disk root.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].initializeParams nested object Buat disk baru menggunakan parameter ini. Nama disk akan menjadi <instance_name>-<five_random_characters>.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].initializeParams.diskSizeGb long Ukuran disk yang dibuat dalam gigabyte.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.disksToCreate[].initializeParams.sourceImage string Nama atau URL yang sepenuhnya memenuhi syarat dari image sumber yang akan digunakan untuk membuat disk ini. Jika Anda memberikan nama image sumber, modul ReplicaPool akan mencari image dengan nama tersebut di project Anda. Jika menentukan image yang disediakan oleh Compute Engine, Anda harus memberikan URL lengkap dengan project yang benar, seperti:
https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/debian-wheezy-7-vYYYYMMDD
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.initAction string Nama Tindakan yang akan dijalankan selama inisialisasi ReplicaPoolModule.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.machineType string Jenis mesin untuk instance ini. URL lengkap, atau nama resource (misalnya, n1-standard-1).
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.metadata nested object Pasangan nilai kunci metadata yang ditetapkan ke instance ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.metadata.fingerPrint string Sidik jari metadata.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.metadata.items[] list Daftar item metadata.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.metadata.items[].key string Kunci metadata.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.metadata.items[].value string Nilai metadata.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[] list Daftar antarmuka jaringan untuk instance. Saat ini, hanya satu antarmuka yang didukung oleh Google Compute Engine.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].accessConfigs[] list Array konfigurasi untuk antarmuka ini. Ini menentukan cara antarmuka ini dikonfigurasi untuk berinteraksi dengan layanan jaringan lainnya
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].accessConfigs[].name string Nama konfigurasi akses ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].accessConfigs[].natIp string Alamat IP eksternal yang dikaitkan dengan instance ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].accessConfigs[].type string Jenis file konfigurasi akses ini. (Saat ini hanya ONE_TO_ONE_NAT yang sah.)
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].name string Nama antarmuka.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].network string Nama NetworkModule yang diterapkan antarmuka ini. Jika tidak ditentukan, atau ditentukan sebagai 'default', jaringan 'default' akan digunakan.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.networkInterfaces[].networkIp string Alamat jaringan internal IPV4 opsional yang akan ditetapkan ke instance untuk antarmuka jaringan ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.onHostMaintenance string Menetapkan perilaku pemeliharaan untuk instance dalam kumpulan replika ini. 

Nilai yang dapat diterima adalah:
  • "MIGRATE": Memigrasikan instance dari peristiwa pemeliharaan tanpa memulai ulang instance.
  • "TERMINATE": Menghentikan dan memulai ulang instance di luar peristiwa pemeliharaan.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.serviceAccounts[] list Daftar Akun Layanan yang akan diaktifkan untuk instance ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.serviceAccounts[].email string Alamat email akun layanan.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.serviceAccounts[].scopes[] list Daftar cakupan OAuth2 yang akan diperoleh untuk akun layanan.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.tags nested object Daftar tag yang akan diterapkan ke instance Google Compute Engine untuk mengidentifikasi resource.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.tags.fingerPrint string Sidik jari tag.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.tags.items[] list Item yang terdapat dalam tag ini.
modules.(key).replicaPoolModule.replicaPoolParams.v1beta1.zone string Zona untuk ReplicaPool ini.
modules.(key).replicaPoolModule.resourceView string [Output Only] Nama tampilan resource yang terkait dengan
modul kumpulan replika. Kolom ini dibuat oleh layanan.
 
modules.(key).type string Jenis modul ini>.

Nilai yang dapat diterima adalah:
  • "AUTOSCALING": Membuat modul penskalaan otomatis
  • "FIREWALL": Membuat modul firewall.
  • "HEALTH_CHECK": Membuat modul health check.
  • "LOAD_BALANCING": Membuat modul load balancing.
  • "NETWORK": Membuat modul jaringan.
  • "REPLICA_POOL": Membuat modul kumpulan replika.
name string Nama template ini. Nama harus sesuai dengan ekspresi: [a-zA-Z0-9-_]{1,64}

Metode

delete
Menghapus template. Tindakan ini akan menghapus template dari project Anda. Menghapus template tidak memengaruhi deployment apa pun yang dibuat dari template ini.
get
Mendapatkan informasi mendetail tentang template.
insert
Menyisipkan template. Menyisipkan template tidak akan membuat resource apa pun. Anda masih perlu membuat deployment dengan template sebelum resource fisik dibuat.
list
Mencantumkan semua template dalam project.