VORTEX

Visão Geral

O Projeto VORTEX foi construído a partir de subscripts que foram criados antes mesmo da ideia do projeto existir. Esses subscripts eram responsáveis por automatizar processos de tratamento de dados. No entanto, quando o desenvolvedor precisou realizar uma coleta de dados, nasceu um script chamado Oxygen. O Oxygen é um controlador de telnet baseado em expect, que se conecta às OLTs via telnet e coleta informações, principalmente relacionadas a ONTs e ONUs.

No entanto, com a criação do script de coleta de dados, foi possível criar um fluxo interno de dados, unindo todos os subscripts e utilizando um script principal para gerenciar esse fluxo. Foi assim que o VORTEX nasceu.

Os subscripts do VORTEX são:

1. Oxygen: Um controlador de telnet em expect, que se conecta com a OLT e executa uma lista de comandos informados no telnet. Além disso, o Oxygen é responsável por elevar o privilégio ou mudar de shell, se necessário. Embora pareça simples, esse script possui a enorme responsabilidade de executar esses procedimentos sem sobrecarregar ou travar a OLT. O Oxygen também solicita os dados de login, garantindo a segurança dessas informações.
2. Tsunami: Um conversor de dados de texto que coleta os dados do usuário e formata-os da maneira desejada. Por exemplo, ele pode transformar IDs de ONTs e ONUs em comandos do telnet, formatar a saída de dados das ONTs para melhor tratamento, entre outras funcionalidades.
3. Obsidian: Esse script é responsável por filtrar dados de sinais dos clientes e das ONTs em dBm. Ele seleciona uma faixa mínima e máxima personalizável para melhorar a identificação de sinais ruins. Além disso, o Obsidian extrai sinais bugados, pois o método antigo de coleta de dados tinha problemas ao coletar informações de ONTs e ONUs desligadas, considerando-as como sinais ruins. O Obsidian reconhece aparelhos desligados e outros problemas do mesmo escopo.

Além dos subscripts mencionados, existem também os pseudo-códigos (assim são chamados), que realizam funções específicas, sem uma qualificação, filtro ou escopo definido. Esses pseudo-códigos podem ser encontrados no meio do código, fora dos outros scripts, e são pequenos demais para terem um nome ou arquivo próprio.

Documentação do Script install.sh

Descrição:

O script install.sh é responsável por facilitar a instalação e reinstalação das dependências necessárias para o projeto Vortex. Além disso, ele clona os repositórios do GitHub relacionados aos scripts de coleta e formatação de dados. Este script é executado durante a configuração inicial do projeto.

Funções Destacadas:

1. instalar_dependencias
   • Instala as dependências essenciais, como Expect, Git e dos2unix.
   • Realiza o clone dos repositórios 'obsidian', 'oxygen', e 'tsunami' do GitHub.
   • Converte os arquivos para o formato Unix, se necessário.
2. reinstalar_dependencias
   • Remove os repositórios já existentes.
   • Executa a função instalar_dependencias para reinstalar todas as dependências.

Uso do Script:

Para executar o script install.sh, utilize o seguinte comando:

sudo bash install.sh [-i] ou [-r]

• i: Instala todas as dependências e realiza o clone dos repositórios.
• r: Reinstala todas as dependências, removendo os repositórios existentes.

Documentação do Script vortex.sh

Descrição:

O script vortex.sh é o ponto central do projeto Vortex. Ele coleta dados do usuário, processa opções da linha de comando e executa outras funções relacionadas à coleta, formatação e análise de dados.

Funções Destacadas:

1. coletar_dados
   • Solicita ao usuário informações como nome do arquivo de entrada, nome do arquivo de saída, IP do servidor Telnet, usuário e senha.
2. processar_opcoes
   • Processa as opções da linha de comando, permitindo a configuração de variáveis importantes.
3. verificar_variaveis
   • Verifica se todas as variáveis necessárias foram preenchidas, evitando erros de execução.
4. verificar_padrao
   • Analisa o padrão da primeira linha do arquivo de entrada e oferece opções de conversão e execução do script Oxygen.
5. executar_oxygen
   • Utiliza o script Oxygen para se comunicar com o servidor Telnet, coletar dados e filtrar informações relevantes.
6. filtrar_dados
   • Formata os dados de saída da execução do Oxygen com o script Tsunami.
7. filtrar_dados_obsidian
   • Oferece a opção de utilizar o script Obsidian para filtrar ainda mais os dados, conforme necessário.

Uso do Script:

Para executar o script vortex.sh, utilize o seguinte comando:

bash vortex.sh [-i arquivo_entrada -u usuario -p senha -s ip_servidor -o arquivo_saida]

• i: Especifica o arquivo de entrada.
• u: Especifica o usuário do servidor Telnet.
• p: Especifica a senha do servidor Telnet.
• s: Especifica o IP do servidor Telnet.
• o: Especifica o arquivo de saída.

Exemplo de Uso:

bash vortex.sh -i dados.txt -u meuusuario -p minhasenha -s 10.10.100.0 -o resultados.txt

Este comando executará o script vortex.sh com as opções fornecidas para coletar, processar e filtrar dados. Certifique-se de que todas as variáveis essenciais foram preenchidas corretamente.

Dependências

As seguintes dependências são necessárias para executar os scripts:

• Expect: É uma ferramenta que automatiza interações com programas de linha de comando, o que é essencial para a comunicação com o servidor Telnet.
• Git: É um sistema de controle de versão usado para clonar repositórios do GitHub.
• dos2unix: É uma ferramenta que converte quebras de linha de arquivos, garantindo a consistência dos formatos de arquivo.

Feedback, Perguntas e Relatórios de Problemas

Se quiser contribuir para a melhoria do projeto Vortex, sugestões, perguntas ou encontrar algum problema, estou aqui para ajudar.

Sugestões e Melhorias

Se você tiver sugestões ou ideias para melhorar o projeto Vortex, sinta-se à vontade para compartilhá-las. Você pode fazer isso das seguintes maneiras:

• Pull Request (PR): Se você deseja contribuir diretamente com código, abra um Pull Request com suas alterações propostas. Analisaremos suas contribuições e trabalharemos juntos para incorporá-las ao projeto.
• Issues: Use as Issues para sugerir melhorias ou novos recursos. Descreva detalhadamente sua ideia para que eu possa entender e discutir como implementá-la.

Relatórios de Problemas (Bugs)

Encontrou um bug ou problema em Vortex? Você pode relatar problemas das seguintes maneiras:

• Issues: Abra uma Issue descrevendo o problema. Inclua informações relevantes, como o ambiente em que o erro ocorreu, etapas para reproduzi-lo e qualquer mensagem de erro que tenha recebido.
• Site: Você também pode reportar bugs em gustavo404.com/sobre. Use os meios de contato para enviar detalhes sobre o problema encontrado.

Perguntas e Suporte

Se você tiver alguma pergunta sobre como usar Vortex ou precisar de suporte, Você pode fazer o seguinte:

• Issues Existentes: Verifique se já existe uma Issue relacionada à sua pergunta. Talvez a resposta que você procura já esteja lá.
• Novas Issues: Se sua pergunta não estiver coberta nas Issues existentes, sinta-se à vontade para criar uma nova Issue com sua pergunta. Ficarei feliz em responder e ajudar.
• Contato pelo Site: Você também pode entrar em contato conosco através do site gustavo404.com/sobre. Utilize os meios de contato para enviar suas perguntas ou dúvidas.

Agradeço por sua contribuição, feedback e envolvimento na comunidade do projeto Vortex.