k8s – Запрос к API K8s
Новое в версии 2.5.
Обзор
- Использует Python-клиент OpenShift для извлечения конкретного объекта по имени, всех соответствующих объектов в пространстве имен или всех соответствующих объектов для всех пространств имен, а также информации о кластере.
- Предоставляет доступ ко всему спектру API K8s.
- Поддерживает аутентификацию через файл конфигурации, сертификаты, пароль или токен.
Псевдонимы: openshift
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, на котором выполняется этот поиск.
- python >= 2.7
- openshift >= 0.6
- PyYAML >= 3.11
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| api_key - | Токен, используемый для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_API_KEY. | ||
| api_version - | По умолчанию: "v1" | Используется для указания версии API. Если предоставлено определение ресурса, apiVersion из resource_definition переопределит этот параметр. | |
| cert_file - | Путь к сертификату, используемому для аутентификации с API. Также может быть задан через переменную окружения K8S_AUTH_CERT_FILE. | ||
| cluster_info - | Используется для указания типа информации о кластере, которую вы пытаетесь получить. Будет иметь приоритет над всеми другими параметрами. | ||
| 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 boolean |
| Требовать проверку SSL-сертификатов API-сервера. Также может быть задан через переменную окружения K8S_AUTH_VERIFY_SSL. |
Примечания
Примечание
- Python-клиент OpenShift оборачивает Python-клиент K8s, предоставляя полный доступ ко всем 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 complex | Один или несколько определений объектов, возвращаемых из API. | ||
| api_version строка | успех | Версионированная схема этого представления объекта. | |
| kind строка | успех | Представляет REST-ресурс, который представляет этот объект. | |
| metadata complex | успех | Стандартные метаданные объекта. Включает имя, пространство имен, аннотации, метки и т. д. | |
| spec complex | успех | Конкретные атрибуты объекта. Будут отличаться в зависимости от api_version и kind. | |
| status complex | успех | Текущие детали состояния объекта. | |
Статус
Авторы
- НЕИЗВЕСТНО
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/plugins/lookup/k8s.html