Documentação do Oracle Cloud Infrastructure

Tarefas de Administração do Management Gateway

Atualizar Propriedades do Gateway de Gerenciamento

Porta do Gateway de Gerenciamento

O Gateway de Gerenciamento é configurado para aceitar tráfego em uma porta específica que é especificada usando a propriedade GatewayPort do arquivo gateway.properties.
  • Nas plataformas Linux, o arquivo gateway.properties está localizado em: /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/config.
  • Nas plataformas Windows, o arquivo gateway.properties está localizado em: C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config.

Para alterar o valor da porta do Gateway de Gerenciamento, edite o arquivo gateway.properties e substitua o valor atual da propriedade GatewayPort pelo número da porta desejada.

Após alterar o arquivo gateway.properties, o serviço Management Gateway deverá ser reiniciado.

  • Para o Oracle Linux 6, use: /sbin/initctl restart mgmt_gateway

  • Para o Oracle Linux 7, use: systemctl restart mgmt_gateway

  • Para Windows, use: 
    net stop mgmt_gateway
net start mgmt_gateway

Se o valor da propriedade GatewayPort for alterado, todos os Agentes de Gerenciamento que usam esse Gateway de Gerenciamento deverão ser alterados para usar o novo valor da porta. Para obter detalhes, consulte Atualizar Agentes de Gerenciamento após Alterações na Configuração do Serviço Management Gateway

Credenciais do Gateway de Gerenciamento

O Gateway normalmente é configurado para usar credenciais: o nome de usuário e a senha são necessários para estabelecer conexão com ele.

Essas credenciais são armazenadas no Oracle Wallets. Para obter informações sobre como adicionar, atualizar ou excluir credenciais, consulte Configurar Credenciais do Serviço Management Gateway.

Se as credenciais do Management Gateway forem alteradas, todos os Agentes de Gerenciamento que usam o Management Gateway deverão ser alterados para usar as novas credenciais. Para obter informações, consulte Atualizar Agentes de Gerenciamento após Alterações na Configuração do Gateway de Gerenciamento.

Configurar Credenciais do Serviço Management Gateway

Esta seção descreve como gerenciar credenciais que podem ser necessárias para o Management Gateway.

O Management Gateway armazena informações confidenciais, como credenciais, em Oracle Wallets.

Depois de instalar um Management Gateway, talvez você precise configurar credenciais.

Observação

Se forem feitas alterações usando os comandos da CLI, o gateway deverá ser reiniciado. Para obter informações sobre comandos da CLI, consulte Referência de Comando da CLI do Oracle Cloud Infrastructure.

Adicionar ou Atualizar Credenciais

Para adicionar credenciais ou atualizar as credenciais existentes, use o script gateway_credentials com a operação upsertCredentials.

  • Linux: O script gateway_credentials.sh está localizado no diretório /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin.
  • Windows: O script gateway_credentials.bat está localizado no diretório C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin.

  1. Crie um arquivo de texto com o nome de usuário e a senha do gateway:

    GatewayUsername=<USER_NAME>
GatewayPassword=<USER_PASSWORD>

    Por exemplo, você pode salvar o arquivo de texto como cred.properties.

  2. Adicione credenciais usando um arquivo de texto.

    • Para Linux, use:
      gateway_credentials.sh -o upsertCredentials

      Por exemplo, você pode executar o seguinte no Linux usando o arquivo cred.properties: 

      cat cred.properties | sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o upsertCredentials
    • Para Windows, use:
      gateway_credentials.bat -o upsertCredentials
      Por exemplo, você pode executar o seguinte no Windows usando o arquivo cred.properties:
      type cred.properties | C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin\gateway_credentials.bat -o upsertCredentials

  3. Exclua o arquivo de texto criado na etapa 1.

    O arquivo de texto contém informações confidenciais. Os clientes são responsáveis por excluir o arquivo de texto de credenciais depois de concluir a operação de adição ou atualização de credenciais.

Excluir Credenciais

