Sphere Agent

25 min

Agente remoto que é instalado como serviço nos sistemas operacionais Windows e Linux. Utilizado para coleta de métricas do ambiente e responsável por executar a automação remota.

Compatibilidade de OS:

O Sphere Agent funciona nas versões Linux (Oracle/CentOS/RHEL/Ubuntu/SUSE/Amazon Linux) e Windows (2008 ou superior) de 64 Bits. Confira mais detalhes na seção Requisitos do Sistema.

Procedimento de instalação:

Antes de começar, vamos entender a estrutura dos arquivos do agent:

sphere-agent/                 # raiz do agent
             plugins/         # diretorio dos plugins do sphere
             queue/           # diretorio temporario de metricas
             atmosphere.yaml  # arquivo de configuração principal
             config.yaml      # arquivo de configuração de coleta
             sphere-agent.log # arquivo de log do agent

Arquivo de configuração (atmosphere.yaml)

Esta é a principal configuração que determina qual o servidor do AIOPS na rede e atributos essenciais do host como permissão de automação e configuração automática do arquivo de coleta config.yaml.

Modificar:

Hostname: Modificar para o IP do host;
Port: Modificar para a porta 80

Adicionar ao arquivo:

path: /sphere-sync
scheme: http

Arquivo de configuração (config.yaml)

Determina a configuração dos plugins, períodos de coleta, proxy, etc. Este arquivo é configurado automaticamente através do Atmos (exige a configuração antecipada do atmosphere.yaml).

Modificar:

Hostname: Modificar para o IP do host;
Port: Modificar para a porta 80

Adicionar ao arquivo:

path: /sphere-sync

Requisitos para instalação

Espaço livre: 500mb (mínimo recomendado)
Volume de instalação:
- Linux: /opt
  - Sub-diretório: /sphere-agent-linux
- Windows: C:/ProgramData/65A
  - Sub-diretório: /sphere-agent-windows

Repositórios e Distribuição

Repositório Cloud AWS/S3: https://65a-internal-sa.s3-sa-east-1.amazonaws.com/repo/latest, este repositório é recomendado para obter a versão mais recente dos agents, sendo necessária a configuração manual dos arquivos (config.yaml e atmosphere.yaml).

Ambiente on-premise: utilize o formato de url http://<aiops-master-node>/repo

Instalação Automática

Procedimento recomendado e disponivel a partir da versão 3.0.0+.

On-premises e Agent pré-configurado

Para realizar a primeira instalação e principalmente nas distribuições on-premises, é recomendado substituir o endereço apontando para a url do servidor principal do AIOPS, desta forma o download será realizado na rede interna e o agent estará automaticamente configurado para este ambiente.

Recomendação de atualização

Recomendamos que antes da atualização do agent verifique o espaço em disco disponível e confirme se a URL utilizada condiz com o tipo de instalação desejada.

Linux (64 bits):

Execute uma das opções de comando abaixo no terminal, a instalação será iniciada e exibirá o log do progresso no console.


# (Opção 1) Utilizando curl
curl -k http://<aiops-master-node>/repo/update-sphere-agent.sh | sudo sh

# (Opção 2) Utilizando wget
wget -O - http://<aiops-master-node>/repo/update-sphere-agent.sh | sudo sh

Com este mesmo comando é possível realizar a atualização do agent quando disponível, um aviso será observado na tela de Infraestrutura do Atmos.

Windows (64 bits):

Faça o download do arquivo no repositório do AIOPS através da url como no exemplo: http://<aiops-master-node>/repo/update-sphere-agent.ps1

Execute o PowerShell como Administrador e rode o comando abaixo:


# Acesse a pasta onde encontra-se o arquivo baixado e execute o comando: 
powershell.exe -ExecutionPolicy Bypass -File .\update-sphere-agent.ps1

Instalação Manual

Windows (64 bits):

