oc - Управление ресурсами OpenShift
Новая версия 2.4.
Обзор
- Этот модуль позволяет управлять ресурсами в кластере OpenShift. Хост инвентаризации может быть любым хостом с сетевым подключением к кластеру OpenShift; стандартный порт — 8443/TCP.
- Этот модуль использует токен для аутентификации в OpenShift. Это может быть токен пользователя или сервисного аккаунта.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| host | нет | 127.0.0.1 | Имя хоста или адрес конечной точки API OpenShift. По умолчанию ожидается, что это текущий хост инвентаризации. | |
| inline | нет | Встроенное определение ресурса. Это взаимоисключающее с параметрами name, namespace и kind. | ||
| kind | да | Тип ресурса, на котором нужно выполнить действие. | ||
| name | нет | Имя ресурса, на котором нужно выполнить действие. | ||
| namespace | нет | Пространство имен ресурса, на котором нужно выполнить действие. | ||
| port | нет | 8443 | Номер порта конечной точки API. | |
| state | да |
| Если состояние present, а ресурс не существует, он будет создан с использованием встроенного определения. Если состояние present и ресурс существует, определение будет обновлено, также используя встроенное определение. Если состояние absent, ресурс будет удален, если он существует. | |
| token | да | Токен для аутентификации в кластере OpenShift. |
Примеры
- name: Create project
oc:
state: present
inline:
kind: ProjectRequest
metadata:
name: ansibletestproject
displayName: Ansible Test Project
description: This project was created using Ansible
token: << redacted >>
- name: Delete a service
oc:
state: absent
name: myservice
namespace: mynamespace
kind: Service
token: << redacted >>
- name: Add project role Admin to a user
oc:
state: present
inline:
kind: RoleBinding
metadata:
name: admin
namespace: mynamespace
roleRef:
name: admin
userNames:
- "myuser"
token: << redacted >>
- name: Obtain an object definition
oc:
state: present
name: myroute
namespace: mynamespace
kind: Route
token: << redacted >>
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| method | HTTP-метод, используемый для выполнения действия над ресурсом | успех | строка | |
| result | Ресурс, который был создан, изменен или иначе определен как присутствующий. В случае удаления — ответ на запрос удаления. | успех | строка | |
| url | URL запрошенного ресурса. | успех | строка |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для помощи в разработке модулей, если вам это нужно, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/oc_module.html