Mengelola penerapan dan komponen lokal - AWS IoT Greengrass
SDK (Versi Minimum)OtorisasiCreateLocalDeploymentListLocalDeploymentsGetLocalDeploymentStatusListComponentsGetComponentDetailsRestartComponentStopComponentCreateDebugPassword

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

Mengelola penerapan dan komponen lokal

catatan

Fitur ini tersedia untuk v2.6.0 dan versi kemudian dari komponen inti Greengrass.

Gunakan layanan Greengrass CLI IPC untuk mengelola penerapan lokal dan komponen Greengrass pada perangkat inti.

Untuk menggunakan operasi IPC ini, sertakan versi 2.6.0 atau yang lebih baru dari komponen Greengrass CLI sebagai dependensi dalam komponen kustom Anda. Anda kemudian dapat menggunakan operasi IPC di komponen kustom Anda untuk melakukan hal berikut:

  • Buat deployment lokal untuk memodifikasi dan mengkonfigurasi komponen Greengrass pada perangkat inti.

  • Memulai ulang dan menghentikan komponen Greengrass pada perangkat inti.

  • Buat kata sandi yang dapat Anda gunakan untuk masuk ke konsol debug lokal.

SDK (Versi Minimum)

Tabel berikut menjelaskan versi minimumAWS IoT Device SDK yang harus Anda gunakan untuk berinteraksi dengan layanan Greengrass CLI IPC.

SDK Versi minimum

AWS IoT Device SDKuntuk Java v2

v1.2.10

AWS IoT Device SDKuntuk Python v2

v1.5.3

AWS IoT Device SDKuntuk C++ v2

v1.17.0

Otorisasi

Untuk menggunakan layanan Greengrass CLI IPC dalam komponen kustom, Anda harus menentukan kebijakan otorisasi yang memungkinkan komponen Anda untuk mengelola deployment lokal dan komponen. Untuk informasi tentang cara menentukan kebijakan otorisasi, lihat Otorisasi komponen untuk melakukan operasi IPC.

Kebijakan otorisasi untuk Greengrass CLI memiliki properti berikut.

Pengenal layanan IPC: aws.greengrass.Cli

Operasi Deskripsi Sumber daya

aws.greengrass#CreateLocalDeployment

Memungkinkan komponen untuk membuat deployment lokal pada perangkat inti.

*

aws.greengrass#ListLocalDeployments

Memungkinkan komponen untuk membuat daftar deployment lokal pada perangkat inti.

*

aws.greengrass#GetLocalDeploymentStatus

Memungkinkan komponen untuk mendapatkan status deployment lokal pada perangkat inti.

ID penyebaran lokal, atau* untuk memungkinkan akses ke semua penerapan lokal.

aws.greengrass#ListComponents

Memungkinkan komponen untuk daftar komponen pada perangkat inti.

*

aws.greengrass#GetComponentDetails

Memungkinkan komponen untuk mendapatkan detail tentang komponen pada perangkat inti.

Nama komponen, seperticom.example.HelloWorld, atau* untuk memungkinkan akses ke semua komponen.

aws.greengrass#RestartComponent

Memungkinkan komponen untuk me-restart komponen pada perangkat inti.

Nama komponen, seperticom.example.HelloWorld, atau* untuk memungkinkan akses ke semua komponen.

aws.greengrass#StopComponent

Memungkinkan komponen untuk menghentikan komponen pada perangkat inti.

Nama komponen, seperticom.example.HelloWorld, atau* untuk memungkinkan akses ke semua komponen.

aws.greengrass#CreateDebugPassword

Memungkinkan komponen untuk menghasilkan kata sandi yang digunakan untuk masuk ke komponen konsol debug lokal.

*
contoh Contoh kebijakan otorisasi

Contoh kebijakan otorisasi berikut memungkinkan komponen untuk membuat penyebaran lokal, melihat semua penerapan dan komponen lokal, dan memulai ulang dan menghentikan komponen bernamacom.example.HelloWorld.

{
  "accessControl": {
    "aws.greengrass.Cli": {
      "com.example.MyLocalManagerComponent:cli:1": {
        "policyDescription": "Allows access to create local deployments and view deployments and components.",
        "operations": [
          "aws.greengrass#CreateLocalDeployment",
          "aws.greengrass#ListLocalDeployments",
          "aws.greengrass#GetLocalDeploymentStatus",
          "aws.greengrass#ListComponents",
          "aws.greengrass#GetComponentDetails"
        ],
        "resources": [
          "*"
        ]
      }
    },
    "aws.greengrass.Cli": {
      "com.example.MyLocalManagerComponent:cli:2": {
        "policyDescription": "Allows access to restart and stop the Hello World component.",
        "operations": [
          "aws.greengrass#RestartComponent",
          "aws.greengrass#StopComponent"
        ],
        "resources": [
          "com.example.HelloWorld"
        ]
      }
    }
  }
}

CreateLocalDeployment

Buat atau perbarui deployment lokal menggunakan resep komponen tertentu, artefak, dan argumen waktu aktif.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah deployment create di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

recipeDirectoryPath(Python:recipe_directory_path)

