diki

Дики

Diki A «Проверка соответствия» или сортировки, детективная структура управления с подключаемыми наборами правил. Это часть семейства садовников, но может использоваться также на других дистрибуциях Kubernetes или даже в условиях, не связанных с некубернетами, например, чтобы проверить соблюдение ваших учетных записей гиперсклада.

Дики - греческое слово «испытание». Вы также можете запомнить его как «детективное расследование ключевых императивов» или как рекурсивную аббревиатуру в стиле GNU ». Дики исследует ключевые императивы». Он в разговорной речи известен как «Не знаю, я это не знаю», что хорошо подходит для того, что он делает.

Важный

Этот репозиторий активно развивается. API могут измениться без какой -либо обратной совместимости.

Начиная

Установка

Если вы установите через выпуск GitHub, вам нужно поместить бинар Diki на свой путь.

Образец установки фрагмента для 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 . Объединенные отчеты могут быть произведены путем установки distinct-by флага. Значение этого флага - это список паров 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 может генерировать JSON, содержащий разницу между двумя выходными файлами выполнения diki run . Это может помочь определить улучшения (или регрессии). Отчеты о различии HTML -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, которые внесли значительный вклад в проект до того, как он был доступен для публики.