CLI do Greengrass - AWS IoT Greengrass
VersõesTipoSistema operacionalRequisitosDependênciasConfiguraçãoArquivo de log localChangelog

CLI do Greengrass

O componente da CLI do Greengrass (aws.greengrass.Cli) fornece uma interface de linha de comando local que você pode usar nos dispositivos principais para desenvolver e depurar componentes localmente. A CLI do Greengrass permite criar implantações locais e reiniciar componentes no dispositivo principal, por exemplo.

É possível instalar esse componente ao instalar o software AWS IoT Greengrass Core. Para ter mais informações, consulte Tutorial: Conceitos básicos do AWS IoT Greengrass V2.

Importante

Recomendamos que você use este componente somente em ambientes de desenvolvimento, não em ambientes de produção. Este componente fornece acesso a informações e operações que você normalmente não precisará em um ambiente de produção. Siga o princípio do privilégio mínimo implantando este componente somente nos dispositivos principais em que você precisar dele.

Depois de instalar esse componente, execute o comando a seguir para ver a documentação de ajuda. Quando esse componente é instalado, ele adiciona um link simbólico à greengrass-cli na pasta /greengrass/v2/bin. Você pode executar a CLI do Greengrass a partir desse caminho ou adicioná-la à sua variável de ambiente PATH para executar a greengrass-cli sem o caminho absoluto.

Linux or Unix
/greengrass/v2/bin/greengrass-cli help
Windows
C:\greengrass\v2\bin\greengrass-cli help

O comando a seguir reinicia um componente chamado com.example.HelloWorld, por exemplo.

Linux or Unix
sudo /greengrass/v2/bin/greengrass-cli component restart --names "com.example.HelloWorld"
Windows
C:\greengrass\v2\bin\greengrass-cli component restart --names "com.example.HelloWorld"

Para ter mais informações, consulte Interface de linha de comando do Greengrass.

Versões

Esse componente tem as seguintes versões:

  • 2.13.x

  • 2.12.x

  • 2.11.x

  • 2.10.x

  • 2.9.x

  • 2.8.x

  • 2.7.x

  • 2.6.x

  • 2.5.x

  • 2.4.x

  • 2.3.x

  • 2.2.x

  • 2.1.x

  • 2.0.x

Tipo

Este componente é um componente de plug-in (aws.greengrass.plugin). O núcleo do Greengrass executa esse componente na mesma Java Virtual Machine (JVM) do núcleo. O núcleo é reiniciado quando você altera a versão desse componente no dispositivo principal.

Esse componente usa o mesmo arquivo de log do núcleo do Greengrass. Para ter mais informações, consulte Monitore AWS IoT Greengrass logs.

Para ter mais informações, consulte Tipos de componentes.

Sistema operacional

Esse componente pode ser instalado em dispositivos principais que executam os seguintes sistemas operacionais:

  • Linux

  • Windows

Requisitos

Esse componente tem os seguintes requisitos:

  • Você deve estar autorizado a usar a CLI do Greengrass para interagir com o software AWS IoT Greengrass Core. Siga um destes procedimentos para usar a CLI do Greengrass:

    • Use o usuário do sistema que executa o software AWS IoT Greengrass Core.

    • Use um usuário com permissões de raiz ou administrativas. Nos dispositivos principais do Linux, você pode usar sudo para ter permissões de raiz.

    • Use um usuário do sistema que esteja em um grupo que você especifica nos parâmetros de configuração AuthorizedPosixGroups ou AuthorizedWindowsGroups ao implantar o componente. Para mais informações, consulte Configuração do componente da CLI do Greengras.

  • O componente da CLI do Greengrass é compatível para execução em uma VPC.

Dependências

Quando você implanta um componente, o AWS IoT Greengrass também implanta versões compatíveis das dependências dele. Isso significa que é preciso atender aos requisitos do componente e de todas as dependências dele para implantá-lo com êxito. Nesta seção, há uma lista de todas as dependências das versões lançadas desse componente e as restrições de versão semântica que definem as versões dos componentes para cada dependência. Também é possível visualizar as dependências de cada versão do componente no console do AWS IoT Greengrass. Na página de detalhes do componente, procure a lista de dependências.

2.13.0