(Opsional) Path absolut ke folder yang berisi file resep komponen.

artifactDirectoryPath(Python:artifact_directory_path)

(Opsional) Path absolut ke folder yang berisi file artefak yang akan disertakan dalam deployment. Folder artefak harus berisi struktur folder berikut:

/path/to/artifact/folder/component-name/component-version/artifacts
rootComponentVersionsToAdd(Python:root_component_versions_to_add)

(Opsional) Versi komponen yang akan dipasang pada perangkat inti. Objek iniComponentToVersionMap,, adalah peta yang berisi pasangan nilai berikut:

key

Nama komponen.

value

Versi komponen.

rootComponentsToRemove(Python:root_components_to_remove)

(Opsional) Komponen yang akan dihapus dari perangkat inti. Tentukan daftar di mana setiap entri adalah nama komponen.

componentToConfiguration(Python:component_to_configuration)

(Opsional) Memperbarui konfigurasi untuk setiap komponen dalam deployment. Objek iniComponentToConfiguration,, adalah peta yang berisi pasangan nilai berikut:

key

Nama komponen.

value

Konfigurasi memperbarui objek JSON untuk komponen. Objek JSON harus dalam format berikut.

{ 
  "MERGE": {
    "config-key": "config-value"
  },
  "RESET": [
    "path/to/reset/"
  ]
}

Untuk informasi selengkapnya tentang pembaruan konfigurasi, lihat Perbarui konfigurasi komponen.

componentToRunWithInfo(Python:component_to_run_with_info)

(Opsional) Konfigurasi runtime untuk setiap komponen dalam penyebaran. Konfigurasi ini mencakup pengguna sistem yang memiliki setiap proses komponen dan batas sistem untuk diterapkan ke setiap komponen. Objek iniComponentToRunWithInfo,, adalah peta yang berisi pasangan nilai berikut:

key

Nama komponen.

value

Konfigurasi runtime untuk komponen tersebut. Jika Anda menghilangkan parameter konfigurasi runtime, perangkat lunakAWS IoT Greengrass Core menggunakan nilai default yang Anda konfigurasikan pada nukleus Greengrass. Objek ini, RunWithInfo, berisi informasi berikut:

posixUser(Python:posix_user)

(Opsional) Pengguna dan, opsional, grup yang akan digunakan untuk menjalankan komponen ini pada perangkat inti Linux. Pengguna, dan grup jika ditentukan, harus ada di setiap perangkat inti Linux. Tentukan pengguna dan grup yang dipisahkan dengan titik dua (:) dalam format berikut: user:group. Grup ini opsional. Jika Anda tidak menentukan grup, perangkat lunakAWS IoT Greengrass inti akan menggunakan grup utama untuk pengguna. Untuk informasi selengkapnya, lihatMengkonfigurasi pengguna yang menjalankan komponen.

windowsUser(Python:windows_user)

(Opsional) Pengguna Windows yang digunakan untuk menjalankan komponen ini pada perangkat inti Windows. Pengguna harus ada di setiap perangkat inti Windows, dan nama serta kata sandinya harus disimpan di instance Manajer Kredensial LocalSystem akun. Untuk informasi selengkapnya, lihatMengkonfigurasi pengguna yang menjalankan komponen.

systemResourceLimits(Python:system_resource_limits)

(Opsional) Batas sumber daya sistem untuk diterapkan pada proses komponen ini. Anda dapat menerapkan batas sumber daya sistem ke komponen Lambda generik dan non-kontainer. Untuk informasi selengkapnya, lihatMengkonfigurasi batas sumber daya sistem untuk komponen.

AWS IoT GreengrassSaat ini tidak mendukung fitur ini pada perangkat inti Windows.

Objek ini, SystemResourceLimits, berisi informasi berikut:

cpus

(Opsional) Jumlah maksimum waktu CPU yang dapat digunakan proses komponen ini pada perangkat inti. Total waktu CPU perangkat inti setara dengan jumlah inti CPU perangkat. Misalnya, pada perangkat inti dengan 4 inti CPU, Anda dapat mengatur nilai ini2 untuk membatasi proses komponen ini hingga 50 persen penggunaan setiap inti CPU. Pada perangkat dengan 1 inti CPU, Anda dapat mengatur nilai ini0.25 untuk membatasi proses komponen ini hingga 25 persen penggunaan CPU. Jika Anda menetapkan nilai ini ke angka yang lebih besar dari jumlah inti CPU, perangkat lunakAWS IoT Greengrass Core tidak membatasi penggunaan CPU komponen.

memory

(Opsional) Jumlah maksimum RAM (dalam kilobyte) yang dapat digunakan proses komponen ini pada perangkat inti.

groupName(Python:group_name)

(Opsional) Nama grup objek yang akan ditargetkan dengan deployment ini.

Response

Tanggapan operasi ini memiliki informasi berikut:

deploymentId(Python:deployment_id)

ID deployment lokal yang dibuat oleh permintaan.

ListLocalDeployments

Dapatkan status dari 10 deployment lokal terakhir.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah daftar penyebaran di Greengrass CLI.

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Response

Tanggapan operasi ini memiliki informasi berikut:

