wiki-js/DevOps/Hashicorp-Vault/Vault-cheat-sheet.md

334 lines
9.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

---
title: Vault Cheat Sheet
description:
published: true
date: 2024-07-17T10:02:21.449Z
tags: vault, cheat, sheet
editor: markdown
dateCreated: 2024-07-17T09:48:03.975Z
---
# Vault Cheat Sheet
<h2>Vault Commands Cheat Sheet</h2>
<h3>Secrets Management</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault kv put</code></td>
<td>Создает или обновляет пару ключ-значение в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv get</code></td>
<td>Извлекает значение определенного ключа в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv delete</code></td>
<td>Удаляет пару ключ-значение из секретного бэкэнда.</td>
</tr>
<tr>
<td><code>vault kv list</code></td>
<td>Список всех ключей в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv metadata get</code></td>
<td>Извлекает метаданные определенного ключа в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv metadata delete</code></td>
<td>Удаляет метаданные определенного ключа в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv metadata list</code></td>
<td>Содержит список метаданных для всех ключей в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv enable-versioning</code></td>
<td>Включает управление версиями для секретного серверного модуля.</td>
</tr>
<tr>
<td><code>vault kv disable-versioning</code></td>
<td>Отключает управление версиями для секретного серверного модуля.</td>
</tr>
<tr>
<td><code>vault kv undelete</code></td>
<td>Восстанавливает удаленную пару ключ-значение в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv destroy</code></td>
<td>Безвозвратно удаляет пару ключ-значение в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv undelete-metadata</code></td>
<td>Восстанавливает метаданные удаленного ключа в секретном бэкэнде.</td>
</tr>
<tr>
<td><code>vault kv destroy-metadata</code></td>
<td>Безвозвратно удаляет метаданные ключа в секретном бэкэнде.</td>
</tr>
</tbody>
</table>
<h3>Authentication</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault login</code></td>
<td>Аутентифицирует пользователя в Vault.</td>
</tr>
<tr>
<td><code>vault logout</code></td>
<td>Текущий аутентифицированный пользователь выходит из системы.</td>
</tr>
<tr>
<td><code>vault token create</code></td>
<td>Создает новый токен для аутентификации.</td>
</tr>
<tr>
<td><code>vault token revoke</code></td>
<td>Отзывает токен, делая его недействительным.</td>
</tr>
<tr>
<td><code>vault token lookup</code></td>
<td>Извлекает информацию о токене.</td>
</tr>
<tr>
<td><code>vault token renew</code></td>
<td>Продлевает аренду токена, продлевая срок его действия.</td>
</tr>
<tr>
<td><code>vault token revoke-prefix</code></td>
<td>Аннулирует все токены с заданным префиксом.</td>
</tr>
<tr>
<td><code>vault auth enable</code></td>
<td>Включает метод аутентификации в Vault.</td>
</tr>
<tr>
<td><code>vault auth disable</code></td>
<td>Отключает метод аутентификации в Vault.</td>
</tr>
<tr>
<td><code>vault auth list</code></td>
<td>Перечислены все разрешенные методы аутентификации в Vault.</td>
</tr>
</tbody>
</table>
<h3>Policies</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault policy write</code></td>
<td>Создает или обновляет политику с указанным именем.</td>
</tr>
<tr>
<td><code>vault policy read</code></td>
<td>Извлекает содержимое политики.</td>
</tr>
<tr>
<td><code>vault policy delete</code></td>
<td>Удаляет политику.</td>
</tr>
<tr>
<td><code>vault policy list</code></td>
<td>Список всех политик в Vault.</td>
</tr>
<tr>
<td><code>vault policy capabilities</code></td>
<td>Отображает возможности политики.</td>
</tr>
<tr>
<td><code>vault write auth/token/roles/my-role</code></td>
<td>Создает или обновляет роль токена.</td>
</tr>
<tr>
</tbody>
</table>
<td></td>
</tr>
<h3>Secrets Engines</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault secrets enable</code></td>
<td>Включает механизм секретов в Vault.</td>
</tr>
<tr>
<td><code>vault secrets disable</code></td>
<td>Отключает движок секретов в Vault.</td>
</tr>
<tr>
<td><code>vault secrets list</code></td>
<td>Список всех включенных движков secrets в Vault.</td>
</tr>
<tr>
<td><code>vault secrets tune</code></td>
<td>Настраивает конфигурацию движка секретов.</td>
</tr>
<tr>
<td><code>vault secrets move</code></td>
<td>Переносит движок секретов с одного пути на другой.</td>
</tr>
<tr>
<td><code>vault secrets migrate</code></td>
<td>Переносит секреты из одного движка secrets engine в другой.</td>
</tr>
<tr>
<td><code>vault secrets upgrade</code></td>
<td>Обновление версии движка secrets engine.</td>
</tr>
<tr>
<td><code>vault secrets path-help</code></td>
<td>Отображает справочную информацию о пути к движку secrets engine.
</td>
</tr>
</tbody>
</table>
<h3>Auditing and Logging</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault audit enable</code></td>
<td>Позволяет устройству аудита в Vault регистрировать события.</td>
</tr>
<tr>
<td><code>vault audit disable</code></td>
<td>Disables an audit device in Vault.</td>
</tr>
<tr>
<td><code>vault audit list</code></td>
<td>Lists all enabled audit devices in Vault.</td>
</tr>
<tr>
<td><code>vault audit hash</code></td>
<td>Hashes a single audit log file for integrity verification.</td>
</tr>
<tr>
<td><code>vault audit recover</code></td>
<td>Recovers and replays the audit log from a specified path.</td>
</tr>
<tr>
<td><code>vault audit migrate</code></td>
<td>Migrates audit devices from one path to another.</td>
</tr>
<tr>
<td><code>vault audit purge</code></td>
<td>Purges audit log files from a specified path.</td>
</tr>
<tr>
<td><code>vault monitor</code></td>
<td>Monitors the activity of secrets engines and authentication requests in real-time.</td>
</tr>
<tr>
<td><code>vault read sys/audit-hash</code></td>
<td>Retrieves the current hash of the audit log file.</td>
</tr>
</tbody>
</table>
<h3>Key Management</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault operator init</code></td>
<td>Initializes a new Vault instance with a master key share.</td>
</tr>
<tr>
<td><code>vault operator unseal</code></td>
<td>Unseals the Vault by providing a master key share.</td>
</tr>
<tr>
<td><code>vault operator seal</code></td>
<td>Seals the Vault, making it inaccessible.</td>
</tr>
<tr>
<td><code>vault operator rekey</code></td>
<td>Rekeys the Vault, rotating the encryption keys.</td>
</tr>
<tr>
<td><code>vault operator rotate</code></td>
<td>Rotates the underlying encryption keys for the transit secrets engine.</td>
</tr>
<tr>
<td><code>vault operator generate-root</code></td>
<td>Generates a new root token for disaster recovery.</td>
</tr>
</tbody>
</table>
<h3>Miscellaneous</h3>
<thead>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>vault status</code></td>
<td>Displays the current status of the Vault.</td>
</tr>
<tr>
<td><code>vault version</code></td>
<td>Displays the version information of the running Vault server.</td>
</tr>
<tr>
<td><code>vault list sys/mounts</code></td>
<td>Lists all the mounted secret backends.</td>
</tr>
<tr>
<td><code>vault auth token/lookup-self</code></td>
<td>Retrieves information about the currently authenticated token.</td>
</tr>
<tr>
<td><code>vault auth token/revoke-self</code></td>
<td>Revokes the currently authenticated token.</td>
</tr>
<tr>
<td><code>vault path-help</code></td>
<td>Displays help information for a specific Vault path.</td>
</tr>
<tr>
<td><code>vault policy validate</code></td>
<td>Validates the syntax of a policy without saving it.</td>
</tr>
<tr>
<td>`vault secrets</td>
<td></td>
</tr>
</tbody>
</table>