Creación de componentes de AWS IoT Greengrass

Si aún no lo ha hecho, instale la CLI de GDK en su computadora de desarrollo. Para obtener más información, consulte Instalación o actualización de la interfaz de línea de comandos del kit de desarrollo de AWS IoT Greengrass.

Vaya a la carpeta en la que desea crear las carpetas de componentes.

Elija una plantilla de componentes o un componente de comunidad para descargar. La CLI de GDK descarga la plantilla o el componente de comunidad, por lo que puede empezar con un ejemplo funcional. Use el comando component list para recuperar la lista de plantillas o componentes de comunidad disponibles.

• Para mostrar una lista de las plantillas de componentes, ejecute el siguiente comando. Cada línea de la respuesta incluye el nombre de la plantilla y el lenguaje de programación.

  gdk component list --template

• Para mostrar una lista de componentes de comunidad, ejecute el siguiente comando.

  gdk component list --repository

Cree y cambie a una carpeta de componentes en la que la CLI de GDK descargue la plantilla o el componente de comunidad. Reemplace HelloWorld por el nombre del componente u otro nombre que lo ayude a identificar esta carpeta de componentes.

Descargue la plantilla o el componente de comunidad en la carpeta actual. Use el comando component init.

• Para crear una carpeta de componentes a partir de una plantilla, ejecute el siguiente comando. Reemplace HelloWorld por el nombre de la plantilla y reemplace python por el nombre del lenguaje de programación.

  gdk component init --template HelloWorld --language python

• Para crear una carpeta de componentes a partir de un componente de comunidad, ejecute el siguiente comando. Reemplace ComponentName por el nombre del componente de comunidad.

  gdk component init --repository ComponentName

La CLI de GDK lee el archivo de configuración de la CLI de GDK, denominado gdk-config.json, para crear y publicar componentes. Este archivo de configuración existe en la raíz de la carpeta del componente. El paso anterior crea este archivo por usted. En este paso, se actualiza gdk-config.json con información acerca de su componente. Haga lo siguiente:

1. Abra gdk-config.json en un editor de texto.

2. (Opcional) Cambie el nombre del componente. El nombre del componente es la clave del objeto component.

3. Cambie el autor del componente.

4. (Opcional) Cambie la versión del componente. Especifique uno de los siguientes valores:

   • NEXT_PATCH: al elegir esta opción, la CLI de GDK establece la versión al publicar el componente. La CLI de GDK consulta el servicio de AWS IoT Greengrass para identificar la versión más reciente publicada del componente. A continuación, establece la versión en la siguiente versión del parche posterior a esa versión. Si no ha publicado el componente antes, la CLI de GDK usa la versión 1.0.0.

     Si elige esta opción, no podrá usar la CLI de Greengrass para implementar y probar localmente el componente en su computadora de desarrollo local que ejecuta el software AWS IoT Greengrass Core. Para habilitar las implementaciones locales, debe especificar una versión semántica en su lugar.

   • Una versión semántica, como 1.0.0. Las versiones semánticas siguen un sistema de números de major.minor.patch. Para obtener más información, consulte la especificación semántica de la versión.

     Si desarrolla componentes en un dispositivo principal de Greengrass en el que desee implementar y probar el componente, elija esta opción. Debe compilar el componente con una versión específica para crear implementaciones locales con la CLI de Greengrass.

5. (Opcional) Cambie la configuración de compilación del componente. La configuración de compilación define cómo la CLI de GDK compila el origen del componente en artefactos. Para build_system, puede elegir entre las siguientes opciones:

   • zip: empaqueta la carpeta del componente en un archivo ZIP para definirla como el único artefacto del componente. Elija esta opción para los siguientes tipos de componentes:

     • Componentes que usan lenguajes de programación interpretados, como Python o JavaScript.

     • Componentes que empaquetan archivos distintos del código, como modelos de machine learning u otros recursos.

     La CLI de GDK comprime la carpeta del componente en un archivo zip con el mismo nombre que la carpeta del componente. Por ejemplo, si el nombre de la carpeta del componente es HelloWorld, la CLI de GDK crea un archivo zip denominado HelloWorld.zip.

     nota

     Si usa la versión 1.0.0 de la CLI de GDK en un dispositivo Windows, los nombres de las carpetas y los archivos zip de los componentes deben contener solo letras minúsculas.

     Cuando la CLI de GDK comprime la carpeta del componente en un archivo zip, omite los siguientes archivos:

     • El archivo gdk-config.json

     • El archivo de receta (recipe.json o recipe.yaml)

     • Carpetas de compilación, como greengrass-build

   • maven: ejecuta el comando mvn clean package para compilar el origen del componente en artefactos. Elija esta opción para los componentes que usan Maven, como los componentes de Java.

     En dispositivos Windows, esta característica está disponible para la versión 1.1.0 y posteriores de la CLI de GDK.

   • gradle: ejecuta el comando gradle build para compilar el origen del componente en artefactos. Elija esta opción para los componentes que usan Gradle. Esta característica está disponible para la versión 1.1.0 y posteriores de la CLI de GDK.

     El sistema de compilación gradle admite Kotlin DSL como archivo de compilación. Esta característica está disponible para la versión 1.2.0 y versiones posteriores de la CLI de GDK.

   • gradlew: ejecuta el comando gradlew para compilar el origen del componente en artefactos. Elija esta opción para los componentes que usan el Gradle Wrapper.

     Esta característica está disponible para la versión 1.2.0 y versiones posteriores de la CLI de GDK.

   • custom: ejecuta un comando personalizado para compilar el origen del componente en una receta y artefactos. Especifique el comando personalizado en el parámetro custom_build_command.

