Argumentos del instalador - AWS IoT Greengrass

Argumentos del instalador

El software AWS IoT Greengrass Core incluye un instalador que configura el software y proporciona los recursos de AWS necesarios para que se ejecute el dispositivo principal de Greengrass. El instalador incluye los siguientes argumentos que puede especificar para configurar la instalación:

-h, --help

(Opcional) Muestra la información de ayuda del instalador.

--version

(Opcional) Muestra la versión del software AWS IoT Greengrass Core.

-Droot

(Opcional) La ruta a la carpeta que se va a usar como la raíz del software AWS IoT Greengrass Core.

nota

Este argumento establece una propiedad de JVM, por lo que debe especificarla antes de -jar cuando ejecute el instalador. Por ejemplo, especifique java -Droot="/greengrass/v2" -jar /path/to/Greengrass.jar.

Predeterminado:

  • Linux: ~/.greengrass

  • Windows: %USERPROFILE%/.greengrass

-ar, --aws-region

La Región de AWS que el software AWS IoT Greengrass Core usa para recuperar o crear los recursos de AWS necesarios.

-p, --provision

(Opcional) Puede registrar este dispositivo como un objeto AWS IoT y aprovisionar los recursos de AWS que necesite el dispositivo principal. Si especifica true, el software AWS IoT Greengrass Core aprovisiona un objeto AWS IoT, (opcional) un grupo de objetos AWS IoT, un rol de IAM y un alias de rol AWS IoT.

Valor predeterminado: false

-tn, --thing-name

(Opcional) El nombre del objeto AWS IoT que registra como este dispositivo principal. Si el objeto con ese nombre no existe en su Cuenta de AWS, será creado por el software AWS IoT Greengrass Core.

nota

El nombre del objeto no puede contener dos puntos (:).

Debe especificar --provision true si desea aplicar este argumento.

Valor predeterminado: GreengrassV2IotThing_ más un UUID asignado al azar.

-tgn, --thing-group-name

(Opcional) El nombre del grupo de objetos AWS IoT al que se agrega el objeto AWS IoT de este dispositivo principal. Si una implementación se dirige a este grupo de objetos, este dispositivo principal recibe esa implementación cuando se conecta a AWS IoT Greengrass. Si el grupo de objetos con este nombre no existe en su Cuenta de AWS, el software AWS IoT Greengrass Core lo crea.

nota

El nombre del grupo de objetos no puede contener dos puntos (:).

Debe especificar --provision true si desea aplicar este argumento.

-tpn, --thing-policy-name

Esta característica está disponible para la versión 2.4.0 y versiones posteriores del componente núcleo de Greengrass.

(Opcional) El nombre de la política de AWS IoT que se debe adjuntar al certificado del objeto AWS IoT de este dispositivo principal. Si la política AWS IoT con este nombre no existe en su Cuenta de AWS, el software AWS IoT Greengrass Core la crea.

El software AWS IoT Greengrass Core crea una política de AWS IoT permisiva de forma predeterminada. Puede limitar el alcance de esta política o crear una política personalizada en la que restrinja los permisos según su caso de uso. Para obtener más información, consulte Política mínima de AWS IoT para dispositivos principales de AWS IoT Greengrass V2.

Debe especificar --provision true si desea aplicar este argumento.

Valor predeterminado: GreengrassV2IoTThingPolicy

-trn, --tes-role-name

(Opcional) El nombre del rol de IAM que se va a usar para adquirir las credenciales de AWS que permiten al dispositivo principal interactuar con los servicios de AWS. Si el rol con este nombre no existe en su Cuenta de AWS, el software AWS IoT Greengrass Core lo crea con la política GreengrassV2TokenExchangeRoleAccess. Este rol no tiene acceso a los buckets de S3 donde aloja los artefactos de los componentes. Por lo tanto, debe agregar permisos a los buckets y objetos de S3 de sus artefactos al crear un componente. Para obtener más información, consulte Autorización de los dispositivos principales para interactuar con los servicios de AWS.

