🐳 RAUDI: 정기적으로 자동 업데이트되는 Docker 이미지

RAUDI (정기적으로 자동 업데이트되는 Docker 이미지)는 개발자가 제공하지 않는 도구들을 위해 _GitHub Actions_를 통해 일련의 _Docker 이미지_를 자동으로 생성하고 최신 상태로 유지합니다.

RAUDI란?

RAUDI는 많은 Docker 이미지를 수동으로 생성하고 관리해야 하는 번거로움에서 벗어나게 해줍니다. 소프트웨어가 업데이트될 때마다 최신 기능을 사용하려면 Docker 이미지를 업데이트해야 하며, 의존성이 더 이상 작동하지 않을 수도 있습니다.

이 작업은 지저분하고 시간이 많이 걸립니다.

더 이상 걱정하지 마세요. 저희가 해결해 드립니다.

이 저장소를 포크하여 GitHub Workflow를 직접 사용하거나 로컬에서 사용할 수 있습니다(원하는 방식으로 실행 관리 가능).

포크

이 저장소를 포크하려면 개인 Docker Hub 계정에 이미지를 푸시할 수 있도록 몇 가지 시크릿을 설정해야 합니다. 다음 두 가지 GitHub 시크릿을 반드시 설정해야 합니다:

DOCKER_USER: Docker Hub 사용자 이름;
DOCKER_API_TOKEN: Docker Hub 비밀번호 또는 API 토큰.

시크릿을 설정한 후에는 tools/main.py 파일에 설정된 organization 변수를 편집해야 합니다. 해당 변수는 SecSI의 Docker Hub에 푸시하도록 구성되어 있기 때문입니다.

이것으로 끝입니다. Action으로 이동하여 포크된 저장소에서 활성화하고 자정까지 기다리면 Workflow가 모든 작업을 처리합니다!

설정

이 저장소는 로컬에서도 실행할 수 있습니다. 충족해야 할 요구 사항은 다음과 같습니다:

Python 3.x
Docker (BuildX 포함)

BuildX 사용에 대한 문서는 다음을 참조하세요: https://docs.docker.com/buildx/working-with-buildx/

설정 단계는 매우 간단합니다. 다음 명령어만 실행하면 됩니다:

git clone https://github.com/cybersecsi/RAUDI
cd RAUDI
pip install -r requirements.txt

준비 완료!

테스트

테스트를 실행하려면 pip install pytest 명령어로 pytest를 설치해야 합니다 (requirements.txt에 없음, 테스트 용도로만 필요). 그런 다음 다음을 실행하면 됩니다:

pytest -s

또는

python -m pytest -s

로컬 사용법

RAUDI는 tools 디렉토리에 있는 모든 도구를 빌드하고 푸시할 수 있습니다. 실행할 때 다양한 옵션을 사용할 수 있습니다. 로컬에서 사용하기 전에 .env 파일을 생성하고(.env.sample 파일을 복사하면 됩니다) _GitHub Personal Access Token_을 추가하여 속도 제한을 피하는 것이 좋습니다. 인증되지 않은 사용자는 시간당 최대 60회 요청이 가능하지만, 인증된 사용자는 시간당 최대 15,000회 요청이 가능합니다. 따라서 추가하는 것을 권장합니다! 어떤 범위도 없는 개인 액세스 토큰을 생성해도 됩니다. 우리가 하는 것은 각 GitHub 저장소의 일부 정보를 읽는 것뿐이기 때문입니다.

실행 모드

일반 실행

이 모드에서는 필요할 경우 RAUDI가 모든 도구를 빌드하려고 시도합니다. 실행 명령어는 간단합니다:

python3 ./raudi.py --all

단일 빌드

이 모드에서는 RAUDI가 지정된 도구만 빌드하려고 시도합니다. 명령어는 다음과 같습니다:

python3 ./raudi.py --single <tool_name>

_tool_name_은 tools 폴더 안에 있는 디렉토리 이름과 동일해야 합니다.

도구 테스트

도구의 설정 구조에 tests 매개변수가 추가되었으므로, 입력된 명령어가 0 상태 코드를 반환하는지 테스트하는 데 유용합니다. 특정 도구를 테스트하는 명령어는 다음과 같습니다:

python3 ./raudi.py --test <tool_name>

_tool_name_은 tools 폴더 안에 있는 디렉토리 이름과 동일해야 합니다.

도구 목록 보기

사용 가능한 도구를 확인하려면 다음 명령어를 실행합니다:

python3 ./raudi.py --list

도구 부트스트랩

사용 가능한 템플릿 중 하나를 기반으로 새 도구 폴더를 빠르게 추가하려면 다음 명령어를 실행합니다:

python3 ./raudi.py --bootstrap <new_tool_name>

옵션

옵션	설명	기본값
--push	Docker Hub에 자동으로 푸시할지 여부	False
--remote	빌드 전에 로컬 Docker 대신 Docker Hub에서 확인할지 여부	False
--force	동일한 태그 이름의 이미지가 발견되어도 빌드할지 여부	False

사용 가능한 도구

현재 추가된 도구 목록입니다. 이들은 모두 개발자가 공식 Docker 이미지를 제공하지 않는 도구들입니다:

RAUDI

인기