6. Si especifica custom para build_system, agregue custom_build_command al objeto build. En custom_build_command, especifique una sola cadena o lista de cadenas, donde cada cadena es una palabra del comando. Por ejemplo, para ejecutar un comando de compilación personalizado para un componente de C++, puede especificar ["cmake", "--build", "build", "--config", "Release"].

7. Si usa la versión 1.1.0 o posteriores de la CLI de GDK, puede especificar el argumento --bucket para especificar el bucket de S3 en el que la CLI de GDK carga los artefactos del componente. Si no especifica este argumento, la CLI de GDK se carga en el bucket de S3 cuyo nombre es bucket-region-accountId, donde bucket y region son los valores que especifica en gdk-config.json y acountId es el ID de su Cuenta de AWS. La CLI de GDK crea el bucket si no existe.

   Cambie la configuración de publicación del componente. Haga lo siguiente:

   1. Especifique el nombre del bucket de S3 que se usará para alojar artefactos de componentes.

   2. Especifique la Región de AWS donde la CLI de GDK publica el componente.

Cuando haya terminado con este paso, el archivo gdk-config.json tendrá un aspecto similar al siguiente ejemplo.

{
  "component": {
    "com.example.PythonHelloWorld": {
      "author": "Amazon",
      "version": "NEXT_PATCH",
      "build": {
        "build_system" : "zip"
      },
      "publish": {
        "bucket": "greengrass-component-artifacts",
        "region": "us-west-2"
      }
    }
  },
  "gdk_version": "1.0.0"
}

Actualice el archivo de receta del componente, denominado recipe.yaml o recipe.json. Haga lo siguiente:

1. Si ha descargado una plantilla o un componente de comunidad que usa el sistema de compilación zip, compruebe que el nombre del artefacto zip coincide con el nombre de la carpeta del componente. La CLI de GDK comprime la carpeta del componente en un archivo zip con el mismo nombre que la carpeta del componente. La receta contiene el nombre del artefacto zip en la lista de artefactos de componentes y en los scripts de ciclo de vida que usan archivos del artefacto zip. Actualice las definiciones Artifacts y Lifecycle de forma que el nombre del archivo zip coincida con el nombre de la carpeta del componente. Los siguientes ejemplos de recetas parciales resaltan el nombre del archivo zip en las definiciones Artifacts y Lifecycle.

   JSON

   {
     ...
     "Manifests": [
       {
         "Platform": {
           "os": "all"
         },
         "Artifacts": [
           {
             "URI": "s3://{COMPONENT_NAME}/{COMPONENT_VERSION}/HelloWorld.zip",
             "Unarchive": "ZIP"
           }
         ],
         "Lifecycle": {
           "Run": "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"
         }
       }
     ]
   }

   YAML

   ---
   ...
   Manifests:
     - Platform:
         os: all
       Artifacts:
         - URI: "s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/HelloWorld.zip"
           Unarchive: ZIP
       Lifecycle:
         Run: "python3 -u {artifacts:decompressedPath}/HelloWorld/main.py {configuration:/Message}"

2. (Opcional) Actualice la descripción del componente, la configuración predeterminada, los artefactos, los scripts del ciclo de vida y el soporte de la plataforma. Para obtener más información, consulte Referencia de receta del componente de AWS IoT Greengrass.

Cuando haya terminado con este paso, el archivo de receta puede ser similar a los siguientes ejemplos.

Desarrolle y compile el componente de Greengrass. El comando component build produce una receta y artefactos en la carpeta greengrass-build de la carpeta del componente. Ejecute el siguiente comando.

gdk component build

Cree una carpeta para sus componentes con subcarpetas para recetas y artefactos. Ejecute los siguientes comandos en su dispositivo principal de Greengrass para crear estas carpetas y cambiarlas a la carpeta de componentes. Reemplace ~/greengrassv2 o %USERPROFILE%\greengrassv2 por la ruta a la carpeta que se usará para el desarrollo local.

Use un editor de texto para crear un archivo de recetas que define los metadatos, parámetros, dependencias, ciclo de vida y capacidad de plataforma de su componente. Incluya la versión del componente en el nombre del archivo de recetas para poder identificar qué receta refleja qué versión del componente. Puede elegir el formato YAML o JSON para su receta.

Por ejemplo, en un sistema basado en Linux, puede ejecutar el siguiente comando para usar GNU nano a fin de crear el archivo.

Defina la receta de su componente. Para obtener más información, consulte Referencia de receta del componente de AWS IoT Greengrass.

Es posible que la receta sea similar a la siguiente receta de ejemplo de Hello World.

Esta receta ejecuta un script de Python de Hello World, que puede ser similar al siguiente script de ejemplo.

import sys

message = "Hello, %s!" % sys.argv[1]

# Print the message to stdout, which Greengrass saves in a log file.
print(message)

Cree una carpeta para desarrollar la versión del componente. Le recomendamos que use una carpeta independiente para los artefactos de cada versión del componente, de modo que pueda identificar los artefactos de cada versión del componente. Ejecute el siguiente comando.

artifacts/componentName/componentVersion/

Cree los artefactos de su componente en la carpeta creada en el paso anterior. Los artefactos pueden incluir software, imágenes y cualquier otro binario que use el componente.

Cuando el componente esté listo, pruébelo.