Configurar um dispositivo IoT Edge para se comunicar por meio de um servidor proxy

Artigo
04/11/2024

Aplica-se a: IoT Edge 1.4

Importante

A versão com suporte é a IoT Edge 1.4. Se você estiver em uma versão anterior, confira Atualizar o IoT Edge.

Os dispositivos IoT Edge enviam solicitações HTTPS para se comunicarem com o Hub IoT. Se você conectou seu dispositivo a uma rede que usa um servidor proxy, precisará configurar o tempo de execução do IoT Edge para se comunicar por meio do servidor. Os servidores proxy também podem afetar módulos individuais do IoT Edge se fizerem solicitações HTTP ou HTTPS que você não roteou pelo hub do IoT Edge.

Este artigo examina as quatro seguintes etapas para configurar e gerenciar um dispositivo IoT Edge por trás de um servidor proxy:

Instalar o runtime do IoT Edge no dispositivo

Os scripts de instalação do IoT Edge efetuam pull de pacotes e arquivos da Internet. Portanto, o dispositivo precisa se comunicar pelo servidor proxy para fazer essas solicitações. Nos dispositivos Windows, o script de instalação também oferece uma opção de instalação offline.

Esta etapa é um processo único para configurar o dispositivo IoT Edge ao configurá-lo pela primeira vez. Você também precisa dessas mesmas conexões ao atualizar o tempo de execução do IoT Edge.
Configurar o IoT Edge e o runtime de contêiner no dispositivo

O IoT Edge é responsável pelas comunicações com o Hub IoT. O runtime de contêiner é responsável pelo gerenciamento de contêineres e, portanto, comunica-se com os registros de contêiner. Esses dois componentes precisam fazer solicitações da Web por meio do servidor proxy.

Esta etapa é um processo único para configurar o dispositivo IoT Edge ao configurá-lo pela primeira vez.
Configurar as propriedades do agente do IoT Edge no arquivo de configuração do dispositivo

A princípio, o daemon do IoT Edge inicia o módulo edgeAgent. Em seguida, o módulo edgeAgent recupera o manifesto de implantação do Hub IoT e inicia todos os outros módulos. Configure as variáveis de ambiente do módulo edgeAgent manualmente no próprio dispositivo, para que o agente do IoT Edge possa fazer a conexão inicial com o Hub IoT. Depois da conexão inicial, você pode configurar o módulo edgeAgent remotamente.

Esta etapa é um processo único para configurar o dispositivo IoT Edge ao configurá-lo pela primeira vez.
Para todas as implantações futuras de módulo, definir variáveis de ambiente para qualquer módulo que se comunica por meio do proxy

Depois de configurar e conectar um dispositivo IoT Edge ao Hub IoT por meio do servidor proxy, você precisará manter a conexão em todas as implantações de módulo futuras.

Esta etapa é um processo contínuo feito remotamente. Portanto, todos as novas atualizações de módulo ou implantação manterão a capacidade do dispositivo de se comunicar por meio do servidor proxy.

Saber a sua URL do proxy

Antes de seguir qualquer etapa deste artigo, você precisa saber a URL do proxy.

Os URLs proxy usam o seguinte formato: protocolo: // proxy_host: proxy_port.

O protocolo é HTTP ou HTTPS. O daemon do Docker pode usar qualquer protocolo, dependendo das configurações do registro de contêiner, mas o daemon do IoT Edge e os contêineres de runtime sempre devem usar HTTPS para se conectar ao proxy.
O proxy_host é um endereço para o servidor proxy. Se o servidor proxy exigir autenticação, você poderá informar as suas credenciais como parte do host de proxy com o seguinte formato: usuário:senha@proxy_host.
O proxy_port é a porta de rede em que o proxy responde ao tráfego de rede.

Instalar o IoT Edge por meio de um proxy

Independentemente do dispositivo IoT Edge ser executado no Windows ou no Linux, você precisa acessar os pacotes de instalação por meio do servidor proxy. Dependendo do sistema operacional, siga as etapas para instalar o runtime do IoT Edge por meio de um servidor proxy.

Dispositivos do Linux

Se você estiver instalando o runtime do IoT Edge em um dispositivo Linux, configure o gerenciador de pacotes para percorrer seu servidor proxy para acessar o pacote de instalação. Por exemplo, Configurar o apt-get para usar um proxy http. Depois de configurar o gerenciador de pacotes, siga as instruções em Instalar o tempo de execução do Azure IoT Edge como de costume.

Dispositivos Windows que usam o IoT Edge para Linux no Windows

Se você estiver instalando o runtime do IoT Edge usando o IoT Edge para Linux no Windows, o IoT Edge será instalado por padrão na sua máquina virtual Linux. Não é necessário instalar ou atualizar outras etapas.

Dispositivos Windows que usam contêineres do Windows