Para excluir credenciais, use o script gateway_credentials com a operação deleteCredentials.

  • Linux:

    O script gateway_credentials.sh está localizado no diretório /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin.

    Sintaxe: 
    gateway_credentials.sh -o deleteCredentials
    Exemplo:
    sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o deleteCredentials
  • Janelas:

    O script gateway_credentials.bat está localizado no diretório C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin.

    Sintaxe: 
    gateway_credentials.bat -o deleteCredentials
    Exemplo:
    C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config\bin\gateway_credentials.bat -o deleteCredentials
Observação

A exclusão de credenciais não exclui a wallet que continha as credenciais.

Atualizar Agentes de Gerenciamento após Alterações na Configuração do Gateway de Gerenciamento

Se a configuração do Management Gateway for alterada, o Management Agent também poderá ter que ser alterado.

  • Host do gateway: Se o Gateway for movido para outro host ou se o host do Gateway for renomeado, todos os Agentes que usam o Gateway deverão ser alterados para usar o novo nome do host.

    Nesse caso, o parâmetro GatewayServerHost do Management Agent deve ser atualizado para usar o novo Gateway.

  • Porta do gateway: Se o valor da porta do Gateway for alterado, todos os Agentes que usam o Gateway deverão ser alterados para usar o novo valor da porta.

    Nesse caso, o parâmetro GatewayServerPort do Management Agent deve ser atualizado para usar a nova porta do Gateway.

  • Credenciais de gateway: Se as credenciais necessárias para estabelecer conexão com o Gateway de Gerenciamento (como nome de usuário e senha) forem alteradas, todos os Agentes que usam o Gateway deverão ser alterados para usar as novas credenciais. Para obter informações, consulte Tipo de Credencial para Gateways e Proxies de Gerenciamento e Adicionar ou Atualizar Credenciais.

Atualizar Credenciais de Proxy para o Management Gateway

Você pode atualizar credenciais de proxy externas existentes para o Management Gateway.

Pré-requisitos:

O Management Gateway deve ser configurado com um proxy usando as duas seguintes propriedades:
  • ProxyHost
  • ProxyPort
Por exemplo:
ProxyHost=myproxy.example.com
ProxyPort=80

Etapa 1: Criar corpo da solicitação para atualizar as credenciais do proxy

Forneça o novo nome de usuário e a senha no arquivo de credenciais usando as seguintes propriedades:

  • ProxyUser: Nome do usuário para autenticação com o proxy.
  • ProxyPassword: Senha do usuário para a autenticação com o proxy.
Observação

As propriedades das credenciais acima fazem distinção entre maiúsculas e minúsculas.

Veja abaixo o arquivo de credenciais de amostra sample-proxycreds.json: 

{"source":"agent.%%agentId%%",
"name":"ManagementAgent-Proxy",
"type":"ProxyCreds",
"description":"Proxy Credentials",
"properties":[
{"name":"ProxyUser","value":"<UserName>"},
{"name":"ProxyPassword","value":"<Password>"}]}

Etapa 2: Executar comando para atualizar a credencial de proxys

Execute o comando abaixo para atualizar as credenciais de proxy usando o arquivo de amostra acima:
  • Para Linux:
    cat sample-proxycreds.json | sudo -u mgmt_agent /opt/oracle/mgmt_agent/agent_inst/bin/credential_mgmt.sh -o upsertCredentials -s Agent
  • Para Windows:
    type sample-proxycreds.json | C:\oracle\mgmt_agent\agent_inst\bin\credential_mgmt.bat -o upsertCredentials -s Agent

Etapa 3: Reiniciar o Management Gateway

  • Para Linux:
    sudo systemctl restart mgmt_gateway
  • Para Windows:
    net stop mgmt_gateway
net start mgmt_gateway
Observação

As credenciais são usadas pelo Management Gateway para comunicação com os serviços do Oracle Cloud Infrastructure. Alterar seu formato ou remover as credenciais pode ter um efeito adverso na capacidade do Management Gateway de se comunicar de volta com os serviços do Oracle Cloud Infrastructure.