A tabela a seguir lista as dependências para as versões 2.12.0 a 2.14.0 deste componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.12.0 <2.14.0 Flexível
2.12.0 – 2.12.6

A tabela a seguir lista as dependências para as versões 2.12.0 a 2.12.6 deste componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.12.0 <2.13.0 Flexível
2.11.0 – 2.11.3

A tabela a seguir lista as dependências das versões 2.11.0 a 2.11.3 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.11.0 <2.12.0 Flexível
2.10.0 – 2.10.3

A tabela a seguir lista as dependências das versões 2.10.0 a 2.10.3 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.11.0 Flexível
2.9.0 – 2.9.6

A tabela a seguir lista as dependências das versões 2.9.0 a 2.9.6 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.10.0 Flexível
2.8.0 – 2.8.1

A tabela a seguir lista as dependências para as versões 2.8.0 e 2.8.1 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.9.0 Flexível
2.7.0

A tabela a seguir lista as dependências da versão 2.7.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.8.0 Flexível
2.6.0

A tabela a seguir lista as dependências para a versão 2.6.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.7.0 Flexível
2.5.0 – 2.5.6

A tabela a seguir lista as dependências das versões 2.5.0 a 2.5.6 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.5.0 <2.6.0 Flexível
2.4.0

A tabela a seguir lista as dependências para a versão 2.4.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.1.0 <2.5.0 Flexível
2.3.0

A tabela a seguir lista as dependências para a versão 2.3.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.1.0 <2.4.0 Flexível
2.2.0

A tabela a seguir lista as dependências para a versão 2.2.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.1.0 <2.3.0 Flexível
2.1.0

A tabela a seguir lista as dependências para a versão 2.1.0 desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.1.0 <2.2.0 Flexível
2.0.x

A tabela a seguir lista as dependências da versão 2.0.x desse componente.

Dependência Versões compatíveis Tipo de dependência
Núcleo do Greengrass >=2.0.0 <2.1.0 Flexível
nota

A versão mínima compatível do núcleo do Greengrass corresponde à versão de patch do componente da CLI do Greengrass.

Para obter mais informações sobre as dependências dos componentes, consulte referência de fórmula do componente.

Configuração

Esse componente fornece os seguintes parâmetros de configuração que podem ser personalizados ao implantar o componente.

2.5.x - 2.13.x
AuthorizedPosixGroups

(Opcional) Uma sequência de caracteres que contém uma lista separada por vírgulas de grupos de sistema. Você autoriza esses grupos de sistemas a usar a CLI do Greengrass para interagir com o software AWS IoT Greengrass Core. Você pode especificar nomes de grupos ou IDs de grupos. Por exemplo, group1,1002,group3 autoriza três grupos do sistema (group1, 1002 e group3) a usar a CLI do Greengrass.

Se você não especificar nenhum grupo para autorizar, poderá usar a CLI do Greengrass como usuário-raiz (sudo) ou como usuário do sistema que executa o software AWS IoT Greengrass Core.

AuthorizedWindowsGroups

(Opcional) Uma sequência de caracteres que contém uma lista separada por vírgulas de grupos de sistema. Você autoriza esses grupos de sistemas a usar a CLI do Greengrass para interagir com o software AWS IoT Greengrass Core. Você pode especificar nomes de grupos ou IDs de grupos. Por exemplo, group1,1002,group3 autoriza três grupos do sistema (group1, 1002 e group3) a usar a CLI do Greengrass.

Se você não especificar nenhum grupo para autorizar, poderá usar a CLI do Greengrass como administrador ou como usuário do sistema que executa o software AWS IoT Greengrass Core.

exemplo Exemplo: atualização da mesclagem de configuração

O exemplo de configuração a seguir especifica a autorização de três grupos de sistema POSIX (group1, 1002 e group3) e dois grupos de usuários do Windows (Device Operators e QA Engineers) para usar a CLI do Greengrass.

{
  "AuthorizedPosixGroups": "group1,1002,group3",
  "AuthorizedWindowsGroups": "Device Operators,QA Engineers"
}
2.4.x - 2.0.x
AuthorizedPosixGroups

(Opcional) Uma sequência de caracteres que contém uma lista separada por vírgulas de grupos de sistema. Você autoriza esses grupos de sistemas a usar a CLI do Greengrass para interagir com o software AWS IoT Greengrass Core. Você pode especificar nomes de grupos ou IDs de grupos. Por exemplo, group1,1002,group3 autoriza três grupos do sistema (group1, 1002 e group3) a usar a CLI do Greengrass.

