Apa isi template terkelola?Prasyarat Tindakan jarak jauh template terkelola dan dokumen pekerjaan

Gunakan templat AWS terkelola untuk menerapkan operasi jarak jauh yang umum

AWS template terkelola adalah template pekerjaan yang disediakan oleh AWS. Mereka digunakan untuk tindakan jarak jauh yang sering dilakukan seperti me-reboot, mengunduh file, atau menginstal aplikasi di perangkat Anda. Template ini memiliki dokumen pekerjaan yang telah ditentukan untuk setiap tindakan jarak jauh sehingga Anda tidak perlu membuat dokumen pekerjaan Anda sendiri.

Anda dapat memilih dari satu set konfigurasi yang telah ditentukan dan membuat pekerjaan menggunakan template ini tanpa menulis kode tambahan apa pun. Dengan menggunakan templat terkelola, Anda dapat melihat dokumen pekerjaan yang disebarkan ke armada Anda. Anda dapat membuat pekerjaan menggunakan template ini dan membuat template pekerjaan khusus yang dapat Anda gunakan kembali untuk operasi jarak jauh Anda.

Apa isi template terkelola?

Setiap template yang AWS dikelola berisi:

Lingkungan untuk menjalankan perintah dalam dokumen pekerjaan.
Dokumen pekerjaan yang menentukan nama operasi dan parameternya. Misalnya, jika Anda menggunakan templat file Unduh, nama operasinya adalah Unduh file dan parameternya dapat berupa:
- URL file yang ingin Anda unduh ke perangkat Anda. Ini bisa berupa sumber daya internet atau URL Amazon Simple Storage Service ((Amazon S3) publik atau yang telah ditandatangani sebelumnya.
- Jalur file lokal pada perangkat untuk menyimpan file yang diunduh.
Untuk informasi lebih lanjut tentang dokumen pekerjaan dan parameternya, lihatTindakan jarak jauh template terkelola dan dokumen pekerjaan.

Prasyarat

Agar perangkat dapat menjalankan tindakan jarak jauh yang ditentukan oleh dokumen pekerjaan templat terkelola, Anda harus:

Instal perangkat lunak tertentu di perangkat Anda

Gunakan perangkat lunak perangkat Anda sendiri dan penangan pekerjaan, atau Klien AWS IoT Perangkat. Tergantung pada kasus bisnis Anda, Anda juga dapat menjalankan keduanya sehingga mereka melakukan fungsi yang berbeda.
- Gunakan perangkat lunak perangkat Anda sendiri dan penangan pekerjaan
  
  Anda dapat menulis kode Anda sendiri untuk perangkat dengan menggunakan AWS IoT Device SDK dan perpustakaan penangan yang mendukung operasi jarak jauh. Untuk menerapkan dan menjalankan pekerjaan, verifikasi bahwa pustaka agen perangkat telah diinstal dengan benar dan berjalan di perangkat.
  
  Anda juga dapat memilih untuk menggunakan penangan Anda sendiri yang mendukung operasi jarak jauh. Untuk informasi selengkapnya, lihat Contoh penangan pekerjaan di GitHub repositori Klien AWS IoT Perangkat.
- Gunakan Klien AWS IoT Perangkat
  
  Atau, Anda dapat menginstal dan menjalankan AWS IoT Device Client di perangkat Anda karena mendukung penggunaan semua template terkelola langsung dari konsol secara default.
  
  Device Client adalah perangkat lunak sumber terbuka yang ditulis dalam C ++ yang dapat Anda kompilasi dan instal pada perangkat IoT berbasis Linux yang disematkan. Klien Perangkat memiliki klien dasar dan fitur sisi klien diskrit. Klien dasar membangun konektivitas dengan AWS IoT lebih dari protokol MQTT dan dapat terhubung dengan fitur sisi klien yang berbeda.
  
  Untuk melakukan operasi jarak jauh pada perangkat Anda, gunakan fitur Pekerjaan sisi klien dari Klien Perangkat. Fitur ini berisi parser untuk menerima dokumen pekerjaan dan penangan pekerjaan yang menerapkan tindakan jarak jauh yang ditentukan dalam dokumen pekerjaan. Untuk informasi selengkapnya tentang Klien Perangkat dan fitur-fiturnya, lihat Klien AWS IoT Perangkat.
  
  Saat berjalan di perangkat, Klien Perangkat menerima dokumen pekerjaan dan memiliki implementasi khusus platform yang digunakan untuk menjalankan perintah dalam dokumen. Untuk informasi selengkapnya tentang pengaturan Device Client dan menggunakan fitur Jobs, lihat AWS IoT tutorial.
Gunakan lingkungan yang didukung

Untuk setiap template terkelola, Anda akan menemukan informasi tentang lingkungan yang dapat Anda gunakan untuk menjalankan tindakan jarak jauh. Kami menyarankan Anda menggunakan template dengan lingkungan Linux yang didukung seperti yang ditentukan dalam template. Gunakan AWS IoT Device Client untuk menjalankan tindakan jarak jauh template terkelola karena mendukung mikroprosesor umum dan lingkungan Linux, seperti Debian dan Ubuntu.

Tindakan jarak jauh template terkelola dan dokumen pekerjaan

Bagian berikut mencantumkan berbagai templat AWS terkelola untuk AWS IoT Pekerjaan, dan menjelaskan tindakan jarak jauh yang dapat dilakukan pada perangkat. Bagian berikut memiliki informasi tentang dokumen pekerjaan dan deskripsi parameter dokumen pekerjaan untuk setiap tindakan jarak jauh. Perangkat lunak sisi perangkat Anda menggunakan nama templat dan parameter untuk melakukan tindakan jarak jauh.

AWS template terkelola menerima parameter input yang Anda tentukan nilainya saat membuat pekerjaan menggunakan templat. Semua template yang dikelola memiliki dua parameter input opsional yang sama: runAsUser danpathToHandler. Kecuali untuk AWS-Reboot template, template memerlukan parameter input tambahan yang harus Anda tentukan nilainya saat membuat pekerjaan menggunakan templat. Parameter input yang diperlukan ini bervariasi tergantung pada template yang Anda pilih. Misalnya, jika Anda memilih AWS-Download-File template, Anda harus menentukan daftar paket untuk menginstal, dan URL untuk men-download file dari.

Tentukan nilai untuk parameter input saat menggunakan AWS IoT konsol atau AWS Command Line Interface (AWS CLI) untuk membuat pekerjaan yang menggunakan templat terkelola. Saat menggunakan CLI, berikan nilai-nilai ini dengan menggunakan objek. document-parameters Untuk informasi selengkapnya, lihat DocumentParameters.

catatan

Gunakan document-parameters hanya saat membuat pekerjaan dari template AWS terkelola. Parameter ini tidak dapat digunakan dengan template pekerjaan khusus atau untuk membuat pekerjaan dari mereka.

Berikut ini menunjukkan deskripsi parameter input opsional umum. Anda akan melihat deskripsi parameter input lain yang diperlukan oleh setiap template terkelola di bagian berikutnya.

runAsUser: Parameter ini menentukan apakah akan menjalankan job handler sebagai pengguna lain. Jika tidak ditentukan selama pembuatan pekerjaan, penangan pekerjaan dijalankan sebagai pengguna yang sama dengan Klien Perangkat. Saat Anda menjalankan job handler sebagai pengguna lain, tentukan nilai string yang tidak lebih dari 256 karakter.

pathToHandler: Jalur ke penangan pekerjaan yang berjalan di perangkat. Jika tidak ditentukan selama pembuatan pekerjaan, Klien Perangkat menggunakan direktori kerja saat ini.

Berikut ini menunjukkan berbagai tindakan jarak jauh, dokumen pekerjaan mereka, dan parameter yang mereka terima. Semua template ini mendukung lingkungan Linux untuk menjalankan operasi jarak jauh pada perangkat.

Nama templat

AWS–Download–File

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk mengunduh file.

Parameter input

Template ini memiliki parameter yang diperlukan berikut. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

downloadUrl: URL untuk mengunduh file dari. Ini bisa berupa sumber daya internet, objek di Amazon S3 yang dapat diakses publik, atau objek di Amazon S3 yang hanya dapat diakses oleh perangkat Anda menggunakan URL yang telah ditetapkan sebelumnya. Untuk informasi selengkapnya tentang penggunaan URL yang telah ditetapkan sebelumnya dan pemberian izin, lihat. URLs yang ditandatangani sebelumnya
filePath: Jalur file lokal yang menunjukkan lokasi di perangkat untuk menyimpan file yang diunduh.

Perilaku perangkat

Perangkat mengunduh file dari lokasi yang ditentukan, memverifikasi bahwa unduhan selesai, dan menyimpannya secara lokal.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell script,download-file.sh, yang harus dijalankan oleh job handler untuk men-download file. Ini juga menunjukkan parameter yang diperlukan downloadUrl danfilePath.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Download-File",
        "type": "runHandler",
        "input": {
          "handler": "download-file.sh",
          "args": [
            "${aws:iot:parameter:downloadUrl}",
            "${aws:iot:parameter:filePath}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Install–Application

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk menginstal satu atau lebih aplikasi.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,packages. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

packages

Daftar terpisah spasi dari satu atau lebih aplikasi yang akan diinstal.

Perilaku perangkat

Perangkat menginstal aplikasi seperti yang ditentukan dalam dokumen pekerjaan.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell script,install-packages.sh, yang harus dijalankan oleh job handler untuk men-download file. Ini juga menunjukkan parameter yang diperlukanpackages.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Install-Application",
        "type": "runHandler",
        "input": {
          "handler": "install-packages.sh",
          "args": [
            "${aws:iot:parameter:packages}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Reboot

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk me-reboot perangkat Anda.

Parameter input

Template ini tidak memiliki parameter yang diperlukan. Anda dapat menentukan parameter opsional runAsUser danpathToHandler.

Perilaku perangkat

Perangkat berhasil reboot.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell script,reboot.sh, yang harus dijalankan oleh job handler untuk me-reboot perangkat.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Reboot",
        "type": "runHandler",
        "input": {
          "handler": "reboot.sh",
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Remove–Application

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk menghapus satu atau beberapa aplikasi.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,packages. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

packages

Daftar terpisah spasi dari satu atau lebih aplikasi yang akan dihapus instalasinya.

Perilaku perangkat

Perangkat menghapus instalan aplikasi seperti yang ditentukan dalam dokumen pekerjaan.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell script,remove-packages.sh, yang harus dijalankan oleh job handler untuk men-download file. Ini juga menunjukkan parameter yang diperlukanpackages.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Remove-Application",
        "type": "runHandler",
        "input": {
          "handler": "remove-packages.sh",
          "args": [
            "${aws:iot:parameter:packages}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Restart–Application

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk menghentikan dan memulai ulang satu atau beberapa layanan.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,services. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

Layanan

Daftar terpisah spasi dari satu atau lebih aplikasi yang akan dimulai ulang.

Perilaku perangkat

Aplikasi yang ditentukan dihentikan dan kemudian dimulai ulang pada perangkat.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell scriptrestart-services.sh, yang harus dijalankan oleh job handler untuk me-restart layanan sistem. Ini juga menunjukkan parameter yang diperlukanservices.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Restart-Application",
        "type": "runHandler",
        "input": {
          "handler": "restart-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS-Start-Application

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk memulai satu atau lebih layanan.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,services. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

services

Daftar terpisah spasi dari satu atau lebih aplikasi yang akan dimulai.

Perilaku perangkat

Aplikasi yang ditentukan mulai berjalan pada perangkat.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell scriptstart-services.sh, yang harus dijalankan oleh job handler untuk memulai layanan sistem. Ini juga menunjukkan parameter yang diperlukanservices.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Start-Application",
        "type": "runHandler",
        "input": {
          "handler": "start-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Stop–Application

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk menghentikan satu atau beberapa layanan.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,services. Anda juga dapat menentukan parameter opsional runAsUser danpathToHandler.

services

Daftar terpisah spasi dari satu atau lebih aplikasi yang akan dihentikan.

Perilaku perangkat

Aplikasi yang ditentukan berhenti berjalan pada perangkat.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan path ke job handler dan shell scriptstop-services.sh, yang harus dijalankan oleh job handler untuk menghentikan layanan sistem. Ini juga menunjukkan parameter yang diperlukanservices.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Stop-Application",
        "type": "runHandler",
        "input": {
          "handler": "stop-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nama templat

AWS–Run–Command

Deskripsi templat

Template terkelola yang disediakan oleh AWS untuk menjalankan perintah shell.

Parameter input

Template ini memiliki parameter yang diperlukan sebagai berikut,command. Anda juga dapat menentukan parameter opsionalrunAsUser.

command

Sebuah string perintah yang dipisahkan koma. Setiap koma yang terkandung dalam perintah itu sendiri harus lolos.

Perilaku perangkat

Perangkat menjalankan perintah shell seperti yang ditentukan dalam dokumen pekerjaan.

Dokumen Job

Berikut ini menunjukkan dokumen pekerjaan dan versi terbarunya. Template menunjukkan jalur ke perintah pekerjaan dan perintah yang Anda berikan yang akan dijalankan perangkat.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Run-Command",
        "type": "runCommand",
        "input": {
          "command": "${aws:iot:parameter:command}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Topik

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Templat Job

Buat pekerjaan dari templat AWS terkelola menggunakan konsol