Ativar Lote para o Management Gateway

Depois de instalar o Management Gateway, você pode ativar o batch para fornecer um gerenciamento melhor e mais rápido dos uploads de log para o serviço Log Analytics.

Para ativar o batch, adicione a seguinte propriedade no arquivo gateway.properties:
BatchingEnabled=true

Depois de atualizar o arquivo gateway.properties, o serviço Management Gateway deverá ser reiniciado. Para reiniciá-lo, execute o seguinte:

  • Para o Oracle Linux 6, use: /sbin/initctl restart mgmt_gateway
  • Para o Oracle Linux 7, use: systemctl restart mgmt_gateway

Fazer Upgrade do Management Gateway

Fazer Upgrade do Management Gateway no Linux

Para fazer upgrade de um gateway no Linux, faça o seguinte:
  • Faça download da versão mais recente do arquivo RPM que contém o arquivo de download do software. Para obter detalhes, consulte Fazer Download do Software do Management Gateway.
  • Para fazer upgrade do gateway, execute o comando rpm com a opção de upgrade: rpm -U.
    sudo rpm -U <rpm_file_name.rpm>

Fazer Upgrade do Management Gateway no Linux usando um arquivo Zip

Para fazer upgrade de um gateway no Linux usando um arquivo Zip, faça o seguinte:

  • Faça download da versão mais recente do arquivo ZIP que contém o arquivo de download do software do gateway. Para obter detalhes, consulte Fazer Download do Software do Management Gateway
  • Navegue até o diretório em que você fez download do arquivo ZIP do software do gateway de gerenciamento e deszipe-o em qualquer local preferencial.
  • Para fazer upgrade do gateway, execute o script installer.sh com a opção:-u 
    installer.sh -u
  • A saída é semelhante à seguinte:
    sudo ./installer.sh -u
Checking pre-requisites
        Checking available disk space for gateway upgrade
        Checking agent version 

Executing install
        Unpacking software zip
        Copying files to destination dir (/opt/oracle/mgmt_agent)
        Updating communication wallet 
        Creating 'mgmt_gateway' daemon
        Starting mgmt_gateway
        Gateway Install Logs: /opt/oracle/mgmt_agent/installer-logs/installer.log

Gateway upgrade successful

Fazer Upgrade do Management Gateway no Windows

Para fazer upgrade de um gateway no Windows:
  • Faça log-in como um usuário Administrador e abra uma janela de prompt de comando.
  • Faça download da versão mais recente do arquivo ZIP que contém o arquivo de download de software do agente. Para obter detalhes, consulte Fazer Download do Software do Management Gateway.
  • Navegue até o diretório em que você fez download do arquivo ZIP do software do agente de gerenciamento e descompacte-o em qualquer local de sua preferência.
  • Para fazer upgrade do gateway, execute o script installer.bat com a opção -u: 
    installer.bat -u

    Por exemplo: C:\Users\test_agent>installer.bat -u

    A saída parece semelhante à seguinte:
    JAVA_HOME found at: C:\Program Files\Java\jdk1.8.0_321
Executing upgrade
        Unpacking software zip
        Copying files to destination dir (C:\Oracle\mgmt_agent)
        Updating communication wallet       
        Creating mgmt_gateway service

Management Gateway upgrade successful
The Oracle Management Gateway service is starting....
The Oracle Management Gateway service was started successfully.

Remover Management Gateway

Ao remover um Management Gateway de um host, o registro do Management Gateway é cancelado no Management Agents Cloud Service antes de ser removido do host.

Para remover ou desinstalar o Management Gateway dos seguintes sistemas operacionais, você pode seguir estas etapas:

Remover o Management Gateway no Linux usando o comando RPM

Execute o seguinte comando rpm com a opção -e :
sudo rpm -e <rpm_name>

Remover o Management Gateway no Linux usando um script desinstalador

