View a markdown version of this page

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 yang lebih baru 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 ketergantungan pada komponen kustom Anda. Anda kemudian dapat menggunakan operasi IPC di komponen kustom Anda untuk melakukan hal berikut:

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

  • Mulai ulang dan hentikan komponen Greengrass pada perangkat inti.

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

SDK (Versi Minimum)

Tabel berikut mencantumkan versi minimum SDK yang dapat Anda gunakan untuk berinteraksi dengan layanan Greengrass CLI IPC.

SDK Versi minimum

AWS IoT Greengrass Komponen SDK (C, C ++, Rust)

v1.0.0

AWS IoT Device SDK untuk Java v2

v1.2.10

AWS IoT Device SDK untuk Python v2

v1.5.3

AWS IoT Device SDK untuk C++ v2

v1.17.0

AWS IoT Device SDK untuk JavaScript v2

v1.12.0

Otorisasi

Untuk menggunakan layanan Greengrass CLI IPC dalam komponen khusus, Anda harus menentukan kebijakan otorisasi yang memungkinkan komponen Anda mengelola penerapan dan komponen lokal. 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 penerapan lokal pada perangkat inti.

*

aws.greengrass#ListLocalDeployments

Memungkinkan komponen untuk mencantumkan penerapan lokal pada perangkat inti.

*

aws.greengrass#GetLocalDeploymentStatus

Memungkinkan komponen untuk mendapatkan status penerapan lokal pada perangkat inti.

ID penerapan lokal, atau * untuk mengizinkan akses ke semua penerapan lokal.

aws.greengrass#ListComponents

Memungkinkan komponen untuk membuat 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

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

*
contoh Contoh kebijakan otorisasi

Contoh kebijakan otorisasi berikut memungkinkan komponen untuk membuat penerapan lokal, melihat semua penerapan lokal dan komponen, dan memulai ulang dan menghentikan komponen bernama. com.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 create penerapan di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

recipeDirectoryPath(Python:recipe_directory_path)

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

artifactsDirectoryPath(Python:artifacts_directory_path)

(Opsional) Jalur absolut ke folder yang berisi file artefak untuk disertakan dalam penerapan. 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 untuk menginstal pada perangkat inti. Objek ini,ComponentToVersionMap, adalah peta yang berisi pasangan kunci-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) Pembaruan konfigurasi untuk setiap komponen dalam penerapan. Objek ini,ComponentToConfiguration, adalah peta yang berisi pasangan kunci-nilai berikut:

key

Nama komponen.

value

Konfigurasi memperbarui objek JSON untuk komponen. Objek JSON harus memiliki 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 penerapan. Konfigurasi ini mencakup pengguna sistem yang memiliki proses masing-masing komponen dan batasan sistem untuk diterapkan pada setiap komponen. Objek ini,ComponentToRunWithInfo, adalah peta yang berisi pasangan kunci-nilai berikut:

key

Nama komponen.

value

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

posixUser(Python:posix_user)

(Opsional) Pengguna sistem POSIX dan, secara opsional, grup untuk 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 lunak AWS IoT Greengrass Core menggunakan grup utama untuk pengguna. Untuk informasi selengkapnya, lihat Konfigurasikan 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 dalam instance LocalSystem Credentials Manager akun. Untuk informasi selengkapnya, lihat Konfigurasikan 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, lihat Konfigurasikan batas sumber daya sistem untuk komponen.

AWS IoT Greengrass saat 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 ini 2 untuk membatasi proses komponen ini hingga 50 persen penggunaan setiap inti CPU. Pada perangkat dengan 1 inti CPU, Anda dapat mengatur nilai ini 0.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 lunak AWS 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 benda yang akan ditargetkan dengan penerapan ini.

failureHandlingPolicy(Python:failure_handling_policy)

(Opsional) Kebijakan penanganan kegagalan yang menentukan bagaimana perangkat lunak AWS IoT Greengrass Core merespons jika penerapan gagal.

ROLLBACK

Perangkat inti memutar kembali ke konfigurasi sebelumnya ketika penerapan gagal.

DO_NOTHING

Perangkat inti menyimpan perubahan dari penerapan yang gagal.

catatan

Perangkat lunak AWS IoT Greengrass Core mengabaikan kebijakan penanganan kegagalan untuk penerapan bootstrap. Penerapan bootstrap memperbarui versi inti Greengrass atau menyertakan komponen dengan langkah siklus hidup bootstrap. Jika penerapan bootstrap gagal, perangkat inti akan kembali ke konfigurasi sebelumnya. Rollback terjadi bahkan jika Anda menetapkan kebijakan penanganan kegagalan keDO_NOTHING.

Respons

Tanggapan operasi ini memiliki informasi berikut:

deploymentId(Python:deployment_id)

ID penerapan lokal yang dibuat permintaan.

ListLocalDeployments

Mendapat status 10 penerapan lokal terakhir.

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

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Respons

Tanggapan operasi ini memiliki informasi berikut:

localDeployments(Python:local_deployments)

Daftar penerapan lokal. Setiap objek dalam daftar ini adalah LocalDeployment objek, yang berisi informasi berikut:

deploymentId(Python:deployment_id)

ID penerapan lokal.

status

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

  • QUEUED

  • IN_PROGRESS

  • SUCCEEDED

  • FAILED

GetLocalDeploymentStatus

Mendapat status penerapan lokal.

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

Permintaan

Permintaan operasi ini memiliki parameter berikut:

