community.kubernetes.k8s – Kubernetes (K8s) источник инвентаризации
Примечание
Этот плагин является частью коллекции community.kubernetes (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install community.kubernetes
Для использования в книге задач, укажите: community.kubernetes.k8s
Обзор
- Получение контейнеров и служб для одного или нескольких кластеров.
- Группировка по имени кластера, имени пространства имён, службам пространства имён, подкастам пространства имён и меткам.
- Использует плагин подключения kubectl для доступа к кластеру Kubernetes.
- Использует конфигурационный файл k8s.(yml|yaml) YAML для настройки значений параметров.
Требования
Ниже перечислены требования к локальному узлу контроллера, на котором выполняется эта инвентаризация.
- python >= 2.7
- openshift >= 0.6
- PyYAML >= 3.11
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии | |
|---|---|---|---|---|
| connections строка | Необязательный список настроек подключения к кластеру. Если подключения не указаны, используется значение по умолчанию ~/.kube/config и активный контекст, а объекты будут возвращены для всех пространств имён, к которым активный пользователь имеет доступ. | |||
| api_key строка | Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY. | |||
| ca_cert строка | Путь к сертификату CA, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT. псевдонимы: ssl_ca_cert | |||
| client_cert строка | Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE. псевдонимы: cert_file | |||
| client_key строка | Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_KEY_FILE. псевдонимы: key_file | |||
| context строка | Имя контекста, найденного в файле конфигурации. Также может быть указано через переменную окружения K8S_AUTH_CONTEXT. | |||
| host строка | Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST. | |||
| kubeconfig строка | Путь к существующему файлу конфигурации Kubernetes. Если не указан и другие параметры подключения отсутствуют, клиент OpenShift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. | |||
| name строка | Необязательное имя для присвоения кластеру. Если не указано, имя строится из сервера и порта. | |||
| namespaces строка | Список пространств имен. Если не указано, будут извлечены все контейнеры для всех пространств имён, к которым пользователь имеет доступ. | |||
| password строка | Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. | |||
| username строка | Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. | |||
| validate_certs логическое |
| Флаг, определяющий, нужно ли проверять сертификаты SSL сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL. псевдонимы: verify_ssl | ||
| plugin строка / обязательно |
| токен, который гарантирует, что это файл источника для плагина 'k8s'. | ||
Примеры
# File must be named k8s.yaml or k8s.yml
# Authenticate with token, and return all pods and services for all namespaces
plugin: community.kubernetes.k8s
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false
# Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
plugin: community.kubernetes.k8s
connections:
- namespaces:
- testing
# Use a custom config file, and a specific context.
plugin: community.kubernetes.k8s
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
Авторы
- Chris Houseknecht <@chouseknecht>
- Fabian von Feilitzsch <@fabianvf>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/kubernetes/k8s_inventory.html