Execute o script uninstaller.sh se tiver instalado o Management Gateway usando os arquivos ZIP.

A saída parece semelhante à seguinte:

$ sudo bash /opt/oracle/mgmt_agent/agent_inst/bin/uninstaller.sh
Executing pre-remove step from uninstall
Attempting to remove the Gateway from Management Agent Cloud service, please do not interrupt...
Attempting to remove the Gateway from Management Agent Cloud service,please do not interrupt...
Gateway was removed from Management Agent Cloud service successfully.
Detected Oracle Linux Server (Red Hat family):
Stopping mgmt_gateway...
Removing mgmt_gateway daemon from systemd...
Removed symlink /etc/systemd/system/multi-user.target.wants/mgmt_gateway.service.
Gateway was removed from the host successfully.
Executing post-remove step from uninstall
Gateway state directory was removed from the host successfully.
Observação

Se você instalou o Management Gateway usando um volume externo no Linux, o script desinstalador do Management Gateway removerá todos os dados no diretório /opt/oracle/mgmt_agent e, em alguns sistemas operacionais, também removerá o diretório de destino para o qual o symlink aponta.

Remover Management Gateway no Windows

Abra uma janela de Prompt de Comando, navegue até o diretório base de instalação do Management Gateway e execute o script uninstaller.bat.

A saída parece semelhante à seguinte: 
C:\Oracle>mgmt_agent\uninstaller.bat
Removing Management Gateway from the OCI service console.
Attempting to remove the agent from Management Agent Cloud service, do not interrupt...
Gateway was removed from the Management Agent Cloud service successfully.
Removing Management Gateway service from the host 
Management Gateway service was removed from the host successfully
Removing Management Gateway directories

Certifique-se de que todas as outras janelas de prompt de comando estejam fechadas ou que não estejam apontando para o diretório home do Management Gateway antes de executar o script uninstaller.bat.

Configurar o Management Gateway usando Certificados Personalizados

Para configurar o Management Gateway, você pode importar certificados personalizados para o Serviço de Certificado do OCI na console do Oracle Cloud. Para obter mais informações, consulte Importando um Certificado.
  1. Na console do Oracle Cloud, abra o menu de Navegação e selecione Identidade e Segurança.
  2. Vá para Certificados e selecione Certificados.
  3. Clique em Criar Certificado.
  4. Selecione o Compartimento, no qual você deseja importar o certificado, ele deve ser o mesmo compartimento no qual o Management Gateway está instalado.
  5. Para importar um certificado que você planeja gerenciar usando uma autoridade de certificação (CA), clique em Importado como o Tipo de Certificado.
  6. Informe um nome para exibição exclusivo para o certificado. Evite digitar informações confidenciais.
  7. Opcionalmente, você pode informar uma descrição para o certificado.
  8. Informe uma chave privada e o certificado de cadeia.

    O certificado estará pronto para ser usado quando o status do certificado estiver Ativo na console do Oracle Cloud.

  9. Em seguida, copie o OCID do certificado e digite o OCID como parâmetro no arquivo de resposta do Management Gateway durante a instalação do Management Gateway usando o formato a seguir. Consulte Configurar um Arquivo de Resposta para o Management Gateway.
    GatewayCertOcid=ocid1.certificate.oc1.iad.<unique-id>
  10. Execute as etapas a seguir para importar os mesmos certificados no Management Agent para que a interação completa de ponta a ponta funcione.

Usar um Usuário do SO Não Padrão para Instalar o Management Gateway

A Oracle recomenda executar a instalação do Management Gateway usando o usuário padrão do SO: mgmt_agent, mas dependendo de seus requisitos, talvez você precise executar a instalação usando outro usuário do SO.

Esta seção descreve como instalar o Management Gateway usando um usuário diferente de mgmt_agent, o usuário padrão do SO.

Pré-requisitos

Observação

