Configure los ajustes de IDT para ejecutar el conjunto de cualificación de AWS IoT Greengrass - AWS IoT Greengrass
Configurar credenciales de AWSConfigurar device.jsonConfigure userdata.jsonObtenga la configuración del almacén de parámetros AWS

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Configure los ajustes de IDT para ejecutar el conjunto de cualificación de AWS IoT Greengrass

Antes de ejecutar las pruebas, debe ajustar la configuración de las credenciales de AWS y los dispositivos en su equipo host.

Configurar AWS las credenciales en config.json

Debe configurar sus credenciales de usuario de IAM en el archivo <device_tester_extract_location>/configs/config.json. Utilice las credenciales del usuario de IDT para AWS IoT Greengrass V2 creado en. Creación y configuración de una Cuenta de AWS Puede especificar sus credenciales de una de las dos formas siguientes:

  • En un archivo de credenciales

  • Como variables de entorno.

IDT utiliza el mismo archivo de credenciales que la AWS CLI. Para obtener más información, consulte Archivos de configuración y credenciales.

La ubicación del archivo de credenciales varía en función del sistema operativo que utilice:

  • macOS, Linux: ~/.aws/credentials

  • Windows: C:\Users\UserName\.aws\credentials

Añada sus credenciales de AWS al archivo de credentials con el siguiente formato:

[default]
aws_access_key_id = <your_access_key_id>
aws_secret_access_key = <your_secret_access_key>

Para configurar IDT para AWS IoT Greengrass V2 de modo que utilice AWS las credenciales del credentials archivo, edítelo de la config.json siguiente manera:

{
  "awsRegion": "region",
  "auth": {
    "method": "file",
    "credentials": {
      "profile": "default"
    }
  }
}
nota

Si no utiliza el perfil default de AWS asegúrese de cambiar el nombre de perfil en su archivo config.json. Para obtener más información, consulte Perfiles con nombre.

Las variables de entorno son las variables que mantiene el sistema operativo y utilizan los comandos del sistema. No se guardan si cierra la sesión de SSH. IDT para AWS IoT Greengrass V2 puede usar las variables de AWS_SECRET_ACCESS_KEY entorno AWS_ACCESS_KEY_ID y para almacenar sus AWS credenciales.

Para establecer estas variables en Linux, MacOS, o Unix, utilice export:

export AWS_ACCESS_KEY_ID=<your_access_key_id>
export AWS_SECRET_ACCESS_KEY=<your_secret_access_key>

Para establecer estas variables en Windows, utilice set:

set AWS_ACCESS_KEY_ID=<your_access_key_id>
set AWS_SECRET_ACCESS_KEY=<your_secret_access_key>

Para configurar IDT para utilizar las variables de entorno, edite la sección auth de su archivo config.json. A continuación se muestra un ejemplo:

{
  "awsRegion": "region",
  "auth": {
    "method": "environment"
  }
}

Configurar device.json

Además de AWS las credenciales, IDT para AWS IoT Greengrass V2 necesita información sobre los dispositivos en los que se ejecutan las pruebas. Algunos ejemplos de información serían la dirección IP, la información de inicio de sesión, el sistema operativo y la arquitectura de la CPU.

Debe proporcionar esta información utilizando la plantilla device.json ubicada en <device_tester_extract_location>/configs/device.json:

[
  {
    "id": "<pool-id>",
    "sku": "<sku>",
    "features": [
      {
        "name": "arch",
        "value": "x86_64 | armv6l | armv7l | aarch64"
      },
      {
        "name": "ml",
        "value": "dlr | tensorflowlite | dlr,tensorflowlite | no"
      },
      {
        "name": "docker",
        "value": "yes | no"
      },
      {
        "name": "streamManagement",
        "value": "yes | no"
      }, 
      {
        "name": "hsi", 
        "value": "hsm | no" 
      }
    ],
    "devices": [
      {
        "id": "<device-id>",
        "operatingSystem": "Linux | Windows",
        "connectivity": {
          "protocol": "ssh",
          "ip": "<ip-address>",
          "port": 22,
          "publicKeyPath": "<public-key-path>",
          "auth": {
            "method": "pki | password",
            "credentials": {
              "user": "<user-name>",
              "privKeyPath": "/path/to/private/key",
              "password": "<password>"
            }
          }
        }
      }
    ]
  }
]
nota

