cfn-hup - AWS CloudFormation
SintaksisOpsifile konfigurasi cfn-hup.confhooks.confberkas konfigurasihooks.ddirektoriContohSumber daya terkait

Ini adalah Panduan Referensi AWS CloudFormation Template baru. Harap perbarui bookmark dan tautan Anda. Untuk bantuan memulai CloudFormation, lihat Panduan AWS CloudFormation Pengguna.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

cfn-hup

cfn-hupHelper adalah daemon yang mendeteksi perubahan dalam metadata sumber daya dan menjalankan tindakan yang ditentukan pengguna saat perubahan terdeteksi. Ini memungkinkan Anda membuat pembaruan konfigurasi pada EC2 instans Amazon yang sedang berjalan melalui tindakan UpdateStack API.

Sintaksis

cfn-hup --config|-c config.dir \
        --no-daemon \
        --verbose|-v

Opsi

Nama Deskripsi Wajib

--config|-c config.dir

Menentukan jalur yang cfn-hup script mencari cfn-hup.conf dan hooks.d direktori. Di Windows, jalur default-nya adalah system_drive\cfn. Di Linux, jalur default-nya adalah /etc/cfn.

Tidak

--no-daemon

Tentukan opsi ini untuk menjalankan cfn-hup skrip sekali dan keluar.

Tidak

-v, --verbose

Tentukan opsi ini untuk menggunakan mode verbose.

Tidak

file konfigurasi cfn-hup.conf

cfn-hup.confFile menyimpan nama tumpukan dan AWS kredensil yang ditargetkan cfn-hup daemon.

cfn-hup.confFile menggunakan format berikut:

[main]
stack=<stack-name-or-id>
Nama Deskripsi Wajib

stack

Nama atau ID tumpukan.

Tipe: String

Ya

credential-file

File kredensial khusus pemilik, dalam format yang sama yang digunakan untuk alat baris perintah.

Tipe: String

Syarat: Parameter role menggantikan parameter ini.

Tidak

role

Nama peran IAM yang terkait dengan instance.

Tipe: String

Tidak

region

Nama yang Wilayah AWS berisi tumpukan.

Contoh

Tidak

umask

Yang umask digunakan oleh cfn-hup daemon.

Nilai ini dapat ditentukan dengan atau tanpa awalan 0. Dalam kedua kasus, itu ditafsirkan sebagai angka oktal (mirip dengan umask perintah Linux). Parameter ini tidak berpengaruh pada Windows.

Jenis: Bilangan bulat oktal antara 0 dan 0777

Default:022, versi 1.4—22 dan lebih tinggi. Nilai default dari grup 022 mask dan izin penulisan dunia, sehingga file yang dibuat oleh cfn-hup daemon tidak dapat ditulisi grup atau dunia secara default. Nilai default untuk versi 1.4 —21 dan sebelumnya adalah0, yang tidak menutupi apa pun.

Tidak

interval

Interval yang digunakan untuk memeriksa perubahan metadata sumber daya dalam hitungan menit.

Tipe: Integer

Default: 15

Tidak

verbose

Menentukan apakah akan menggunakan pencatatan verbose.

Jenis: Boolean

Default: false

Tidak

hooks.confberkas konfigurasi

Tindakan pengguna yang dipanggil cfn-hup daemon secara berkala ditentukan dalam file hooks.conf konfigurasi. hooks.confFile menggunakan format berikut:

[hookname]
triggers=post.add or post.update or post.remove
path=Resources.<logicalResourceId> (.Metadata or .PhysicalResourceId)(.<optionalMetadatapath>)
action=<arbitrary shell command>
runas=<runas user>

Ketika operasi dijalankan, itu dijalankan dalam salinan lingkungan saat ini (yang cfn-hup ada di), dengan CFN_OLD_METADATA disetel ke nilai metadata sebelumnya yang ditentukan oleh jalur, dan CFN_NEW_METADATA disetel ke nilai saat ini.