Ao escolher um usuário do sistema operacional diferente de mgmt_agent para executar a instalação do Management Gateway nos sistemas Linux ou Unix, as seguintes considerações precisam ser tomadas:

  • Selecione um usuário do SO com privilégios limitados.

    O usuário padrão do SO mgmt_agent é um usuário do SO com privilégio mínimo sem shell de log-in. Se você decidir selecionar outro usuário do SO, certifique-se de que o usuário escolhido tenha privilégios limitados.

  • O Management Gateway é um aplicativo multithread e cada thread (LWP) conta para o limite do usuário do SO. Certifique-se de que o limite do usuário (ulimit) para max user processes seja definido adequadamente verificando:
    ulimit -u

    A escolha de um limite inadequado pode resultar na instabilidade do Management Gateway e dos aplicativos em execução conforme o usuário do SO selecionado.

  1. Identifique um usuário do SO válido para executar a instalação do Management Gateway e usá-la como valor para a variável RUN_AGENT_AS_USER.
    A Oracle recomenda que o usuário do SO selecionado tenha o mínimo de privilégios e nenhum shell de login.
    id -un <username>

    Exemplo 1

    id -un myexistinguser
    O usuário do SO myexistinguser existe. A saída retorna o valor do usuário selecionado e se parece com o seguinte:
    myexistinguser
    Exemplo 2:
    id -un mytestuser2
    O usuário do SO mytestuser2 não existe e não é um usuário válido. A saída não retorna nenhum valor de usuário e se parece com o seguinte:
    id: mytestuser2: no such user
  2. Identifique o grupo principal do usuário a ser usado como valor para a variável AGENT_USER_GROUP.
    Certifique-se de que o valor de AGENT_USER_GROUP seja o grupo de usuários principal do usuário do SO selecionado.
    Observação

    O uso de um grupo secundário não é suportado e pode resultar em danos no Management Gateway. 
    id -gn <username>
    Por exemplo:
    id -gn myexistinguser
    A saída parece semelhante à seguinte:
    staff

Definir Variáveis de Ambiente e Instalar o Management Gateway

  1. Defina as seguintes variáveis de ambiente:
    RUN_AGENT_AS_USER=<selected_OS_user_for_ManagementGateway_installation>
AGENT_USER_GROUP=<OS_primary_group_of_selected_OS_user>
    Por exemplo:
    RUN_AGENT_AS_USER=myexistinguser
AGENT_USER_GROUP=staff
  2. Certifique-se de que a variável de ambiente acima esteja acessível pelo usuário do SO root.

    Por padrão, as variáveis de ambiente não são compartilhadas com o usuário root.

  3. Verifique se as variáveis de ambiente estão definidas corretamente executando o seguinte:
    sudo su
echo $RUN_AGENT_AS_USER
echo $AGENT_USER_GROUP
    Por exemplo, a saída é a seguinte:
    myexistinguser
staff
    Se root não conseguir acessar as variáveis de ambiente, edite o arquivo /etc/sudoers e adicione o seguinte:
    Defaults env_keep+=RUN_AGENT_AS_USER
Defaults env_keep+=AGENT_USER_GROUP

    O acima garante que as variáveis de ambiente RUN_AGENT_AS_USER e AGENT_USER_GROUP sejam preservadas e acessíveis pelo usuário root.

    Depois de atualizar o arquivo /etc/sudoers, defina as variáveis de ambiente novamente e verifique se root pode acessar as variáveis de ambiente.

  4. Depois que a verificação for concluída, você poderá iniciar a instalação do Management Gateway: Faça log-in como root, defina as variáveis de ambiente e, em seguida, inicie a instalação do Management Gateway.

    Dependendo do seu método preferido, você pode seguir as instruções de Instalar o Management Gateway no arquivo RPM do Linux ou Instalar o Management Gateway no arquivo ZIP do Linux.

    Por exemplo, siga as instruções em Instalar o Management Gateway no arquivo RPM do Linux. Nesse caso, ignore a etapa 1, pois você já é root e não há necessidade de privilégios sudo. Comece na etapa 2: rpm -ivh <rpm_file_name.rpm>