Especifique privKeyPath solo si method está establecido en pki

Especifique password solo si method está establecido en password

Todas las propiedades que contienen valores son obligatorias, tal y como se describe a continuación:

id

Un ID alfanumérico definido por el usuario que identifica de forma única una colección de dispositivos que se conoce como grupo de dispositivos. Los dispositivos que pertenecen a un grupo deben tener idéntico hardware. Al ejecutar un conjunto de pruebas, los dispositivos del grupo se utilizan para paralelizar la carga de trabajo. Se utilizan varios dispositivos para ejecutar diferentes pruebas.

sku

Un valor alfanumérico que identifica de forma única el dispositivo a prueba. El SKU se utiliza para realizar un seguimiento de placas cualificadas.

nota

Si quieres incluir tu dispositivo en el catálogo de AWS Partner dispositivos, el SKU que especifiques aquí debe coincidir con el SKU que utilices en el proceso de publicación.

features

Una matriz que contenga las características compatibles del dispositivo. Todas las características son obligatorias.

arch

Las arquitecturas de sistemas operativos compatibles que valida la prueba. Los valores válidos son:

  • x86_64

  • armv6l

  • armv7l

  • aarch64

ml

Valida que el dispositivo cumpla con todas las dependencias técnicas necesarias para utilizar los componentes de aprendizaje automático AWS (ML) proporcionados.

Al habilitar esta función, también se valida que el dispositivo pueda realizar inferencias de aprendizaje automático mediante los marcos Deep Learning Runtime y TensorFlow Lite ML.

Los valores válidos son cualquier combinación de dlr ytensorflowlite, o. no

docker

Valida que el dispositivo cumpla con todas las dependencias técnicas necesarias para utilizar el componente Docker application manager () AWS proporcionado. aws.greengrass.DockerApplicationManager

Al habilitar esta función, también se valida que el dispositivo pueda descargar una imagen de contenedor de Docker desde Amazon ECR.

Los valores válidos son cualquier combinación de o. yes no

streamManagement

Valida que el dispositivo pueda descargar, instalar y ejecutar el administrador de AWS IoT Greengrass transmisiones.

Los valores válidos son cualquier combinación de yes ono.

hsi

Valida que el dispositivo pueda autenticar las conexiones a los AWS IoT AWS IoT Greengrass servicios mediante una clave privada y un certificado almacenados en un módulo de seguridad de hardware (HSM). Esta prueba también verifica que el componente del proveedor PKCS #11 AWS proporcionado pueda interactuar con el HSM mediante una biblioteca PKCS #11 proporcionada por el proveedor. Para obtener más información, consulte Integración de la seguridad de hardware.

Los valores válidos son hsm o no.

nota

La versión 4.2.0 de IDT y las versiones posteriores permiten probar las funciones y. ml docker streamManagement Si no desea probar estas funciones, defina el valor correspondiente en. no

nota

La prueba solo hsi está disponible con la versión 4.5.1 de IDT y versiones posteriores.

devices.id

Un identificador único y definido por el usuario para el dispositivo que se está probando.

devices.operatingSystem

El sistema operativo del dispositivo. Los valores admitidos son Linux y Windows.

connectivity.protocol

El protocolo de comunicación que se usará para la comunicación con este dispositivo. Actualmente, el único valor admitido es ssh para dispositivos físicos.

connectivity.ip

La dirección IP del dispositivo que se está probando.

Esta propiedad solo se aplica si connectivity.protocol está establecido en ssh.

connectivity.port

Opcional. El número de puerto que se va a utilizar para las conexiones SSH.

El valor predeterminado es 22.

Esta propiedad solo se aplica si connectivity.protocol está establecido en ssh.

connectivity.publicKeyPath

Opcional. La ruta completa a la clave pública utilizada para autenticar las conexiones al dispositivo que se está probando.

