kubernetes.core.k8s inventory – Источник инвентаризации Kubernetes (K8s)
Примечание
Этот плагин инвентаризации является частью коллекции kubernetes.core (версия 3.2.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install kubernetes.core. Для использования этого плагина инвентаризации необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook, укажите: kubernetes.core.k8s.
УСТАРЕВШИЙ
- Удалено в:
-
версия 6.0.0
- Почему:
-
Как обсуждалось в https://github.com/ansible-collections/kubernetes.core/issues/31, мы решили удалить плагин инвентаризации k8s в релизе 6.0.0.
- Альтернатива:
-
Используйте kubernetes.core.k8s_info и ansible.builtin.add_host вместо этого.
Краткое описание
- Извлечение контейнеров и сервисов для одного или нескольких кластеров.
- Группировка по имени кластера, пространству имен, namespace_services, namespace_pods и меткам.
- Использование плагина подключения kubectl для доступа к кластеру Kubernetes.
- Использование файла конфигурации YAML k8s.(yml|yaml) для установки значений параметров.
Требования
Следующие требования необходимы на локальном узле контроллера, который выполняет эту инвентаризацию.
- python >= 3.9
- kubernetes >= 24.2.0
- PyYAML >= 3.11
Параметры
Параметр | Комментарии |
|---|---|
connections string | Необязательный список параметров подключения к кластеру. Если параметры подключения не указаны, будут использоваться значения по умолчанию ~/.kube/config и активный контекст, и объекты будут возвращены для всех пространств имен, к которым активный пользователь имеет доступ. |
|
api_key string |
Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY. |
|
ca_cert aliases: ssl_ca_cert string |
Путь к сертификату CA, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT. |
|
client_cert aliases: cert_file string |
Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE. |
|
client_key aliases: key_file string |
Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_KEY_FILE. |
|
context string |
Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную окружения K8S_AUTH_CONTEXT. |
|
host string |
Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST. |
|
kubeconfig string |
Путь к существующему файлу конфигурации Kubernetes. Если не указан, и другие параметры подключения не указаны, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. |
|
name string |
Необязательное имя для присвоения кластеру. Если не указано, имя создается из сервера и порта. |
|
namespaces string |
Список пространств имен. Если не указано, будут извлечены все контейнеры для всех пространств имен, к которым пользователь имеет доступ. |
|
password string |
Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. |
|
username string |
Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. |
|
validate_certs aliases: verify_ssl boolean |
Проверять ли SSL-сертификаты сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL. Варианты:
|
plugin string / required | Токен, который гарантирует, что это исходный файл для плагина «k8s». Варианты:
|
Примеры
# File must be named k8s.yaml or k8s.yml
- name: Authenticate with token, and return all pods and services for all namespaces
plugin: kubernetes.core.k8s
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
plugin: kubernetes.core.k8s
connections:
- namespaces:
- testing
- name: Use a custom config file, and a specific context.
plugin: kubernetes.core.k8s
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
Статус
- Этот инвентарь будет удалён в версии 6.0.0. [устаревший]
- Дополнительную информацию см. в УСТАРЕВШЕМ.
Ссылки на сборки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/kubernetes/core/k8s_inventory.html