File konfigurasi hook dimuat saat cfn-hup daemon start up saja, jadi kait baru akan memerlukan daemon untuk di-restart. Cache nilai metadata sebelumnya disimpan di /var/lib/cfn-hup/data/metadata_db — Anda dapat menghapus cache ini cfn-hup untuk memaksa menjalankan semua post.add tindakan lagi.

Nama Deskripsi Wajib

hookname

Nama unik untuk kait ini.

Tipe: String

Ya

triggers

Daftar syarat yang dipisahkan koma untuk dideteksi.

Nilai yang valid: post.add, post.update, atau post.remove

Contoh: post.add, post.update

Ya

path

Jalur ke objek metadata. Mendukung jalur dalam yang berubah-ubah di dalam blok Metadata.

Opsi format jalur

  • Sumber daya. <LogicalResourceId>— pantau waktu terakhir yang diperbarui dari sumber daya, memicu perubahan apa pun pada sumber daya.

  • Sumber daya. <LogicalResourceId>. PhysicalResourceId— memantau ID fisik sumber daya, memicu hanya ketika identitas sumber daya terkait berubah (seperti EC2 contoh baru).

  • Sumber daya. <LogicalResourceId>.Metadata (.optional path) — memantau metadata sumber daya untuk perubahan (subpath metadata dapat ditentukan ke tingkat dalam yang sewenang-wenang untuk memantau nilai tertentu).

Ya

action

Perintah shell berubah-ubah yang dijalankan seperti yang diberikan.

Ya

runas

Seorang pengguna untuk menjalankan perintah sebagai. cfn-hupmenggunakan perintah su untuk beralih ke pengguna.

Ya

hooks.ddirektori

Untuk mendukung komposisi beberapa aplikasi yang menggunakan kait pemberitahuan perubahan, cfn-hup mendukung direktori bernama hooks.d yang terletak di direktori konfigurasi kait. Anda dapat menempatkan satu atau lebih file konfigurasi kait tambahan di hooks.d direktori. File kait tambahan harus menggunakan tata letak yang sama dengan hooks.conf file.

cfn-hupDaemon mem-parsing dan memuat setiap file dalam direktori ini. Jika ada kait di hooks.d direktori yang memiliki nama yang sama dengan hook inhooks.conf, kait akan digabungkan (artinya hooks.d akan hooks.conf menimpa nilai apa pun yang ditentukan oleh kedua file).

Contoh

Dalam contoh berikut, CloudFormation memicu file cfn-auto-reloader.conf kait saat Anda mengubah AWS::CloudFormation::Init sumber daya yang terkait dengan sumber daya. LaunchConfig

JSON

...
    "LaunchConfig": {
      "Type" : "AWS::AutoScaling::LaunchConfiguration",
      "Metadata" : {
        "QBVersion": {"Ref": "paramQBVersion"},
        "AWS::CloudFormation::Init" : {
...
              "/etc/cfn/hooks.d/cfn-auto-reloader.conf": {
                "content": { "Fn::Join": [ "", [
                  "[cfn-auto-reloader-hook]\n",
                  "triggers=post.update\n",
                  "path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init\n",
                  "action=/opt/aws/bin/cfn-init -v ",
                          "         --stack ", { "Ref" : "AWS::StackName" },
                          "         --resource LaunchConfig ",
                          "         --configsets wordpress_install ",
                          "         --region ", { "Ref" : "AWS::Region" }, "\n",
                  "runas=root\n"
                ]]},          
                "mode"  : "000400",
                "owner" : "root",
                "group" : "root"
              }
...

YAML

...
  LaunchConfig:
    Type: "AWS::AutoScaling::LaunchConfiguration"
    Metadata:
      QBVersion: !Ref paramQBVersion
      AWS::CloudFormation::Init:
...
            /etc/cfn/hooks.d/cfn-auto-reloader.conf:
              content: !Sub |
                [cfn-auto-reloader-hook]
                triggers=post.update
                path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init
                action=/opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --configsets wordpress_install --region ${AWS::Region}
                runas=root
              mode: "000400"
              owner: "root"
              group: "root"
...

Anda juga dapat mengunjungi GitHub repositori kami untuk mengunduh contoh templat yang digunakancfn-hup, termasuk templat berikut.