Se você estiver instalando o runtime do IoT Edge em um dispositivo Windows, precisará passar duas vezes pelo servidor proxy. A primeira conexão faz download do arquivo de script do instalador e a segunda conexão é feita durante a instalação para fazer download dos componentes necessários. Você pode configurar as informações de proxy nas configurações do Windows ou incluir as informações de proxy diretamente nos comandos do PowerShell.

As seguintes etapas demonstram um exemplo de uma instalação do Windows usando o argumento -proxy:

O comando Invoke-WebRequest precisa de informações de proxy para acessar o script do instalador. Em seguida, o comando Deploy-IoTEdge precisa das informações de proxy para fazer download dos arquivos de instalação.
```
. {Invoke-WebRequest -proxy <proxy URL> -useb aka.ms/iotedge-win} | Invoke-Expression; Deploy-IoTEdge -proxy <proxy URL>
```
O comando Initialize-IoTEdge não precisa passar pelo servidor proxy. Portanto, a segunda etapa somente requer informações de proxy para o Invoke-WebRequest.
```
. {Invoke-WebRequest -proxy <proxy URL> -useb aka.ms/iotedge-win} | Invoke-Expression; Initialize-IoTEdge
```

Se você tiver credenciais complicadas para o servidor proxy que não podem ser incluídas na URL, use o parâmetro dentro -InvokeWebRequestParametersde -ProxyCredential . Por exemplo,

$proxyCredential = (Get-Credential).GetNetworkCredential()
. {Invoke-WebRequest -proxy <proxy URL> -ProxyCredential $proxyCredential -useb aka.ms/iotedge-win} | Invoke-Expression; `
Deploy-IoTEdge -InvokeWebRequestParameters @{ '-Proxy' = '<proxy URL>'; '-ProxyCredential' = $proxyCredential }

Para obter mais informações sobre parâmetros de proxy, consulte Invoke-WebRequest.

Configurar IoT Edge e Moby

O IoT Edge depende de dois daemons em execução no dispositivo IoT Edge. O daemon do Moby faz solicitações da Web para efetuar pull de imagens de contêiner dos registros de contêiner. O daemon do IoT Edge faz solicitações da Web para se comunicar com o Hub IoT.

Você deve configurar os daemons Moby e IoT Edge para usar o servidor proxy para a funcionalidade contínua do dispositivo. Essa etapa ocorre no dispositivo IoT Edge durante a configuração inicial do dispositivo.

Daemon do Moby

Como o Moby é integrado ao Docker, veja a documentação do Docker para configurar o daemon do Moby com variáveis de ambiente. A maioria dos registros de contêiner (incluindo DockerHub e Azure Container Registries) oferece suporte a solicitações HTTPS, portanto, o parâmetro que você deve definir é HTTPS_PROXY. Se você está obtendo imagens de um registro que não dão suporte ao protocolo TLS (TLS), você deve definir o parâmetro HTTP_PROXY.

Escolha o artigo que se aplica ao sistema operacional do dispositivo IoT Edge:

Configurar o daemon do Docker no Linux O daemon do Moby em dispositivos Linux mantém o nome Docker.
Configurar o daemon do Docker no Windows O daemon do Moby em dispositivos Windows é chamado de iotedge-moby. Os nomes são diferentes porque é possível executar o Docker Desktop e o Moby paralelamente em um dispositivo Windows.

Daemon do IoT Edge

O daemon IoT Edge é semelhante ao daemon Moby. Use as etapas a seguir para definir uma variável de ambiente para o serviço, com base em seu sistema operacional.

O daemon do IoT Edge sempre usa HTTPS para enviar solicitações ao Hub IoT.

Linux

Abra um editor no terminal para configurar o daemon do IoT Edge.

sudo systemctl edit aziot-edged

Insira o texto a seguir, substituindo <URL do proxy> pelo endereço e pela porta do seu servidor proxy. Em seguida, salve e saia.

[Service]
Environment="https_proxy=<proxy URL>"

Da versão 1.2 em diante, o IoT Edge usa o serviço de identidade de IoT para lidar com o provisionamento de dispositivos com o Hub IoT ou o Serviço de Provisionamento de Dispositivos no Hub IoT. Abra um editor no terminal para configurar o daemon do serviço de identidade do IoT Edge.

sudo systemctl edit aziot-identityd

Insira o texto a seguir, substituindo <URL do proxy> pelo endereço e pela porta do seu servidor proxy. Em seguida, salve e saia.

[Service]
Environment="https_proxy=<proxy URL>"

Atualize o gerenciador de serviços para escolher as novas configurações.

sudo systemctl daemon-reload

Reinicie os serviços do sistema IoT Edge para que as alterações dos dois daemons entrem em vigor.

sudo iotedge system restart

Verifique se as variáveis de ambiente e a nova configuração estão presentes.

systemctl show --property=Environment aziot-edged
systemctl show --property=Environment aziot-identityd

Windows que usa o IoT Edge para Linux no Windows

Entre em sua máquina virtual do IoT Edge para Linux no Windows:

Connect-EflowVm

Siga as mesmas etapas da seção Linux deste artigo para configurar o daemon IoT Edge.

Windows que usa contêineres do Windows

Abra uma janela do PowerShell como administrador e execute o seguinte comando para editar o registro com a nova variável de ambiente. Substitua <URL do proxy> pelo endereço e pela porta do seu servidor proxy.

reg add HKLM\SYSTEM\CurrentControlSet\Services\iotedge /v Environment /t REG_MULTI_SZ /d https_proxy=<proxy URL>

Reinicie o IoT Edge para que as alterações entrem em vigor.

Restart-Service iotedge

Configurar o dispositivo IoT Edge

O agente IoT Edge é o primeiro módulo a ser iniciado em qualquer dispositivo IoT Edge. Este módulo é iniciado pela primeira vez com base nas informações do arquivo de configuração do IoT Edge. Em seguida, o agente do IoT Edge se conecta ao Hub IoT para recuperar manifestos de implantação. O manifesto declara quais outros módulos o dispositivo deve implantar.

Essa etapa ocorre uma vez no dispositivo IoT Edge durante a configuração inicial do dispositivo.

Abra o arquivo de configuração no dispositivo IoT Edge: /etc/aziot/config.toml. Você precisa de privilégios administrativos para acessar o arquivo de configuração. Em sistemas Linux, use o comando sudo antes de abrir o arquivo no seu editor de texto preferido.
No arquivo de configuração, localize a [agent] seção, que contém todas as informações de configuração do módulo edgeAgent que serão usadas na inicialização. Verifique se a [agent] seção está sem comentários. Se a [agent] seção estiver ausente, adicione-a config.tomlao . A definição do agente do IoT Edge inclui uma subseção [agent.env] na qual é possível adicionar variáveis de ambiente.

Adicione o parâmetro https_proxy à seção de variáveis de ambiente e defina a URL de proxy com o valor dele.

[agent]
name = "edgeAgent"
type = "docker"

[agent.config]
image = "mcr.microsoft.com/azureiotedge-agent:1.4"

[agent.env]
# "RuntimeLogLevel" = "debug"
# "UpstreamProtocol" = "AmqpWs"
"https_proxy" = "<proxy URL>"

O runtime do IoT Edge usa o AMQP por padrão para falar com o IoT Hub. Alguns servidores proxy bloqueiam as portas AMQP. Se for esse o caso, você também precisará configurar o edgeAgent para usar o AMQP em WebSocket. Remova a marca de comentário do parâmetro UpstreamProtocol.
```
[agent.config]
image = "mcr.microsoft.com/azureiotedge-agent:1.4"