Faça o download do Agent para Windows:https://65a-internal-sa.s3.sa-east-1.amazonaws.com/repo/latest/sphere-agent-windows_x64.zip
Salve o arquivo na pasta de serviços desejados, recomendamos a pasta: C:\ProgramData\65A
Descompacte o arquivo baixado (se houver, escolha a opção "Extrair Aqui”)
Acesse a pasta criada e execute o arquivo no PowerShell:.\install-service.ps1
Confirme no gerenciador de serviços do Windows se o processo “sphere-agent” foi iniciado, caso contrário, inicie o serviço.
Reiniciar o serviço (após modificar o config.yaml), no PowerShell: Restart-Service -Name "sphere-agent"

Linux (64 bits):

Faça o download do Agent para Linux:wget -O /opt/sphere-agent-linux.tar.gz https://65a-internal-sa.s3.sa-east-1.amazonaws.com/repo/latest/sphere-agent-linux_x64.tar.gz
Salve o arquivo na pasta de serviços desejados, recomendamos uma das pastas: /opt/ /srv/ /usr/src
Descompacte o arquivo na pasta ou via comando no terminal: tar -zxvf sphere-agent-linux_x64.tar.gz
Acesse a pasta criada e execute o comando no terminal:sudo bash ./install-service.sh
Confirme o status do serviço rodando um dos comandos no terminal:sudo systemctl status sphere-agent
Reiniciar o serviço no terminal (após modificar o arquivo config.yaml):sudo systemctl restart sphere-agent

Arquivos de configuração

Confira o arquivo config.yaml se a seção output.server foi configurada corretamente. Caso já tenha iniciado o serviço, realize as mudanças no arquivo config.yaml e em seguida reinicie o serviço.

Exemplo do atmosphere.yaml


apiVersion: v1                      # versão da api do AIOPS
kind: Host                          # tipo do item de configuração
metadata:
  namespace: default                # namespace deste host
  domain: "<root-domain>"           # nome do dominio raiz
  annotations:                      # anotações locais do host
    atmosphere/host.services: '[]'  # lista de serviços mapeados
config:
  hostname: "127.0.0.1"             # ip/hostname do AIOPS
  api_key: "<atmosphere-api>"       # chave da api
  scheme: http                      # (opcional) se utilizar SSL / Default http
  port: 18001                       # SSL - 443, Default 18001
  path: /sphere-sync                 
  path: /                           # /sphere-sync (se utilizar proxy 80/443)
  agent:                            # configurações do agent local
    self_update: true               # atualizações automáticas do agent

Com este arquivo presente na pasta de configuração será possível controlar as configurações do agent remotamente (via Atmos).

Remoção do agent

Linux

# Utilize o arquivo uninstall.sh para remover o agent
sudo bash /opt/sphere-agent-linux/uninstall.sh

# Remover as pastas do agent
rm -rf /opt/sphere-agent-linux*

# Bonus: Se o atmosphere (módulo de automação) tiver instalado:
# Remover as pastas do atmosphere
rm -rf /opt/.atmosphere

Aviso: Cuidado ao utilizar o comando "rm -rf ***" apontando somente as pastas do agent informadas acima.

Windows

Ao utilizar o instalador ".msi" você poderá desinstalar o agent no gerenciador de programas do próprio Windows. Ou então poderá seguir para a remoção via script (uninstall.ps1) presente na pasta do agent:

# Desinstalar o Agent
powershell.exe -ExecutionPolicy Bypass -File C:\ProgramData\65A\sphere-agent\uninstall.ps1

Atmosphere

O Atmosphere é o módulo adicional que se conecta ao Sphere Agent instalado na máquina e fornece as ferramentas necessárias para execução de rotinas de automação/recuperação de processos e serviços.

Compatibilidade de OS:

O Atmosphere funciona em todas as versões Linux compatíveis com Sphere Agent. Para as versões Windows há somente disponibilidade parcial de algumas distribuições.

Requisitos para instalação

Espaço livre: 500mb (mínimo recomendado)
Diretório de Instalação: /opt/.atmosphere

Instalação Automática

Linux (64 bits):

Execute uma das opções de comando abaixo no terminal, a instalação será iniciada e exibirá o log do progresso no console.


# (Opção 1) Utilizando curl
curl -k http://<aiops-master-node>/repo/install-atmosphere.sh | sudo sh

# (Opção 2) Utilizando wget
wget -O - http://<aiops-master-node>/repo/install-atmosphere.sh | sudo sh

Após a instalação o AIOPS irá detectar e exibir automaticamente em suas soluções que o módulo está disponível no Item de Configuração relacionado.

Utilização de Recursos do Agent

Resource	Idle	Load
Disk	-	170mb
CPU (single core)	< 0,5%	3,5% max
Memory	32mb	50mb max
Network	0,5 KB/sec	10,9 KB/sec max