Se você não especificar nenhum grupo para autorizar, poderá usar a CLI do Greengrass como usuário-raiz (sudo) ou como usuário do sistema que executa o software AWS IoT Greengrass Core.

exemplo Exemplo: atualização da mesclagem de configuração

O exemplo de configuração a seguir especifica a autorização de três grupos do sistema (group1, 1002 e group3) a usar a CLI do Greengrass.

{
  "AuthorizedPosixGroups": "group1,1002,group3"
}

Arquivo de log local

Esse componente usa o mesmo arquivo de log do componente de núcleo do Greengrass.

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
Para exibir os logs desse componente

  • Execute o comando a seguir no dispositivo principal para visualizar o arquivo de log desse componente em tempo real. Substitua /greengrass/v2 ou C:\greengrass\v2 pelo caminho para a pasta raiz do AWS IoT Greengrass.

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

Changelog

A tabela a seguir descreve as alterações em cada versão do componente.

Version (Versão)

Alterações

2.13.0

Versão atualizada para o lançamento da versão 2.13.0 do núcleo do Greengrass.

2.12.6

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.6.

2.12.5

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.5.

2.12.4

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.4.

2.12.3
Atenção

Esta versão não está mais disponível. As melhorias nesta versão estão disponíveis em versões posteriores desse componente.

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.3.

2.12.2

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.2.

2.12.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.12.1.

2.12.0

Versão atualizada para o núcleo do Greengrass 2.12.0.

2.11.3

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.11.3.

2.11.2

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.11.2.

2.11.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.11.1.

2.11.0
Novos atributos

  • Permite que você cancele uma implantação local.

  • Permite configurar uma política de tratamento de falhas para uma implantação local.

  • Melhora os relatórios detalhados do status de implantação.

2.10.3

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.10.3.

2.10.2

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.10.2.

2.10.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.10.1.

2.10.0

Versão atualizada para o lançamento da versão 2.10.0 do núcleo do Greengrass.

2.9.6

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.6.

2.9.5

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.5.

2.9.4

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.4.

2.9.3

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.3.

2.9.2

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.2.

2.9.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.9.1.

2.9.0

 Versão atualizada para o núcleo do Greengrass 2.9.0.

2.8.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.8.1.

2.8.0

 Versão atualizada para o lançamento da versão 2.8.0 do núcleo do Greengrass.

2.7.0

Versão atualizada para o lançamento da versão 2.7.0 do núcleo do Greengrass.

2.6.0
Novos atributos

  • Adiciona suporte para componentes personalizados para chamar operações de comunicação entre processos (IPC) que a CLI do Greengrass usa. Você pode usar essas operações de IPC para gerenciar implantações locais, visualizar detalhes do componente e gerar uma senha que pode ser usada para entrar no console de depuração local. Para saber mais informações, consulte IPC: gerenciar implantações e componentes locais.

Correções de bugs e melhorias

  • Correções secundárias e melhorias adicionais.

2.5.6

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.6.

2.5.5

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.5.

2.5.4

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.4.

2.5.3

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.3.

2.5.2

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.2.

2.5.1

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.5.1.

2.5.0
Novos atributos

  • Adiciona suporte para dispositivos principais que executam o Windows.

  • Adiciona o novo parâmetro de configuração AuthorizedWindowsGroups que você pode especificar para autorizar grupos do sistema a usar a CLI do Greengrass em dispositivos Windows.

  • Adiciona o parâmetro windowsUser para implantações locais. Você pode usar esse parâmetro para especificar o usuário a ser usado para executar componentes em um dispositivo principal do Windows.

2.4.0
Novos atributos

2.3.0

Versão atualizada para o lançamento da versão 2.3.0 do núcleo do Greengrass.

2.2.0

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.2.0.

2.1.0

Versão atualizada para o lançamento do núcleo do Greengrass versão 2.1.0.

2.0.5

 Versão atualizada para o lançamento do núcleo do Greengrass versão 2.0.5.

2.0.4

 Versão atualizada para o lançamento do núcleo do Greengrass versão 2.0.4.

2.0.3

Versão inicial.