Al especificar la publicKeyPath, IDT valida la clave pública del dispositivo cuando establece una conexión SSH con el dispositivo que se está probando. Si no se especifica este valor, IDT crea una conexión SSH, pero no valida la clave pública del dispositivo.

Le recomendamos encarecidamente que especifique la ruta a la clave pública y que utilice un método seguro para obtenerla. En el caso de los clientes SSH estándar basados en la línea de comandos, la clave pública se proporciona en el archivo known_hosts. Si especifica un archivo de clave pública independiente, este archivo debe usar el mismo formato que el archivo known_hosts, es decir, ip-address key-type public-key. Si hay varias entradas con la misma dirección IP, la entrada del tipo de clave utilizada por IDT debe estar antes que las demás entradas del archivo.

connectivity.auth

Información de autenticación para la conexión.

Esta propiedad solo se aplica si connectivity.protocol está establecido en ssh.

connectivity.auth.method

El método de autenticación que se utiliza para acceder a un dispositivo a través de un determinado protocolo de conectividad.

Los valores admitidos son:

  • pki

  • password

connectivity.auth.credentials

Las credenciales que se utilizan para la autenticación.

connectivity.auth.credentials.password

La contraseña que se utiliza para iniciar sesión en el dispositivo que se va a probar.

Este valor solo se aplica si connectivity.auth.method está establecido en password.

connectivity.auth.credentials.privKeyPath

La ruta completa a la clave privada que se utiliza para iniciar sesión en el dispositivo que se está probando.

Este valor solo se aplica si connectivity.auth.method está establecido en pki.

connectivity.auth.credentials.user

El nombre de usuario para iniciar sesión en el dispositivo que se está probando.

Configure userdata.json

IDT para AWS IoT Greengrass V2 también necesita información adicional sobre la ubicación de los artefactos y el software de prueba. AWS IoT Greengrass

Debe proporcionar esta información utilizando la plantilla userdata.json ubicada en <device_tester_extract_location>/configs/userdata.json:

{
    "TempResourcesDirOnDevice": "/path/to/temp/folder",
    "InstallationDirRootOnDevice": "/path/to/installation/folder",
    "GreengrassNucleusZip": "/path/to/aws.greengrass.nucleus.zip",
    "PreInstalled": "yes/no",
    "GreengrassV2TokenExchangeRole": "custom-iam-role-name",
	"hsm": {
        "greengrassPkcsPluginJar": "/path/to/aws.greengrass.crypto.Pkcs11Provider-latest.jar",
        "pkcs11ProviderLibrary": "/path/to/pkcs11-vendor-library",
        "slotId": "slot-id",
        "slotLabel": "slot-label",
        "slotUserPin": "slot-pin",
        "keyLabel": "key-label",
        "preloadedCertificateArn": "certificate-arn"
        "rootCA": "path/to/root-ca"
    }
}

Todas las propiedades que contienen valores son obligatorias, tal y como se describe aquí:

TempResourcesDirOnDevice

La ruta completa a una carpeta temporal del dispositivo que se está probando en la que se almacenan los artefactos de prueba. Asegúrese de que no se requieren permisos de sudo para escribir en este directorio.

nota

IDT borra el contenido de esta carpeta cuando termina de ejecutar una prueba.

InstallationDirRootOnDevice

La ruta completa a la carpeta del dispositivo en la que se va a instalar. AWS IoT Greengrass Para PreInstalled Greengrass, esta es la ruta al directorio de instalación de Greengrass.

Debe establecer los permisos de archivo necesarios para esta carpeta. Ejecute el siguiente comando para cada carpeta de la ruta de instalación.

sudo chmod 755 folder-name
GreengrassNucleusZip

La ruta completa al archivo ZIP (greengrass-nucleus-latest.zip) del núcleo de Greengrass en el equipo host. Este campo no es obligatorio para realizar pruebas con PreInstalled Greengrass.

nota

Para obtener información sobre las versiones compatibles del núcleo de Greengrass para IDT, consulte. AWS IoT Greengrass Última versión de IDT para V2 AWS IoT Greengrass Para descargar el software Greengrass más reciente, consulte Descargar el AWS IoT Greengrass software.

PreInstalled

Esta función solo está disponible para IDT v4.5.8 y versiones posteriores en dispositivos Linux.