Debe especificar --provision true si desea aplicar este argumento.

Valor predeterminado: GreengrassV2TokenExchangeRole

-tra, --tes-role-alias-name

(Opcional) El nombre del alias del rol AWS IoT que apunta al rol de IAM que proporciona las credenciales de AWS para este dispositivo principal. Si el alias del rol con este nombre no existe en su Cuenta de AWS, el software AWS IoT Greengrass Core lo crea y lo dirige al rol de IAM que especifique.

Debe especificar --provision true si desea aplicar este argumento.

Valor predeterminado: GreengrassV2TokenExchangeRoleAlias

-ss, --setup-system-service

(Opcional) Puede configurar el software AWS IoT Greengrass Core como un servicio del sistema que se ejecute cuando arranque el dispositivo. El nombre del servicio del sistema es greengrass. Para obtener más información, consulte Configuración del núcleo de Greengrass como un servicio del sistema.

En los sistemas operativos Linux, este argumento requiere que el sistema de inicio systemd esté disponible en el dispositivo.

importante

En los dispositivos principales de Windows, debe configurar el software AWS IoT Greengrass Core como un servicio del sistema.

Valor predeterminado: false

-u, --component-default-user

El nombre o ID del usuario que el software AWS IoT Greengrass Core usa para ejecutar los componentes. Por ejemplo, puede especificar ggc_user. Este valor es obligatorio cuando se ejecuta el instalador en sistemas operativos Windows.

En los sistemas operativos Linux, también puede especificar el grupo de forma opcional. Especifique el usuario y el grupo separados por dos puntos. Por ejemplo, ggc_user:ggc_group.

Las siguientes consideraciones adicionales se aplican a los sistemas operativos Linux:

  • Si se ejecuta como raíz, el usuario del componente predeterminado es el usuario definido en el archivo de configuración. Si el archivo de configuración no define un usuario, el valor predeterminado es ggc_user:ggc_group. Si no existen ggc_user o ggc_group, el software los crea.

  • Si se ejecuta como un usuario no raíz, el software AWS IoT Greengrass Core usa ese usuario para ejecutar los componentes.

  • Si no especifica un grupo, el software AWS IoT Greengrass Core usa el grupo principal del usuario del sistema.

Para obtener más información, consulte Configuración del usuario que ejecuta los componentes.

-d, --deploy-dev-tools

(Opcional) Puede descargar e implementar el componente de la CLI de Greengrass en este dispositivo principal. Puede usar esta herramienta para desarrollar y depurar los componentes en este dispositivo principal.

importante

Se recomienda usar este componente solo en entornos de desarrollo y no en entornos de producción. Este componente brinda acceso a información y operaciones que, por lo general, no necesitará en un entorno de producción. Siga el principio de privilegio mínimo al implementar este componente solo en los dispositivos principales donde lo necesite.

Debe especificar --provision true si desea aplicar este argumento.

Valor predeterminado: false

-init, --init-config

(Opcional) La ruta al archivo de configuración que se usa para instalar el software AWS IoT Greengrass Core. Puede usar esta opción para configurar nuevos dispositivos principales con una configuración de núcleo específica, por ejemplo.

importante

El archivo de configuración que especifique se fusiona con el archivo de configuración existente en el dispositivo principal. Esto incluye los componentes y las configuraciones de los componentes del dispositivo principal. Se recomienda que el archivo de configuración solo muestre las configuraciones que está intentando cambiar.

-tp, --trusted-plugin

(Opcional) La ruta a un archivo JAR para cargarlo como un complemento de confianza. Use esta opción para brindar aprovisionamiento a los archivos JAR del complemento, por ejemplo, para instalarlo con el aprovisionamiento de flota o el aprovisionamiento personalizado, o para instalarlo con la clave privada y el certificado en un módulo de seguridad de hardware.

-s, --start

(Opcional) Puede iniciar el software AWS IoT Greengrass Core después de que se haya instalado y, de forma opcional, aprovisionar recursos.

Valor predeterminado: true