deploymentId(Python:deployment_id)

ID penerapan lokal yang akan didapat.

Respons

Tanggapan operasi ini memiliki informasi berikut:

deployment

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

deploymentId(Python:deployment_id)

ID penerapan lokal.

status

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

  • QUEUED

  • IN_PROGRESS

  • SUCCEEDED

  • FAILED

ListComponents

Mendapat nama, versi, status, dan konfigurasi setiap komponen root pada perangkat inti. Komponen root adalah komponen yang Anda tentukan dalam penerapan. Respons ini tidak menyertakan komponen yang diinstal sebagai dependensi komponen lain.

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

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Respons

Tanggapan operasi ini memiliki informasi berikut:

components

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

componentName(Python:component_name)

Nama komponen.

version

Versi komponen.

state

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

  • BROKEN

  • ERRORED

  • FINISHED

  • INSTALLED

  • NEW

  • RUNNING

  • STARTING

  • STOPPING

configuration

Konfigurasi komponen sebagai objek JSON.

GetComponentDetails

Mendapat 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.

Respons

Tanggapan operasi ini memiliki informasi berikut:

componentDetails(Python:component_details)

Detail 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 berikut ini:

  • BROKEN

  • ERRORED

  • FINISHED

  • INSTALLED

  • NEW

  • RUNNING

  • STARTING

  • STOPPING

configuration

Konfigurasi komponen sebagai objek JSON.

RestartComponent

Memulai ulang komponen pada perangkat inti.

catatan

Meskipun Anda dapat memulai ulang komponen apa pun, kami sarankan Anda memulai ulang 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.

Respons

Tanggapan operasi ini memiliki informasi berikut:

restartStatus(Python:restart_status)

Status permintaan restart. Status permintaan dapat berupa salah satu dari berikut ini:

  • SUCCEEDED

  • FAILED

message

Pesan tentang mengapa komponen gagal restart, jika permintaan gagal.

Contoh

Contoh-contoh berikut ini menunjukkan cara memanggil operasi ini dalam kode komponen kustom.

Rust
contoh Contoh: Mulai ulang komponen
use gg_sdk::Sdk;

fn main() {
    let sdk = Sdk::init();
    sdk.connect().expect("Failed to establish IPC connection");

    let component_name = "com.example.HelloWorld";

    sdk.restart_component(component_name)
        .expect("Failed to restart component");

    println!("Successfully requested restart for component: {component_name}");
}
C
contoh Contoh: Mulai ulang komponen
#include <gg/error.h>
#include <gg/ipc/client.h>
#include <gg/sdk.h>
#include <stdio.h>
#include <stdlib.h>

int main(void) {
    gg_sdk_init();

    GgError err = ggipc_connect();
    if (err != GG_ERR_OK) {
        fprintf(stderr, "Failed to establish IPC connection.\n");
        exit(-1);
    }

    GgBuffer component_name = GG_STR("com.example.HelloWorld");

    err = ggipc_restart_component(component_name);
    if (err != GG_ERR_OK) {
        fprintf(
            stderr,
            "Failed to restart component: %.*s\n",
            (int) component_name.len,
            component_name.data
        );
        exit(-1);
    }

    printf(
        "Successfully requested restart for component: %.*s\n",
        (int) component_name.len,
        component_name.data
    );
}
C++ (Component SDK)
contoh Contoh: Mulai ulang komponen
#include <gg/ipc/client.hpp>
#include <iostream>

int main() {
    auto &client = gg::ipc::Client::get();

    auto error = client.connect();
    if (error) {
        std::cerr << "Failed to establish IPC connection.\n";
        exit(-1);
    }

    std::string_view component_name = "com.example.HelloWorld";

    error = client.restart_component(component_name);
    if (error) {
        std::cerr << "Failed to restart component: " << component_name << "\n";
        exit(-1);
    }

    std::cout << "Successfully requested restart for component: "
              << component_name << "\n";
}

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 penghentian komponen di Greengrass CLI.

Permintaan

Permintaan operasi ini memiliki parameter berikut:

componentName(Python:component_name)

Nama komponen.

Respons

Tanggapan operasi ini memiliki informasi berikut:

stopStatus(Python:stop_status)

Status permintaan berhenti. Status permintaan dapat berupa salah satu dari berikut ini:

  • 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 perintah get-debug-password di Greengrass CLI.

Permintaan

Operasi ini tidak memiliki parameter apa pun.

Respons

Tanggapan operasi ini memiliki informasi berikut:

username

Nama pengguna yang akan digunakan untuk masuk.

password

Kata sandi yang digunakan untuk masuk.

passwordExpiration(Python:password_expiration)

Waktu ketika kata sandi kedaluwarsa.

certificateSHA256Hash(Python:certificate_sha256_hash)

Si SHA-256 dik jari untuk sertifikat yang ditandatangani sendiri yang digunakan konsol debug lokal saat HTTPS diaktifkan. Saat Anda membuka konsol debug lokal, gunakan sidik jari ini untuk memverifikasi bahwa sertifikat sah dan koneksi aman.

certificateSHA1Hash(Python:certificate_sha1_hash)

Si SHA-1 dik jari untuk sertifikat yang ditandatangani sendiri yang digunakan konsol debug lokal saat HTTPS diaktifkan. Saat Anda membuka konsol debug lokal, gunakan sidik jari ini untuk memverifikasi bahwa sertifikat sah dan koneksi aman.