[agent.env]
# "RuntimeLogLevel" = "debug"
"UpstreamProtocol" = "AmqpWs"
"https_proxy" = "<proxy URL>"
```

Adicione o parâmetro https_proxy à seção de variáveis de ambiente e defina a URL de proxy com o valor dele.

[agent]
name = "edgeAgent"
type = "docker"

[agent.config]
image = "mcr.microsoft.com/azureiotedge-agent:1.4"

[agent.env]
# "RuntimeLogLevel" = "debug"
# "UpstreamProtocol" = "AmqpWs"
"https_proxy" = "<proxy URL>"

O runtime do IoT Edge usa o AMQP por padrão para falar com o IoT Hub. Alguns servidores proxy bloqueiam as portas AMQP. Se for esse o caso, você também precisará configurar o edgeAgent para usar o AMQP em WebSocket. Remova a marca de comentário do parâmetro UpstreamProtocol.
```
[agent.config]
image = "mcr.microsoft.com/azureiotedge-agent:1.4"

[agent.env]
# "RuntimeLogLevel" = "debug"
"UpstreamProtocol" = "AmqpWs"
"https_proxy" = "<proxy URL>"
```
Salve as alterações e feche o editor. Aplique as suas últimas alterações.
```
sudo iotedge config apply
```
Verifique se as configurações de proxy são propagadas usando docker inspect edgeAgent na seção Env. Caso contrário, você deve recriar o contêiner.
```
sudo docker rm -f edgeAgent
```
O runtime do IoT Edge deve ser recriado edgeAgent dentro de um minuto. Quando o contêiner estiver sendo executado novamente, use o edgeAgentdocker inspect edgeAgent comando para verificar se as configurações de proxy correspondem ao arquivo de configuração.

Configurar manifestos de implantação

Depois de configurar o dispositivo IoT Edge para funcionar com o servidor proxy, declare a variável de ambiente HTTPS_PROXY em manifestos de implantação futuros. Você pode editar os manifestos de implantação usando o assistente do portal do Azure ou editando um arquivo JSON de manifesto de implantação.

Sempre configure os dois módulos de runtime: edgeAgent e edgeHub para se comunicar por meio do servidor proxy para que eles possam manter uma conexão com o Hub IoT. Se você remover as informações de proxy do módulo edgeAgent, a única maneira de restabelecer a conexão será editar o arquivo de configuração no dispositivo, conforme descrito na seção anterior.

Além dos módulos edgeAgent e edgeHub, outros módulos podem precisar da configuração de proxy. Os módulos que precisam acessar outros recursos do Azure além do Hub IoT, como o armazenamento de blobs, devem ter a variável HTTPS_PROXY especificada no arquivo de manifesto de implantação.

O procedimento a seguir se aplica durante a vida útil do dispositivo IoT Edge.

Portal do Azure

Quando você usa o assistente Configurar módulos para criar implantações de dispositivos IoT Edge, cada módulo tem uma seção Variáveis de Ambiente na qual você pode configurar as conexões do servidor proxy.

Para configurar os módulos do hub do IoT Edge e do agente do IoT Edge, escolha Configurações do Runtime na primeira etapa do assistente.

Screenshot of how to configure advanced Edge Runtime settings.

Adicione a variável de ambiente https_proxy às definições do módulo de agente IoT Edge e do hub do IoT Edge. Se você incluiu a variável de ambiente UpstreamProtocol no arquivo de configuração do dispositivo IoT Edge, inclua isso também na definição do módulo do agente do IoT Edge.

Screenshot of how to set the https_proxy environment variable.

Todos os outros módulos adicionados a um manifesto de implantação seguem o mesmo padrão. Selecione Aplicar para salvar as alterações.

Arquivos de manifesto de implantação de JSON

Se você criar implantações para dispositivos IoT Edge usando os modelos no Visual Studio Code ou criando manualmente arquivos JSON, poderá adicionar as variáveis de ambiente diretamente a cada definição de módulo. Se você não os adicionou no portal do Azure, adicione-os aqui ao seu arquivo de manifesto JSON. Substitua <proxy URL> por um valor próprio.

Use o seguinte formato JSON:

"env": {
    "https_proxy": {
        "value": "<proxy URL>"
    }
}

Com as variáveis de ambiente incluídas, sua definição de módulo deve ser semelhante ao seguinte exemplo edgeHub:

"edgeHub": {
    "type": "docker",
    "settings": {
        "image": "mcr.microsoft.com/azureiotedge-hub:1.4",
        "createOptions": "{}"
    },
    "env": {
        "https_proxy": {
            "value": "http://proxy.example.com:3128"
        }
    },
    "status": "running",
    "restartPolicy": "always"
}

Se você incluiu a variável de ambiente UpstreamProtocol no arquivo confige.yaml em seu dispositivo IoT Edge, inclua isso na definição do módulo do agente do IoT Edge também.

"env": {
    "https_proxy": {
        "value": "<proxy URL>"
    },
    "UpstreamProtocol": {
        "value": "AmqpWs"
    }
}

Trabalhando com proxies de inspeção de tráfego

Alguns proxies, como o Zscaler, podem inspecionar o tráfego criptografado por TLS. Durante a inspeção do tráfego TLS, o certificado retornado pelo proxy não é o do servidor de destino, mas aquele assinado pelo próprio certificado raiz do proxy. Por padrão, os módulos do IoT Edge (incluindo edgeAgent e edgeHub) não confiam no certificado desse proxy e o handshake TLS falha.

Para resolver o handshake com falha, configure o sistema operacional e os módulos do IoT Edge para confiar no certificado raiz do proxy com as etapas a seguir.

Configure o certificado do proxy no repositório de certificados raiz confiáveis do sistema operacional host. Para saber como instalar um certificado raiz, confira Instalar a AC raiz no repositório de certificados do sistema operacional.
Configure o dispositivo IoT Edge para se comunicar por meio de um servidor proxy fazendo referência ao certificado no pacote de confiança. Para saber como configurar o pacote de confiança, confira Gerenciar a AC raiz confiável (pacote de confiança).

Para configurar o suporte do proxy de inspeção de tráfego para contêineres não gerenciados pelo IoT Edge, entre em contato com o provedor do proxy.

Nomes de domínio totalmente qualificados (FQDNs) de destinos com os quais a IoT Edge se comunica

Se o firewall do proxy exigir que você adicione todos os FQDNs à sua lista de permissões para conectividade com a Internet, revise a lista em Permitir conexões de dispositivos IoT Edge para determinar quais FQDNs adicionar.

Próximas etapas

Saiba mais sobre as funções do runtime do IoT Edge.

Solucione problemas de erros de instalação e configuração com problemas comuns e resoluções para o Azure IoT Edge