cybersecsi/raudiUm repositório para gerar e manter atualizadas automaticamente uma série de imagens Docker através do GitHub Actions.
RAUDI (Imagens Docker Atualizadas Regular e Automaticamente) gera automaticamente e mantém atualizada uma série de Imagens Docker por meio de GitHub Actions para ferramentas que não são fornecidas pelos desenvolvedores.
RAUDI é o que vai te salvar de criar e gerenciar muitas Imagens Docker manualmente. Toda vez que um software é atualizado, você precisa atualizar a Imagem Docker se quiser usar os recursos mais recentes, as dependências podem parar de funcionar.
Isso é confuso e demorado.
Não se preocupe mais, nós cuidamos disso.
Você pode tanto bifurcar (fork) este repositório e usar o Workflow do GitHub por conta própria, quanto usá-lo localmente (e gerenciar sua execução da forma que preferir).
Se você quiser bifurcar este repositório, também precisa definir alguns segredos (secrets) para conseguir enviar suas imagens para sua conta pessoal do Docker Hub. Dois segredos do GitHub devem ser configurados:
Após configurar esses segredos, você precisa editar a variável organization definida no arquivo tools/main.py, pois ela está configurada para enviar para o Docker Hub da SecSI.
É isso aí, pessoal: vá em Action, ative-a para o seu repositório bifurcado, espere até meia-noite, e o Workflow fará o trabalho pesado!
Este repositório também pode ser executado localmente. Os requisitos a serem atendidos são os seguintes:
Aqui está a documentação para trabalhar com BuildX: https://docs.docker.com/buildx/working-with-buildx/
A fase de configuração é bastante direta; você só precisa dos seguintes comandos:
git clone https://github.com/cybersecsi/RAUDI
cd RAUDI
pip install -r requirements.txt
Você está pronto para começar!
Para executar o teste, você precisa instalar o pytest com o comando pip install pytest (não está em requirements.txt pois é necessário apenas para fins de teste) e então pode executar:
pytest -s
ou
python -m pytest -s
para rodar os testes.
RAUDI pode construir e enviar todas as ferramentas colocadas no diretório tools. Existem diferentes opções que podem ser usadas ao executá-lo. Antes de usá-lo localmente, você deve criar um arquivo .env (você pode simplesmente copiar o arquivo .env.sample) e adicionar seu Token de Acesso Pessoal do GitHub para evitar Limitação de Taxa (Rate Limiting). Para usuários não autenticados, o GitHub permite até 60 requisições por hora, enquanto usuários autenticados podem fazer até 15.000 requisições por hora. Por isso, recomendamos que você o adicione! Você também pode criar um token de acesso pessoal sem nenhum escopo, pois tudo o que fazemos é ler algumas informações de cada repositório do GitHub.
Neste modo, o RAUDI tenta construir todas as ferramentas, se necessário. O comando para executá-lo é simplesmente:
python3 ./raudi.py --all
Neste modo, o RAUDI tenta construir apenas a ferramenta especificada. O comando neste caso é:
python3 ./raudi.py --single <nome_da_ferramenta>
<nome_da_ferramenta> DEVE ser o nome do diretório dentro da pasta tools.
Como o parâmetro tests foi adicionado à estrutura de configuração da ferramenta, pode ser útil testar se os comandos inseridos retornam um código de status 0. O comando para testar uma ferramenta específica é:
python3 ./raudi.py --test <nome_da_ferramenta>
<nome_da_ferramenta> DEVE ser o nome do diretório dentro da pasta tools.
Se você quiser saber as ferramentas disponíveis, pode executar este comando:
python3 ./raudi.py --list
Se você quiser adicionar rapidamente uma nova pasta de ferramenta a partir de um dos templates disponíveis, pode executar este comando:
python3 ./raudi.py --bootstrap <novo_nome_da_ferramenta>
| Opção | Descrição | Valor Padrão |
|---|---|---|
| --push | Se deve enviar automaticamente para o Docker Hub | False |
| --remote | Se deve verificar no Docker Hub em vez do Docker local antes de construir | False |
| --force | Se deve construir ou não se uma imagem com o mesmo nome de tag foi encontrada | False |
Esta é a lista atual de ferramentas que foram adicionadas. Todas são ferramentas que não possuem uma Imagem Docker oficial fornecida pelo desenvolvedor: