Огляд
Описує поля і структуру різних ресурсів.
Ця команда описує поля, повʼязані з кожним підтримуваним ресурсом API. Поля ідентифікуються за допомогою простого ідентифікатора JSONPath:
<type>.<fieldName>[.<fieldName>]
Інформація про кожне поле отримується з сервера у форматі OpenAPI.
Використовуйте "kubectl api-resources" для отримання повного списку підтримуваних ресурсів.
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [-o|--output=plaintext|plaintext-openapiv2]
Приклади
# Отримати документацію про ресурс та його поля
kubectl explain pods
# Отримати всі поля ресурсу
kubectl explain pods --recursive
# Отримати пояснення щодо deployment у підтримуваних версіях api
kubectl explain deployments --api-version=apps/v1
# Отримати документацію щодо певного поля ресурсу
kubectl explain pods.spec.containers
# Отримати документацію ресурсів у іншому форматі
kubectl explain deployment --output=plaintext-openapiv2
Параметри
| --api-version string | |
Використовувати вказану api-version (group/version) ресурсу. | |
| -h, --help | |
Довідка explain | |
| -o, --output string Типово: "plaintext" | |
Формат, у якому потрібно показати схему. Допустимими значеннями є: (plaintext, plaintext-openapiv2). | |
| --recursive | |
Якщо значення true, вивести назви всіх полів рекурсивно. Інакше, вивести доступні поля з їхнім описом. | |
Параметри батьківських команд
| --as string | |
Імʼя користувача, яке використовується для виконання операції. Користувач може бути звичайним користувачем або службовим обліковим записом в просторі імен. | |
| --as-group strings | |
Група, яка використовується для операції; цей прапорець можна повторити для вказівки декількох груп. | |
| --as-uid string | |
UID, який використовується для операції. | |
| --cache-dir string Типово: "$HOME/.kube/cache" | |
Типове розташування теки кешу | |
| --certificate-authority string | |
Шлях до файлу сертифіката для центра сертифікації | |
| --client-certificate string | |
Шлях до файлу клієнтського сертифіката для TLS | |
| --client-key string | |
Шлях до файлу ключа клієнта для TLS | |
| --cluster string | |
Назва файлу kubeconfig кластера, який слід використовувати | |
| --context string | |
Назва контексту kubeconfig, який слід використовувати | |
| --default-not-ready-toleration-seconds int Типово: 300 | |
Вказує tolerationSeconds для toleration notReady:NoExecute, який типово додається до кожного Pod, який ще не має такої толерантності. | |
| --default-unreachable-toleration-seconds int Типово: 300 | |
Вказує tolerationSeconds для toleration unreachable:NoExecute, який типово додається до кожного Pod, який ще не має такої толерантності. | |
| --disable-compression | |
Якщо true, відмовляється від стиснення відповіді для всіх запитів до сервера | |
| --insecure-skip-tls-verify | |
Якщо true, сертифікат сервера не буде перевірятися на дійсність. Це зробить ваші HTTPS-зʼєднання небезпечними | |
| --kubeconfig string | |
Шлях до файлу kubeconfig, який слід використовувати для CLI-запитів. | |
| --match-server-version | |
Вимагає, щоб версія сервера відповідала версії клієнта | |
| -n, --namespace string | |
Якщо присутній, простір імен для цього CLI-запиту | |
| --password string | |
Пароль для базової автентифікації на API-сервері | |
| --profile string Типово: "none" | |
Імʼя профілю для захоплення. Одне із (none|cpu|heap|goroutine|threadcreate|block|mutex) | |
| --profile-output string Типово: "profile.pprof" | |
Імʼя файлу, в який записується профіль | |
| --request-timeout string Типово: "0" | |
Час очікування перед відмовою у виконанні окремого запиту до сервера. Ненульові значення повинні містити відповідну одиницю часу (наприклад, 1s, 2m, 3h). Значення нуль означає відсутність тайм-ауту запитів. | |
| -s, --server string | |
Адреса та порт сервера API Kubernetes | |
| --storage-driver-buffer-duration duration Типово: 1m0s | |
Записи в драйвері зберігання будуть буферизовані на цей час і збережені в бекендах без памʼяті як одна транзакція | |
| --storage-driver-db string Типово: "cadvisor" | |
Назва бази даних | |
| --storage-driver-host string Типово: "localhost:8086" | |
Хост:порт бази даних | |
| --storage-driver-password string Типово: "root" | |
Пароль бази даних | |
| --storage-driver-secure | |
використовувати захищене зʼєднання з базою даних | |
| --storage-driver-table string Типово: "stats" | |
Назва таблиці | |
| --storage-driver-user string Типово: "root" | |
Імʼя користувача бази даних | |
| --tls-server-name string | |
Імʼя сервера, яке використовується для перевірки дійсності сертифіката сервера. Якщо воно не надане, використовується імʼя хоста, яке використовується для звʼязку з сервером | |
| --token string | |
Токен на предʼявника для автентифікації на API-сервері | |
| --user string | |
Імʼя користувача kubeconfig, яке слід використовувати | |
| --username string | |
Імʼя користувача для базової автентифікації на API-сервері | |
| --version version[=true] | |
--version, --version=raw виводить інформацію про версію та завершує роботу; --version=vX.Y.Z... задає відповідну версію | |
| --warnings-as-errors | |
Трактувати попередження, отримані від сервера, як помилки і виходити з ненульовим кодом виходу | |
Дивіться також
- kubectl — kubectl керує менеджером кластерів Kubernetes