diki

디키

Diki A "Compliance Checker"또는 정렬, 플러그 가능한 규칙 세트가있는 탐정 제어 프레임 워크. Gardener 가족의 일부이지만 다른 Kubernetes 배포판 또는 비 Kubernetes 환경에서도 사용될 수 있으며 예를 들어 hyperscaler 계정의 준수를 확인합니다.

Diki는 "시험"의 그리스어입니다. 또한 "주요 명령에 대한 탐정 조사"또는 GNU 스타일의 재귀 약어 "Diki가 주요 명령을 조사합니다"로 암기 할 수 있습니다. 구어체 적으로 "나는 그것을 알지 못합니다"로 알려져 있습니다. 그것은 그것이하는 일에도 잘 맞습니다.

중요한

이 저장소는 적극적으로 개발 중입니다. API는 거꾸로 호환되지 않고 변경 될 수 있습니다.

시작하기

설치

GitHub 릴리스를 통해 설치하면 경로에 Diki Binary를 넣어야합니다.

MacOS 용 샘플 설치 스 니펫은 다음과 같습니다.

 # Example for macOS

# set operating system and architecture
os=darwin # choose between darwin, linux, windows
arch=amd64 # choose between amd64, arm64

# Get latest version. Alternatively set your desired version
version= $( curl -Ls -H ' Accept: application/json ' https://github.com/gardener/diki/releases/latest | jq -r ' .tag_name ' )

# Download diki
curl -LO " https://github.com/gardener/diki/releases/download/ ${version} /diki- ${os} - ${arch} "

# Make the diki binary executable
chmod +x " ./diki- ${os} - ${arch} "

# Move the binary in to your PATH
sudo mv " ./diki- ${os} - ${arch} " /usr/local/bin/diki

달리다

Diki의 run 구성의 대부분은 구성 파일을 통해 제공됩니다. 옵션은 다른 공급자와 규칙 세트에 따라 다릅니다. 다음은 시작하기위한 몇 가지 명령입니다.

• 알려진 모든 공급자를 위해 알려진 모든 규칙 세트를 실행하십시오

diki run 
    --config=config.yaml 
    --all

• 알려진 모든 공급자에 대해 알려진 모든 규칙 세트를 실행하고 요약 JSON 보고서 파일을 만듭니다.

diki run 
    --config=config.yaml 
    --all 
    --output=./report.json

• 알려진 공급자에 대한 특정 규칙 세트를 실행하십시오

diki run 
    --config=config.yaml 
    --provider=gardener 
    --ruleset-id=disa-kubernetes-stig 
    --ruleset-version=v2r1

• 알려진 공급자에 대해 규칙 세트에 정의 된 특정 규칙을 실행합니다.

diki run 
    --config=config.yaml 
    --provider=gardener 
    --ruleset-id=disa-kubernetes-stig 
    --ruleset-version=v2r1 
    --rule-id=242414

보고서

Diki는 diki run Execution의 출력 파일에서 인간 읽기 가능한 보고서를 생성 할 수 있습니다. 병합 된 보고서는 distinct-by 플래그를 설정하여 생성 할 수 있습니다. 이 플래그의 값은 키가 병합 된 보고서에 포함하려는 공급자의 ID 인 key=value 쌍의 목록이며, 값은 다른 제공자 실행 사이의 구별 값으로 사용되는 고유 한 메타 데이터 필드입니다.

• HTML 보고서를 생성하십시오

diki report generate 
    --output=report.html 
    output.json

• 병합 된 HTML 보고서를 생성하십시오

diki report generate 
    --distinct-by=gardener=id 
    --output=report.html 
    output1.json output2.json

차이점

Diki는 diki run 실행의 두 출력 파일의 차이를 포함하는 JSON을 생성 할 수 있습니다. 이것은 개선 (또는 회귀)을 식별하는 데 도움이 될 수 있습니다. 차이 보고서에서 인간 읽기 쉬운 HTML 차이 보고서를 생성 할 수 있습니다.

• 두 보고서간에 JSON 차이를 생성합니다

diki report diff 
    --title=Title 
    --old=output1.json 
    --new=output2.json 
    --output=difference.json

• 하나 이상의 JSON 차이 보고서를 HTML 보고서에 결합하십시오.

diki report generate diff 
    --identity-attributes=gardener=id 
    --output=difference.html 
    difference1.json difference2.json

단위 테스트

make test 통해 수동으로 테스트를 실행할 수 있습니다.

기여

기부금은 매우 환영합니다. 자세한 내용은 기고자 안내서를 참조하십시오.

크레딧

@vlerenc, @aleksandarsavchev 및 @dimityrmirchev에게 특별한 감사를 표합니다.