(Opcional) Si el valor es sí, IDT asumirá que la ruta mencionada es el directorio en InstallationDirRootOnDevice el que está instalado Greengrass.

Para obtener más información sobre cómo instalar Greengrass en su dispositivo, consulte. Instale el software AWS IoT Greengrass principal con aprovisionamiento automático de recursos Si la instalación se realiza con aprovisionamiento manual, incluya el paso «AWS IoTAñadir el elemento a un grupo de objetos nuevo o existente» al crear un elemento manualmente AWS IoT. IDT supone que la cosa y el grupo de cosas se crean durante la configuración de la instalación. Asegúrese de que estos valores se reflejen en el effectiveConfig.yaml archivo. IDT busca el archivo que aparece effectiveConfig.yaml debajo<InstallationDirRootOnDevice>/config/effectiveConfig.yaml.

Para ejecutar pruebas con HSM, asegúrese de que el aws.greengrass.crypto.Pkcs11Provider campo esté actualizado en. effectiveConfig.yaml

GreengrassV2TokenExchangeRole

(Opcional) La función de IAM personalizada que desea utilizar como función de intercambio de fichas que el dispositivo objeto de prueba asume para interactuar con AWS los recursos.

nota

IDT utiliza esta función de IAM personalizada en lugar de crear la función de intercambio de fichas predeterminada durante la ejecución de la prueba. Si usa un rol personalizado, puede actualizar los permisos de IAM del usuario de prueba para excluir la iamResourcesUpdate declaración que permite al usuario crear y eliminar roles y políticas de IAM.

Para obtener más información sobre cómo crear una función de IAM personalizada como función de intercambio de fichas, consulte. Configure una función de intercambio de fichas personalizada

hsm

Esta función está disponible para la versión 4.5.1 de IDT y versiones posteriores.

(Opcional) La información de configuración para realizar pruebas con un módulo de seguridad de AWS IoT Greengrass hardware (HSM). De lo contrario, la propiedad hsm debe omitirse. Para obtener más información, consulte Integración de la seguridad de hardware.

Esta propiedad solo se aplica si connectivity.protocol está establecido en ssh.

aviso

La configuración del HSM puede considerarse información confidencial si IDT y otro sistema comparten el módulo de seguridad de hardware. En esta situación, puede evitar proteger estos valores de configuración en texto plano almacenándolos en un AWS parámetro del almacén SecureString de parámetros y configurando IDT para que los recupere durante la ejecución de la prueba. Para obtener más información, consulte Obtenga la configuración del almacén de parámetros AWS

hsm.greengrassPkcsPluginJar

La ruta completa al componente del proveedor PKCS #11 que se descarga en la máquina host de IDT. AWS IoT Greengrassproporciona este componente como un archivo JAR que puede descargar para especificarlo como complemento de aprovisionamiento durante la instalación. Puede descargar la última versión del archivo JAR del componente en la siguiente URL: https://d2s8p88vqu9w66.cloudfront.net/releases/Pkcs11Provider/aws.greengrass.crypto.Pkcs11Provider-latest.jar.

hsm.pkcs11ProviderLibrary

La ruta completa a la biblioteca PKCS #11 que proporciona el proveedor del módulo de seguridad de hardware (HSM) para interactuar con el HSM.

hsm.slotId

El identificador de ranura que se utiliza para identificar la ranura del HSM en la que se cargan la clave y el certificado.

hsm.slotLabel

La etiqueta de ranura que se utiliza para identificar la ranura HSM en la que se cargan la clave y el certificado.

hsm.slotUserPin

El PIN de usuario que IDT utiliza para autenticar el software AWS IoT Greengrass principal en el HSM.

nota

Como práctica recomendada de seguridad, no utilices el mismo PIN de usuario en los dispositivos de producción.

hsm.keyLabel

Es la etiqueta que se utiliza para identificar la clave en el módulo de hardware. Tanto la clave como el certificado deben usar la misma etiqueta de clave.

hsm.preloadedCertificateArn

El nombre de recurso de Amazon (ARN) del certificado de dispositivo cargado en la AWS IoT nube.

