k8s - Запрос к API K8s
Новое в версии 2.5.
Описание
- Использует OpenShift Python клиент для получения определенного объекта по имени, всех соответствующих объектов в рамках пространства имен или всех соответствующих объектов для всех пространств имен.
- Обеспечивает доступ ко всему диапазону API K8s.
- Включает аутентификацию через файл конфигурации, сертификаты, пароль или токен.
Требования
Ниже приведены требования к локальному мастер-узлу, на котором выполняется этот запрос.
- python >= 2.7
- openshift == 0.4.1
- PyYAML >= 3.11
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| api_key | Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY. | ||
| api_version | По умолчанию: v1 | Используется для указания версии API. Если задано определение ресурса, apiVersion из resource_definition переопределит этот параметр. | |
| cert_file | Путь к сертификату, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_CERT_FILE. | ||
| context | Имя контекста, найденного в файле конфигурации. Также может быть задан через переменную окружения K8S_AUTH_CONTEXT. | ||
| field_selector | Конкретные поля для запроса. Игнорируется, когда задано resource_name. | ||
| host | Укажите URL для доступа к API. Также может быть задан через переменную окружения K8S_AUTH_HOST. | ||
| key_file | Путь к файлу ключа, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_HOST. | ||
| kind обязательно | Используется для указания модели объекта. Если задано определение ресурса, kind из resource_definition переопределит этот параметр. | ||
| kubeconfig | Путь к существующему файлу конфигурации Kubernetes. Если не указан и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть задан через переменную окружения K8S_AUTH_KUBECONFIG. | ||
| label_selector | Дополнительные метки для включения в запрос. Игнорируется, когда задано resource_name. | ||
| namespace | Ограничить возвращаемые объекты определенным пространством имен. Если задано определение ресурса, значение metadata.namespace из resource_definition переопределит этот параметр. | ||
| password | Укажите пароль для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_PASSWORD. | ||
| resource_definition | Укажите YAML конфигурацию для объекта. ПРИМЕЧАНИЕ: kind, api_version, resource_name и namespace будут перезаписаны соответствующими значениями, найденными в предоставленном resource_definition. | ||
| resource_name | Получить определенный объект по имени. Если задано определение ресурса, значение metadata.name из resource_definition переопределит этот параметр. | ||
| src | Укажите путь к файлу, содержащему допустимое YAML определение объекта. Взаимоисключающий с resource_definition. ПРИМЕЧАНИЕ: kind, api_version, resource_name и namespace будут перезаписаны соответствующими значениями, найденными в конфигурации, считанной из файла src. Чтение из локальной файловой системы. Для чтения из файловой системы контроллера Ansible используйте плагин поиска файла или плагин поиска шаблонов, совместно с фильтром from_yaml, и передайте результат в resource_definition. См. примеры ниже. | ||
| ssl_ca_cert | Путь к сертификату CA, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_SSL_CA_CERT. | ||
| username | Укажите имя пользователя для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_USERNAME. | ||
| verify_ssl |
| Выполнять ли проверку SSL-сертификатов API-сервера. Также может быть задан через переменную окружения K8S_AUTH_VERIFY_SSL. |
Примечания
Примечание
- OpenShift Python клиент оборачивает K8s Python клиент, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версиях API и дополнительную информацию см. на https://github.com/openshift/openshift-restclient-python
Примеры
- name: Fetch a list of namespaces
set_fact:
projects: "{{ lookup('k8s', api_version='v1', kind='Namespace') }}"
- name: Fetch all deployments
set_fact:
deployments: "{{ lookup('k8s', kind='Deployment', namespace='testing') }}"
- name: Fetch all deployments in a namespace
set_fact:
deployments: "{{ lookup('k8s', kind='Deployment', namespace='testing') }}"
- name: Fetch a specific deployment by name
set_fact:
deployments: "{{ lookup('k8s', kind='Deployment', namespace='testing', resource_name='elastic') }}"
- name: Fetch with label selector
set_fact:
service: "{{ lookup('k8s', kind='Service', label_selector='app=galaxy') }}"
# Use parameters from a YAML config
- name: Load config from the Ansible controller filesystem
set_fact:
config: "{{ lookup('file', 'service.yml') | from_yaml }}"
- name: Using the config (loaded from a file in prior task), fetch the latest version of the object
set_fact:
service: "{{ lookup('k8s', resource_definition=config) }}"
- name: Use a config from the local filesystem
set_fact:
service: "{{ lookup('k8s', src='service.yml') }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого запроса:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| _list сложный | Один или более определений объектов, возвращаемых из API. | ||
| status сложный | успех | Текущие детали статуса объекта. | |
| kind строка | успех | Представляет REST-ресурс, который представляет этот объект. | |
| spec сложный | успех | Конкретные атрибуты объекта. Будут различаться в зависимости от api_version и kind. | |
| api_version строка | успех | Версионированная схема этого представления объекта. | |
| metadata сложный | успех | Стандартные метаданные объекта. Включают имя, пространство имен, аннотации, метки и т.д. | |
Статус
Автор
- НЕИЗВЕСТНО
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/plugins/lookup/k8s.html