Шпаргалка
Шпаргалка Helm со всеми командами, необходимыми для управления приложениями.
Основные термины
Chart:
- Это имя вашего чарта, если он был загружен и распакован.
- Это <имя_репозитория>/<имя_чарта>, если репозиторий был добавлен, но чарт не загружен.
- Это URL или абсолютный путь к чарту.
Name:
- Это имя, которое вы хотите присвоить текущей установке чарта Helm.
Release:
- Это имя, которое вы присвоили экземпляру установки.
Revision:
- Это значение из вывода команды
helm history.
Repo-name:
- Имя репозитория.
DIR:
- Имя директории или путь к ней.
Управление чартами
helm create <name> # Создаёт директорию чарта вместе с общими файлами и директориями, используемыми в чарте.
helm package <chart-path> # Упаковывает чарт в версионированный архивный файл.
helm lint <chart> # Запускает тесты для проверки чарта и выявления возможных проблем.
helm show all <chart> # Проверяет чарт и выводит его содержимое.
helm show values <chart> # Отображает содержимое файла values.yaml.
helm pull <chart> # Скачивает чарт.
helm pull <chart> --untar=true # Если true, распаковывает чарт после скачивания.
helm pull <chart> --verify # Проверяет пакет перед использованием.
helm pull <chart> --version <number> # По умолчанию используется последняя версия; указывает ограничение версии чарта.
helm dependency list <chart> # Отображает список зависимостей чарта.
Установка и удаление приложений
helm install <name> <chart> # Устанавливает чарт с указанным именем.
helm install <name> <chart> --namespace <namespace> # Устанавливает чарт в указанное пространство имён.
helm install <name> <chart> --set key1=val1,key2=val2 # Задаёт значения в командной строке (можно указать несколько значений через запятую).
helm install <name> <chart> --values <yaml-file/url> # Устанавливает чарт с указанными значениями.
helm install <name> <chart> --dry-run --debug # Запускает тестовую установку для проверки чарта.
helm install <name> <chart> --verify # Проверяет пакет перед использованием.
helm install <name> <chart> --dependency-update # Обновляет зависимости, если они отсутствуют, перед установкой чарта.
helm uninstall <name> # Удаляет релиз из текущего (по умолчанию) пространства имён.
helm uninstall <release-name> --namespace <namespace> # Удаляет релиз из указанного пространства имён.
Обновление и откат приложений
helm upgrade <release> <chart> # Обновляет релиз.
helm upgrade <release> <chart> --rollback-on-failure # При неудачном обновлении откатывает внесённые изменения.
helm upgrade <release> <chart> --dependency-update # Обновляет зависимости, если они отсутствуют, перед установкой чарта.
helm upgrade <release> <chart> --version <version_number> # Указывает ограничение версии чарта.
helm upgrade <release> <chart> --values # Указывает значения в YAML-файле или по URL (можно указать несколько).
helm upgrade <release> <chart> --set key1=val1,key2=val2 # Задаёт значения в командной строке (можно указать несколько значений через запятую).
helm upgrade <release> <chart> --force # Принудительно обновляет ресурсы через стратегию замены.
helm rollback <release> <revision> # Откатывает релиз к указанной ревизии.
helm rollback <release> <revision> --cleanup-on-fail # Позволяет удалить новые ресурсы, созданные при откате, если откат не удался.
Работа с репозиториями
helm repo add <repo-name> <url> # Добавляет репозиторий из интернета.
helm repo list # Выводит список добавленных репозиториев чартов.
helm repo update # Обновляет локальную информацию о доступных чартах из репозиториев.
helm repo remove <repo_name> # Удаляет один или несколько репозиториев чартов.
helm repo index <DIR> # Читает текущую директорию и генерирует индексный файл на основе найденных чартов.
helm repo index <DIR> --merge # Объединяет сгенерированный индекс с существующим индексным файлом.
helm search repo <keyword> # Ищет чарты по ключевому слову в репозиториях.
helm search hub <keyword> # Ищет чарты в Artifact Hub или вашем собственном хабе.
Мониторинг релизов Helm
helm list # Выводит все релизы для указанного пространства имён; использует текущий контекст, если пространство имён не указано.
helm list --all # Показывает все релизы без фильтров (можно использовать -a).
helm list --all-namespaces # Выводит релизы из всех пространств имён (можно использовать -A).
helm list -l key1=value1,key2=value2 # Селектор (запрос по меткам) для фильтрации; поддерживает '=', '==' и '!='.
helm list --date # Сортирует по дате релиза.
helm list --deployed # Показывает развёрнутые релизы. Включается автоматически, если не указано иное.
helm list --pending # Показывает ожидающие релизы.
helm list --failed # Показывает неудавшиеся релизы.
helm list --uninstalled # Показывает удалённые релизы (если использовался 'helm uninstall --keep-history').
helm list --superseded # Показывает замещённые релизы.
helm list -o yaml # Выводит результат в указанном формате. Допустимые значения: table, json, yaml (по умолчанию table).
helm status <release> # Показывает статус указанного релиза.
helm status <release> --revision <number> # Показывает статус указанного релиза с определённой ревизией.
helm history <release> # Показывает историю ревизий для указанного релиза.
helm env # Выводит всю информацию об окружении, используемую Helm.
Получение информации о релизе
helm get all <release> # Выводит удобочитаемую информацию о заметках, хуках, переданных значениях и сгенерированном манифесте релиза.
helm get hooks <release> # Скачивает хуки для указанного релиза. Хуки форматируются в YAML и разделяются разделителем '---\n'.
helm get manifest <release> # Манифест — это YAML-представление ресурсов Kubernetes, сгенерированных из чарта(ов) релиза. Включает ресурсы зависимых чартов.
helm get notes <release> # Показывает заметки, предоставленные чартом указанного релиза.
helm get values <release> # Скачивает файл значений для указанного релиза. Используйте -o для форматирования вывода.
Управление плагинами
helm plugin install <path/url> # Устанавливает плагины.
helm plugin list # Показывает список всех установленных плагинов.
helm plugin update <plugin> # Обновляет плагины.
helm plugin uninstall <plugin> # Удаляет плагин.