localDeployments(Python:local_deployments)

Daftar penyebaran lokal. Setiap objek dalam daftar ini adalahLocalDeployment objek, yang berisi informasi berikut:

deploymentId(Python:deployment_id)

ID deployment lokal.

status

Status penyebaran lokal. Enum ini, DeploymentStatus, memiliki nilai-nilai berikut:

  • QUEUED

  • IN_PROGRESS

  • SUCCEEDED

  • FAILED

GetLocalDeploymentStatus

Dapatkan status deployment lokal.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah status penyebaran di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

deploymentId(Python:deployment_id)

ID deployment lokal yang akan didapat.

Response

Tanggapan operasi ini memiliki informasi berikut:

deployment

Deployment lokal. Objek ini, LocalDeployment, berisi informasi berikut:

deploymentId(Python:deployment_id)

ID deployment lokal.

status

Status penyebaran lokal. Enum ini, DeploymentStatus, memiliki nilai-nilai berikut:

  • QUEUED

  • IN_PROGRESS

  • SUCCEEDED

  • FAILED

ListComponents

Dapatkan nama, versi, status, dan konfigurasi dari setiap komponen akar pada perangkat inti. Komponen root adalah komponen yang Anda tentukan dalam penyebaran. Respons ini tidak menyertakan komponen yang diinstal sebagai dependensi komponen lainnya.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah daftar komponen di Greengrass CLI.

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Response

Tanggapan operasi ini memiliki informasi berikut:

components

Daftar komponen root pada perangkat inti. Setiap objek dalam daftar ini adalahComponentDetails objek, yang berisi informasi berikut:

componentName(Python:component_name)

Nama komponen.

version

Versi komponen.

state

Keadaan komponen. Keadaan ini dapat menjadi salah satu dari yang berikut:

  • RUNNING

  • ERRORED

configuration

Konfigurasi komponen sebagai objek JSON.

GetComponentDetails

Dapatkan versi, status, dan konfigurasi komponen pada perangkat inti.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah detail komponen di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

componentName(Python:component_name)

Nama komponen yang akan didapat.

Response

Tanggapan operasi ini memiliki informasi berikut:

componentDetails(Python:component_details)

Rincian komponen. Objek ini, ComponentDetails, berisi informasi berikut:

componentName(Python:component_name)

Nama komponen.

version

Versi komponen.

state

Keadaan komponen. Keadaan ini dapat menjadi salah satu dari yang berikut:

  • RUNNING

  • ERRORED

configuration

Konfigurasi komponen sebagai objek JSON.

RestartComponent

Memulai ulang komponen pada perangkat inti.

catatan

Meskipun Anda dapat me-restart komponen apa pun, kami sarankan Anda me-restart hanya komponen generik.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah restart komponen di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

componentName(Python:component_name)

Nama komponen.

Response

Tanggapan operasi ini memiliki informasi berikut:

restartStatus(Python:restart_status)

Status permintaan restart. Status permintaan dapat menjadi salah satu dari yang berikut:

  • SUCCEEDED

  • FAILED

message

Pesan tentang mengapa komponen gagal memulai ulang, jika permintaan gagal.

StopComponent

Menghentikan proses komponen pada perangkat inti.

catatan

Meskipun Anda dapat menghentikan komponen apa pun, kami sarankan Anda menghentikan hanya komponen generik.

Operasi ini menyediakan fungsionalitas yang sama dengan perintah component stop di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

componentName(Python:component_name)

Nama komponen.

Response

Tanggapan operasi ini memiliki informasi berikut:

stopStatus(Python:stop_status)

Status permintaan yang berhenti. Status permintaan dapat menjadi salah satu dari yang berikut:

  • SUCCEEDED

  • FAILED

message

Pesan tentang mengapa komponen gagal berhenti, jika permintaan gagal.

CreateDebugPassword

Menghasilkan kata sandi acak yang dapat Anda gunakan untuk masuk ke komponen konsol debug lokal. Kata sandi kedaluwarsa 8 jam setelah dibuat.

Operasi ini menyediakan fungsionalitas yang sama dengan get-debug-password perintah di Greengrass CLI.

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Response

Tanggapan operasi ini memiliki informasi berikut:

username

Nama pengguna yang digunakan untuk masuk.

password

Kata sandi yang digunakan untuk masuk.

passwordExpiration(Python:password_expiration)

Waktu ketika kata sandi kedaluwarsa.

certificateSHA256Hash(Python:certificate_sha256_hash)

Sidik jari SHA-256 untuk sertifikat yang ditandatangani sendiri yang digunakan konsol debug lokal saat HTTPS diaktifkan. Ketika Anda membuka konsol debug lokal, gunakan sidik jari ini untuk memverifikasi bahwa sertifikat itu sah dan sambungan aman.

certificateSHA1Hash(Python:certificate_sha1_hash)

Sidik jari SHA-1 untuk sertifikat yang ditandatangani sendiri yang digunakan konsol debug lokal saat HTTPS diaktifkan. Ketika Anda membuka konsol debug lokal, gunakan sidik jari ini untuk memverifikasi bahwa sertifikat itu sah dan sambungan aman.