Debe haber generado previamente este certificado con la clave del HSM, haberlo importado a su HSM y haberlo subido a la nube. AWS IoT Para obtener información sobre cómo generar e importar el certificado, consulte la documentación de su HSM.

Debe cargar el certificado en la misma cuenta y región que proporcionó en config.json. . Para obtener más información sobre cómo cargar el certificado aAWS IoT, consulte Registrar un certificado de cliente manualmente en la Guía para AWS IoT desarrolladores.

hsm.rootCAPath

(Opcional) La ruta completa de la máquina host de IDT hasta la entidad emisora de certificados (CA) raíz que firmó el certificado. Esto es obligatorio si el certificado creado en el HSM no está firmado por la CA raíz de Amazon.

Obtenga la configuración del almacén de parámetros AWS

AWS IoTEl Device Tester (IDT) incluye una función opcional para obtener los valores de configuración del almacén de parámetros de AWSSystems Manager. AWS El almacén de parámetros permite el almacenamiento seguro y cifrado de las configuraciones. Cuando está configurado, IDT puede recuperar los parámetros del almacén de AWS parámetros en lugar de almacenarlos en texto plano dentro del archivo. userdata.json Esto resulta útil para cualquier dato confidencial que deba almacenarse cifrado, como contraseñas, números PIN y otros datos secretos.

  1. Para utilizar esta función, debe actualizar los permisos utilizados al crear su usuario de IDT para permitir la GetParameter acción en los parámetros para los que IDT está configurado. A continuación se muestra un ejemplo de una declaración de permiso que se puede añadir al usuario de IDT. Para obtener más información, consulte la guía del AWS Systems Managerusuario.

    {
       "Sid":"parameterStoreResources",
       "Effect": "Allow",
        "Action": [
            "ssm:GetParameter"
        ],
        "Resource": "arn:aws:ssm:*:*:parameter/IDT*"
}

    El permiso anterior está configurado para permitir la obtención de todos los parámetros cuyo nombre comience porIDT, mediante el uso del carácter comodín. * Debe personalizarlo según sus necesidades para que IDT tenga acceso a cualquier parámetro configurado en función del nombre de los parámetros que esté utilizando.

  2. Debe almacenar los valores de configuración en AWS Paramater Store. Esto se puede hacer desde la AWS consola o desde la AWS CLI. AWS El almacén de parámetros le permite elegir un almacenamiento cifrado o no cifrado. Para almacenar valores confidenciales, como secretos, contraseñas y números PIN, debe utilizar la opción cifrada, que es un tipo de parámetro de SecureString. Para cargar un parámetro mediante la AWS CLI, puede utilizar el siguiente comando:

    aws ssm put-parameter --name IDT-example-name --value IDT-example-value --type SecureString

    Puede comprobar que un parámetro está almacenado mediante el siguiente comando. (Opcional) Utilice la --with-decryption marca para obtener un parámetro descifrado. SecureString 

    aws ssm get-parameter --name IDT-example-name

    El uso de la AWS CLI cargará el parámetro en la AWS región del usuario de CLI actual e IDT obtendrá los parámetros de la región configurada. config.json Para comprobar su región desde la AWS CLI, utilice lo siguiente:

    aws configure get region

  3. Una vez que tenga un valor de configuración en la AWS nube, puede actualizar cualquier valor de la configuración de IDT para obtenerlo de la AWS nube. Para ello, utilice un marcador de posición en la configuración de IDT del formulario {{AWS.Parameter.parameter_name}} para buscar el parámetro con ese nombre en el almacén de parámetros. AWS

    Por ejemplo, supongamos que quiere usar el IDT-example-name parámetro del paso 2 como HSM KeyLabel en su configuración de HSM. Para ello, puede actualizar el suyo userdata.json de la siguiente manera:

    "hsm": {
        "keyLabel": "{{AWS.Parameter.IDT-example-name}}",
        [...]
    }

    IDT obtendrá el valor de este parámetro en tiempo de ejecución que se configuró IDT-example-value en el paso 2. Esta configuración es similar a la configuración, "keyLabel": "IDT-example-value" pero, en cambio, ese valor se almacena cifrado en la AWS nube.